PortalRenderSet - 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 PortalRenderSet

All Known Implementing Classes:: RenderSetImpl

public interface PortalRenderSet

A portal render set is a wrapper for the 4 renderer interface implementations.

A portal render set consists of 4 renderers. Each renderer is responsible to generate parts of the markup of a region, and to delegate to the appropriate renderer for any sub regions that need to be embedded. The basic architecture is such that the region renderer is the outer most container. It is responsible for generating the markup that contains all the markup of a region. For each portlet that needs to be rendered in the region, the region renderer delegates to the window renderer. The window renderer is responsible for the generated markup of each portlet window. It delegates to the decoration renderer to generate the markup for the state and mode links, and the portlet title. The portlet window renderer also delegates to the portlet renderer which is responsible for the markup of the portlet itself. The render set is used in combination with a RenderContext. Each renderer can access the other renderers in the set via the render context.

See Also:: RenderContext, RegionRenderer, WindowRenderer, DecorationRenderer, PortletRenderer

Method Summary

java.lang.String getAppID()
          Get the name of the application (the WAR) that contains this render set.

DecorationRenderer getDecorationRenderer()
          Get the implementation of the decoration renderer in this set.

MediaType getMediaType()
          Get the media/content/mime type of this set.

java.lang.String getName()
          Get the name of this render set.

PortletRenderer getPortletRenderer()
          Get the implementation of the portlet renderer in this set.

RegionRenderer getRegionRenderer()
          Get the implementation of the region renderer in this set.

WindowRenderer getWindowRenderer()
          Get the implementation of the window renderer in this set.

Method Detail

getRegionRenderer

public RegionRenderer getRegionRenderer()

Get the implementation of the region renderer in this set.

Returns:: the implementation of the region renderer in this set

getWindowRenderer

public WindowRenderer getWindowRenderer()

Get the implementation of the window renderer in this set.

Returns:: the implementation of the window renderer in this set

getPortletRenderer

public PortletRenderer getPortletRenderer()

Get the implementation of the portlet renderer in this set.

Returns:: the implementation of the portlet renderer in this set

getDecorationRenderer

public DecorationRenderer getDecorationRenderer()

Get the implementation of the decoration renderer in this set.

Returns:: the implementation of the decoration renderer in this set

getMediaType

public MediaType getMediaType()

Get the media/content/mime type of this set.

Returns:: the media type of this set

getAppID

public java.lang.String getAppID()

Get the name of the application (the WAR) that contains this render set.

Returns:: the name of the application (the WAR) that contains this render set

getName

public java.lang.String getName()

Get the name of this render set.

Returns:: the name of this render set