com.luciad.view.labeling.algorithm.discrete

LuciadLightspeedEnum ILcdLabelPlacementEvaluator.PlacementResult

java.lang.Object

java.lang.Enum<ILcdLabelPlacementEvaluator.PlacementResult>

com.luciad.view.labeling.algorithm.discrete.ILcdLabelPlacementEvaluator.PlacementResult

All Implemented Interfaces:

Serializable, Comparable<ILcdLabelPlacementEvaluator.PlacementResult>

Enclosing interface:

ILcdLabelPlacementEvaluator

public static enum ILcdLabelPlacementEvaluator.PlacementResult
extends Enum<ILcdLabelPlacementEvaluator.PlacementResult>

Placement result for a label. This value can denote if a label is a valid placement or not, and if one should try to evaluate other label placements or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED This placement result denotes that a placement is not a valid placement, and that no other label placement will be a valid placement.
FALLBACK This placement result denotes that a placement is a valid placement, but a better placement is preferred.
SUCCESS This placement result denotes that a placement is a valid placement, and can be used as placement for a label.
TRY_NEW_PLACEMENT This placement result denotes that a placement is not a valid placement, and should not be used as placement for a label.

Method Summary

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

SUCCESS

public static final ILcdLabelPlacementEvaluator.PlacementResult SUCCESS

This placement result denotes that a placement is a valid placement, and can be used as placement for a label. When this result is returned, no other label placements should be tried as this is a valid one.

FALLBACK

public static final ILcdLabelPlacementEvaluator.PlacementResult FALLBACK

This placement result denotes that a placement is a valid placement, but a better placement is preferred. When this result is returned, other placements should be tried in order to find a better placement. When no better placement can be found, the fallback placement can be used as placement for a label.

TRY_NEW_PLACEMENT

public static final ILcdLabelPlacementEvaluator.PlacementResult TRY_NEW_PLACEMENT

This placement result denotes that a placement is not a valid placement, and should not be used as placement for a label. When this result is returned, other placements should be tried in order to find a better placement. When no better placement can be found (and there is no fallback placement), no placement should be used for the label.

FAILED

public static final ILcdLabelPlacementEvaluator.PlacementResult FAILED

This placement result denotes that a placement is not a valid placement, and that no other label placement will be a valid placement. When this result is returned, no other placements should be tried in order to find a better placement. No placement should be used for the label.

Method Detail

values

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

Returns:

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

valueOf

public static ILcdLabelPlacementEvaluator.PlacementResult 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