Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.macro
Class UserMacro

java.lang.Object
  extended by com.jivesoftware.forum.renderer.AbstractRenderFilter
      extended by com.jivesoftware.forum.renderer.macro.UserMacro
All Implemented Interfaces:
com.jivesoftware.forum.renderer.impl.JiveSystemRenderFilter, RenderFilter, RenderMacro

public class UserMacro
extends AbstractRenderFilter
implements RenderMacro, com.jivesoftware.forum.renderer.impl.JiveSystemRenderFilter

A macro to convert {user:id=123} into a profile link


Field Summary
static java.lang.String TAG_NAME
           
 
Constructor Summary
UserMacro()
           
 
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 getEndTag()
           
 java.lang.String getMacroTagName()
          Returns the tag name of the macro.
 java.lang.String getMidTag()
           
 java.lang.String getName()
          Returns the unique name of the filter.
 java.util.Map getParameters()
          Returns a Map of user provided parameters to the macro.
 java.lang.String getStartTag()
           
protected  boolean isEnabledByDefault()
          Returns true if the filter should be enabled by default, false otherwise.
 boolean isSingleTagMacro()
          Returns true is the macro has only a single tag such as {testMacro}, false if the macro should have both an opening and closing tag ({testMacro}text here{testMacro})
 void setEndTag(java.lang.String endTag)
           
 void setMidTag(java.lang.String midTag)
           
 void setParameters(java.util.Map parameters)
          Sets a map of user provided parameters for the macro to use.
 void setStartTag(java.lang.String startTag)
           
 
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
 
Methods inherited from interface com.jivesoftware.forum.renderer.RenderMacro
execute
 
Methods inherited from interface com.jivesoftware.forum.renderer.RenderFilter
getUserDocumentation, isEnabled, setEnabled
 

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME
See Also:
Constant Field Values
Constructor Detail

UserMacro

public UserMacro()
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.

getMacroTagName

public java.lang.String getMacroTagName()
Description copied from interface: RenderMacro
Returns the tag name of the macro. The tag name will be used to map between macro tag names and the macro to execute. For example, if the macro tag name is testMacro the processing engine will know to associate any {testMacro} tag with the macro.

Specified by:
getMacroTagName in interface RenderMacro
Returns:
the macro tag name.

isSingleTagMacro

public boolean isSingleTagMacro()
Description copied from interface: RenderMacro
Returns true is the macro has only a single tag such as {testMacro}, false if the macro should have both an opening and closing tag ({testMacro}text here{testMacro})

Specified by:
isSingleTagMacro in interface RenderMacro
Returns:
true is the macro has only a single tag, false if the macro should have both an opening and closing tag

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

getParameters

public java.util.Map getParameters()
Description copied from interface: RenderMacro
Returns a Map of user provided parameters to the macro.

Specified by:
getParameters in interface RenderMacro
Returns:
a Map of user provided parameters to the macro

setParameters

public void setParameters(java.util.Map parameters)
Description copied from interface: RenderMacro
Sets a map of user provided parameters for the macro to use.

Specified by:
setParameters in interface RenderMacro
Parameters:
parameters - a map of user provided parameters

getStartTag

public java.lang.String getStartTag()

setStartTag

public void setStartTag(java.lang.String startTag)

getMidTag

public java.lang.String getMidTag()

setMidTag

public void setMidTag(java.lang.String midTag)

getEndTag

public java.lang.String getEndTag()

setEndTag

public void setEndTag(java.lang.String endTag)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.