RenderRegionCommand - 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.core.command
Class RenderRegionCommand

java.lang.Object
  org.jboss.portal.common.invocation.Invocation
      org.jboss.portal.core.command.ControllerCommand
          org.jboss.portal.core.command.PortalObjectCommand
              org.jboss.portal.core.command.MarkupCommand
                  org.jboss.portal.core.command.RenderRegionCommand

public final class RenderRegionCommand
extends MarkupCommand

Render the content (markup) of a particular region on a page.

Field Summary

Fields inherited from class org.jboss.portal.core.command.ControllerCommand

context, log

Constructor Summary

RenderRegionCommand(java.lang.String pageRef, Region region)

Method Summary

MarkupResult renderFragments(ServerConfig cfg, NavigationalStateContext navCtx)
Call the component / portlet invocation for each portlet window in this region, and assemble the resulting markup fragments into a region result

Methods inherited from class org.jboss.portal.core.command.MarkupCommand

create, enforceSecurity, execute, getInfo, getLayout, getLayout, getMarkupContainer, getPage, getPageRef, getTarget, renderPortletWindow

Methods inherited from class org.jboss.portal.core.command.ControllerCommand

destroy, dispatch, getContext, setContext

Methods inherited from class org.jboss.portal.common.invocation.Invocation

getAttribute, invoke, invokeNext, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderRegionCommand

public RenderRegionCommand(java.lang.String pageRef,
                           Region region)

Method Detail

renderFragments

public MarkupResult renderFragments(ServerConfig cfg,
                                    NavigationalStateContext navCtx)
                             throws CommandException

Call the component / portlet invocation for each portlet window in this region, and assemble the resulting markup fragments into a region result

Specified by:: renderFragments in class MarkupCommand

Parameters:: cfg - the server configuration to get access to customizable error behaviour; navCtx - the navigational state context to access page and window navigational state
Returns:: a modifiable region result containing the markup fragments from the individual portlets on this page
Throws:: InvocationException; CommandException