com.jivesoftware.community.renderer
Enum RenderTarget

java.lang.Object
  java.lang.Enum<RenderTarget>
      com.jivesoftware.community.renderer.RenderTarget

All Implemented Interfaces:

Serializable, Comparable<RenderTarget>

public enum RenderTarget
extends Enum<RenderTarget>

The target of a particular render operation.

See Also:

RenderStrategy

Enum Constant Summary

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

TARGET_NO_MARKUP
Use this render target for when no rendering is to be performed.

TARGET_PLAIN_MESSAGE
This target's rendered output will be suitable for sending in plain text emails or other similar messages.

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

TARGET_WYSIWYG_EDITOR
This target's output will be appropriate for display in the wysiwyg editor.

TARGET_XML
This target's output will have all wiki markup converted into xml and the final output coerced into xml if it isn't already.

Method Summary

String	appendExtension(String docName)
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
String	getValue() Gets the value of a RenderTarget object
String	toString()
static RenderTarget	valueOf(String name) Returns the enum constant of this type with the specified name.
static RenderTarget[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant 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_MESSAGE

public static final RenderTarget TARGET_PLAIN_MESSAGE

This target's rendered output will be suitable for sending in plain text emails or other similar messages.

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.

TARGET_XML

public static final RenderTarget TARGET_XML

This target's output will have all wiki markup converted into xml and the final output coerced into xml if it isn't already.

Method Detail

values

public static final RenderTarget[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(RenderTarget c : RenderTarget.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static RenderTarget valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

getKey

public long getKey()

Gets the key of a RenderTarget object

Returns:

the key value representing the RenderTarget object

getValue

public 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 String toString()

Overrides:

toString in class Enum<RenderTarget>

appendExtension

public String appendExtension(String docName)