haul 2004/04/25 13:09:34
Modified:
src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl
AbstractCIncludeAspect.java RemovableAspect.java
TabContentAspect.java CompositeContentAspect.java
RendererAspectChain.java WindowAspect.java
HistoryAspect.java FrameAspect.java
SizingAspect.java AbstractAspect.java
AbstractCompositeAspect.java
DefaultCopletAspect.java PortletWindowAspect.java
ParameterAspect.java DefaultRendererContext.java
CIncludeCopletAspect.java
FullScreenCopletAspect.java
src/blocks/portal/java/org/apache/cocoon/portal/coplet/adapter/impl
CachingURICopletAdapter.java
ApplicationCopletAdapter.java
AbstractCopletAdapter.java
src/blocks/portal/java/org/apache/cocoon/portal/layout/impl
FrameLayout.java CopletLayout.java
DefaultLayoutFactory.java LinkLayout.java
src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect
RendererAspect.java
Log:
work on javadocs
Revision Changes Path
1.4 +8 -3
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/AbstractCIncludeAspect.java
Index: AbstractCIncludeAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/AbstractCIncludeAspect.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AbstractCIncludeAspect.java 5 Mar 2004 13:02:13 -0000 1.3
+++ AbstractCIncludeAspect.java 25 Apr 2004 20:09:34 -0000 1.4
@@ -21,7 +21,9 @@
import org.xml.sax.SAXException;
/**
- *
+ * Base class for aspect renderers that generate cinclude statements.
Provides a single
+ * method for creating the cinclude tag.
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
*
@@ -37,7 +39,10 @@
protected static final String ATTRIBUTE =
CIncludeTransformer.CINCLUDE_INCLUDE_ELEMENT_SRC_ATTRIBUTE;
/**
- * Create the cinclude statement
+ * Create the cinclude statement.
+ *
+ * @param source attribute value for the cinclude tag
+ * @param handler SAX event handler
*/
protected void createCInclude(String source, ContentHandler handler)
throws SAXException {
1.7 +14 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/RemovableAspect.java
Index: RemovableAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/RemovableAspect.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- RemovableAspect.java 5 Mar 2004 13:02:13 -0000 1.6
+++ RemovableAspect.java 25 Apr 2004 20:09:34 -0000 1.7
@@ -26,6 +26,19 @@
import org.xml.sax.SAXException;
/**
+ * Add a tag holding a URI used to remove a coplet from a layout to the
+ * output stream if the coplet is not set to mandatory.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <remove-uri>layout-remove-event</remove-uri>
+ * <!-- output from following renderers -->
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.CopletLayout}</li>
+ * </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.14 +28 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/TabContentAspect.java
Index: TabContentAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/TabContentAspect.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- TabContentAspect.java 5 Mar 2004 13:02:13 -0000 1.13
+++ TabContentAspect.java 25 Apr 2004 20:09:34 -0000 1.14
@@ -34,6 +34,32 @@
import org.xml.sax.SAXException;
/**
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <composite>
+ * <named-item name="..." parameter="link-event"/>
+ * <named-item name="..." selected="true">
+ * <!-- output from processing layout -->
+ * </named-item>
+ * <named-item name="..." parameter="link-event"/>
+ * <named-item name="..." parameter="link-event"/>
+ * </composite>
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.CompositeLayout}</li>
+ * </ul>
+ *
+ * <h2>Parameters</h2>
+ * <table><tbody>
+ *
<tr><th>store</th><td></td><td>req</td><td>String</td><td><code>null</code></td></tr>
+ * <tr><th>aspect-name</th><td>Aspect holding the current tab
state.</td><td>req</td><td>String</td><td><code>"tab"</code></td></tr>
+ * <tr><th>tag-name</th><td>Name of the tag enclosing the following
output.</td>
+ * <td></td><td>String</td><td><code>"composite"</code></td></tr>
+ * <tr><th>root-tag</th><td>Should a tag enclosing the following output be
generated?</td>
+ * <td></td><td>boolean</td><td><code>true</code></td></tr>
+ * </tbody></table>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
@@ -77,7 +103,7 @@
if (j == selected) {
attributes.addCDATAAttribute("selected", "true");
} else {
- ChangeAspectDataEvent event = new
ChangeAspectDataEvent(tabLayout, "tab", new Integer(j));
+ ChangeAspectDataEvent event = new
ChangeAspectDataEvent(tabLayout, config.aspectName, new Integer(j));
attributes.addCDATAAttribute("parameter",
service.getComponentManager().getLinkService().getLinkURI(event));
}
XMLUtils.startElement(handler, "named-item", attributes);
1.7 +28 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/CompositeContentAspect.java
Index: CompositeContentAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/CompositeContentAspect.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- CompositeContentAspect.java 5 Mar 2004 13:02:13 -0000 1.6
+++ CompositeContentAspect.java 25 Apr 2004 20:09:34 -0000 1.7
@@ -30,6 +30,33 @@
import org.xml.sax.SAXException;
/**
+ * Add several contents.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <composite>
+ * <item param1="value1" param2="value2">
+ * <!-- included content from following renderers for this item's
layout-->
+ * </item>
+ * <item>
+ * <!-- included content from following renderers for this item's
layout-->
+ * </item>
+ * <item param1="value1">
+ * <!-- included content from following renderers for this item's
layout-->
+ * </item>
+ * </composite>
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.CompositeLayout}</li>
+ * </ul>
+ *
+ * <h2>Parameters</h2>
+ * <table><tbody>
+ * <tr><th>root-tag</th><td><Enclose result in root
tag?/td><td></td><td>boolean</td><td><code>true</code></td></tr>
+ * <tr><th>tag-name</th><td>Name of root tag to
use.</td><td></td><td>String</td><td><code>"composite"</code></td></tr>
+ * </tbody></table>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.6 +13 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/RendererAspectChain.java
Index: RendererAspectChain.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/RendererAspectChain.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RendererAspectChain.java 5 Mar 2004 13:02:13 -0000 1.5
+++ RendererAspectChain.java 25 Apr 2004 20:09:34 -0000 1.6
@@ -29,7 +29,18 @@
/**
* This chain holds all configured renderer aspects for one renderer.
- *
+ *
+ * <h2>Configuration</h2>
+ * <table><tbody>
+ * <tr><th>aspect</th>
+ * <td>Multiple aspect renderer configurations. Required attribute
+ * <code>type</code>. Nested configuration must contain parameters
+ * for aspect rederer.
+ * </td>
+ * <td>req</td><td>Configuration</td><td><code>null</code></td>
+ * </tr>
+ * </tbody></table>
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
*
1.8 +24 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/WindowAspect.java
Index: WindowAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/WindowAspect.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- WindowAspect.java 5 Mar 2004 13:02:13 -0000 1.7
+++ WindowAspect.java 25 Apr 2004 20:09:34 -0000 1.8
@@ -27,7 +27,29 @@
import org.xml.sax.SAXException;
/**
- *
+ * Create a title tag for a coplet as well as an optional enclosing tag.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <window>
+ * <title>title</title>
+ * </window>
+ * </pre>
+ *
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.CopletLayout}</li>
+ * </ul>
+ *
+ * <h2>Parameters</h2>
+ * <table><tbody>
+ * <tr><th>root-tag</th><td>Should a tag enclosing the following output be
generated?</td>
+ * <td></td><td>boolean</td><td><code>true</code></td></tr>
+ * <tr><th>tag-name</th><td>Name of tag enclosing follwoing output if
requested.</td>
+ * <td></td><td>String</td><td><code>"window"</code></td></tr>
+ * </tbody></table>
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
*
1.4 +15 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/HistoryAspect.java
Index: HistoryAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/HistoryAspect.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- HistoryAspect.java 5 Mar 2004 13:02:13 -0000 1.3
+++ HistoryAspect.java 25 Apr 2004 20:09:34 -0000 1.4
@@ -34,7 +34,20 @@
/**
- * Save the current state of the layout into the session
+ * Save the current state of the layout into the session. Takes into account
+ * state already present as request attribute. Includes aspect data and
parameters
+ * as well as aspect data and attributes of a coplet instance if layout is a
+ * coplet layout. This aspect does not add to the XML created by the
renderer chain.
+ *
+ * <h2>Example XML</h2>
+ * <pre>
+ * <!-- output from following renderers -->
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED] org.apache.cocoon.portal.layout.Layout}</li>
+ * </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
*
1.8 +18 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/FrameAspect.java
Index: FrameAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/FrameAspect.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- FrameAspect.java 5 Mar 2004 13:02:13 -0000 1.7
+++ FrameAspect.java 25 Apr 2004 20:09:34 -0000 1.8
@@ -29,6 +29,23 @@
import org.xml.sax.SAXException;
/**
+ * Adds a cinclude tag for a FrameLayout's source to the resulting stream.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <xy:z src="coplet://copletID"/>
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.FrameLayout}</li>
+ * </ul>
+ *
+ * <h2>Parameters</h2>
+ * <table><tbody>
+ *
<tr><th>aspect-name</th><td></td><td></td><td>String</td><td><code>"frame"</code></td></tr>
+ *
<tr><th>store</th><td></td><td>req</td><td>String</td><td><code>null</code></td></tr>
+ * </tbody></table>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.9 +21 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/SizingAspect.java
Index: SizingAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/SizingAspect.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- SizingAspect.java 10 Mar 2004 12:28:29 -0000 1.8
+++ SizingAspect.java 25 Apr 2004 20:09:34 -0000 1.9
@@ -27,7 +27,26 @@
import org.xml.sax.SAXException;
/**
- * This renderer aspect tests, if a coplet is sizable and/or maxpageable.
+ * This renderer aspect tests, if a coplet is sizable and/or maxpageable and
adds
+ * tags holding URIs for switching to currently inactive modes (i.e.
maximize or
+ * minimize).
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <minimize-uri>minimize-event</minimize-uri>
+ * <!-- output from following renderers -->
+ *
+ * or
+ *
+ * <maximize-uri>maximize-event</maximize-uri>
+ * <!-- processing stops here -->
+ *
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.CopletLayout}</li>
+ * </ul>
*
* TODO: make the names of the aspects to test configurable
*
1.8 +2 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/AbstractAspect.java
Index: AbstractAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/AbstractAspect.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AbstractAspect.java 5 Mar 2004 13:02:13 -0000 1.7
+++ AbstractAspect.java 25 Apr 2004 20:09:34 -0000 1.8
@@ -32,6 +32,7 @@
import org.xml.sax.SAXException;
/**
+ * Base class for renderer aspects.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.7 +20 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/AbstractCompositeAspect.java
Index: AbstractCompositeAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/AbstractCompositeAspect.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- AbstractCompositeAspect.java 5 Mar 2004 13:02:13 -0000 1.6
+++ AbstractCompositeAspect.java 25 Apr 2004 20:09:34 -0000 1.7
@@ -27,6 +27,15 @@
import org.xml.sax.SAXException;
/**
+ * Insert a composite layout's elements into the resulting XML. Elements
(items)
+ * are processed in order. Concrete descendents of this class need to
implement the
+ * actual handling of layout elements.
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.CompositeLayout}</li>
+ * </ul>
+ *
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
@@ -56,11 +65,20 @@
}
}
+ /**
+ * Process a single layout element.
+ *
+ * @param item layout item to be processed
+ * @param handler SAX handler taking events
+ * @param service portal service providing component access
+ * @throws SAXException
+ */
protected abstract void processItem(Item item, ContentHandler handler,
PortalService service)
throws SAXException;
/**
- * Process a Layout
+ * Default implementation for processing a Layout. Calls the associated
+ * renderer for a layout to render it.
*/
protected void processLayout(Layout layout, PortalService service,
ContentHandler handler) throws SAXException {
final String rendererName = layout.getRendererName();
1.5 +17 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/DefaultCopletAspect.java
Index: DefaultCopletAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/DefaultCopletAspect.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DefaultCopletAspect.java 5 Mar 2004 13:02:13 -0000 1.4
+++ DefaultCopletAspect.java 25 Apr 2004 20:09:34 -0000 1.5
@@ -30,6 +30,22 @@
/**
* This aspect directly invokes the coplet adapter to stream out the coplet
content.
+ * An alternative solution is to generate only cinclude tags by using the
+ * [EMAIL PROTECTED]
org.apache.cocoon.portal.layout.renderer.aspect.impl.CIncludeCopletAspect}
+ * and include the coplet contents later. That would allow caching up to the
point
+ * of the cinclude transformer.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <content>
+ * <!-- content streamed from coplet -->
+ * </content>
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.CopletLayout}</li>
+ * </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.8 +29 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/PortletWindowAspect.java
Index: PortletWindowAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/PortletWindowAspect.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- PortletWindowAspect.java 16 Mar 2004 15:56:43 -0000 1.7
+++ PortletWindowAspect.java 25 Apr 2004 20:09:34 -0000 1.8
@@ -45,7 +45,34 @@
import org.xml.sax.SAXException;
/**
- * This aspect draws a portlet window for a JSR-168 implementation
+ * This aspect draws a portlet window for a JSR-168 implementation.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <window>
+ * <title>title</title>
+ * <maximize-uri>event</maximize-uri>
+ * <minimize-uri>event</minimize-uri>
+ * <fullscreen-uri>event</fullscreen-uri>
+ * <edit-uri>event</edit-uri>
+ * <help-uri>event</help-uri>
+ * <view-uri>event</view-uri>
+ * <!-- output of following renderers -->
+ * </window>
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.CopletLayout}</li>
+ * </ul>
+ *
+ * <h2>Parameters</h2>
+ * <table><tbody>
+ * <tr><th>root-tag</th><td>Should a root tag surrounding the following
output
+ * be
generated?</td><td></td><td>boolean</td><td><code>true</code></td></tr>
+ * <tr><th>tag-name</th><td>Name of the root tag if requested.
+ * </td><td></td><td>String</td><td><code>"window"</code></td></tr>
+ * </tbody></table>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
*
1.3 +23 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/ParameterAspect.java
Index: ParameterAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/ParameterAspect.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ParameterAspect.java 5 Mar 2004 13:02:13 -0000 1.2
+++ ParameterAspect.java 25 Apr 2004 20:09:34 -0000 1.3
@@ -29,7 +29,29 @@
import org.xml.sax.SAXException;
/**
+ * Add layout parameter to resulting XML stream so that they can be picked
+ * up later from a stylesheet for example. When passing parameters to the
+ * [EMAIL PROTECTED]
org.apache.cocoon.portal.layout.renderer.aspect.impl.XSLTAspect}
+ * consider it's ability to set XSL parameters directly.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ * <parameter name1="value1" name2="value2" ... >
+ * <!-- output from following renderers -->
+ * </parameter>
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED] org.apache.cocoon.portal.layout.Layout}</li>
+ * </ul>
*
+ * <h2>Parameters</h2>
+ * <table><tbody>
+ * <tr><th>tag-name</th><td>Name of tag holding key-value pairs as
attributes.</td>
+ * <td></td><td>String</td><td><code>"parameter"</code></td></tr>
+ * </tbody></table>
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
*
* @version CVS $Id$
1.6 +4 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/DefaultRendererContext.java
Index: DefaultRendererContext.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/DefaultRendererContext.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DefaultRendererContext.java 5 Mar 2004 13:02:13 -0000 1.5
+++ DefaultRendererContext.java 25 Apr 2004 20:09:34 -0000 1.6
@@ -27,6 +27,9 @@
import org.xml.sax.SAXException;
/**
+ * The renderer aspect context is passed to every renderer aspect.
+ * Using this context, a renderer aspect can get it's configuration
+ * and it can invoke (if wanted) the next aspect in the aspect chain.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.5 +15 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/CIncludeCopletAspect.java
Index: CIncludeCopletAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/CIncludeCopletAspect.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CIncludeCopletAspect.java 5 Mar 2004 13:02:13 -0000 1.4
+++ CIncludeCopletAspect.java 25 Apr 2004 20:09:34 -0000 1.5
@@ -27,6 +27,20 @@
/**
* This aspect streams a cinclude statement into the stream that
* will include the coplet using the coplet protocol.
+ *
+ * <h2>Resulting XML:</h2>
+ * <pre>
+ * <content>
+ * <xy:z src="coplet://copletID"/>
+ * </content>
+ * </pre>
+ * where <code>xy</code> is the CInclude namespace and <code>z</code> is
+ * the CInclude tagname.
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.CopletLayout}</li>
+ * </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.8 +18 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/FullScreenCopletAspect.java
Index: FullScreenCopletAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/impl/FullScreenCopletAspect.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- FullScreenCopletAspect.java 5 Mar 2004 13:02:13 -0000 1.7
+++ FullScreenCopletAspect.java 25 Apr 2004 20:09:34 -0000 1.8
@@ -26,6 +26,23 @@
import org.xml.sax.SAXException;
/**
+ * Includes a tag containing a URI that is connected with a fullscreen
+ * display of a coplet. If fullscreen is explicitly unsupported, no tag
+ * will be created. Otherwise, it depends on the current layout being the
+ * fullscreen layout or not whether the URI contains an event that switches
+ * to this layout or not.
+ *
+ * <h2>Example XML:</h2>
+ * <pre>
+ *
<fullscreen-uri>fullscreen-event-if-supported</fullscreen-uri>
+ * <!-- output from following renderers -->
+ * </pre>
+ *
+ * <h2>Applicable to:</h2>
+ * <ul>
+ * <li>[EMAIL PROTECTED]
org.apache.cocoon.portal.layout.impl.CopletLayout}</li>
+ * </ul>
+ *
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.5 +8 -5
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/adapter/impl/CachingURICopletAdapter.java
Index: CachingURICopletAdapter.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/adapter/impl/CachingURICopletAdapter.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CachingURICopletAdapter.java 31 Mar 2004 09:32:24 -0000 1.4
+++ CachingURICopletAdapter.java 25 Apr 2004 20:09:34 -0000 1.5
@@ -27,7 +27,10 @@
/**
* This is the adapter to use pipelines as coplets. The result of the called
- * pipeline is cached until the coplet gets a new CopletLinkEvent.
+ * pipeline is cached until a
+ * [EMAIL PROTECTED] org.apache.cocoon.portal.event.CopletInstanceEvent}
+ * for that coplet is received. Configuration options of super
+ * classes apply.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Gerald Kahrer</a>
*
@@ -116,11 +119,11 @@
bi.deserialize(bc.getSAXFragment());
} else {
- this.toCache(coplet, bc.getSAXFragment());
+ this.toCache(coplet, bc.getSAXFragment());
- this.toSAXFromCache(coplet, contentHandler);
- }
+ this.toSAXFromCache(coplet, contentHandler);
}
+ }
}
/**
1.5 +3 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/adapter/impl/ApplicationCopletAdapter.java
Index: ApplicationCopletAdapter.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/adapter/impl/ApplicationCopletAdapter.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ApplicationCopletAdapter.java 5 Mar 2004 13:02:10 -0000 1.4
+++ ApplicationCopletAdapter.java 25 Apr 2004 20:09:34 -0000 1.5
@@ -35,7 +35,8 @@
import org.xml.sax.SAXException;
/**
- * This coplet adapter is used to connect to external applications that are
plugged into the portal
+ * This coplet adapter is used to connect to external applications that are
+ * plugged into the portal
*
* @author <a href="mailto:[EMAIL PROTECTED]">Gerald Kahrer</a>
*
1.11 +25 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/adapter/impl/AbstractCopletAdapter.java
Index: AbstractCopletAdapter.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/adapter/impl/AbstractCopletAdapter.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- AbstractCopletAdapter.java 5 Mar 2004 13:02:10 -0000 1.10
+++ AbstractCopletAdapter.java 25 Apr 2004 20:09:34 -0000 1.11
@@ -32,7 +32,30 @@
import org.xml.sax.SAXException;
/**
- * This is the adapter to use pipelines as coplets
+ * This is the abstract base adapter to use pipelines as coplets
+ *
+ * <h2>Configuration</h2>
+ * <table><tbody>
+ * <tr>
+ * <th>buffer</th>
+ * <td>Shall the content of the coplet be buffered? If a coplet is
+ * buffered, errors local to the coplet are caught and a not
+ * availability notice is delivered instead. Buffering does not
+ * cache responses for subsequent requests.</td>
+ * <td></td>
+ * <td>boolean</td>
+ * <td><code>false</code></td>
+ * </tr>
+ * <tr>
+ * <th>timeout</th>
+ * <td>Max time in seconds content delivery may take. After a timeout,
+ * a not availability notice is delivered. Setting a timeout
automatically
+ * turns on buffering.</td>
+ * <td></td>
+ * <td>int</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * </tbody></table>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.3 +4 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/FrameLayout.java
Index: FrameLayout.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/FrameLayout.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- FrameLayout.java 5 Mar 2004 13:02:13 -0000 1.2
+++ FrameLayout.java 25 Apr 2004 20:09:34 -0000 1.3
@@ -18,6 +18,9 @@
import org.apache.cocoon.portal.layout.AbstractLayout;
/**
+ * A frame layout holds a source URI. The URI can be changed dynamically
through
+ * events. The URI may contain any URI that can be resolved by the Cocoon
+ * [EMAIL PROTECTED] org.apache.cocoon.environment.SourceResolver}.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.4 +3 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/CopletLayout.java
Index: CopletLayout.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/CopletLayout.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CopletLayout.java 5 Mar 2004 13:02:13 -0000 1.3
+++ CopletLayout.java 25 Apr 2004 20:09:34 -0000 1.4
@@ -19,6 +19,8 @@
import org.apache.cocoon.portal.layout.AbstractLayout;
/**
+ * A coplet layout holds a coplet.
+ *
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.16 +61 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/DefaultLayoutFactory.java
Index: DefaultLayoutFactory.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/DefaultLayoutFactory.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- DefaultLayoutFactory.java 5 Mar 2004 13:02:13 -0000 1.15
+++ DefaultLayoutFactory.java 25 Apr 2004 20:09:34 -0000 1.16
@@ -58,6 +58,66 @@
/**
*
+ * <h2>Configuration</h2>
+ * <table><tbody>
+ * <tr><th>layouts</th>
+ * <td>List of layouts.</td>
+ * <td>req</td>
+ * <td>Configuration</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * <tr>
+ * <th>layouts/layout</th>
+ * <td>Multiple configured layouts.
+ * </td>
+ * <td>req</td>
+ * <td>Configuration</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * <tr>
+ * <th>layouts/layout/attribute::name</th>
+ * <td>Unique layout name.</td>
+ * <td>req</td>
+ * <td>String</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * <tr>
+ * <th>layouts/layout/attribute::create-id</th>
+ * <td></td>
+ * <td></td>
+ * <td>boolean</td>
+ * <td><code>false</code></td>
+ * </tr>
+ * <tr>
+ * <th>layouts/layout/renderers/attribute::default</th>
+ * <td></td>
+ * <td>req</td>
+ * <td>String</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * <tr>
+ * <th>layouts/layout/renderers/renderer</th>
+ * <td></td>
+ * <td>req</td>
+ * <td>Configuration</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * <tr>
+ * <th>layouts/layout/renderers/renderer/attribute::name</th>
+ * <td></td>
+ * <td>req</td>
+ * <td>String</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * <tr>
+ * <th>layouts/layout/aspects/aspect</th>
+ * <td></td>
+ * <td>req</td>
+ * <td>String</td>
+ * <td><code>null</code></td>
+ * </tr>
+ * </tbody></table>
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
*
1.4 +3 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/LinkLayout.java
Index: LinkLayout.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/LinkLayout.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- LinkLayout.java 5 Mar 2004 13:02:13 -0000 1.3
+++ LinkLayout.java 25 Apr 2004 20:09:34 -0000 1.4
@@ -19,6 +19,8 @@
import org.apache.cocoon.portal.layout.Layout;
/**
+ * A link layout references another layout to be used instead. The reference
+ * can be changed using events.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
1.6 +2 -1
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/RendererAspect.java
Index: RendererAspect.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/renderer/aspect/RendererAspect.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RendererAspect.java 5 Mar 2004 13:02:13 -0000 1.5
+++ RendererAspect.java 25 Apr 2004 20:09:34 -0000 1.6
@@ -27,6 +27,7 @@
/**
* A renderer aspect extends a renderer with a distinct functionality.
+ * It can add a particular decoration like a border or buttons for example.
* A renderer aspect has to be thread safe!
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
