Package org.daisy.dotify.api.formatter

Enum PageAreaProperties.Alignment

java.lang.Object

java.lang.Enum<PageAreaProperties.Alignment>

org.daisy.dotify.api.formatter.PageAreaProperties.Alignment

All Implemented Interfaces:

Serializable, Comparable<PageAreaProperties.Alignment>

Enclosing class:

PageAreaProperties

public static enum PageAreaProperties.Alignment
extends Enum<PageAreaProperties.Alignment>

Specifies the alignment of the page area.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	Aligns toward the bottom of the page, above the footer
TOP	Aligns toward the top of the page, below the header

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOP

public static final PageAreaProperties.Alignment TOP

Aligns toward the top of the page, below the header

BOTTOM

public static final PageAreaProperties.Alignment BOTTOM

Aligns toward the bottom of the page, above the footer

Method Detail

values

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

Returns:

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

valueOf

public static PageAreaProperties.Alignment 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