站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

StrategyResponse - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.theme.strategy
Class StrategyResponse

java.lang.Object
  extended byorg.jboss.portal.theme.strategy.StrategyResponse

public final class StrategyResponse
extends java.lang.Object

Implementation of the strategy response.

This response is a context for a layout stategy to use in order to communicate desired changes back to the portal.

Version:
$Revision: 5448 $
Author:
Martin Holzner.

Field Summary
private  java.lang.String layoutURI
           
private  java.util.Map modeChangeMap
           
private  java.util.List noRenderList
           
private  java.lang.String state
           
private  java.util.Map stateChangeMap
           
private  java.util.Map windowContextsToRestore
           
private  java.util.Map windowRegionChangeMap
           
 
Constructor Summary
(package private) StrategyResponse()
          Create a new instance of a response.
 
Method Summary
 void addNoRender(WindowLocation portlet)
           
 void addPortletModeChange(WindowContext portlet, Mode mode)
           
 void addWindowStateChange(WindowContext portlet, WindowState state)
           
 void changeRegion(java.lang.String windowID, java.lang.String regionName)
           
 java.lang.String getLayoutState()
           
 java.lang.String getLayoutURI()
           
 java.util.List getNoRenderList()
           
 java.util.Map getPortletModeChangeMap()
           
 java.util.Map getWindowIDsToRestore()
           
 java.util.Map getWindowRegionChangeMap()
           
 java.util.Map getWindowStateChangeMap()
           
 void reset()
           
 void restoreWindowLocation(java.lang.String windowID, WindowState newState)
          Restore the previous (original?) state of this window context
 void setLayoutState(java.lang.String state)
           
 void setLayoutURI(java.lang.String layoutURI)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

state

private java.lang.String state

layoutURI

private java.lang.String layoutURI

stateChangeMap

private java.util.Map stateChangeMap

modeChangeMap

private java.util.Map modeChangeMap

noRenderList

private java.util.List noRenderList

windowContextsToRestore

private java.util.Map windowContextsToRestore

windowRegionChangeMap

private java.util.Map windowRegionChangeMap
Constructor Detail

StrategyResponse

StrategyResponse()
Create a new instance of a response.

Method Detail

getLayoutURI

public java.lang.String getLayoutURI()
See Also:
getLayoutURI()

getWindowStateChangeMap

public java.util.Map getWindowStateChangeMap()
See Also:
getWindowStateChangeMap()

getNoRenderList

public java.util.List getNoRenderList()
See Also:
getNoRenderList()

addNoRender

public void addNoRender(WindowLocation portlet)

addPortletModeChange

public void addPortletModeChange(WindowContext portlet,
                                 Mode mode)

getPortletModeChangeMap

public java.util.Map getPortletModeChangeMap()

addWindowStateChange

public void addWindowStateChange(WindowContext portlet,
                                 WindowState state)
See Also:
addWindowStateChange(org.jboss.portal.theme.page.WindowContext, org.jboss.portal.WindowState)

reset

public void reset()
See Also:
reset()

setLayoutURI

public void setLayoutURI(java.lang.String layoutURI)
See Also:
setLayoutURI(java.lang.String)

setLayoutState

public void setLayoutState(java.lang.String state)
See Also:
setLayoutState(java.lang.String)

getLayoutState

public java.lang.String getLayoutState()
See Also:
getLayoutState()

restoreWindowLocation

public void restoreWindowLocation(java.lang.String windowID,
                                  WindowState newState)
Restore the previous (original?) state of this window context

This is a cnvenience method for cases like the maximized portlet that temporarily moves to another region while it is maximized. Once the maximized state is changed back, the portlet needs to move back to its original region and order

Parameters:
windowID -

getWindowIDsToRestore

public java.util.Map getWindowIDsToRestore()

changeRegion

public void changeRegion(java.lang.String windowID,
                         java.lang.String regionName)

getWindowRegionChangeMap

public java.util.Map getWindowRegionChangeMap()