com.atlassian.renderer.v2.macro

Enum WysiwygBodyType

java.lang.Object

java.lang.Enum<WysiwygBodyType>

com.atlassian.renderer.v2.macro.WysiwygBodyType

All Implemented Interfaces:

Serializable, Comparable<WysiwygBodyType>

public enum WysiwygBodyType
extends Enum<WysiwygBodyType>

There are two ways that a Macro Body can be rendered for a Wysiwyg editor. The default way is to interpret the body as wiki markup and render it to Xhtml like it would any other wiki markup. The other is to interpret it as plain text and escape it displays exactly as-is. Such text is wrapped in a preformat block to preserve newlines and multiple spaces.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PREFORMAT Body is not wiki markup and should only have html characters escaped.
WIKI_MARKUP Body is wiki markup and should be rendered to html.

Method Summary

Modifier and Type	Method and Description
static WysiwygBodyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WysiwygBodyType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WIKI_MARKUP

public static final WysiwygBodyType WIKI_MARKUP

Body is wiki markup and should be rendered to html.

PREFORMAT

public static final WysiwygBodyType PREFORMAT

Body is not wiki markup and should only have html characters escaped.

Method Detail

values

public static WysiwygBodyType[] values()

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

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

Returns:

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

valueOf

public static WysiwygBodyType 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

NullPointerException - if the argument is null