PortalRenderSet


1   /*
2    * JBoss, the OpenSource J2EE webOS
3    *
4    * Distributable under LGPL license.
5    * See terms of license at gnu.org.
6    */
7   
8   package org.jboss.portal.server.theme;
9   
10  import org.jboss.portal.common.MediaType;
11  import org.jboss.portal.server.theme.render.DecorationRenderer;
12  import org.jboss.portal.server.theme.render.PortletRenderer;
13  import org.jboss.portal.server.theme.render.RegionRenderer;
14  import org.jboss.portal.server.theme.render.WindowRenderer;
15  
16  /**
17   * A portal render set is a wrapper for the 4 renderer interface implementations.
18   * <p>A portal render set consists of 4 renderers. Each renderer is responsible to generate parts of
19   * the markup of a region, and to delegate to the appropriate renderer for any sub regions that need to be
20   * embedded. The basic architecture is such that the region renderer is the outer most container. It is responsible for
21   * generating the markup that contains all the markup of a region. For each portlet that needs to be
22   * rendered in the region, the region renderer delegates to the window renderer. The window renderer is
23   * responsible for the generated markup of each portlet window. It delegates to the decoration renderer to
24   * generate the markup for the state and mode links, and the portlet title. The portlet window renderer also
25   * delegates to the portlet renderer which is responsible for the markup of the portlet itself. The render set is
26   * used in combination with a RenderContext. Each renderer can access the other renderers in the set via the render
27   * context.</p>
28   *
29   * @author <a HREF="mailto:mholzner@novell.com">Martin Holzner</a>.
30   * @version <tt>$Revision: 1.6 $</tt>
31   * @see org.jboss.portal.server.theme.render.RenderContext
32   * @see RegionRenderer
33   * @see WindowRenderer
34   * @see DecorationRenderer
35   * @see PortletRenderer
36   */
37  public interface PortalRenderSet
38  {
39     /**
40      * Get the implementation of the region renderer in this set.
41      *
42      * @return the implementation of the region renderer in this set
43      */
44     RegionRenderer getRegionRenderer();
45  
46     /**
47      * Get the implementation of the window renderer in this set.
48      *
49      * @return the implementation of the window renderer in this set
50      */
51     WindowRenderer getWindowRenderer();
52  
53     /**
54      * Get the implementation of the portlet renderer in this set.
55      *
56      * @return the implementation of the portlet renderer in this set
57      */
58     PortletRenderer getPortletRenderer();
59  
60     /**
61      * Get the implementation of the decoration renderer in this set.
62      *
63      * @return the implementation of the decoration renderer in this set
64      */
65     DecorationRenderer getDecorationRenderer();
66  
67     /**
68      * Get the media/content/mime type of this set.
69      *
70      * @return the media type of this set
71      */
72     MediaType getMediaType();
73  
74     /**
75      * Get the name of the application (the WAR) that contains this render set.
76      *
77      * @return the name of the application (the WAR) that contains this render set
78      */
79     String   getAppName();
80  
81     /**
82      * Get the name of this render set.
83      *
84      * @return the name of this render set
85      */
86     String   getName();
87  }
88
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags