com.jivesoftware.community.renderer
Class BaseFilter

java.lang.Object
  com.jivesoftware.community.renderer.AbstractRenderFilter
      com.jivesoftware.community.renderer.BaseFilter

All Implemented Interfaces:

RenderFilter

Direct Known Subclasses:

BaseMacro

public abstract class BaseFilter
extends AbstractRenderFilter

A Base class to be used to create a filter. Subclasses of this macro can be configured by using annotions;

• Name : Used to change the name of the macro. If not used getClass().getShortName() is used.
• Description : A description of the macro. No description by default.
• EnableByDefault : Whether this macro is enabled or disabled by default. The default value is true.
• RenderTypes : RenderTypes this macro works for. Default is RenderType.BODY

See Also:

Name, Description, EnableByDefault, RenderType

Constructor Summary

BaseFilter()

Method Summary

protected static java.lang.String	applyFreemarkerTemplate(freemarker.template.Configuration config, java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String templateName) Processes the specified template file and returns a String containing the content of the template file.
protected java.lang.String[]	getDefaultHelp() Not currently used.
protected java.util.Map<java.lang.String,java.lang.String[]>	getDocumentationMap() Not currently used.
java.lang.String	getName() Returns the value of the Name annotation if defined otherwise the value of getClass().getSimpleName().
protected boolean	isEnabledByDefault() Returns the value of the EnableByDefault annotation if it is defined, else true.

Methods inherited from class com.jivesoftware.community.renderer.AbstractRenderFilter

execute, executeHtmlTarget, executeNoMarkupTarget, executePlainEmailTarget, executePlainTextTarget, executeWysiwygEditorTarget, executeXMLTarget, getUserDocumentation, isDisplayable, isEnabled, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseFilter

public BaseFilter()

Method Detail

getName

public java.lang.String getName()

Returns the value of the Name annotation if defined otherwise the value of getClass().getSimpleName().

Specified by:

getName in interface RenderFilter

Specified by:

getName in class AbstractRenderFilter

Returns:

The name of the macro.

isEnabledByDefault

protected boolean isEnabledByDefault()

Returns the value of the EnableByDefault annotation if it is defined, else true.

Specified by:

isEnabledByDefault in class AbstractRenderFilter

Returns:

Whether or not the plugin is enabled by default.

getDocumentationMap

protected java.util.Map<java.lang.String,java.lang.String[]> getDocumentationMap()

Not currently used.

Specified by:

getDocumentationMap in class AbstractRenderFilter

Returns:

Returns null.

getDefaultHelp

protected java.lang.String[] getDefaultHelp()

Not currently used.

Specified by:

getDefaultHelp in class AbstractRenderFilter

Returns:

Returns an open string array.

applyFreemarkerTemplate

protected static java.lang.String applyFreemarkerTemplate(freemarker.template.Configuration config,
                                                          java.util.Map<java.lang.String,java.lang.Object> properties,
                                                          java.lang.String templateName)

Processes the specified template file and returns a String containing the content of the template file.

Parameters:

config - the freemarker configuration

properties - used for the freemarker context

templateName - name of the template

Returns:

the content of the specified template file