Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer
Class RenderTarget

java.lang.Object
  extended by com.jivesoftware.forum.renderer.RenderTarget

public class RenderTarget
extends java.lang.Object

The target of a particular render operation.

See Also:
RenderStrategy

Field Summary
static RenderTarget[] RENDER_TARGETS
          An array containing all possible types of targets
static RenderTarget TARGET_HTML
          This target's output will have all wiki markup converted into html for display.
static RenderTarget TARGET_NO_MARKUP
          Use this render target for when no rendering is to be performed.
static RenderTarget TARGET_PLAIN_EMAIL
          This target's rendered output will be suitable for sending in plain text emails.
static RenderTarget TARGET_PLAIN_TEXT
          This target's output will contain wiki markup suitable for the plain text editor.
static RenderTarget TARGET_WYSIWYG_EDITOR
          This target's output will be appropriate for display in the wysiwyg editor.
 
Method Summary
 long getKey()
          Gets the key of a RenderTarget object
static RenderTarget getRenderTarget(int key)
          A helper method to get a specific RenderTarget object from its key
 java.lang.String getValue()
          Gets the value of a RenderTarget object
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TARGET_PLAIN_TEXT

public static final RenderTarget TARGET_PLAIN_TEXT
This target's output will contain wiki markup suitable for the plain text editor.


TARGET_PLAIN_EMAIL

public static final RenderTarget TARGET_PLAIN_EMAIL
This target's rendered output will be suitable for sending in plain text emails.


TARGET_HTML

public static final RenderTarget TARGET_HTML
This target's output will have all wiki markup converted into html for display.


TARGET_WYSIWYG_EDITOR

public static final RenderTarget TARGET_WYSIWYG_EDITOR
This target's output will be appropriate for display in the wysiwyg editor. Filters and macros are required to be able to 'undo' their conversions if they are to output html, otherwise they should not display html and instead leave the wiki markup intact.


TARGET_NO_MARKUP

public static final RenderTarget TARGET_NO_MARKUP
Use this render target for when no rendering is to be performed. When this target is used all html and wiki markup is to be removed.


RENDER_TARGETS

public static final RenderTarget[] RENDER_TARGETS
An array containing all possible types of targets

Method Detail

getKey

public long getKey()
Gets the key of a RenderTarget object

Returns:
the key value representing the RenderTarget object

getValue

public java.lang.String getValue()
Gets the value of a RenderTarget object

Returns:
the String value representing the RenderTarget object

getRenderTarget

public static RenderTarget getRenderTarget(int key)
A helper method to get a specific RenderTarget object from its key

Parameters:
key - the key value of the RenderTarget object
Returns:
the RenderTarget object corresponding to the key value. NULL if the key is invalid.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.