|
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.AbstractRenderFilter
com.jivesoftware.forum.renderer.filter.WikiEscapeFilter
public class WikiEscapeFilter
A filter that escapes wiki syntax for html output. This filter is useful for messages imported or inherited from older jive products that didn't use the new wiki-style markup syntax. A cutoff date is required to be provided to this filter so that it can know at which point in time the upgrade/migration was completed. This is required since we do not want to escape wiki-style markup from new or updated content.
Constructor Summary | |
---|---|
WikiEscapeFilter()
|
Method Summary | |
---|---|
protected java.lang.String |
executeHtmlTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_HTML . |
protected java.lang.String |
executeNoMarkupTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_NO_MARKUP . |
protected java.lang.String |
executePlainEmailTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_EMAIL . |
protected java.lang.String |
executePlainTextTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_TEXT . |
protected java.lang.String |
executeWysiwygEditorTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_WYSIWYG_EDITOR . |
java.lang.String |
getCutoffDate()
Returns the cutoff date after which content will not be escaped. |
protected java.lang.String[] |
getDefaultHelp()
Returns a String[section,title,body] for the default help for the filter. |
protected java.util.Map |
getDocumentationMap()
Returns a documentation Map keyed by languageCode -> String[section,title,body]. |
java.lang.String |
getName()
Returns the unique name of the filter. |
protected boolean |
isEnabledByDefault()
Returns true if the filter should be enabled by default, false otherwise. |
void |
setCutoffDate(java.lang.String cutoffDate)
Sets the cutoff date after which content will not be escaped. |
Methods inherited from class com.jivesoftware.forum.renderer.AbstractRenderFilter |
---|
execute, getUserDocumentation, isEnabled, setEnabled |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WikiEscapeFilter()
Method Detail |
---|
public java.lang.String getName()
RenderFilter
getName
in interface RenderFilter
getName
in class AbstractRenderFilter
protected boolean isEnabledByDefault()
AbstractRenderFilter
isEnabledByDefault
in class AbstractRenderFilter
protected java.lang.String executePlainTextTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_PLAIN_TEXT
.
executePlainTextTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executePlainEmailTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_PLAIN_EMAIL
.
executePlainEmailTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executeHtmlTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_HTML
.
executeHtmlTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executeWysiwygEditorTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_WYSIWYG_EDITOR
.
executeWysiwygEditorTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executeNoMarkupTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_NO_MARKUP
.
executeNoMarkupTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.util.Map getDocumentationMap()
AbstractRenderFilter
getDocumentationMap
in class AbstractRenderFilter
protected java.lang.String[] getDefaultHelp()
AbstractRenderFilter
getDefaultHelp
in class AbstractRenderFilter
public java.lang.String getCutoffDate()
public void setCutoffDate(java.lang.String cutoffDate)
cutoffDate
- the cutoff date after which content will not be escaped.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |