LayoutStrategy - JBOSS Portal 2.2 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.theme.strategy
Interface LayoutStrategy

All Known Implementing Classes:: AbstractLayoutStrategy

public interface LayoutStrategy

The strategy of a layout can prepare the portal to render the correct portlets in the correct state.

A layout strategy is a place where the layout can tell the portal to change attributes of the portlets that are about to be rendered. It can only influence portlets that are in the current list of portlets to be rendered. The operations available to the strategy are:

flag individual portlets in the list as 'do-not-render'
change the window state of individual portlets in the list
change the layout to be used to generate the portal markup

Method Summary

StrategyResponse evaluate(StrategyContext context)
          Evaluate the strategy and return a strategy response, containing the desired changes.

java.lang.String getAppID()


MediaType getMediaType()


java.lang.String getName()

Method Detail

evaluate

public StrategyResponse evaluate(StrategyContext context)
                          throws StrategyException

Evaluate the strategy and return a strategy response, containing the desired changes.

Parameters:: context - a context containing the portal's current information about portlets, states and layout
Returns:: a strategy response with the desired changes
Throws:: StrategyException - if the strategy is missconfigured, or can't deal with the provided information
See Also:: StrategyResponse, StrategyContext

getAppID

public java.lang.String getAppID()

getName

public java.lang.String getName()

getMediaType

public MediaType getMediaType()