org.apache.cocoon.portal.layout.renderer.aspect
Interface RendererAspect

All Superinterfaces:

Component

All Known Implementing Classes:

AbstractActionAspect, AbstractAspect, AbstractCIncludeAspect, AbstractCompositeAspect, AddToBasketAspect, CIncludeCopletAspect, CompositeContentAspect, DefaultCopletAspect, FrameAspect, FullScreenCopletAspect, HistoryAspect, ParameterAspect, PortletWindowAspect, RemovableAspect, SizingAspect, TabContentAspect, WindowAspect, XSLTAspect

public interface RendererAspect
extends Component

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!

Version:

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

Author:

Carsten Ziegeler, Volker Schmitt

Field Summary

static String

ROLE

Method Summary

Iterator	getAspectDescriptions(Object preparedConfiguration) Return the aspects required for this renderer
boolean	isRequired()
Object	prepareConfiguration(Parameters configuration) Compile the configuration.
void	toSAX(RendererAspectContext context, Layout layout, PortalService service, ContentHandler handler) Stream out raw layout

Field Detail

ROLE

static final String ROLE

Method Detail

toSAX

void toSAX(RendererAspectContext context,
           Layout layout,
           PortalService service,
           ContentHandler handler)
           throws SAXException

Stream out raw layout

Throws:

SAXException

getAspectDescriptions

Iterator getAspectDescriptions(Object preparedConfiguration)

Return the aspects required for this renderer

Returns:

An iterator for the aspect descriptions or null.

prepareConfiguration

Object prepareConfiguration(Parameters configuration)
                            throws ParameterException

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

Throws:

ParameterException

isRequired

boolean isRequired()