Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter
Class WikiFilter

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

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

This render filter will render wiki style markup such as *bold* to html and vice versa. The following styles are implemented:

This filter also recognizes different lists like numbered lists, unnumbered lists, greek lists, and alpha lists.


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

WikiFilter

public WikiFilter()
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

isStylesEnabled

public boolean isStylesEnabled()

setStylesEnabled

public void setStylesEnabled(boolean stylesEnabled)

isLinksEnabled

public boolean isLinksEnabled()

setLinksEnabled

public void setLinksEnabled(boolean linksEnabled)

isListsEnabled

public boolean isListsEnabled()

setListsEnabled

public void setListsEnabled(boolean listsEnabled)

isTablesEnabled

public boolean isTablesEnabled()

setTablesEnabled

public void setTablesEnabled(boolean tablesEnabled)

isHeadingsEnabled

public boolean isHeadingsEnabled()

setHeadingsEnabled

public void setHeadingsEnabled(boolean headingsEnabled)

isImagesEnabled

public boolean isImagesEnabled()

setImagesEnabled

public void setImagesEnabled(boolean imagesEnabled)

isLinkNewWindowEnabled

public boolean isLinkNewWindowEnabled()

setLinkNewWindowEnabled

public void setLinkNewWindowEnabled(boolean linkNewWindowEnabled)

getLinkSchemes

public java.lang.String getLinkSchemes()

setLinkSchemes

public void setLinkSchemes(java.lang.String linkSchemes)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.