KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > portal > server > theme > render > WindowRenderer


1 /*****************************************
2  * *
3  * JBoss Portal: The OpenSource Portal *
4  * *
5  * Distributable under LGPL license. *
6  * See terms of license at gnu.org. *
7  * *
8  *****************************************/
9
10 package org.jboss.portal.server.theme.render;
11
12 import org.jboss.portal.server.output.FragmentResult;
13
14 /**
15  * A window renderer is responsible for the creation of the markup of each portlet window in a portal page region.
16  * <p>A Portlet window is the frame (the container) around the markup gernerated by the Portlet. It includes things like
17  * the title, and the portlet mode and portlet window state information. The window renderer is assumed to delegate
18  * to the <code>DecorationRenderer</code> to generate the title and mode and state markup, and to the
19  * <code>PortletRenderer</code> to render the markup produced by the portlet. Note that the renderer do not call the
20  * portlet container to execute the doView doEdit etc. method. The renderer is only responsible for placing the created
21  * markup inside the page, and creating the necessary markup around it.</p>
22  *
23  * @author <a HREF="mailto:mholzner@novell.com>Martin Holzner</a>
24  * @version $LastChangedRevision$, $LastChangedDate$
25  * @see org.jboss.portal.server.theme.PortalRenderSet
26  * @see RegionRenderer
27  * @see DecorationRenderer
28  * @see PortletRenderer
29  */
30 public interface WindowRenderer
31    extends Renderer
32 {
33    /**
34     * Render the markup of a portlet window.
35     *
36     * @param renderContext the state holder to provide information about the region, it's portlets, and the render set,
37     * which allows access to the other renderer interfaces of the render set.
38     * @param result a fragment result containing the markup produced by the portlet
39     * @throws RenderException
40     * @see RegionRenderer#render
41     * @see PortletRenderer#render
42     * @see DecorationRenderer#render
43     */
44    void render(RenderContext renderContext, FragmentResult result) throws RenderException;
45 }
46
Popular Tags