raphael 2002/11/22 09:36:32
Added: docs/site layout.html
docs/site/images layout.png
Log:
Early draft of layout documentation
Revision Changes Path
1.1 jakarta-jetspeed/docs/site/layout.html
Index: layout.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<title>Jetspeed - Jetspeed Layout system</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td align="left">
<a href="http://jakarta.apache.org";><img
src="http://jakarta.apache.org/images/jakarta-logo.gif"; border="0"/></a>
</td>
<td align="right">
<a href="http://jakarta.apache.org/jetspeed/";><img src="./images/logo.gif"
alt="Jetspeed" border="0"/></a>
</td>
</tr>
</table>
<table border="0" width="100%" cellspacing="4">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td width="20%" valign="top" nowrap="true">
<p><strong>Essentials</strong></p>
<ul>
<li> <a href="./index.html">Overview</a>
</li>
<li> <a href="./features.html">Features</a>
</li>
<li> <a href="./license.html">License</a>
</li>
<li> <a href="./install.html">Installation</a>
</li>
<li> <a href="./faq.html">FAQ</a>
</li>
<li> <a href="./usejetspeed.html">Sample Sites</a>
</li>
<li> <a href="./resources.html">Resources</a>
</li>
<li> <a href="./todo.html">Todo</a>
</li>
<li> <a href="./changes.html">Changes</a>
</li>
</ul>
<p><strong>Download</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/binindex.html";>Binaries</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/sourceindex.html";>Source Code</a>
</li>
<li> <a href="./supporting-projects.html">Supporting
Projects</a>
</li>
</ul>
<p><strong>Documentation</strong></p>
<ul>
<li> <a href="./config_guide.html">Configuration Guide</a>
</li>
<li> <a
href="http://jakarta.apache.org/jetspeed/api/index.html";>Javadocs</a>
</li>
<li> <a href="./application-development.html">Development</a>
</li>
<li> <a
href="http://www.bluesunrise.com/jetspeed-docs/PortletHowTo.htm";>Portlet Howto</a>
</li>
<li> <a href="./catalog.html">Portlet Catalog</a>
</li>
<li> <a
href="http://mml.hpl.hp.com:9090/jetspeed/trailmap/index.html";>Jetspeed Trailmap</a>
</li>
</ul>
<p><strong>Components</strong></p>
<ul>
<li> <a href="./security.html">Security</a>
</li>
<li> <a href="./content-syndication.html">Syndication</a>
</li>
<li> <a href="./wap.html">WAP</a>
</li>
<li> <a href="./customizer.html">Customization</a>
</li>
<li> <a href="./diskcache.html">Cache</a>
</li>
<li> <a href="./psml.html">PSML</a>
</li>
</ul>
<p><strong>Get Involved</strong></p>
<ul>
<li> <a href="./contributors.html">Contributors</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/cvsindex.html";>CVS Repository</a>
</li>
<li> <a href="./branches.html">CVS Branches</a>
</li>
<li> <a href="./code-standards.html">Coding Spec</a>
</li>
<li> <a
href="http://nagoya.apache.org/bugzilla/query.cgi?product=Jetspeed";>Bug Database</a>
</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
<table
border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Jetspeed Layout"><strong>Jetspeed Layout</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<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>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Layout elements"><strong>Layout elements</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<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>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Portal Layout API"><strong>Portal Layout API</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>
<strong>To be completed</strong>
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2002, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
</body>
</html>
<!-- end the processing -->
1.1 jakarta-jetspeed/docs/site/images/layout.png
<<Binary file>>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
![http://jakarta.apache.org/images/jakarta-logo.gif"](http://jakarta.apache.org/images/jakarta-logo.gif"){kind=link}
