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

PageResponse - 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.page
Class PageResponse

java.lang.Object
  extended byorg.jboss.portal.theme.page.PageResponse
All Implemented Interfaces:
PageResult
public class PageResponse
extends java.lang.Object
implements PageResult

Field Summary
protected  PageResponseContext context
           
protected  PortalLayout layout
           
protected  PortalTheme theme
           
protected  java.util.Set windows
           
 
Constructor Summary
PageResponse(PageResponseContext responseContext, java.lang.String pageName, java.util.Map pageProperties)
           
 
Method Summary
 void addPortletContext(PortletContext portletContext)
           
 void addWindowID(java.lang.String windowID)
           
 void addWindowResult(java.lang.String windowID, WindowResult result)
           
 PageResponseContext getContext()
           
 PortalLayout getLayout()
          Get the layout that was determined for this page.
 java.lang.String getLayoutState()
          Get the state string of the layout.
 java.lang.String getLayoutURI()
          Get the uri of the layout that is used.
 java.lang.String getName()
          Get the name of the requested page.
 java.util.Map getPageProperties()
          Get the properties that were set for this page.
 PortletContext getPortletContext(java.lang.String windowID)
          Get the PortletContext for the provided window id.
 java.util.Map getPortletContextMap()
          Get a map of all PortletContexts on the page keyed by window id
 Region getRegion(java.lang.String regionName)
          Get a reference to the region object for the provided region name.
 PortalRenderSet getRenderSet()
          Get the rendet set for the page.
 HTTPStreamInfo getStreamInfo()
          Information about the http connection.
 PortalTheme getTheme()
          Get the portal theme to use.
 java.util.Set getWindowIDs()
          Get a Set of all window ids that are contained in this page.
 java.util.Set getWindowIDs(java.lang.String regionName)
          Get a Set of all window ids of the portlets in the the provided region.
 WindowResult getWindowResult(java.lang.String windowHandle)
          Get the WindowResult for a specific portlet window.
 java.util.Map getWindowResultMap()
          Get a map of WindowResults keyed by window id
 void setLayout(PortalLayout layout)
           
 void setLayoutState(java.lang.String layoutState)
           
 void setLayoutURI(java.lang.String uri)
           
 void setRenderSet(PortalRenderSet renderSet)
           
 void setTheme(PortalTheme theme)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

context

protected final PageResponseContext context

windows

protected final java.util.Set windows

layout

protected PortalLayout layout

theme

protected PortalTheme theme
Constructor Detail

PageResponse

public PageResponse(PageResponseContext responseContext,
                    java.lang.String pageName,
                    java.util.Map pageProperties)
Method Detail

getStreamInfo

public HTTPStreamInfo getStreamInfo()
Description copied from interface: PageResult
Information about the http connection.

Specified by:
getStreamInfo in interface PageResult
Returns:
details about the http connection

getLayout

public PortalLayout getLayout()
Description copied from interface: PageResult
Get the layout that was determined for this page.

Specified by:
getLayout in interface PageResult
Returns:
the layout that will be used to render the page response

getLayoutURI

public java.lang.String getLayoutURI()
Description copied from interface: PageResult
Get the uri of the layout that is used.

The uri is relative to the application context that hosts the layout.

Specified by:
getLayoutURI in interface PageResult
Returns:
the uri of the used layout

getLayoutState

public java.lang.String getLayoutState()
Description copied from interface: PageResult
Get the state string of the layout.

The state is used to further sub select a layout uri. One layout can contain a separate layout uri per state. The state has to match to string version of one of the allowed window states.

Specified by:
getLayoutState in interface PageResult
Returns:
a string representing the current window state to potentially further select a more specific layout uri

getTheme

public PortalTheme getTheme()
Description copied from interface: PageResult
Get the portal theme to use.

Specified by:
getTheme in interface PageResult
Returns:
the theme that will be used to theme the rendered markup

getWindowResultMap

public java.util.Map getWindowResultMap()
Description copied from interface: PageResult
Get a map of WindowResults keyed by window id

Specified by:
getWindowResultMap in interface PageResult
Returns:
a map of window results

getWindowResult

public WindowResult getWindowResult(java.lang.String windowHandle)
Description copied from interface: PageResult
Get the WindowResult for a specific portlet window.

Specified by:
getWindowResult in interface PageResult
Parameters:
windowHandle - the window id identifying the portlet window to get the window result for
Returns:
the window result for the provided window id

getWindowIDs

public java.util.Set getWindowIDs(java.lang.String regionName)
Description copied from interface: PageResult
Get a Set of all window ids of the portlets in the the provided region.

Specified by:
getWindowIDs in interface PageResult
Parameters:
regionName - the name of the region that hosts the portlets that we are interested in
Returns:
the portlets that are part of the provided region

getWindowIDs

public java.util.Set getWindowIDs()
Description copied from interface: PageResult
Get a Set of all window ids that are contained in this page.

Specified by:
getWindowIDs in interface PageResult
Returns:
a set of windowIDs that need to be rendered (of type String)

getRegion

public Region getRegion(java.lang.String regionName)
Description copied from interface: PageResult
Get a reference to the region object for the provided region name.

Specified by:
getRegion in interface PageResult
Parameters:
regionName - the name of the region to get
Returns:
the region for the provided region name

getPortletContextMap

public java.util.Map getPortletContextMap()
Description copied from interface: PageResult
Get a map of all PortletContexts on the page keyed by window id

Specified by:
getPortletContextMap in interface PageResult
Returns:
a map of all portlet on the page

getPortletContext

public PortletContext getPortletContext(java.lang.String windowID)
Description copied from interface: PageResult
Get the PortletContext for the provided window id.

Specified by:
getPortletContext in interface PageResult
Parameters:
windowID - the window id identifying the portlet to get the context for
Returns:
the portlet context for the provided window id

getRenderSet

public PortalRenderSet getRenderSet()
Description copied from interface: PageResult
Get the rendet set for the page.

Specified by:
getRenderSet in interface PageResult
Returns:
the rendet set to use when rendering the markup of this page

getName

public java.lang.String getName()
Description copied from interface: PageResult
Get the name of the requested page.

Specified by:
getName in interface PageResult
Returns:
the name of the page that is being rendered

getPageProperties

public java.util.Map getPageProperties()
Description copied from interface: PageResult
Get the properties that were set for this page.

Specified by:
getPageProperties in interface PageResult
Returns:
a java.util.Map of the properties of this page

getContext

public PageResponseContext getContext()

setLayout

public void setLayout(PortalLayout layout)

setLayoutURI

public void setLayoutURI(java.lang.String uri)

setTheme

public void setTheme(PortalTheme theme)

addWindowID

public void addWindowID(java.lang.String windowID)

addWindowResult

public void addWindowResult(java.lang.String windowID,
                            WindowResult result)

addPortletContext

public void addPortletContext(PortletContext portletContext)

setLayoutState

public void setLayoutState(java.lang.String layoutState)

setRenderSet

public void setRenderSet(PortalRenderSet renderSet)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD