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
  Log:
  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"?>
  <document>
  <properties>
    <title>Jetspeed Layout system</title>
    <authors>
      <person name="RaphaŽl Luta" email="raphael@apache.org"/>
    </authors>
  </properties>
  <body>
    <section name="Jetspeed Layout">
      <p>
        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.
      </p>
      <p>
        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
and
        screen.
      </p>
    </section>
    <section name="Layout elements">
      <p>
        Jetspeed manages its layout with 4 main components:
      </p>
      <dl>
        <dt><strong>Portlet</strong></dt>
        <dd>
          <p>
            A <code>Portlet</code> is the basic layout component responsible for
rendering
            its content, wherever it's placed within the portal page.
          </p>
        </dd>
        <dt><strong>PortletController</strong></dt>
        <dd>
          <p>
            A <code>PortletController</code> is responsible for laying out a set
of 
            <code>Portlet</code> objects on a page, using layout constraints and
hints.
          </p>
        </dd>
        <dt><strong>PortletSet</strong></dt>
        <dd>
          <p>
            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.
          </p>
        </dd>
        <dt><strong>PortletControl</strong></dt>
        <dd>
          <p>
            A <code>PortletControl</code> is a specific Portlet that is responsible
for
            decorating another <code>Portlet</code>. These controls are mainly
used to provide titlebars
            around objects and control the 
          </p>
        </dd>
      </dl>
      <p>
        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:
      </p>
      <image src="images/layout.png" />
      <p>
        This example also shows how the Jetspeed panes are handled by specialized controllers
and
        controls, respectively <code>PanedPortletController</code> and <code>PanedPortletControl</code>.
        The main difference between a regular <code>PortletController</code> and
a
        <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.
      </p>
    </section>
    <section name="Portal Layout API">
      <p>
        <strong>To be completed</strong>
      </p>
    </section>
  </body>
  </document>
  
  
  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>


Mime
View raw message