com.deltaxml.odf
Enum FontDecoration

java.lang.Object
  java.lang.Enum<FontDecoration>
      com.deltaxml.odf.FontDecoration

All Implemented Interfaces:

Serializable, Comparable<FontDecoration>

public enum FontDecoration
extends Enum<FontDecoration>

Enumeration representing the possible values to set as the font decoration for added and deleted text.

Enum Constant Summary

DOUBLE_STRIKETHROUGH
The value representing double strike-through (or line-through) text

DOUBLE_UNDERLINE
The value representing double-underlined text.

NONE
The value representing no font decoration.

STRIKETHROUGH
The value representing single strike-through (or line-through) text

UNDERLINE
The value representing single-underlined text.

Method Summary

static FontDecoration	getFontDecoration(String value) Returns a FontDecoration object from the supplied String value if appropriate.
String	toString() Returns a String representation of the FontDecoration.
static FontDecoration	valueOf(String name) Returns the enum constant of this type with the specified name.
static FontDecoration[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final FontDecoration NONE

The value representing no font decoration.

UNDERLINE

public static final FontDecoration UNDERLINE

The value representing single-underlined text.

DOUBLE_UNDERLINE

public static final FontDecoration DOUBLE_UNDERLINE

The value representing double-underlined text.

STRIKETHROUGH

public static final FontDecoration STRIKETHROUGH

The value representing single strike-through (or line-through) text

DOUBLE_STRIKETHROUGH

public static final FontDecoration DOUBLE_STRIKETHROUGH

The value representing double strike-through (or line-through) text

Method Detail

values

public static final FontDecoration[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(FontDecoration c : FontDecoration.values())
        System.out.println(c);

Returns:

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

valueOf

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

toString

public String toString()

Returns a String representation of the FontDecoration.

Overrides:

toString in class Enum<FontDecoration>

Returns:

a String representing the FontDecoration object

getFontDecoration

public static FontDecoration getFontDecoration(String value)

Returns a FontDecoration object from the supplied String value if appropriate.

This method should not normally be necessary. However, if you have a String representation of FontDecoration, it may be a useful utility method.

Parameters:

value - the String representation of the FontDecoration

Returns:

the FontDecoration instance corresponding to the parameter, or null if the value is invalid