info.magnolia.rendering.context

Interface RenderingContext

All Known Implementing Classes:

AggregationStateBasedRenderingContext

public interface RenderingContext

Provides all information needed in the rendering process.

Method Summary

Modifier and Type	Method and Description
void	addListener(AbstractRenderingListener renderingListener)
void	after(javax.jcr.Node content, RenderableDefinition definition, Map<String,Object> contextObjects, OutputProvider out)
Collection<AbstractRenderingListener.RenderingListenerReturnCode>	before(javax.jcr.Node content, RenderableDefinition definition, Map<String,Object> contextObjects, OutputProvider out)
RenderableDefinition	getAncestorDefinition(int level)
AppendableWriter	getAppendable()
javax.jcr.Node	getCurrentContent()
javax.jcr.Node	getMainContent()
OutputProvider	getOutputProvider()
OutputStream	getOutputStream()
AreaDefinition	getParentAreaDefinition()
RenderableDefinition	getRenderableDefinition()
void	handleException(RenderException renderException)
void	pop()
void	push(javax.jcr.Node content, RenderableDefinition renderableDefinition) Pushes the content and renderableDefinition to be used for rendering.
void	push(javax.jcr.Node content, RenderableDefinition renderableDefinition, OutputProvider outputProvider) Pushes the content and renderableDefinition to be used for rendering.
void	setListeners(List<AbstractRenderingListener> listeners)

Method Detail

getMainContent

javax.jcr.Node getMainContent()

getCurrentContent

javax.jcr.Node getCurrentContent()

getRenderableDefinition

RenderableDefinition getRenderableDefinition()

getParentAreaDefinition

AreaDefinition getParentAreaDefinition()

getAncestorDefinition

RenderableDefinition getAncestorDefinition(int level)

getOutputProvider

OutputProvider getOutputProvider()

push

void push(javax.jcr.Node content,
          RenderableDefinition renderableDefinition)

Pushes the content and renderableDefinition to be used for rendering. Output will be written using the OutputProvider already set.

push

void push(javax.jcr.Node content,
          RenderableDefinition renderableDefinition,
          OutputProvider outputProvider)

Pushes the content and renderableDefinition to be used for rendering.

Parameters:

outputProvider - the OutputProvider to be used for output or null to use the OutputProvider already set

pop

void pop()

getAppendable

AppendableWriter getAppendable()
                        throws IOException

Throws:

IOException

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Throws:

IOException

handleException

void handleException(RenderException renderException)

addListener

void addListener(AbstractRenderingListener renderingListener)

setListeners

void setListeners(List<AbstractRenderingListener> listeners)

before

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

after

void after(javax.jcr.Node content,
           RenderableDefinition definition,
           Map<String,Object> contextObjects,
           OutputProvider out)