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

MarkupResult - JBOSS Portal 2.4 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.render
Class MarkupResult

java.lang.Object
  extended byorg.jboss.portal.theme.render.MarkupResult
Direct Known Subclasses:
PageResult, RegionResult, UnusableMarkupResult, WindowResult
public abstract class MarkupResult
extends java.lang.Object

The resulting markup fragment from a render process.

Field Summary
protected  java.lang.String layoutState
           
protected  java.lang.String layoutURI
           
protected  NavigationalStateContext navigationalStateContext
           
protected  java.lang.String pageName
           
protected  java.util.Map pageProperties
           
protected  java.util.Map portalProperties
           
protected  java.util.Map portlets
           
protected  PortalRenderSet renderSet
           
protected  java.util.Map results
           
 
Constructor Summary
MarkupResult()
           
MarkupResult(NavigationalStateContext navCtx, java.lang.String pageName, java.util.Map pageProperties, java.util.Map portalProperties)
           
 
Method Summary
 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 getPageName()
          Get the name of the requested page.
 java.util.Map getPageProperties()
          Get the properties that were set for this page.
 java.util.Map getPortalProperties()
          Get the properties that were set for this page.
 Mode getPortletMode(java.lang.String windowId)
          Get the portlet mode of a window
 WindowContext getWindowContext(java.lang.String windowId)
          Get the WindowContext for the provided window id.
 java.util.Map getWindowContextMap()
          Get a map of all PortletContexts on the page keyed by window id
 java.util.Set getWindowIDs()
          Get a Set of all window ids that are contained in this page.
 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
 WindowState getWindowState(java.lang.String windowId)
          Get the window state of a window
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

results

protected final java.util.Map results

portlets

protected final java.util.Map portlets

pageName

protected java.lang.String pageName

portalProperties

protected java.util.Map portalProperties

pageProperties

protected java.util.Map pageProperties

navigationalStateContext

protected NavigationalStateContext navigationalStateContext

layoutURI

protected java.lang.String layoutURI

layoutState

protected java.lang.String layoutState

renderSet

protected PortalRenderSet renderSet
Constructor Detail

MarkupResult

public MarkupResult()

MarkupResult

public MarkupResult(NavigationalStateContext navCtx,
                    java.lang.String pageName,
                    java.util.Map pageProperties,
                    java.util.Map portalProperties)
Method Detail

getPageName

public java.lang.String getPageName()
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

getPortalProperties

public java.util.Map getPortalProperties()
Get the properties that were set for this page.

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

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

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

getWindowResult

public WindowResult getWindowResult(java.lang.String windowHandle)
Get the WindowResult for a specific portlet window.

Parameters:
windowHandle - the window id identifying the portlet window to get the window result for
Returns:
the window result for the provided window id

getWindowResultMap

public java.util.Map getWindowResultMap()
Get a map of WindowResults keyed by window id

Returns:
a map of window results

getWindowContext

public WindowContext getWindowContext(java.lang.String windowId)
Get the WindowContext for the provided window id.

Parameters:
windowId - the window id identifying the portlet to get the context for
Returns:
the window context for the provided window id

getWindowContextMap

public java.util.Map getWindowContextMap()
Get a map of all PortletContexts on the page keyed by window id

Returns:
a map of all portlet on the page

getWindowState

public WindowState getWindowState(java.lang.String windowId)
Get the window state of a window

Parameters:
windowId - the identifier of the window on the page
Returns:
the window state of the provided window
Throws:
java.lang.IllegalStateException - if no navigational state context was provided for this markup result
See Also:
org.jboss.portal.portlet.WindowState, WindowNavigationalState

getPortletMode

public Mode getPortletMode(java.lang.String windowId)
Get the portlet mode of a window

Parameters:
windowId - the identifier of the window on the page
Returns:
the portlet mode of the provided window
Throws:
java.lang.IllegalStateException - if no navigational state context was provided for this markup result
See Also:
Mode, WindowNavigationalState
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD