|
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.EmoticonFilter
public class EmoticonFilter
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 |
---|
public EmoticonFilter()
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 java.lang.String applyFilter(java.lang.String string, RenderContext renderContext)
public java.lang.String getImageURL()
public void setImageURL(java.lang.String imageURL)
imageURL
- the base URL for emoticon images.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |