info.magnolia.rendering.listeners

Class AreaFilteringListener

java.lang.Object

info.magnolia.rendering.listeners.AbstractRenderingListener

info.magnolia.rendering.listeners.AreaFilteringListener

public class AreaFilteringListener
extends AbstractRenderingListener

Area rendering listener for enabling/disabling output according to rendered content.

Nested Class Summary

Nested classes/interfaces inherited from class info.magnolia.rendering.listeners.AbstractRenderingListener

AbstractRenderingListener.RenderingListenerReturnCode

Field Summary

Fields

Modifier and Type	Field and Description
static String	MGNL_AREA_PARAMETER
static String	MGNL_AREA_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AreaFilteringListener(TemplateDefinitionAssignment templateDefinitionAssignment)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractRenderingListener.RenderingListenerReturnCode	after(javax.jcr.Node content, RenderableDefinition definition, Map<String,Object> contextObjects, OutputProvider out)
AbstractRenderingListener.RenderingListenerReturnCode	before(javax.jcr.Node content, RenderableDefinition definition, Map<String,Object> contextObjects, OutputProvider out)
AreaFilteringListener	copy() The instance of each AbstractRenderingListener needs to be copied per request.
AbstractRenderingListener.RenderingListenerReturnCode	init(OutputProvider out, javax.servlet.http.HttpServletResponse response)
boolean	isCheckAreaExistence()
void	setCheckAreaExistence(boolean checkAreaExistence)

Methods inherited from class info.magnolia.rendering.listeners.AbstractRenderingListener

getShouldProcess, isEnabled, setEnabled, setShouldProcess, shouldProcess

Methods inherited from class java.lang.Object

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

Field Detail

MGNL_AREA_PARAMETER

public static final String MGNL_AREA_PARAMETER

See Also:

Constant Field Values

MGNL_AREA_PATH_SEPARATOR

public static final String MGNL_AREA_PATH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

AreaFilteringListener

@Inject
public AreaFilteringListener(TemplateDefinitionAssignment templateDefinitionAssignment)

Method Detail

init

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

Overrides:

init in class AbstractRenderingListener

Throws:

javax.jcr.RepositoryException

before

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

Specified by:

before in class AbstractRenderingListener

Throws:

javax.jcr.RepositoryException

after

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

Specified by:

after in class AbstractRenderingListener

Throws:

javax.jcr.RepositoryException

copy

public AreaFilteringListener copy()

Description copied from class: AbstractRenderingListener

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.

Overrides:

copy in class AbstractRenderingListener

isCheckAreaExistence

public boolean isCheckAreaExistence()

setCheckAreaExistence

public void setCheckAreaExistence(boolean checkAreaExistence)