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

All Known Implementing Classes:
AbstractAspect

public interface RendererAspect

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:
$Id: RendererAspect.java 327168 2005-10-21 12:56:35Z cziegeler $

Field Summary
static String ROLE
           
 
Method Summary
 Object prepareConfiguration(Parameters configuration)
          Compile the configuration.
 void toSAX(RendererAspectContext context, Layout layout, PortalService service, ContentHandler handler)
          Stream out raw layout
 

Field Detail

ROLE

public static final String ROLE
Method Detail

toSAX

public void toSAX(RendererAspectContext context,
                  Layout layout,
                  PortalService service,
                  ContentHandler handler)
           throws SAXException
Stream out raw layout

Throws:
SAXException

prepareConfiguration

public 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 available during streaming via the context object. This method can also be used for validating the configuration.

Throws:
ParameterException


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