org.xwiki.rendering.listener
Enum Format

java.lang.Object
  java.lang.Enum<Format>
      org.xwiki.rendering.listener.Format

All Implemented Interfaces:

Serializable, Comparable<Format>

public enum Format
extends Enum<Format>

Represents a text formatting (bold, italic, etc).

Since:

1.6M1

Version:

$Id: e3494ede83d2538f24b833584f9c7ed7107ea8dd $

Enum Constant Summary

BOLD
Bold style.

ITALIC
Italic style.

MONOSPACE
Monospace style.

NONE
No style.

STRIKEDOUT
Strikedout style.

SUBSCRIPT
Subscript style.

SUPERSCRIPT
Superscript style.

UNDERLINED
Underlined style.

Method Summary

static Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static Format[]	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

BOLD

public static final Format BOLD

Bold style.

ITALIC

public static final Format ITALIC

Italic style.

UNDERLINED

public static final Format UNDERLINED

Underlined style.

STRIKEDOUT

public static final Format STRIKEDOUT

Strikedout style.

SUPERSCRIPT

public static final Format SUPERSCRIPT

Superscript style.

SUBSCRIPT

public static final Format SUBSCRIPT

Subscript style.

MONOSPACE

public static final Format MONOSPACE

Monospace style.

NONE

public static final Format NONE

No style.

Method Detail

values

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

Returns:

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

valueOf

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