org.mapfish.print.processor.map.scalebar

Enum Orientation

java.lang.Object

java.lang.Enum<Orientation>

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

All Implemented Interfaces:

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

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

Specify a orientation for the labels and the bar.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static Orientation	fromString(java.lang.String label) Get a direction from its label.
java.lang.String	getLabel()
boolean	isHorizontal()
static Orientation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Orientation[]	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

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 Detail

values

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

Returns:

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

valueOf

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

fromString

public static Orientation fromString(java.lang.String label)

Get a direction from its label.

Parameters:

label - the direction label

isHorizontal

public final boolean isHorizontal()

getLabel

public final java.lang.String getLabel()