WindowRenderer - 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
Interface WindowRenderer

All Superinterfaces:: Renderer

All Known Implementing Classes:: DivWindowRenderer, EmptyWindowRenderer

public interface WindowRenderer
extends Renderer

A window renderer is responsible for the creation of the markup of each portlet window in a portal page region.

A Portlet window is the frame (the container) around the markup gernerated by the Portlet. It includes things like the title, and the portlet mode and portlet window state information. The window renderer is assumed to delegate to the DecorationRenderer to generate the title and mode and state markup, and to the PortletRenderer to render the markup produced by the portlet. Note that the renderer do not call the portlet container to execute the doView doEdit etc. method. The renderer is only responsible for placing the created markup inside the page, and creating the necessary markup around it.

See Also:: PortalRenderSet, RegionRenderer, DecorationRenderer, PortletRenderer

Method Summary

void render(RenderContext renderContext, WindowContext portletContext, WindowResult result)
Render the markup of a portlet window.

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

renderEnd, renderStart

Method Detail

render

public void render(RenderContext renderContext,
                   WindowContext portletContext,
                   WindowResult result)
            throws RenderException

Render the markup of a portlet window.

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.; portletContext - the information about the portlet that was rendered; result - a window result containing the markup produced by the portlet
Throws:: RenderException
See Also:: RegionRenderer.render(org.jboss.portal.theme.render.RenderContext, org.jboss.portal.theme.page.Region, java.util.Map, java.util.Map), PortletRenderer.render(org.jboss.portal.theme.render.RenderContext, org.jboss.portal.theme.page.WindowContext, org.jboss.portal.theme.page.WindowResult), DecorationRenderer.render(org.jboss.portal.theme.render.RenderContext, org.jboss.portal.theme.page.WindowContext, org.jboss.portal.theme.page.WindowResult), WindowContext, WindowResult