org.odftoolkit.simple.common.field

Enum ReferenceField.DisplayType

java.lang.Object

java.lang.Enum<ReferenceField.DisplayType>

org.odftoolkit.simple.common.field.ReferenceField.DisplayType

All Implemented Interfaces:

Serializable, Comparable<ReferenceField.DisplayType>

Enclosing class:

ReferenceField

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

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

• CHAPTER: displays the number of the chapter in which the referenced item appears.
• DIRECTION: displays whether the referenced item is above or below the reference field.
• PAGE: displays the number of the page on which the referenced item appears.
• TEXT: displays the text of the referenced item.

Since:

0.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHAPTER
DIRECTION
PAGE
TEXT

Method Summary

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

CHAPTER

public static final ReferenceField.DisplayType CHAPTER

DIRECTION

public static final ReferenceField.DisplayType DIRECTION

PAGE

public static final ReferenceField.DisplayType PAGE

TEXT

public static final ReferenceField.DisplayType TEXT

Method Detail

values

public static ReferenceField.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 (ReferenceField.DisplayType c : ReferenceField.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 ReferenceField.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<ReferenceField.DisplayType>