com.luciad.view.lightspeed.editor.operation

LuciadLightspeedEnum ELspInteractionStatus

java.lang.Object

java.lang.Enum<ELspInteractionStatus>

com.luciad.view.lightspeed.editor.operation.ELspInteractionStatus

All Implemented Interfaces:

Serializable, Comparable<ELspInteractionStatus>

public enum ELspInteractionStatus
extends Enum<ELspInteractionStatus>

Indicates the state of the object being edited after an interaction performed through a handle.

Since:

2012.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED Indicates that this edit operation is an important key point.
IN_PROGRESS Indicates that this edit operation is transitional.

Method Summary

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

IN_PROGRESS

public static final ELspInteractionStatus IN_PROGRESS

Indicates that this edit operation is transitional. This means more edit operations are coming. A use case when this occurs is for instance the mouse button is being dragged. All mouse dragged events are marked as IN_PROGRESS. This makes writing undo behavior easier, as it is more evident to know which operations are transitional and which are final.

See Also:

FINISHED

FINISHED

public static final ELspInteractionStatus FINISHED

Indicates that this edit operation is an important key point. A use case when this occurs is for instance the mouse button was released. This signifies that, while further edit operations may exist, this edit operation was key, and can be used to, for instance, model a significant point for performing undo operations.

See Also:

IN_PROGRESS

Method Detail

values

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

Returns:

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

valueOf

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