org.apache.cocoon.portal.layout.renderer.aspect.impl
Class TabContentAspect
java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractCompositeAspect
org.apache.cocoon.portal.layout.renderer.aspect.impl.CompositeContentAspect
org.apache.cocoon.portal.layout.renderer.aspect.impl.TabContentAspect
- All Implemented Interfaces:
- LogEnabled, RendererAspect, Serviceable, ThreadSafe
- public class TabContentAspect
- extends CompositeContentAspect
Example XML:
<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>
Example XML with sub-navigation (child-tag-name enabled):
<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">
<child-tag-name>
<named-item name="..." parameter="link-event"/>
<named-item name="..." parameter="link-event"/>
</child-tag-name>
</named-item>
</composite>
Example XML with sub-navigation (show-all-nav without child-tag-name enabled):
<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">
<named-item name="..." parameter="link-event"/>
<named-item name="..." parameter="link-event"/>
</named-item>
</composite>
Applicable to:
Parameters
store | | req | String | null |
aspect-name | Parameter holding the current tab state. | req | String | "tab" |
tag-name | Name of the tag enclosing the following output. |
| String | "composite" |
root-tag | Should a tag enclosing the following output be generated? |
| boolean | true |
child-tag-name | The name of the tag to enclose named items (i.e. the subnavigation)
of non-selected (default) items. Setting this parameter will enable show-all-nav. |
| String | "" |
show-all-nav | Setting this value to true will output the enclosed named-items |
| boolean | false |
include-selected | Setting this value to true will output the enclosed named-items of the selected tab too. |
| boolean | false |
- Version:
- $Id: TabContentAspect.java 328461 2005-10-25 19:44:00Z cziegeler $
Fields inherited from interface org.apache.cocoon.portal.layout.renderer.aspect.RendererAspect |
ROLE |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TabContentAspect
public TabContentAspect()
toSAX
public void toSAX(RendererAspectContext context,
Layout layout,
PortalService service,
ContentHandler handler)
throws SAXException
- Description copied from interface:
RendererAspect
- Stream out raw layout
- Specified by:
toSAX
in interface RendererAspect
- Overrides:
toSAX
in class CompositeContentAspect
- Throws:
SAXException
- See Also:
RendererAspect.toSAX(org.apache.cocoon.portal.layout.renderer.aspect.RendererAspectContext, org.apache.cocoon.portal.layout.Layout, org.apache.cocoon.portal.PortalService, org.xml.sax.ContentHandler)
prepareConfiguration
public Object prepareConfiguration(Parameters configuration)
throws ParameterException
- Description copied from interface:
RendererAspect
- Compile the configuration.
A renderer aspect can "compile" the configuration in
order to increase performance.
If the renderer does not want to compile it should
simply return the configuration.
The "compiled" configuration is available during streaming via the context object.
This method can also be used for validating the configuration.
- Specified by:
prepareConfiguration
in interface RendererAspect
- Overrides:
prepareConfiguration
in class CompositeContentAspect
- Throws:
ParameterException
- See Also:
RendererAspect.prepareConfiguration(org.apache.avalon.framework.parameters.Parameters)
Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.