|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.renderer.impl.JiveRenderContext
public class JiveRenderContext
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 |
---|
public JiveRenderContext(ForumFactory factory)
public JiveRenderContext(ForumFactory factory, java.lang.Object sourceObject)
public JiveRenderContext(ForumFactory factory, java.lang.Object sourceObject, java.util.Map params, RenderStrategy strategy, java.util.List filterTags)
public JiveRenderContext(ForumFactory factory, java.lang.Object sourceObject, java.util.Map params, RenderStrategy strategy, RenderPipe pipe, java.util.List filterTags)
Method Detail |
---|
public java.lang.Object getSourceObject()
RenderContext
getSourceObject
in interface RenderContext
public void setSourceObject(java.lang.Object sourceObject)
public ForumFactory getForumFactory()
RenderContext
getForumFactory
in interface RenderContext
public void setForumFactory(ForumFactory factory)
public java.util.Map getContextParameters()
RenderContext
getContextParameters
in interface RenderContext
public void setParams(java.util.Map params)
public java.lang.Object getContextParameter(java.lang.String key)
RenderContext
getContextParameter
in interface RenderContext
key
- the context parameter key
public void setContextParameter(java.lang.String key, java.lang.Object value)
RenderContext
setContextParameter
in interface RenderContext
key
- the context parameter keyvalue
- the context parameter valuepublic RenderStrategy getRenderStrategy()
RenderContext
getRenderStrategy
in interface RenderContext
public void setRenderStrategy(RenderStrategy renderStategy)
RenderContext
setRenderStrategy
in interface RenderContext
renderStategy
- the render strategy that will be used for rendering.public RenderPipe getRenderPipe()
RenderContext
getRenderPipe
in interface RenderContext
public void setRenderPipe(RenderPipe pipe)
RenderContext
setRenderPipe
in interface RenderContext
pipe
- the render pipe that will be used for rendering.public RenderedTextStore getRenderedTextStore()
RenderContext
getRenderedTextStore
in interface RenderContext
public java.util.List getFilterTags()
RenderContext
TagFilter
interface. This method is provided since some filters need to know
what other tags are being used by other filters.
getFilterTags
in interface RenderContext
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |