com.xpn.xwiki.objects.classes

Enum TextAreaClass.EditorType

java.lang.Object

java.lang.Enum<TextAreaClass.EditorType>

com.xpn.xwiki.objects.classes.TextAreaClass.EditorType

All Implemented Interfaces:

Serializable, Comparable<TextAreaClass.EditorType>

Enclosing class:

TextAreaClass

public static enum TextAreaClass.EditorType
extends Enum<TextAreaClass.EditorType>

Possible values for the editor meta property.

Indicates which editor should be used to manipulate the content of the property.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PURE_TEXT Plain text without any known syntax.
TEXT Edit wiki syntax using a text editor.
WYSIWYG Edit wiki syntax using a visual editor.

Method Summary

Modifier and Type	Method and Description
static TextAreaClass.EditorType	getByValue(String value) Retreive the TextAreaClass.EditorType based on its value.
String	toString()
static TextAreaClass.EditorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TextAreaClass.EditorType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PURE_TEXT

public static final TextAreaClass.EditorType PURE_TEXT

Plain text without any known syntax.

TEXT

public static final TextAreaClass.EditorType TEXT

Edit wiki syntax using a text editor.

WYSIWYG

public static final TextAreaClass.EditorType WYSIWYG

Edit wiki syntax using a visual editor.

Method Detail

values

public static TextAreaClass.EditorType[] 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 (TextAreaClass.EditorType c : TextAreaClass.EditorType.values())
    System.out.println(c);

Returns:

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

valueOf

public static TextAreaClass.EditorType 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

getByValue

public static TextAreaClass.EditorType getByValue(String value)

Retreive the TextAreaClass.EditorType based on its value.

The search is case insensitive.

Parameters:

value - the value of the editor type

Returns:

the editor type matching the value or null

Since:

10.7RC1

toString

public String toString()

Overrides:

toString in class Enum<TextAreaClass.EditorType>