当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

StrategyResponseImpl - 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.impl.strategy
Class StrategyResponseImpl

java.lang.Object
  org.jboss.portal.theme.impl.strategy.StrategyResponseImpl

All Implemented Interfaces:

StrategyResponse

---

public class StrategyResponseImpl

extends java.lang.Object

implements StrategyResponse

Implementation of the strategy response.

See Also:

StrategyResponse

---

Method Summary
void	addNoRender(PortletContext portlet)           Add a portlet to the list of portlets that are excluded from the render process.
void	addPortletModeChange(PortletContext portlet, Mode mode)           Add a portlet to the list of portlets that received a new portlet mode by the strategy.
void	addWindowStateChange(PortletContext portlet, WindowState state)           Add a portlet to the list of portlets that received a new window state by the strategy.
java.lang.String	getLayoutState()           Get the state for this strategy response
java.lang.String	getLayoutURI()           Get the URI of the layout to use.
java.util.List	getNoRenderList()           Get the list of portlets (portlet context) that should not be rendered by the portlet container.
java.util.Map	getPortletModeChangeMap()           Get a map of portlets that should change their mode, with the new mode in the value
java.util.Map	getWindowStateChangeMap()           Get a map of portlets that should change their window state, with the new state in the value
void	reset()           Reset all the state of this response.
void	setLayoutState(java.lang.String state)           Set the state for this strategy response.
void	setLayoutURI(java.lang.String layoutURI)           Set the layout URI to use

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

getLayoutURI

public java.lang.String getLayoutURI()

Description copied from interface: StrategyResponse

Get the URI of the layout to use. Note: this URI can only be one of the layout URIs defined in the layout of this request If the strategy does not return a URI, the strategy interceptor will test if the response contains a state, and if so, will try to get the URI for that state from the layout

Specified by:

getLayoutURI in interface StrategyResponse

Returns:

the URI of the layout to delegate to

See Also:

StrategyResponse.getLayoutURI()

---

getWindowStateChangeMap

public java.util.Map getWindowStateChangeMap()

Description copied from interface: StrategyResponse

Get a map of portlets that should change their window state, with the new state in the value

Specified by:

getWindowStateChangeMap in interface StrategyResponse

Returns:

a map of portlets with changed window states (key: portlet context: value: window state)

See Also:

StrategyResponse.getWindowStateChangeMap()

---

getNoRenderList

public java.util.List getNoRenderList()

Description copied from interface: StrategyResponse

Get the list of portlets (portlet context) that should not be rendered by the portlet container.

Specified by:

getNoRenderList in interface StrategyResponse

Returns:

the list of portlets that should not be rendered

See Also:

StrategyResponse.getNoRenderList()

---

addNoRender

public void addNoRender(PortletContext portlet)

Description copied from interface: StrategyResponse

Add a portlet to the list of portlets that are excluded from the render process.

Specified by:

addNoRender in interface StrategyResponse

Parameters:

portlet - the portlet to exclude

See Also:

StrategyResponse.addNoRender(org.jboss.portal.theme.page.PortletContext)

---

addPortletModeChange

public void addPortletModeChange(PortletContext portlet,
                                 Mode mode)

Description copied from interface: StrategyResponse

Add a portlet to the list of portlets that received a new portlet mode by the strategy.

Specified by:

addPortletModeChange in interface StrategyResponse

Parameters:

portlet - the portlet that got the new portlet mode

mode - the new portlet mode

See Also:

PortletContext, Mode, StrategyResponse.getPortletModeChangeMap()

---

getPortletModeChangeMap

public java.util.Map getPortletModeChangeMap()

Description copied from interface: StrategyResponse

Get a map of portlets that should change their mode, with the new mode in the value

Specified by:

getPortletModeChangeMap in interface StrategyResponse

Returns:

a map of portlets with changed portlet modes (key: portlet context: value: portlet mode)

See Also:

PortletContext, Mode, StrategyResponse.addPortletModeChange(org.jboss.portal.theme.page.PortletContext, org.jboss.portal.Mode)

---

addWindowStateChange

public void addWindowStateChange(PortletContext portlet,
                                 WindowState state)

Description copied from interface: StrategyResponse

Add a portlet to the list of portlets that received a new window state by the strategy.

Specified by:

addWindowStateChange in interface StrategyResponse

Parameters:

portlet - the portlet that got the new window state

state - the new window state

See Also:

StrategyResponse.addWindowStateChange(org.jboss.portal.theme.page.PortletContext, org.jboss.portal.WindowState)

---

reset

public void reset()

Description copied from interface: StrategyResponse

Reset all the state of this response.

After the reset, the response's state is equal to the state after it was created

Specified by:

reset in interface StrategyResponse

See Also:

StrategyResponse.reset()

---

setLayoutURI

public void setLayoutURI(java.lang.String layoutURI)

Description copied from interface: StrategyResponse

Set the layout URI to use

Specified by:

setLayoutURI in interface StrategyResponse

Parameters:

layoutURI - the layout URI to use

See Also:

StrategyResponse.setLayoutURI(java.lang.String)

---

setLayoutState

public void setLayoutState(java.lang.String state)

Description copied from interface: StrategyResponse

Set the state for this strategy response.

The state is used to find a layout URI that is more atuned to this particular state

Specified by:

setLayoutState in interface StrategyResponse

Parameters:

state - the state to use when looking for a layout URI

See Also:

StrategyResponse.setLayoutState(java.lang.String)

---

getLayoutState

public java.lang.String getLayoutState()

Description copied from interface: StrategyResponse

Get the state for this strategy response

Specified by:

getLayoutState in interface StrategyResponse

Returns:

the state for this strategy response

See Also:

StrategyResponse.getLayoutState()

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---