KickJava   Java API By Example, From Geeks To Geeks.

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


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.theme.Region;
13
14 /**
15  * A region renderer is responsible to create the markup container for a set of portlets on a page region.
16  * <p>The Portlets on a portal page can be assigned to regions of that page. Regions are sub elements of a page, that
17  * will be used by a layout to position groups of portlets over the areas of the page.
18  * The region renderer can be invoked to render the entire content of the region. It is assumed to take over the
19  * responsibility of delegating to the <code>WindowRenderer</code> for each portlet that needs to be rendered in the
20  * region in question.</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  */
27 public interface RegionRenderer
28    extends Renderer
29 {
30    /**
31     * Render the markup of an entire page region with all the portlets that are assigned to that region.
32     *
33     * @param renderContext the state holder to provide information about the region, it's portlets, and the render set,
34     * which allows access to the other renderer interfaces of the render set.
35     * @param region the region to be rendered
36     * @throws RenderException
37     * @see WindowRenderer#render
38     */
39    void render(RenderContext renderContext, Region region) throws RenderException;
40 }
41
Popular Tags