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

PageResult - 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
Interface PageResult

All Known Implementing Classes:

PageResponse

---

public interface PageResult

Interface to represent the read only information of a rendered portal page.

The page result allows access to all the information needed to generate the final markup.

---

Method Summary
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 windowID)           Get the WindowResult for a specific portlet window.
java.util.Map	getWindowResultMap()           Get a map of WindowResults keyed by window id

 

Method Detail

getStreamInfo

public HTTPStreamInfo getStreamInfo()

Information about the http connection.

Returns:

details about the http connection

---

getLayout

public PortalLayout getLayout()

Get the layout that was determined for this page.

Returns:

the layout that will be used to render the page response

---

getLayoutURI

public java.lang.String getLayoutURI()

Get the uri of the layout that is used.

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

Returns:

the uri of the used layout

---

getLayoutState

public java.lang.String getLayoutState()

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.

Returns:

a string representing the current window state to potentially further select a more specific layout uri

---

getTheme

public PortalTheme getTheme()

Get the portal theme to use.

Returns:

the theme that will be used to theme the rendered markup

---

getWindowResultMap

public java.util.Map getWindowResultMap()

Get a map of WindowResults keyed by window id

Returns:

a map of window results

---

getWindowResult

public WindowResult getWindowResult(java.lang.String windowID)

Get the WindowResult for a specific portlet window.

Parameters:

windowID - 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()

Get a Set of all window ids that are contained in this page.

Returns:

a set of all window ids on this page

---

getWindowIDs

public java.util.Set getWindowIDs(java.lang.String regionName)

Get a Set of all window ids of the portlets in the the provided region.

Parameters:

regionName - the name of the region to get all window ids for

Returns:

a set of portlet window ids that are assigned to the provided region

---

getRegion

public Region getRegion(java.lang.String regionName)

Get a reference to the region object for the provided region name.

Parameters:

regionName - the name of the region to get

Returns:

the region for the provided region name

---

getPortletContextMap

public java.util.Map getPortletContextMap()

Get a map of all PortletContexts on the page keyed by window id

Returns:

a map of all portlet on the page

---

getPortletContext

public PortletContext getPortletContext(java.lang.String windowID)

Get the PortletContext for the provided window id.

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()

Get the rendet set for the page.

Returns:

the rendet set to use when rendering the markup of this page

---

getName

public java.lang.String getName()

Get the name of the requested page.

Returns:

the name of the page that is being rendered

---

getPageProperties

public java.util.Map getPageProperties()

Get the properties that were set for this page.

Returns:

a java.util.Map of the properties of this page

---

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

---