|
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.AbstractRegexTokenRenderFilter
com.jivesoftware.forum.renderer.impl.AbstractClassicRegexTokenRenderFilter
com.jivesoftware.forum.renderer.filter.ThreadFilter
public class ThreadFilter
A filter that converts [thread]123[/thread] tags into urls.
Field Summary |
---|
Fields inherited from class com.jivesoftware.forum.renderer.filter.AbstractRegexTokenRenderFilter |
---|
MULTILINE, SINGLELINE |
Constructor Summary | |
---|---|
ThreadFilter()
|
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 . |
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 |
getEndTag()
|
java.lang.String |
getMidTag()
|
java.lang.String |
getName()
Returns the unique name of the filter. |
java.lang.String |
getStartTag()
|
java.lang.String[] |
getTags()
Returns an array of string for the tag names a filter uses. |
java.lang.String |
getThreadMatch()
|
void |
handleMatch(java.lang.StringBuffer buffer,
JdkMatchResult result,
RenderContext renderContext)
Method is called for every occurance of a regular expression. |
protected boolean |
isEnabledByDefault()
Returns true if the filter should be enabled by default, false otherwise. |
void |
setEndTag(java.lang.String endTag)
|
void |
setMidTag(java.lang.String midTag)
|
void |
setStartTag(java.lang.String startTag)
|
void |
setThreadMatch(java.lang.String match)
|
Methods inherited from class com.jivesoftware.forum.renderer.impl.AbstractClassicRegexTokenRenderFilter |
---|
isDisplayable, isTest, setTest |
Methods inherited from class com.jivesoftware.forum.renderer.filter.AbstractRegexTokenRenderFilter |
---|
addRegex, addRegex, addRegex, clearRegex, filter |
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 |
Methods inherited from interface com.jivesoftware.forum.renderer.RenderFilter |
---|
execute, getUserDocumentation, isEnabled, setEnabled |
Methods inherited from interface com.jivesoftware.forum.renderer.impl.JiveClassicRenderFilter |
---|
isDisplayable |
Constructor Detail |
---|
public ThreadFilter()
Method Detail |
---|
public java.lang.String getName()
RenderFilter
getName
in interface RenderFilter
getName
in class AbstractRenderFilter
public java.lang.String[] getTags()
TagFilter
getTags
in interface TagFilter
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 void handleMatch(java.lang.StringBuffer buffer, JdkMatchResult result, RenderContext renderContext)
AbstractRegexTokenRenderFilter
handleMatch
in class AbstractRegexTokenRenderFilter
buffer
- Buffer to write replacement string toresult
- Hit with the found regular expressionrenderContext
- RenderContext for filtersRegexTokenFilter.handleMatch(StringBuffer, com.jivesoftware.forum.renderer.filter.regex.jdk.JdkMatchResult, com.jivesoftware.forum.renderer.RenderContext)
public java.lang.String getStartTag()
public void setStartTag(java.lang.String startTag)
public java.lang.String getMidTag()
public void setMidTag(java.lang.String midTag)
public java.lang.String getEndTag()
public void setEndTag(java.lang.String endTag)
public java.lang.String getThreadMatch()
public void setThreadMatch(java.lang.String match)
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |