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 decoration renderer is responsible for generating the markup of the portlet window title bar. <p>The decoration
30: * renderer has the responsibility to create the title , the window state links, and the portlet mode links. It is
31: * intended to be called by the <code>WindowRenderer</code> to produce part of the markup of a portlet wiindow. The
32: * other parts are intended to be created by the <code>PortletRenderer</code>, and the <code>WindowRenderer</code>
33: * itself.</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: * @see PortletRenderer
40: */
41: public interface DecorationRenderer extends ObjectRenderer {
42: /**
43: * Create the markup for the portlet decoration
44: *
45: * @param rendererContext the state holder to provide information about the region, it's portlets, and the render
46: * set, which allows access to the other renderer interfaces of the render set.
47: * @throws org.jboss.portal.theme.render.RenderException
48: *
49: */
50: void render(RendererContext rendererContext,
51: DecorationRendererContext drc) throws RenderException;
52:
53: }
|