net.sf.jett.model
Enum FontTypeOffset

java.lang.Object
  java.lang.Enum<FontTypeOffset>
      net.sf.jett.model.FontTypeOffset

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FontTypeOffset>

public enum FontTypeOffset
extends java.lang.Enum<FontTypeOffset>

FontTypeOffsets represent the built-in type offset names that correspond with Excel's type offset scheme. These are used in conjunction with the type offset property in the style tag. Legal values are the names of the enumeration objects, without underscores, case insensitive, e.g. "sub" == "Sub" == "SUB".

Since:

0.4.0

Author:

Randy Gettman

See Also:

StyleTag, StyleParser.PROPERTY_FONT_TYPE_OFFSET

Enum Constant Summary

NONE

SUB

SUPER

Method Summary

short	getIndex() Returns the index.
java.lang.String	toString() Returns the name, in all lowercase, no underscores or spaces.
static FontTypeOffset	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FontTypeOffset[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final FontTypeOffset NONE

SUB

public static final FontTypeOffset SUB

SUPER

public static final FontTypeOffset SUPER

Method Detail

values

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

Returns:

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

valueOf

public static FontTypeOffset valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getIndex

public short getIndex()

Returns the index.

Returns:

The index.

toString

public java.lang.String toString()

Returns the name, in all lowercase, no underscores or spaces.

Overrides:

toString in class java.lang.Enum<FontTypeOffset>

Returns:

The name, in all lowercase, no underscores or spaces.