Enum Class CursorType

java.lang.Object
java.lang.Enum<CursorType>
com.thecsdev.commonmc.api.client.gui.util.CursorType
All Implemented Interfaces:
Serializable, Comparable<CursorType>, Constable
@Environment(CLIENT) public enum CursorType extends Enum<CursorType>
An enumeration representing different types of mouse cursors that can be used in the graphical user interface (GUI).
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ARROW
    Standard arrow.
    CROSSHAIR
    Crosshair.
    DEFAULT
    Default cursor icon.
    IBEAM
    Vertical line with serifs.
    Indicates an editable text field.
    NOT_ALLOWED
    Slashed circle (circle with a diagonal line ⊘).
    Indicating an action cannot be performed, like clicking or during drag-and-drop operations.
    POINTING_HAND
    Hand Pointer with index finger pointing up.
    Indicating a clickable link or interactive UI element.
    RESIZE_ALL
    Four-way arrow (↔ with ↕ overlaid).
    For moving an element or resizing in any direction.
    RESIZE_EW
    Vertical double arrow (↕).
    For resizing a window or element vertically.
    RESIZE_NS
    Horizontal double arrow (↔).
    For resizing a window or element horizontally.

  • Method Summary

    Modifier and Type
    Method
    Description
    final com.mojang.blaze3d.platform.cursor.CursorType
    getNative()
    Returns the game's corresponding CursorType intance that is represented by this CursorType.
    static CursorType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CursorType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DEFAULT

      public static final CursorType DEFAULT
      Default cursor icon. Same as ARROW.

    • ARROW

      public static final CursorType ARROW
      Standard arrow. Default pointer.
      General navigation, for non-interactive elements.

    • IBEAM

      public static final CursorType IBEAM
      Vertical line with serifs.
      Indicates an editable text field. For text selection and insertion.

    • CROSSHAIR

      public static final CursorType CROSSHAIR
      Crosshair. Thin plus-shaped icon.
      For precise selection, drawing, or targeting.

    • POINTING_HAND

      public static final CursorType POINTING_HAND
      Hand Pointer with index finger pointing up.
      Indicating a clickable link or interactive UI element.

    • RESIZE_NS

      public static final CursorType RESIZE_NS
      Horizontal double arrow (↔).
      For resizing a window or element horizontally.

    • RESIZE_EW

      public static final CursorType RESIZE_EW
      Vertical double arrow (↕).
      For resizing a window or element vertically.

    • RESIZE_ALL

      public static final CursorType RESIZE_ALL
      Four-way arrow (↔ with ↕ overlaid).
      For moving an element or resizing in any direction.

    • NOT_ALLOWED

      public static final CursorType NOT_ALLOWED
      Slashed circle (circle with a diagonal line ⊘).
      Indicating an action cannot be performed, like clicking or during drag-and-drop operations.

  • Method Details

    • values

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

    • getNative

      @Internal public final com.mojang.blaze3d.platform.cursor.CursorType getNative()
      Returns the game's corresponding CursorType intance that is represented by this CursorType.

      Used internally by this API mod to display said cursor on screen.