com.luciad.view.lightspeed.label.algorithm

LuciadLightspeedEnum TLspFixedOnPathLabelLocationProvider.VerticalAlignment

java.lang.Object

java.lang.Enum<TLspFixedOnPathLabelLocationProvider.VerticalAlignment>

com.luciad.view.lightspeed.label.algorithm.TLspFixedOnPathLabelLocationProvider.VerticalAlignment

All Implemented Interfaces:

Serializable, Comparable<TLspFixedOnPathLabelLocationProvider.VerticalAlignment>

Enclosing class:

TLspFixedOnPathLabelLocationProvider

public static enum TLspFixedOnPathLabelLocationProvider.VerticalAlignment
extends Enum<TLspFixedOnPathLabelLocationProvider.VerticalAlignment>

Represents the vertical alignment, i.e. the offset of the label perpendicular to the line.

Since:

2016.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE Alignment mode, indicating that the label is shifted to a direction so that is positioned above the path.
BELOW Alignment mode, indicating that the label is shifted to a direction so that is positioned below the path.
CENTER Alignment mode, indicating that the label is placed on the path.
LEFT Alignment mode, indicating that the label is shifted to the left, when the path is followed from start to end.
RIGHT Alignment mode, indicating that the label is shifted to the right, when the path is followed from start to end.

Method Summary

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

CENTER

public static final TLspFixedOnPathLabelLocationProvider.VerticalAlignment CENTER

Alignment mode, indicating that the label is placed on the path.

LEFT

public static final TLspFixedOnPathLabelLocationProvider.VerticalAlignment LEFT

Alignment mode, indicating that the label is shifted to the left, when the path is followed from start to end. Say for example that we have a square-like polygon whose points are defined in a clockwise direction. In that case we can always position the label outside the path by using the LEFT vertical alignment.

RIGHT

public static final TLspFixedOnPathLabelLocationProvider.VerticalAlignment RIGHT

Alignment mode, indicating that the label is shifted to the right, when the path is followed from start to end. Say for example that we have a square-like polygon whose points are defined in a clockwise direction. In that case we can always position the label inside the path by using the RIGHT vertical alignment.

ABOVE

public static final TLspFixedOnPathLabelLocationProvider.VerticalAlignment ABOVE

Alignment mode, indicating that the label is shifted to a direction so that is positioned above the path.

BELOW

public static final TLspFixedOnPathLabelLocationProvider.VerticalAlignment BELOW

Alignment mode, indicating that the label is shifted to a direction so that is positioned below the path.

Method Detail

values

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

Returns:

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

valueOf

public static TLspFixedOnPathLabelLocationProvider.VerticalAlignment 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