org.odftoolkit.simple.common.field

Enum ChapterField.DisplayType

java.lang.Object

java.lang.Enum<ChapterField.DisplayType>

org.odftoolkit.simple.common.field.ChapterField.DisplayType

All Implemented Interfaces:

Serializable, Comparable<ChapterField.DisplayType>

Enclosing class:

ChapterField

public static enum ChapterField.DisplayType
extends Enum<ChapterField.DisplayType>

A DisplayType specifies the information that a chapter field should display.

Since:

0.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
NAME
NUMBER
NUMBER_AND_NAME
PLAIN_NUMBER
PLAIN_NUMBER_AND_NAME

Method Summary

Modifier and Type	Method and Description
String	toString()
static ChapterField.DisplayType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChapterField.DisplayType[]	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

NAME

public static final ChapterField.DisplayType NAME

NUMBER

public static final ChapterField.DisplayType NUMBER

NUMBER_AND_NAME

public static final ChapterField.DisplayType NUMBER_AND_NAME

PLAIN_NUMBER

public static final ChapterField.DisplayType PLAIN_NUMBER

PLAIN_NUMBER_AND_NAME

public static final ChapterField.DisplayType PLAIN_NUMBER_AND_NAME

Method Detail

values

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

Returns:

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

valueOf

public static ChapterField.DisplayType 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

toString

public String toString()

Overrides:

toString in class Enum<ChapterField.DisplayType>