|
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.WikiFilter
public class WikiFilter
This render filter will render wiki style markup such as *bold* to html and vice versa. The following styles are implemented:
Constructor Summary | |
---|---|
WikiFilter()
|
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 |
getLinkSchemes()
|
java.lang.String |
getName()
Returns the unique name of the filter. |
protected boolean |
isEnabledByDefault()
Returns true if the filter should be enabled by default, false otherwise. |
boolean |
isHeadingsEnabled()
|
boolean |
isImagesEnabled()
|
boolean |
isLinkNewWindowEnabled()
|
boolean |
isLinksEnabled()
|
boolean |
isListsEnabled()
|
boolean |
isStylesEnabled()
|
boolean |
isTablesEnabled()
|
void |
setHeadingsEnabled(boolean headingsEnabled)
|
void |
setImagesEnabled(boolean imagesEnabled)
|
void |
setLinkNewWindowEnabled(boolean linkNewWindowEnabled)
|
void |
setLinkSchemes(java.lang.String linkSchemes)
|
void |
setLinksEnabled(boolean linksEnabled)
|
void |
setListsEnabled(boolean listsEnabled)
|
void |
setStylesEnabled(boolean stylesEnabled)
|
void |
setTablesEnabled(boolean tablesEnabled)
|
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 WikiFilter()
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 boolean isStylesEnabled()
public void setStylesEnabled(boolean stylesEnabled)
public boolean isLinksEnabled()
public void setLinksEnabled(boolean linksEnabled)
public boolean isListsEnabled()
public void setListsEnabled(boolean listsEnabled)
public boolean isTablesEnabled()
public void setTablesEnabled(boolean tablesEnabled)
public boolean isHeadingsEnabled()
public void setHeadingsEnabled(boolean headingsEnabled)
public boolean isImagesEnabled()
public void setImagesEnabled(boolean imagesEnabled)
public boolean isLinkNewWindowEnabled()
public void setLinkNewWindowEnabled(boolean linkNewWindowEnabled)
public java.lang.String getLinkSchemes()
public void setLinkSchemes(java.lang.String linkSchemes)
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |