org.axsl.common.value

Enum LeaderAlignment

java.lang.Object

java.lang.Enum<LeaderAlignment>

org.axsl.common.value.LeaderAlignment

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LeaderAlignment>

public enum LeaderAlignment
extends java.lang.Enum<LeaderAlignment>

Enumeration of the possible leader-alignment values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE The leader pattern has no special alignment.
PAGE The leader pattern is aligned as if it began on the current page's start-edge.
REFERENCE_AREA The leader pattern is aligned as if it began on the current reference area's content-rectangle start-edge.

Method Summary

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

NONE

public static final LeaderAlignment NONE

The leader pattern has no special alignment.

REFERENCE_AREA

public static final LeaderAlignment REFERENCE_AREA

The leader pattern is aligned as if it began on the current reference area's content-rectangle start-edge.

PAGE

public static final LeaderAlignment PAGE

The leader pattern is aligned as if it began on the current page's start-edge.

Method Detail

values

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

Returns:

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

valueOf

public static LeaderAlignment valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null