Package com.teamten.typeset.element

Enum Class SectionBookmark.Type

java.lang.Object

java.lang.Enum<SectionBookmark.Type>

com.teamten.typeset.element.SectionBookmark.Type

All Implemented Interfaces:

Serializable, Comparable<SectionBookmark.Type>, Constable

Enclosing class:

SectionBookmark

public static enum SectionBookmark.Type
extends Enum<SectionBookmark.Type>

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
COPYRIGHT_PAGE
HALF_TITLE_PAGE
INDEX
MINOR_SECTION
PART
TABLE_OF_CONTENTS
TITLE_PAGE

Method Summary

Modifier and Type	Method	Description
boolean	isIncludedInTableOfContents()	Whether this section should be included in the table of contents.
String	toString()
static SectionBookmark.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SectionBookmark.Type[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PART

public static final SectionBookmark.Type PART

CHAPTER

public static final SectionBookmark.Type CHAPTER

MINOR_SECTION

public static final SectionBookmark.Type MINOR_SECTION

HALF_TITLE_PAGE

public static final SectionBookmark.Type HALF_TITLE_PAGE

TITLE_PAGE

public static final SectionBookmark.Type TITLE_PAGE

COPYRIGHT_PAGE

public static final SectionBookmark.Type COPYRIGHT_PAGE

TABLE_OF_CONTENTS

public static final SectionBookmark.Type TABLE_OF_CONTENTS

INDEX

public static final SectionBookmark.Type INDEX

Method Details

values

public static SectionBookmark.Type[] 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 SectionBookmark.Type 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

isIncludedInTableOfContents

public boolean isIncludedInTableOfContents()

Whether this section should be included in the table of contents.

toString

public String toString()

Overrides:

toString in class Enum<SectionBookmark.Type>