Package dev.prozilla.pine.core.state.input

Enum Class CursorMode

java.lang.Object
java.lang.Enum<CursorMode>
dev.prozilla.pine.core.state.input.CursorMode
All Implemented Interfaces:
IntEnum, Serializable, Comparable<CursorMode>, Constable
public enum CursorMode extends Enum<CursorMode> implements IntEnum

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CAPTURED
    Makes the cursor visible and confined to the content area of the window.
    DISABLED
    Makes the cursor invisible and locks its position, but still provides virtual cursor movement.
    HIDDEN
    Makes the cursor invisible when it is hovering over the content area of the window.
    NORMAL
    Makes the cursor visible and makes the cursor behave normally.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getValue()
    Returns the integer value of this instance.
    static boolean
    isValid(int value)
    Checks if a given value is a valid value for a cursor type.
    static CursorMode
    parse(int value)
    Parses a given value to a cursor type
    static CursorMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CursorMode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NORMAL

      public static final CursorMode NORMAL
      Makes the cursor visible and makes the cursor behave normally.

    • HIDDEN

      public static final CursorMode HIDDEN
      Makes the cursor invisible when it is hovering over the content area of the window.

    • DISABLED

      public static final CursorMode DISABLED
      Makes the cursor invisible and locks its position, but still provides virtual cursor movement.

    • CAPTURED

      public static final CursorMode CAPTURED
      Makes the cursor visible and confined to the content area of the window.

  • Method Details

    • values

      public static CursorMode[] 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

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

    • getValue

      public int getValue()
      Description copied from interface: IntEnum
      Returns the integer value of this instance.
      Specified by:
      getValue in interface IntEnum
      Returns:
      The integer value.

    • isValid

      public static boolean isValid(int value)
      Checks if a given value is a valid value for a cursor type.
      Parameters:
      value - Value to test
      Returns:
      True if the value is a valid value

    • parse

      public static CursorMode parse(int value)
      Parses a given value to a cursor type
      Parameters:
      value - Value
      Returns:
      Cursor mode