Package com.independentsoft.office.odf

# Enum Class IndexScope

java.lang.Object
java.lang.Enum<IndexScope>
com.independentsoft.office.odf.IndexScope

All Implemented Interfaces:
  `Serializable`, `Comparable<IndexScope>`, `Constable`

public enum IndexScope extends Enum<IndexScope>
Specifies whether an index is constructed for an entire document or for a chapter.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `CHAPTER`
  The index is constructed for the entire document.
  `DOCUMENT`
  The index is constructed for the chapter that contains the index.
  `NONE`
  None.

- ## Method Summary

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

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### DOCUMENT

    public static final IndexScope DOCUMENT
    The index is constructed for the chapter that contains the index. A chapter consists of all those paragraphs and headings which have the same immediately preceding heading with outline level 1.

  - ### CHAPTER

    public static final IndexScope CHAPTER
    The index is constructed for the entire document.

  - ### NONE

    public static final IndexScope NONE
    None.

- ## Method Details

  - ### values

    public static IndexScope[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static IndexScope valueOf​(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null