Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter
Class RegexReplaceFilter

java.lang.Object
  extended by com.jivesoftware.forum.renderer.AbstractRenderFilter
      extended by com.jivesoftware.forum.renderer.filter.RegexReplaceFilter
All Implemented Interfaces:
com.jivesoftware.forum.renderer.impl.JiveSystemRenderFilter, RenderFilter

public class RegexReplaceFilter
extends AbstractRenderFilter
implements com.jivesoftware.forum.renderer.impl.JiveSystemRenderFilter

A filter that allows arbitrary regular expressions to be used to replace text blocks. Up to five JDK 1.4 regular expressions are matched against the String to filter. If a match is found, the replacement text is used to replace the matched text. The filter is essentially equivalent to using the String.replaceAll(String, String) method.


Constructor Summary
RegexReplaceFilter()
           
 
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 getName()
          Returns the unique name of the filter.
 java.lang.String getPattern1()
           
 java.lang.String getPattern2()
           
 java.lang.String getPattern3()
           
 java.lang.String getPattern4()
           
 java.lang.String getPattern5()
           
 java.lang.String getReplace1()
           
 java.lang.String getReplace2()
           
 java.lang.String getReplace3()
           
 java.lang.String getReplace4()
           
 java.lang.String getReplace5()
           
protected  boolean isEnabledByDefault()
          Returns true if the filter should be enabled by default, false otherwise.
 void setPattern1(java.lang.String pattern)
           
 void setPattern2(java.lang.String pattern)
           
 void setPattern3(java.lang.String pattern)
           
 void setPattern4(java.lang.String pattern)
           
 void setPattern5(java.lang.String pattern)
           
 void setReplace1(java.lang.String replace)
           
 void setReplace2(java.lang.String replace)
           
 void setReplace3(java.lang.String replace)
           
 void setReplace4(java.lang.String replace)
           
 void setReplace5(java.lang.String replace)
           
 
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

RegexReplaceFilter

public RegexReplaceFilter()
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.

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

getPattern1

public java.lang.String getPattern1()

setPattern1

public void setPattern1(java.lang.String pattern)

getPattern2

public java.lang.String getPattern2()

setPattern2

public void setPattern2(java.lang.String pattern)

getPattern3

public java.lang.String getPattern3()

setPattern3

public void setPattern3(java.lang.String pattern)

getPattern4

public java.lang.String getPattern4()

setPattern4

public void setPattern4(java.lang.String pattern)

getPattern5

public java.lang.String getPattern5()

setPattern5

public void setPattern5(java.lang.String pattern)

getReplace1

public java.lang.String getReplace1()

setReplace1

public void setReplace1(java.lang.String replace)

getReplace2

public java.lang.String getReplace2()

setReplace2

public void setReplace2(java.lang.String replace)

getReplace3

public java.lang.String getReplace3()

setReplace3

public void setReplace3(java.lang.String replace)

getReplace4

public java.lang.String getReplace4()

setReplace4

public void setReplace4(java.lang.String replace)

getReplace5

public java.lang.String getReplace5()

setReplace5

public void setReplace5(java.lang.String replace)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.