portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From raph...@apache.org
Subject cvs commit: jakarta-jetspeed/xdocs/images layout.png
Date Fri, 22 Nov 2002 17:35:45 GMT
raphael     2002/11/22 09:35:45

  Added:       xdocs    layout.xml
               xdocs/images layout.png
  Early draft of layout documentation
  Revision  Changes    Path
  1.1                  jakarta-jetspeed/xdocs/layout.xml
  Index: layout.xml
  <?xml version="1.0" encoding="iso-8859-1"?>
    <title>Jetspeed Layout system</title>
      <person name="RaphaŽl Luta" email="raphael@apache.org"/>
    <section name="Jetspeed Layout">
        This section presents the main concepts used by Jetspeed portal layout system 
        as well as the document object model on some fundamental aspects of the
        portal layout API.
        The reader is assumed to have familiarity with the
        <a href="http://jakarta.apache.org/turbine/turbine-2/fsd.html">Turbine 2 principles</a>
        especially those related to the page real estate organization, ie layout, navigation
    <section name="Layout elements">
        Jetspeed manages its layout with 4 main components:
            A <code>Portlet</code> is the basic layout component responsible for
            its content, wherever it's placed within the portal page.
            A <code>PortletController</code> is responsible for laying out a set
            <code>Portlet</code> objects on a page, using layout constraints and
            A <code>PortletSet</code> is a specific <code>Portlet</code>
that acts as a container,
            holding several portlets to be displayed on the same page. A <code>PortletSet</code>

            instance is always associated with a <code>PortletController</code>
that governs its
            actual layout strategy.
            A <code>PortletControl</code> is a specific Portlet that is responsible
            decorating another <code>Portlet</code>. These controls are mainly
used to provide titlebars
            around objects and control the 
        A typical portal page would combine all of these elements to render the full portal
        within a single Turbine screen area, as shown in the following schema:
      <image src="images/layout.png" />
        This example also shows how the Jetspeed panes are handled by specialized controllers
        controls, respectively <code>PanedPortletController</code> and <code>PanedPortletControl</code>.
        The main difference between a regular <code>PortletController</code> and
        <code>PanedPortletController</code> is that the latter does not render
all its managed portlets
        at the same time on the page and thus needs to provide methods to "browse" through
the different
        hidden portlets. A <code>PanedPortletControl</code> is a control that
knows that its content
        may not be fully visible at a given time and thus provides navigation links to display
        the none visible elements.
    <section name="Portal Layout API">
        <strong>To be completed</strong>
  1.1                  jakarta-jetspeed/xdocs/images/layout.png
  	<<Binary file>>

To unsubscribe, e-mail:   <mailto:jetspeed-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:jetspeed-dev-help@jakarta.apache.org>

View raw message