|
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.JavaCodeFilter
public class JavaCodeFilter
This filter renders [code] java code here[/code]. This filter is deprecated - use the code macro instead.
Field Summary |
---|
Fields inherited from class com.jivesoftware.forum.renderer.filter.AbstractRegexTokenRenderFilter |
---|
MULTILINE, SINGLELINE |
Constructor Summary | |
---|---|
JavaCodeFilter()
|
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 . |
boolean |
getApplyTableSurround()
|
java.lang.String |
getBracketEnd()
|
java.lang.String |
getBracketStart()
|
java.lang.String |
getCharacterEnd()
|
java.lang.String |
getCharacterStart()
|
java.lang.String |
getCodeMatch()
|
java.lang.String |
getCommentEnd()
|
java.lang.String |
getCommentStart()
|
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]. |
boolean |
getFilterMethod()
|
boolean |
getFilterNumber()
|
java.lang.String |
getLineNumberColor()
|
java.lang.String |
getMethodEnd()
|
java.lang.String |
getMethodStart()
|
java.lang.String |
getName()
Returns the unique name of the filter. |
java.lang.String |
getNumberEnd()
|
java.lang.String |
getNumberStart()
|
java.lang.String |
getReservedWordEnd()
|
java.lang.String |
getReservedWordStart()
|
boolean |
getShowLineCount()
|
java.lang.String |
getStringEnd()
|
java.lang.String |
getStringStart()
|
java.lang.String |
getTableBorderColor()
|
java.lang.String |
getTableCodePanelBckgrndColor()
|
java.lang.String |
getTableLinePanelBckgrndColor()
|
java.lang.String[] |
getTags()
Returns an array of string for the tag names a filter uses. |
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 |
setApplyTableSurround(boolean applyTableSurround)
|
void |
setBracketEnd(java.lang.String bracketEnd)
|
void |
setBracketStart(java.lang.String bracketStart)
|
void |
setCharacterEnd(java.lang.String characterEnd)
|
void |
setCharacterStart(java.lang.String characterStart)
|
void |
setCodeMatch(java.lang.String match)
|
void |
setCommentEnd(java.lang.String commentEnd)
|
void |
setCommentStart(java.lang.String commentStart)
|
void |
setFilterMethod(boolean filterMethod)
|
void |
setFilterNumber(boolean filterNumber)
|
void |
setLineNumberColor(java.lang.String lineNumberColor)
|
void |
setMethodEnd(java.lang.String methodEnd)
|
void |
setMethodStart(java.lang.String methodStart)
|
void |
setNumberEnd(java.lang.String numberEnd)
|
void |
setNumberStart(java.lang.String numberStart)
|
void |
setReservedWordEnd(java.lang.String reservedWordEnd)
|
void |
setReservedWordStart(java.lang.String reservedWordStart)
|
void |
setShowLineCount(boolean showLineCount)
|
void |
setStringEnd(java.lang.String stringEnd)
|
void |
setStringStart(java.lang.String stringStart)
|
void |
setTableBorderColor(java.lang.String tableBorderColor)
|
void |
setTableCodePanelBckgrndColor(java.lang.String tableCodePanelBckgrndColor)
|
void |
setTableLinePanelBckgrndColor(java.lang.String tableLinePanelBckgrndColor)
|
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 JavaCodeFilter()
Method Detail |
---|
public java.lang.String getName()
RenderFilter
getName
in interface RenderFilter
getName
in class AbstractRenderFilter
protected boolean isEnabledByDefault()
AbstractRenderFilter
isEnabledByDefault
in class AbstractRenderFilter
public java.lang.String[] getTags()
TagFilter
getTags
in interface TagFilter
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 getCodeMatch()
public void setCodeMatch(java.lang.String match)
public boolean getApplyTableSurround()
public void setApplyTableSurround(boolean applyTableSurround)
public boolean getShowLineCount()
public void setShowLineCount(boolean showLineCount)
public java.lang.String getTableBorderColor()
public void setTableBorderColor(java.lang.String tableBorderColor)
public java.lang.String getTableLinePanelBckgrndColor()
public void setTableLinePanelBckgrndColor(java.lang.String tableLinePanelBckgrndColor)
public java.lang.String getTableCodePanelBckgrndColor()
public void setTableCodePanelBckgrndColor(java.lang.String tableCodePanelBckgrndColor)
public java.lang.String getLineNumberColor()
public void setLineNumberColor(java.lang.String lineNumberColor)
public java.lang.String getCommentStart()
public void setCommentStart(java.lang.String commentStart)
public java.lang.String getCommentEnd()
public void setCommentEnd(java.lang.String commentEnd)
public java.lang.String getStringStart()
public void setStringStart(java.lang.String stringStart)
public java.lang.String getStringEnd()
public void setStringEnd(java.lang.String stringEnd)
public java.lang.String getReservedWordStart()
public void setReservedWordStart(java.lang.String reservedWordStart)
public java.lang.String getReservedWordEnd()
public void setReservedWordEnd(java.lang.String reservedWordEnd)
public java.lang.String getMethodStart()
public void setMethodStart(java.lang.String methodStart)
public java.lang.String getMethodEnd()
public void setMethodEnd(java.lang.String methodEnd)
public java.lang.String getCharacterStart()
public void setCharacterStart(java.lang.String characterStart)
public java.lang.String getCharacterEnd()
public void setCharacterEnd(java.lang.String characterEnd)
public java.lang.String getBracketStart()
public void setBracketStart(java.lang.String bracketStart)
public java.lang.String getBracketEnd()
public void setBracketEnd(java.lang.String bracketEnd)
public java.lang.String getNumberStart()
public void setNumberStart(java.lang.String numberStart)
public java.lang.String getNumberEnd()
public void setNumberEnd(java.lang.String numberEnd)
public boolean getFilterMethod()
public void setFilterMethod(boolean filterMethod)
public boolean getFilterNumber()
public void setFilterNumber(boolean filterNumber)
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |