org.apache.cocoon.portal.layout.renderer.aspect.impl
Class CIncludeCopletAspect

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
          extended byorg.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractCIncludeAspect
              extended byorg.apache.cocoon.portal.layout.renderer.aspect.impl.CIncludeCopletAspect
All Implemented Interfaces:
LogEnabled, RendererAspect, Serviceable, ThreadSafe

public class CIncludeCopletAspect
extends AbstractCIncludeAspect

This aspect streams a cinclude statement into the stream that will include the coplet using the coplet protocol.

Resulting XML:

 <content>
  <xy:z src="coplet://copletID"/>
 </content>
 
where xy is the CInclude namespace and z is the CInclude tagname. By default, the cinclude statetement is surrounded by a "content" element; this can be further controlled by parameters (see below).

Applicable to:

Parameters

root-tagShould a tag enclosing the cinclude be generated? (Default is true) booleantrue
tag-nameName of enclosing tag. String"content"

Version:
$Id: CIncludeCopletAspect.java 322471 2005-10-16 13:24:19Z cziegeler $

Nested Class Summary
protected static class CIncludeCopletAspect.PreparedConfiguration
           
 
Field Summary
 
Fields inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractCIncludeAspect
ATTRIBUTE, ELEMENT, NAMESPACE, PREFIX, QELEMENT
 
Fields inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
manager
 
Fields inherited from interface org.apache.cocoon.portal.layout.renderer.aspect.RendererAspect
ROLE
 
Constructor Summary
CIncludeCopletAspect()
           
 
Method Summary
 Object prepareConfiguration(Parameters configuration)
          Compile the configuration.
 void toSAX(RendererAspectContext context, Layout layout, PortalService service, ContentHandler handler)
          Stream out raw layout
 
Methods inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractCIncludeAspect
createCInclude
 
Methods inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
service
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CIncludeCopletAspect

public CIncludeCopletAspect()
Method Detail

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 AbstractAspect
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 AbstractAspect
Throws:
ParameterException
See Also:
RendererAspect.prepareConfiguration(org.apache.avalon.framework.parameters.Parameters)


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.