com.luciad.view.gxy.labeling.algorithm.discrete

LuciadLightspeedEnum TLcdGXYOnPathLabelingAlgorithm.AlignmentMode

java.lang.Object

java.lang.Enum<TLcdGXYOnPathLabelingAlgorithm.AlignmentMode>

com.luciad.view.gxy.labeling.algorithm.discrete.TLcdGXYOnPathLabelingAlgorithm.AlignmentMode

All Implemented Interfaces:

Serializable, Comparable<TLcdGXYOnPathLabelingAlgorithm.AlignmentMode>

Enclosing class:

TLcdGXYOnPathLabelingAlgorithm

public static enum TLcdGXYOnPathLabelingAlgorithm.AlignmentMode
extends Enum<TLcdGXYOnPathLabelingAlgorithm.AlignmentMode>

Alignment mode that determines if label are placed on, outside or inside the paths.

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.
INSIDE Alignment mode, indicating that the label is shifted to a location inside the path.
LEFT Alignment mode, indicating that the label is shifted to the left, when the path is followed from start to end.
OUTSIDE Alignment mode, indicating that the label is placed outside the path.
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 TLcdGXYOnPathLabelingAlgorithm.AlignmentMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static TLcdGXYOnPathLabelingAlgorithm.AlignmentMode[]	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 TLcdGXYOnPathLabelingAlgorithm.AlignmentMode CENTER

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

OUTSIDE

public static final TLcdGXYOnPathLabelingAlgorithm.AlignmentMode OUTSIDE

Alignment mode, indicating that the label is placed outside the path. When a path is a polyline instead of a polygon, the polyline is interpreted as a polygon to check if a label is placed outside the path. This is done by connecting the endpoints of the polyline.

INSIDE

public static final TLcdGXYOnPathLabelingAlgorithm.AlignmentMode INSIDE

Alignment mode, indicating that the label is shifted to a location inside the path. When a path is a polyline instead of a polygon, the polyline is interpreted as a polygon to check if a label is placed inside the path. This is done by connecting the endpoints of the polyline.

LEFT

public static final TLcdGXYOnPathLabelingAlgorithm.AlignmentMode LEFT

Alignment mode, indicating that the label is shifted to the left, when the path is followed from start to end.

RIGHT

public static final TLcdGXYOnPathLabelingAlgorithm.AlignmentMode RIGHT

Alignment mode, indicating that the label is shifted to the right, when the path is followed from start to end.

ABOVE

public static final TLcdGXYOnPathLabelingAlgorithm.AlignmentMode ABOVE

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

BELOW

public static final TLcdGXYOnPathLabelingAlgorithm.AlignmentMode BELOW

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

Method Detail

values

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

Returns:

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

valueOf

public static TLcdGXYOnPathLabelingAlgorithm.AlignmentMode 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