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

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

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:
CVS $Id: CIncludeCopletAspect.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Carsten Ziegeler, Volker Schmitt

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
getAspectDescriptions, isRequired, 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

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 passed to the RendererAspect.getAspectDescriptions(Object) method and is available during streaming via the context object. This method can also be used for validation the configuration.

Specified by:
prepareConfiguration in interface RendererAspect
Overrides:
prepareConfiguration in class AbstractAspect
Throws:
ParameterException


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.