info.magnolia.rendering.listeners

Class AbstractInjectionListener

java.lang.Object

info.magnolia.rendering.listeners.AbstractRenderingListener

info.magnolia.rendering.listeners.AbstractInjectionListener

public abstract class AbstractInjectionListener
extends AbstractRenderingListener

Listener for text injection.

Nested Class Summary

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

AbstractRenderingListener.RenderingListenerReturnCode

Constructor Summary

Constructors

Constructor and Description
AbstractInjectionListener()

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)
AbstractRenderingListener	copy() The instance of each AbstractRenderingListener needs to be copied per request.
String	getAfter()
Collection<String>	getArguments()
String	getBefore()
boolean	isSkipRendering()
protected String	processBeforeInjection(String text, javax.jcr.Node content, RenderableDefinition definition)
void	setAfter(String after)
void	setArguments(Collection<String> arguments)
void	setBefore(String before)
void	setSkipRendering(boolean skipRendering)
protected abstract boolean	shouldInclude(javax.jcr.Node content, RenderableDefinition definition)

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

getShouldProcess, init, isEnabled, setEnabled, setShouldProcess, shouldProcess

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInjectionListener

public AbstractInjectionListener()

Method Detail

shouldInclude

protected abstract boolean shouldInclude(javax.jcr.Node content,
                    RenderableDefinition definition)
                                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

copy

public AbstractRenderingListener 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

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

processBeforeInjection

protected String processBeforeInjection(String text,
                            javax.jcr.Node content,
                            RenderableDefinition definition)
                                 throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getBefore

public String getBefore()

setBefore

public void setBefore(String before)

getAfter

public String getAfter()

setAfter

public void setAfter(String after)

isSkipRendering

public boolean isSkipRendering()

setSkipRendering

public void setSkipRendering(boolean skipRendering)

getArguments

public Collection<String> getArguments()

setArguments

public void setArguments(Collection<String> arguments)