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

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

All Known Implementing Classes:

DefaultRendererContext

public interface RendererAspectContext

The renderer aspect context is passed to every renderer aspect. Using this context, a renderer aspect can get it's configuration and it can invoke (if wanted) the next aspect in the aspect chain.

Version:

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

Author:

Carsten Ziegeler, Volker Schmitt

Method Summary

Object	getAspectConfiguration() Get the "compiled" configuration of the aspect.
Object	getAttribute(String key) Get an attribute
Map	getObjectModel() Get the object model
void	invokeNext(Layout layout, PortalService service, ContentHandler handler) Stream out raw layout
boolean	isRendering() Return whether rendering is enabled for this chain.
void	removeAttribute(String key) Remove an attribute
void	setAttribute(String key, Object attribute) Set an attribute

Method Detail

invokeNext

void invokeNext(Layout layout,
                PortalService service,
                ContentHandler handler)
                throws SAXException

Stream out raw layout

Throws:

SAXException

getAspectConfiguration

Object getAspectConfiguration()

Get the "compiled" configuration of the aspect.

setAttribute

void setAttribute(String key,
                  Object attribute)

Set an attribute

getAttribute

Object getAttribute(String key)

Get an attribute

removeAttribute

void removeAttribute(String key)

Remove an attribute

getObjectModel

Map getObjectModel()

Get the object model

isRendering

boolean isRendering()

Return whether rendering is enabled for this chain.

Returns:

true if rendering is enabled, false otherwise.