info.magnolia.rendering.listeners

Class AbstractRenderingListener

java.lang.Object

info.magnolia.rendering.listeners.AbstractRenderingListener

Direct Known Subclasses:

AbstractInjectionListener, AreaFilteringListener

public abstract class AbstractRenderingListener
extends Object

Listener for RenderingEngine.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRenderingListener.RenderingListenerReturnCode Rendering listener return codes.

Constructor Summary

Constructors

Constructor and Description
AbstractRenderingListener()

Method Summary

Methods

Modifier and Type	Method and Description
abstract AbstractRenderingListener.RenderingListenerReturnCode	after(javax.jcr.Node content, RenderableDefinition definition, Map<String,Object> contextObjects, OutputProvider out)
abstract AbstractRenderingListener.RenderingListenerReturnCode	before(javax.jcr.Node content, RenderableDefinition definition, Map<String,Object> contextObjects, OutputProvider out)
AbstractRenderingListener	copy() The instance of each AbstractRenderingListener needs to be copied per request.
VoterSet<javax.servlet.http.HttpServletResponse>	getShouldProcess()
AbstractRenderingListener.RenderingListenerReturnCode	init(OutputProvider outputProvider, javax.servlet.http.HttpServletResponse response)
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setShouldProcess(VoterSet<javax.servlet.http.HttpServletResponse> shouldProcess)
protected boolean	shouldProcess(javax.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractRenderingListener

public AbstractRenderingListener()

Method Detail

init

public AbstractRenderingListener.RenderingListenerReturnCode init(OutputProvider outputProvider,
                                                         javax.servlet.http.HttpServletResponse response)
                                                           throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

shouldProcess

protected boolean shouldProcess(javax.servlet.http.HttpServletResponse response)

before

public abstract AbstractRenderingListener.RenderingListenerReturnCode before(javax.jcr.Node content,
                                                           RenderableDefinition definition,
                                                           Map<String,Object> contextObjects,
                                                           OutputProvider out)
                                                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

after

public abstract AbstractRenderingListener.RenderingListenerReturnCode after(javax.jcr.Node content,
                                                          RenderableDefinition definition,
                                                          Map<String,Object> contextObjects,
                                                          OutputProvider out)
                                                                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

copy

public AbstractRenderingListener copy()

The instance of each AbstractRenderingListener needs to be copied per request. Override this method to set your custom properties which should be shared between all instances.

getShouldProcess

public VoterSet<javax.servlet.http.HttpServletResponse> getShouldProcess()

setShouldProcess

public void setShouldProcess(VoterSet<javax.servlet.http.HttpServletResponse> shouldProcess)