01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.theme.render.renderer;
23:
24: import org.jboss.portal.theme.render.ObjectRenderer;
25: import org.jboss.portal.theme.render.RenderException;
26: import org.jboss.portal.theme.render.RendererContext;
27:
28: /**
29: * A region renderer is responsible to create the markup container for a set of portlets on a page region. <p>The
30: * Portlets on a portal page can be assigned to regions of that page. Regions are sub elements of a page, that will be
31: * used by a layout to position groups of portlets over the areas of the page. The region renderer can be invoked to
32: * render the entire content of the region. It is assumed to take over the responsibility of delegating to the
33: * <code>WindowRenderer</code> for each portlet that needs to be rendered in the region in question.</p>
34: *
35: * @author <a href="mailto:mholzner@novell.com>Martin Holzner</a>
36: * @version $LastChangedRevision: 8784 $, $LastChangedDate: 2007-10-27 19:01:46 -0400 (Sat, 27 Oct 2007) $
37: * @see org.jboss.portal.theme.PortalRenderSet
38: * @see WindowRenderer
39: */
40: public interface RegionRenderer extends ObjectRenderer {
41: void renderBody(RendererContext rendererContext,
42: RegionRendererContext rrc) throws RenderException;
43:
44: void renderHeader(RendererContext rendererContext,
45: RegionRendererContext rrc) throws RenderException;
46:
47: void renderFooter(RendererContext rendererContext,
48: RegionRendererContext rrc) throws RenderException;
49: }
|