Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.impl
Class JiveRenderContext

java.lang.Object
  extended by com.jivesoftware.forum.renderer.impl.JiveRenderContext
All Implemented Interfaces:
RenderContext

public class JiveRenderContext
extends java.lang.Object
implements RenderContext


Constructor Summary
JiveRenderContext(ForumFactory factory)
           
JiveRenderContext(ForumFactory factory, java.lang.Object sourceObject)
           
JiveRenderContext(ForumFactory factory, java.lang.Object sourceObject, java.util.Map params, RenderStrategy strategy, java.util.List filterTags)
           
JiveRenderContext(ForumFactory factory, java.lang.Object sourceObject, java.util.Map params, RenderStrategy strategy, RenderPipe pipe, java.util.List filterTags)
           
 
Method Summary
 java.lang.Object getContextParameter(java.lang.String key)
          Returns the context parameter associated with the specified key, or null if no association exists.
 java.util.Map getContextParameters()
          Returns a map of all the context parameters.
 java.util.List getFilterTags()
          Returns a list of tags for all the currently configured render filters which implement the TagFilter interface.
 ForumFactory getForumFactory()
          Returns the forum factory under which the filter is executing.
 RenderedTextStore getRenderedTextStore()
          Returns the text store associated with the context.
 RenderPipe getRenderPipe()
          Returns the render pipe that will be used for rendering.
 RenderStrategy getRenderStrategy()
          Returns the render strategy that will be used for rendering.
 java.lang.Object getSourceObject()
          Returns the source object for which we're filtering a string from.
 void setContextParameter(java.lang.String key, java.lang.Object value)
          Set a context parameter.
 void setForumFactory(ForumFactory factory)
           
 void setParams(java.util.Map params)
           
 void setRenderPipe(RenderPipe pipe)
          Sets the render pipe that will be used for rendering.
 void setRenderStrategy(RenderStrategy renderStategy)
          Sets the render strategy that will be used for rendering.
 void setSourceObject(java.lang.Object sourceObject)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JiveRenderContext

public JiveRenderContext(ForumFactory factory)

JiveRenderContext

public JiveRenderContext(ForumFactory factory,
                         java.lang.Object sourceObject)

JiveRenderContext

public JiveRenderContext(ForumFactory factory,
                         java.lang.Object sourceObject,
                         java.util.Map params,
                         RenderStrategy strategy,
                         java.util.List filterTags)

JiveRenderContext

public JiveRenderContext(ForumFactory factory,
                         java.lang.Object sourceObject,
                         java.util.Map params,
                         RenderStrategy strategy,
                         RenderPipe pipe,
                         java.util.List filterTags)
Method Detail

getSourceObject

public java.lang.Object getSourceObject()
Description copied from interface: RenderContext
Returns the source object for which we're filtering a string from. This method allows a filter or macro to get access to the source object if required.

Specified by:
getSourceObject in interface RenderContext
Returns:
the source object for which we're filtering a string from.

setSourceObject

public void setSourceObject(java.lang.Object sourceObject)

getForumFactory

public ForumFactory getForumFactory()
Description copied from interface: RenderContext
Returns the forum factory under which the filter is executing.

Specified by:
getForumFactory in interface RenderContext
Returns:
the forum factory under which the filter is executing.

setForumFactory

public void setForumFactory(ForumFactory factory)

getContextParameters

public java.util.Map getContextParameters()
Description copied from interface: RenderContext
Returns a map of all the context parameters.

Specified by:
getContextParameters in interface RenderContext
Returns:
a map of all the context parameters.

setParams

public void setParams(java.util.Map params)

getContextParameter

public java.lang.Object getContextParameter(java.lang.String key)
Description copied from interface: RenderContext
Returns the context parameter associated with the specified key, or null if no association exists.

Specified by:
getContextParameter in interface RenderContext
Parameters:
key - the context parameter key
Returns:
the context parameter associated with the specified key

setContextParameter

public void setContextParameter(java.lang.String key,
                                java.lang.Object value)
Description copied from interface: RenderContext
Set a context parameter.

Specified by:
setContextParameter in interface RenderContext
Parameters:
key - the context parameter key
value - the context parameter value

getRenderStrategy

public RenderStrategy getRenderStrategy()
Description copied from interface: RenderContext
Returns the render strategy that will be used for rendering.

Specified by:
getRenderStrategy in interface RenderContext
Returns:
the render strategy that will be used for rendering.

setRenderStrategy

public void setRenderStrategy(RenderStrategy renderStategy)
Description copied from interface: RenderContext
Sets the render strategy that will be used for rendering.

Specified by:
setRenderStrategy in interface RenderContext
Parameters:
renderStategy - the render strategy that will be used for rendering.

getRenderPipe

public RenderPipe getRenderPipe()
Description copied from interface: RenderContext
Returns the render pipe that will be used for rendering.

Specified by:
getRenderPipe in interface RenderContext
Returns:
the render pipe that will be used for rendering.

setRenderPipe

public void setRenderPipe(RenderPipe pipe)
Description copied from interface: RenderContext
Sets the render pipe that will be used for rendering.

Specified by:
setRenderPipe in interface RenderContext
Parameters:
pipe - the render pipe that will be used for rendering.

getRenderedTextStore

public RenderedTextStore getRenderedTextStore()
Description copied from interface: RenderContext
Returns the text store associated with the context.

Specified by:
getRenderedTextStore in interface RenderContext
Returns:
the text store associated with the context.

getFilterTags

public java.util.List getFilterTags()
Description copied from interface: RenderContext
Returns a list of tags for all the currently configured render filters which implement the TagFilter interface. This method is provided since some filters need to know what other tags are being used by other filters.

Specified by:
getFilterTags in interface RenderContext
Returns:
a list of tags for all the configured render filters implementing the TagFilter interface.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.