Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter
Class JavaCodeFilter

java.lang.Object
  extended by com.jivesoftware.forum.renderer.AbstractRenderFilter
      extended by com.jivesoftware.forum.renderer.filter.AbstractRegexTokenRenderFilter
          extended by com.jivesoftware.forum.renderer.impl.AbstractClassicRegexTokenRenderFilter
              extended by com.jivesoftware.forum.renderer.filter.JavaCodeFilter
All Implemented Interfaces:
com.jivesoftware.forum.renderer.impl.JiveClassicRenderFilter, com.jivesoftware.forum.renderer.impl.JiveSystemRenderFilter, RenderFilter, TagFilter

public class JavaCodeFilter
extends AbstractClassicRegexTokenRenderFilter
implements TagFilter, com.jivesoftware.forum.renderer.impl.JiveClassicRenderFilter

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

JavaCodeFilter

public JavaCodeFilter()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: RenderFilter
Returns the unique name of the filter.

Specified by:
getName in interface RenderFilter
Specified by:
getName in class AbstractRenderFilter
Returns:
the unique name of the filter.

isEnabledByDefault

protected boolean isEnabledByDefault()
Description copied from class: AbstractRenderFilter
Returns true if the filter should be enabled by default, false otherwise.

Specified by:
isEnabledByDefault in class AbstractRenderFilter
Returns:
true if the filter should be enabled by default, false otherwise.

getTags

public java.lang.String[] getTags()
Description copied from interface: TagFilter
Returns an array of string for the tag names a filter uses. For example, a filter which filters upon the tags [url] and [ftp] should return a two element array of "url", "ftp"

Specified by:
getTags in interface TagFilter
Returns:
an array of string for the tag names a filter uses.

executePlainTextTarget

protected java.lang.String executePlainTextTarget(java.lang.String string,
                                                  RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_TEXT.

Specified by:
executePlainTextTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executePlainEmailTarget

protected java.lang.String executePlainEmailTarget(java.lang.String string,
                                                   RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_EMAIL.

Specified by:
executePlainEmailTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executeHtmlTarget

protected java.lang.String executeHtmlTarget(java.lang.String string,
                                             RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_HTML.

Specified by:
executeHtmlTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executeWysiwygEditorTarget

protected java.lang.String executeWysiwygEditorTarget(java.lang.String string,
                                                      RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_WYSIWYG_EDITOR.

Specified by:
executeWysiwygEditorTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executeNoMarkupTarget

protected java.lang.String executeNoMarkupTarget(java.lang.String string,
                                                 RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_NO_MARKUP.

Specified by:
executeNoMarkupTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

getDocumentationMap

protected java.util.Map getDocumentationMap()
Description copied from class: AbstractRenderFilter
Returns a documentation Map keyed by languageCode -> String[section,title,body].

Specified by:
getDocumentationMap in class AbstractRenderFilter
Returns:
a documentation Map keyed by languageCode -> String[section,title,body]

getDefaultHelp

protected java.lang.String[] getDefaultHelp()
Description copied from class: AbstractRenderFilter
Returns a String[section,title,body] for the default help for the filter.

Specified by:
getDefaultHelp in class AbstractRenderFilter
Returns:
a String[section,title,body] for the default help for the filter

handleMatch

public void handleMatch(java.lang.StringBuffer buffer,
                        JdkMatchResult result,
                        RenderContext renderContext)
Description copied from class: AbstractRegexTokenRenderFilter
Method is called for every occurance of a regular expression. Subclasses have to implement this method.

Specified by:
handleMatch in class AbstractRegexTokenRenderFilter
Parameters:
buffer - Buffer to write replacement string to
result - Hit with the found regular expression
renderContext - RenderContext for filters
See Also:
RegexTokenFilter.handleMatch(StringBuffer, com.jivesoftware.forum.renderer.filter.regex.jdk.JdkMatchResult, com.jivesoftware.forum.renderer.RenderContext)

getCodeMatch

public java.lang.String getCodeMatch()

setCodeMatch

public void setCodeMatch(java.lang.String match)

getApplyTableSurround

public boolean getApplyTableSurround()

setApplyTableSurround

public void setApplyTableSurround(boolean applyTableSurround)

getShowLineCount

public boolean getShowLineCount()

setShowLineCount

public void setShowLineCount(boolean showLineCount)

getTableBorderColor

public java.lang.String getTableBorderColor()

setTableBorderColor

public void setTableBorderColor(java.lang.String tableBorderColor)

getTableLinePanelBckgrndColor

public java.lang.String getTableLinePanelBckgrndColor()

setTableLinePanelBckgrndColor

public void setTableLinePanelBckgrndColor(java.lang.String tableLinePanelBckgrndColor)

getTableCodePanelBckgrndColor

public java.lang.String getTableCodePanelBckgrndColor()

setTableCodePanelBckgrndColor

public void setTableCodePanelBckgrndColor(java.lang.String tableCodePanelBckgrndColor)

getLineNumberColor

public java.lang.String getLineNumberColor()

setLineNumberColor

public void setLineNumberColor(java.lang.String lineNumberColor)

getCommentStart

public java.lang.String getCommentStart()

setCommentStart

public void setCommentStart(java.lang.String commentStart)

getCommentEnd

public java.lang.String getCommentEnd()

setCommentEnd

public void setCommentEnd(java.lang.String commentEnd)

getStringStart

public java.lang.String getStringStart()

setStringStart

public void setStringStart(java.lang.String stringStart)

getStringEnd

public java.lang.String getStringEnd()

setStringEnd

public void setStringEnd(java.lang.String stringEnd)

getReservedWordStart

public java.lang.String getReservedWordStart()

setReservedWordStart

public void setReservedWordStart(java.lang.String reservedWordStart)

getReservedWordEnd

public java.lang.String getReservedWordEnd()

setReservedWordEnd

public void setReservedWordEnd(java.lang.String reservedWordEnd)

getMethodStart

public java.lang.String getMethodStart()

setMethodStart

public void setMethodStart(java.lang.String methodStart)

getMethodEnd

public java.lang.String getMethodEnd()

setMethodEnd

public void setMethodEnd(java.lang.String methodEnd)

getCharacterStart

public java.lang.String getCharacterStart()

setCharacterStart

public void setCharacterStart(java.lang.String characterStart)

getCharacterEnd

public java.lang.String getCharacterEnd()

setCharacterEnd

public void setCharacterEnd(java.lang.String characterEnd)

getBracketStart

public java.lang.String getBracketStart()

setBracketStart

public void setBracketStart(java.lang.String bracketStart)

getBracketEnd

public java.lang.String getBracketEnd()

setBracketEnd

public void setBracketEnd(java.lang.String bracketEnd)

getNumberStart

public java.lang.String getNumberStart()

setNumberStart

public void setNumberStart(java.lang.String numberStart)

getNumberEnd

public java.lang.String getNumberEnd()

setNumberEnd

public void setNumberEnd(java.lang.String numberEnd)

getFilterMethod

public boolean getFilterMethod()

setFilterMethod

public void setFilterMethod(boolean filterMethod)

getFilterNumber

public boolean getFilterNumber()

setFilterNumber

public void setFilterNumber(boolean filterNumber)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.