Enum Class EditHandleState

java.lang.Object
java.lang.Enum<EditHandleState>
com.luciad.edit.handles.EditHandleState
All Implemented Interfaces:
Serializable, Comparable<EditHandleState>, Constable

public enum EditHandleState extends Enum<EditHandleState>
The possible states of an IEditHandle.

The state determines the order in which events are dispatched to a handle, and the order in which the mouse cursor is retrieved: Active > Highlighted > Inactive

Depending on their state, handles are usually visualized differently or have a different mouse cursor.

  • Enum Constant Details Link icon

    • Inactive Link icon

      public static final EditHandleState Inactive
      Inactive handles have the lowest priority when it comes to event handling.

      Both highlighted and active handles have a higher priority. They are also typically painted differently than highlighted or active handles, and they typically don't trigger the use of a non-standard mouse cursor.

    • Highlighted Link icon

      public static final EditHandleState Highlighted
      Highlighted handles are not interacted with, but signal that they are ready for interaction.

      Handles are typically highlighted when users hover over them using the mouse. As for handling events, active handles take precedence. Highlighted handles however take precedence over other handles, and get the chance to become active first.

      Highlighted handles can be painted differently to make it visually clear that they can be interacted with, or they can trigger the use of a different mouse cursor.

    • Active Link icon

      public static final EditHandleState Active
      Active handles are handles that users are currently interacting with.

      This is the case while a user drags a point handle, for example. Active handles get the chance to consume events before any other handle.

      Active handles can be painted differently to make it visually clear that they are being interacted with, or they can trigger the use of a different mouse cursor.

  • Method Details Link icon

    • values Link icon

      public static EditHandleState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf Link icon

      public static EditHandleState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null