com.tutego.jrtf

Enum RtfText.FieldModifier

java.lang.Object

java.lang.Enum<RtfText.FieldModifier>

com.tutego.jrtf.RtfText.FieldModifier

All Implemented Interfaces:

Serializable, Comparable<RtfText.FieldModifier>

Enclosing class:

RtfText

public static enum RtfText.FieldModifier
extends Enum<RtfText.FieldModifier>

Modifiers for fields.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIRTY A formatting change has been made to the field result since the field was last updated.
EDITED Text has been added to, or removed from, the field result since the field was last updated.
LOCKED Field is locked and cannot be updated.
NONDISPLAYABLE Result is not in a form suitable for display (for example, binary data used by fields whose result is a picture).

Method Summary

Methods

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

DIRTY

public static final RtfText.FieldModifier DIRTY

A formatting change has been made to the field result since the field was last updated.

EDITED

public static final RtfText.FieldModifier EDITED

Text has been added to, or removed from, the field result since the field was last updated.

LOCKED

public static final RtfText.FieldModifier LOCKED

Field is locked and cannot be updated.

NONDISPLAYABLE

public static final RtfText.FieldModifier NONDISPLAYABLE

Result is not in a form suitable for display (for example, binary data used by fields whose result is a picture).

Method Detail

values

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

Returns:

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

valueOf

public static RtfText.FieldModifier 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