org.axsl.common.value

Enum ChangeBarPlacement

java.lang.Object

java.lang.Enum<ChangeBarPlacement>

org.axsl.common.value.ChangeBarPlacement

All Implemented Interfaces:

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

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

An enumeration of the possible change-bar-placement values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALTERNATE When there are exactly two columns, the change bar will be offset from the start edge of all column one areas and the end edge of all column two areeas; when there are any other number of columns, this value is equivalent to "outside".
END The change bar will be offset from the end edge of all column areas.
INSIDE If the page binding edge is on the start-edge, the change bar will be offset from the start edge of all column areas.
LEFT The change bar will be offset from the left edge of all column areas.
OUTSIDE If the page binding edge is on the start-edge, the change bar will be offset from the end edge of all column areas.
RIGHT The change bar will be offset from the right edge of all column areas.
START The change bar will be offset from the start edge of all column areas.

Method Summary

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

START

public static final ChangeBarPlacement START

The change bar will be offset from the start edge of all column areas.

END

public static final ChangeBarPlacement END

The change bar will be offset from the end edge of all column areas.

LEFT

public static final ChangeBarPlacement LEFT

The change bar will be offset from the left edge of all column areas.

RIGHT

public static final ChangeBarPlacement RIGHT

The change bar will be offset from the right edge of all column areas.

INSIDE

public static final ChangeBarPlacement INSIDE

If the page binding edge is on the start-edge, the change bar will be offset from the start edge of all column areas. If the binding is the end-edge, the change bar will be offset from the end edge of all column areas. If the page binding edge is on neither the start-edge nor end-edge, the change bar will be offset from the start edge of all column areas.

OUTSIDE

public static final ChangeBarPlacement OUTSIDE

If the page binding edge is on the start-edge, the change bar will be offset from the end edge of all column areas. If the binding is the end-edge, the change bar will be offset from the start edge of all column areas. If the page binding edge is on neither the start-edge nor end-edge, the change bar will be offset from the end edge of all column areas.

ALTERNATE

public static final ChangeBarPlacement ALTERNATE

When there are exactly two columns, the change bar will be offset from the start edge of all column one areas and the end edge of all column two areeas; when there are any other number of columns, this value is equivalent to "outside".

Method Detail

values

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

Returns:

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

valueOf

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