|
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.RegexReplaceFilter
public class RegexReplaceFilter
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 |
---|
public RegexReplaceFilter()
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 getPattern1()
public void setPattern1(java.lang.String pattern)
public java.lang.String getPattern2()
public void setPattern2(java.lang.String pattern)
public java.lang.String getPattern3()
public void setPattern3(java.lang.String pattern)
public java.lang.String getPattern4()
public void setPattern4(java.lang.String pattern)
public java.lang.String getPattern5()
public void setPattern5(java.lang.String pattern)
public java.lang.String getReplace1()
public void setReplace1(java.lang.String replace)
public java.lang.String getReplace2()
public void setReplace2(java.lang.String replace)
public java.lang.String getReplace3()
public void setReplace3(java.lang.String replace)
public java.lang.String getReplace4()
public void setReplace4(java.lang.String replace)
public java.lang.String getReplace5()
public void setReplace5(java.lang.String replace)
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |