RegionRenderer - 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.render
Interface RegionRenderer

All Superinterfaces:: Renderer

All Known Implementing Classes:: DivRegionRenderer, EmptyRegionRenderer

public interface RegionRenderer
extends Renderer

A region renderer is responsible to create the markup container for a set of portlets on a page region.

The Portlets on a portal page can be assigned to regions of that page. Regions are sub elements of a page, that will be used by a layout to position groups of portlets over the areas of the page. The region renderer can be invoked to render the entire content of the region. It is assumed to take over the responsibility of delegating to the WindowRenderer for each portlet that needs to be rendered in the region in question.

See Also:: PortalRenderSet, WindowRenderer

Method Summary

void render(RenderContext renderContext, Region region, java.util.Map portletContexts, java.util.Map windowResults)
Render the markup of an entire page region with all the portlets that are assigned to that region.

Methods inherited from interface org.jboss.portal.theme.render.Renderer

renderEnd, renderStart

Method Detail

render

public void render(RenderContext renderContext,
                   Region region,
                   java.util.Map portletContexts,
                   java.util.Map windowResults)
            throws RenderException

Render the markup of an entire page region with all the portlets that are assigned to that region.

Parameters:: renderContext - the state holder to provide information about the region, it's portlets, and the render set, which allows access to the other renderer interfaces of the render set.; region - the region to be rendered; windowResults -
Throws:: RenderException
See Also:: WindowRenderer.render(org.jboss.portal.theme.render.RenderContext, org.jboss.portal.theme.page.PortletContext, org.jboss.portal.theme.page.WindowResult)