com.scroogexhtml.rtf

Enum Destination

java.lang.Object

java.lang.Enum<Destination>

com.scroogexhtml.rtf.Destination

All Implemented Interfaces:

Serializable, Comparable<Destination>

public enum Destination
extends Enum<Destination>

This enum defines available RTF document destinations.

Author:

Michael

Enum Constant Summary

Enum Constants

Enum Constant and Description
DG_BKMKSTRT Bookmark start.
DG_BODY Document body.
DG_COLORTABLE Color table.
DG_FIELD Field.
DG_FLDINST Field expression.
DG_FLDRSLT Field result.
DG_FONTTABLE Font table.
DG_FOOTNOTE Footnote.
DG_IGNORE Unknown.
DG_LIST List.
DG_LISTLEVEL List level.
DG_LISTOVERRIDE List override.
DG_LISTTABLE List table.
DG_PARAGRAPH_NUMBERING \pn Turns on paragraph numbering.
DG_PICTURE Picture.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DG_IGNORE

public static final Destination DG_IGNORE

Unknown.

DG_BODY

public static final Destination DG_BODY

Document body.

DG_FONTTABLE

public static final Destination DG_FONTTABLE

Font table.

DG_LISTTABLE

public static final Destination DG_LISTTABLE

List table.

DG_LIST

public static final Destination DG_LIST

List.

DG_LISTOVERRIDE

public static final Destination DG_LISTOVERRIDE

List override.

DG_LISTLEVEL

public static final Destination DG_LISTLEVEL

List level.

DG_COLORTABLE

public static final Destination DG_COLORTABLE

Color table.

DG_PARAGRAPH_NUMBERING

public static final Destination DG_PARAGRAPH_NUMBERING

\pn Turns on paragraph numbering. This is a destination control word..

DG_PICTURE

public static final Destination DG_PICTURE

Picture.

DG_FLDINST

public static final Destination DG_FLDINST

Field expression.

DG_FLDRSLT

public static final Destination DG_FLDRSLT

Field result.

DG_BKMKSTRT

public static final Destination DG_BKMKSTRT

Bookmark start.

DG_FIELD

public static final Destination DG_FIELD

Field.

DG_FOOTNOTE

public static final Destination DG_FOOTNOTE

Footnote.

Method Detail

values

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

Returns:

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

valueOf

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