Package org.mapfish.print.processor.map.scalebar

Enum Class Orientation

java.lang.Object

java.lang.Enum<Orientation>

org.mapfish.print.processor.map.scalebar.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>, Constable

public enum Orientation
extends Enum<Orientation>

Specify a orientation for the labels and the bar.

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
HORIZONTAL_LABELS_ABOVE	Horizontal scalebar and the labels are shown above the bar.
HORIZONTAL_LABELS_BELOW	Horizontal scalebar and the labels are shown below the bar.
VERTICAL_LABELS_LEFT	Vertical scalebar and the labels are shown left of the bar.
VERTICAL_LABELS_RIGHT	Vertical scalebar and the labels are shown right of the bar.

Method Summary

Modifier and Type	Method	Description
static Orientation	fromString(String label)	Get a direction from its label.
final String	getLabel()
final boolean	isHorizontal()
static Orientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Orientation[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HORIZONTAL_LABELS_BELOW

public static final Orientation HORIZONTAL_LABELS_BELOW

Horizontal scalebar and the labels are shown below the bar.

HORIZONTAL_LABELS_ABOVE

public static final Orientation HORIZONTAL_LABELS_ABOVE

Horizontal scalebar and the labels are shown above the bar.

VERTICAL_LABELS_LEFT

public static final Orientation VERTICAL_LABELS_LEFT

Vertical scalebar and the labels are shown left of the bar.

VERTICAL_LABELS_RIGHT

public static final Orientation VERTICAL_LABELS_RIGHT

Vertical scalebar and the labels are shown right of the bar.

Method Details

values

public static Orientation[] 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 Orientation 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

fromString

public static Orientation fromString(String label)

Get a direction from its label.

Parameters:

label - the direction label

isHorizontal

public final boolean isHorizontal()

getLabel

public final String getLabel()