Package org.odftoolkit.odfdom.changes

Enum PageArea

java.lang.Object

java.lang.Enum<PageArea>

org.odftoolkit.odfdom.changes.PageArea

All Implemented Interfaces:

Serializable, Comparable<PageArea>, java.lang.constant.Constable

public enum PageArea
extends Enum<PageArea>

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
BODY
FOOTER_DEFAULT
FOOTER_EVEN
FOOTER_FIRST
HEADER_DEFAULT	The parser is always in one of the three areas header, footer and body
HEADER_EVEN
HEADER_FIRST

Method Summary

Modifier and Type	Method	Description
String	getLocalName()
String	getPageAreaName()
static PageArea	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PageArea[]	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, 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

HEADER_DEFAULT

public static final PageArea HEADER_DEFAULT

The parser is always in one of the three areas header, footer and body

HEADER_FIRST

public static final PageArea HEADER_FIRST

HEADER_EVEN

public static final PageArea HEADER_EVEN

BODY

public static final PageArea BODY

FOOTER_DEFAULT

public static final PageArea FOOTER_DEFAULT

FOOTER_FIRST

public static final PageArea FOOTER_FIRST

FOOTER_EVEN

public static final PageArea FOOTER_EVEN

Method Details

values

public static PageArea[] values()

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

Returns:

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

valueOf

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

getPageAreaName

public String getPageAreaName()

getLocalName

public String getLocalName()

Returns:

the local name of the XML element