raphael 2002/11/26 07:47:20
Modified: xdocs layout.xml
Added: xdocs/images sequence3.png
Log:
Update and complete initial layout documentation
Revision Changes Path
1.2 +33 -2 jakarta-jetspeed/xdocs/layout.xml
Index: layout.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/layout.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- layout.xml 22 Nov 2002 17:35:45 -0000 1.1
+++ layout.xml 26 Nov 2002 15:47:20 -0000 1.2
@@ -61,7 +61,7 @@
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" />
+ <image src="images/layout.png" align="center"/>
<p>
This example also shows how the Jetspeed panes are handled by specialized
controllers and
controls, respectively <code>PanedPortletController</code> and
<code>PanedPortletControl</code>.
@@ -75,8 +75,39 @@
</section>
<section name="Portal Layout API">
<p>
- <strong>To be completed</strong>
+ The Layout API which is the foundation of the portal page rendering in
Jetspeed is loosely based
+ on AWT design:
</p>
+ <ul>
+ <li>Portlet = AWT Component</li>
+ <li>PortletSet = AWT Container</li>
+ <li>PortletController = AWT LayoutManager</li>
+ </ul>
+ <p>
+ There's no real equivalent to the <code>PortletControl</code> class, which
mostly acts as a
+ managing proxy for an inner <code>Portlet</code> or <code>PortletSet</code>.
+ </p>
+ <image src="images/portal.png" align="center" />
+ <p>
+ Note that in this API, the <code>Portlet</code> class is used as a simple
graphical widget
+ and thus although it's possible to overload its behavior to also have a
servlet-like
+ component lifecycle model, it's best to keep its subclass operations as
simple as possible
+ and implement expensive business operations in other classes (Turbine tools,
EJBs, etc...).
+ </p>
+ <p>
+ The portal page is rendered by the portal engine using a document object
model tree of portlet
+ objects. This DOM tree is typically created by the <code>PortalToolkit</code>
service from a
+ static PSML page description resource.
+ </p>
+ <image src="images/portaldom.png" align="center" />
+ <p>
+ The complete page rendering process is triggered by calling the
<code>getContent</code> method
+ on the root portlet object. The following sequences describe the standard
layout sequence using
+ the default Velocity based Turbine setup.
+ </p>
+ <image src="images/sequence1.png" align="center" />
+ <image src="images/sequence2.png" align="center" />
+ <image src="images/sequence3.png" align="center" />
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/images/sequence3.png
<<Binary file>>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
