KickJava   Java API By Example, From Geeks To Geeks.

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


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.WindowContext;
13 import org.jboss.portal.server.output.FragmentResult;
14
15 /**
16  * A decoration renderer is responsible for generating the markup of the portlet window title bar.
17  * <p>The decoration renderer has the responsibility to create the title , the window state links, and the portlet mode
18  * links. It is intended to be called by the <code>WindowRenderer</code> to produce part of the markup of a
19  * portlet wiindow. The other parts are intended to be created by the <code>PortletRenderer</code>, and
20  * the <code>WindowRenderer</code> itself.</p>
21  *
22  * @author <a HREF="mailto:mholzner@novell.com>Martin Holzner</a>
23  * @version $LastChangedRevision$, $LastChangedDate$
24  * @see org.jboss.portal.server.theme.PortalRenderSet
25  * @see WindowRenderer
26  * @see PortletRenderer
27  */
28 public interface DecorationRenderer
29    extends Renderer
30 {
31    /**
32     * Create the markup for the portlet decoration
33     *
34     * @param renderContext the state holder to provide information about the region, it's portlets, and the render set,
35     * which allows access to the other renderer interfaces of the render set.
36     * @param window the window context containing information about the modes and states available to the portlet
37     * @param result the fragment result containing the produced markup from the portlet
38     * @throws RenderException
39     */
40    void render(RenderContext renderContext, WindowContext window, FragmentResult result) throws RenderException;
41 }
42
Popular Tags