|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RenderFilter
A filter is an object that performs filtering on Strings. For example, a filter might look for newline characters in a string (\n, \r\n) and replace them with <br> or <p> tags.
It is recommended that each filter provide through theBeanInfo
interface the
following:
getUserDocumentation(String)
method. The output of this method is expected to follow
the guidelines outlined in the documentation distributed with the product.
Instantiating classes of this interface are required to have a zero argument constructor.
JiveBeanInfo
Method Summary | |
---|---|
java.lang.String |
execute(java.lang.String string,
com.jivesoftware.forum.renderer.RenderContext renderContext)
Applies the filter to the passed in string and returns the filtered string. |
java.lang.String |
getName()
Returns the unique name of the filter. |
java.lang.String[] |
getUserDocumentation(java.lang.String language)
Returns a string array of [section,title, body] of xml formatted documentation that is targetted for end user usage. |
boolean |
isEnabled()
Returns true if the filter is enabled, false otherwise. |
void |
setEnabled(boolean enabled)
Sets whether the filter is enabled or disabled. |
Method Detail |
---|
java.lang.String getName()
boolean isEnabled()
void setEnabled(boolean enabled)
enabled
- true if the filter should be enabled, false otherwise.java.lang.String execute(java.lang.String string, com.jivesoftware.forum.renderer.RenderContext renderContext)
RenderStrategy
denotes that links should not be filtered and
the current filter does nothing but change text to links, then the filter should
just return the input string.RenderTarget
that the filter
should target the output towards.RenderedTextStore
to store text snippets if no further rendering of the
all or portions of the returned content should not be performed.
string
- the String to filterrenderContext
- the context the filter is being executed within
java.lang.String[] getUserDocumentation(java.lang.String language)
language
- the language as an ISO-639 language code to return the documentation in.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |