KickJava   Java API By Example, From Geeks To Geeks.

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


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  * The portlet renderer is responsible for adding the created markup of a portlet to the page.
17  * <p>The portlet renderer is intended to be called by the <code>WindowRenderer</code> as part of the
18  * generation of the markup for a portlet window. The portlet renderer is not responsible for generating
19  * the decoration markup, like the title. The <code>DecorationRenderer</code> is responsible for that. It is also
20  * called by the <code>WindowRenderer</code> as part of the render process for one portlet window.</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 DecorationRenderer
27  */
28 public interface PortletRenderer
29    extends Renderer
30 {
31    /**
32     * Render the markup of a portlet.
33     * <p>Note: this is not calling the portlet container to produce the markup. The markup has already been created.
34     * The PortletRenderer only places the markup on the page, and can gnerate some containing markup around it if it
35     * chooses to do so</p>.
36     *
37     * @param renderContext the state holder to provide information about the region, it's portlets, and the render set,
38     * which allows access to the other renderer interfaces of the render set.
39     * @param window the window context containing information about the portlet's state
40     * @param result the fragment result containing the portlet's markup
41     * @throws RenderException
42     */
43    void render(RenderContext renderContext, WindowContext window, FragmentResult result) throws RenderException;
44 }
45
Popular Tags