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

java.lang.Object
  org.jboss.portal.theme.render.MarkupResult
      org.jboss.portal.theme.page.PageResult

Direct Known Subclasses:: ModifiablePageResult

public class PageResult
extends MarkupResult

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.

Field Summary

protected java.util.Map portletRegions


Fields inherited from class org.jboss.portal.theme.render.MarkupResult

layoutState, layoutURI, navigationalStateContext, pageName, pageProperties, portalProperties, portlets, renderSet, results

Constructor Summary

PageResult(NavigationalStateContext navCtx, java.lang.String pageName, java.util.Map pageProperties, java.util.Map portalProperties)


Method Summary

Region getRegion(java.lang.String regionName)
          Get a reference to the region object for the provided region name.

Methods inherited from class org.jboss.portal.theme.render.MarkupResult

getLayoutState, getLayoutURI, getPageName, getPageProperties, getPortalProperties, getPortletMode, getWindowContext, getWindowContextMap, getWindowIDs, getWindowResult, getWindowResultMap, getWindowState

Methods inherited from class java.lang.Object

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

Field Detail

portletRegions

protected final java.util.Map portletRegions

Constructor Detail

PageResult

public PageResult(NavigationalStateContext navCtx,
                  java.lang.String pageName,
                  java.util.Map pageProperties,
                  java.util.Map portalProperties)

Method Detail

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