com.jivesoftware.forum.renderer.filter
Class EmoticonFilter

java.lang.Object
  com.jivesoftware.forum.renderer.AbstractRenderFilter
      com.jivesoftware.forum.renderer.filter.EmoticonFilter

All Implemented Interfaces:

com.jivesoftware.forum.renderer.impl.JiveSystemRenderFilter, RenderFilter

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

A Filter that converts ASCII emoticons into image equivalents.

The filter must be configured with information about where the image files are located. A table containing all the supported emoticons with their ASCII representations and image file names is as follows:

Emotion	ASCII	Image
Happy	:) or :-)	happy.gif
Sad	:( or :-(	sad.gif
Grin	:D	grin.gif
Love	:x	love.gif
Mischief	;\	mischief.gif
Cool	B-)	cool.gif
Devil	]:)	devil.gif
Silly	:p	silly.gif
Angry	X-(	angry.gif
Laugh	:^0	laugh.gif
Wink	;) or ;-)	wink.gif
Blush	:8}	blush.gif
Cry	:_|	cry.gif
Confused	?:|	confused.gif
Shocked	:0	shocked.gif
Plain	:|	plain.gif

Note: special thanks to August Harrison for implementing an earlier version of this filter.

Constructor Summary

EmoticonFilter()

Method Summary

java.lang.String	applyFilter(java.lang.String string, RenderContext renderContext)
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	getImageURL() Returns the base URL for emoticon images.
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.
void	setImageURL(java.lang.String imageURL) Sets the base URL for emoticon images.

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

EmoticonFilter

public EmoticonFilter()

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

applyFilter

public java.lang.String applyFilter(java.lang.String string,
                                    RenderContext renderContext)

getImageURL

public java.lang.String getImageURL()

Returns the base URL for emoticon images. This can be specified as an absolute or relative path.

Returns:

the base URL for smiley images.

setImageURL

public void setImageURL(java.lang.String imageURL)

Sets the base URL for emoticon images. This can be specified as an absolute or relative path.

Parameters:

imageURL - the base URL for emoticon images.