This project has retired. For details please refer to its Attic page.

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

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.AbstractCIncludeAspect
              org.apache.cocoon.portal.layout.renderer.aspect.impl.FrameAspect

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, RendererAspect

public class FrameAspect
extends AbstractCIncludeAspect

Adds a cinclude tag for a FrameLayout's source to the resulting stream.

Example XML:

  <xy:z src="coplet://copletID"/>
 

Applicable to:

• FrameLayout

Parameters

aspect-name			String	"frame"
store		req	String	null

Version:

CVS $Id: FrameAspect.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler, Volker Schmitt

Nested Class Summary

protected static class

FrameAspect.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

FrameAspect()

Method Summary

Iterator	getAspectDescriptions(Object configuration) Return the aspects required for this renderer
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

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

FrameAspect

public FrameAspect()

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

getAspectDescriptions

public Iterator getAspectDescriptions(Object configuration)

Return the aspects required for this renderer

Specified by:

getAspectDescriptions in interface RendererAspect

Overrides:

getAspectDescriptions in class AbstractAspect

Returns:

An iterator for the aspect descriptions or null.