Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## org.odftoolkit.odfdom.dom.type.text
Enum OdfBookmarkReferenceFormatType

    java.lang.Object
      java.lang.Enum<OdfBookmarkReferenceFormatType>
          org.odftoolkit.odfdom.dom.type.text.OdfBookmarkReferenceFormatType

All Implemented Interfaces:
  Serializable, Comparable<OdfBookmarkReferenceFormatType>

    public enum OdfBookmarkReferenceFormatType

extends Enum<OdfBookmarkReferenceFormatType>

DOM implementation of OpenDocument attribute text:reference-format.

Enum Constant Summary
`CHAPTER`
`DIRECTION`
`NUMBER`
`NUMBER_ALL_SUPERIOR`
`NUMBER_NO_SUPERIOR`
`PAGE`
`TEXT`

Method Summary
`static OdfBookmarkReferenceFormatType` | `enumValueOf(String stringValue)` String to enum, turns a String into its corresponding enum constant
`String` | `toString()` gets the name of this enum.
`static String` | `toString(OdfBookmarkReferenceFormatType enumeration)` enum to String, gets the name of this enum constant as a string.
`static OdfBookmarkReferenceFormatType` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OdfBookmarkReferenceFormatType[]` | `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

### NUMBER

    public static final OdfBookmarkReferenceFormatType NUMBER

### NUMBER_NO_SUPERIOR

    public static final OdfBookmarkReferenceFormatType NUMBER_NO_SUPERIOR

### DIRECTION

    public static final OdfBookmarkReferenceFormatType DIRECTION

### NUMBER_ALL_SUPERIOR

    public static final OdfBookmarkReferenceFormatType NUMBER_ALL_SUPERIOR

### PAGE

    public static final OdfBookmarkReferenceFormatType PAGE

### TEXT

    public static final OdfBookmarkReferenceFormatType TEXT

### CHAPTER

    public static final OdfBookmarkReferenceFormatType CHAPTER

Method Detail

### values

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

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

### valueOf

    public static OdfBookmarkReferenceFormatType 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()

  gets the name of this enum.

  Overrides:
    `toString` in class `Enum<OdfBookmarkReferenceFormatType>`
  Returns:
    return the name of OdfBookmarkReferenceFormatType

### toString

    public static String toString(OdfBookmarkReferenceFormatType enumeration)

  enum to String, gets the name of this enum constant as a string.

  Parameters:
    `enumeration` - the constant of OdfBookmarkReferenceFormatType, see text:reference-format
  Returns:
    return the name of OdfBookmarkReferenceFormatType

### enumValueOf

    public static OdfBookmarkReferenceFormatType enumValueOf(String stringValue)

  String to enum, turns a String into its corresponding enum constant

  Parameters:
    `stringValue` - the name of OdfBookmarkReferenceFormatType
  Returns:
    return the constant of OdfBookmarkReferenceFormatType, see text:reference-format

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

Copyright © 2009. All Rights Reserved.