java.lang.Object
java.awt.Cursor
- All Implemented Interfaces:
Serializable
A class to encapsulate the bitmap representation of the mouse cursor.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The crosshair cursor type.static final int
The type associated with all custom cursors.static final int
The default cursor type (gets set if no cursor is defined).static final int
The east-resize cursor type.static final int
The hand cursor type.static final int
The move cursor type.static final int
The north-resize cursor type.protected String
The user-visible name of the cursor.static final int
The north-east-resize cursor type.static final int
The north-west-resize cursor type.protected static Cursor[]
Deprecated.static final int
The south-resize cursor type.static final int
The south-east-resize cursor type.static final int
The south-west-resize cursor type.static final int
The text cursor type.static final int
The west-resize cursor type.static final int
The wait cursor type. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Cursor
Return the system default cursor.getName()
Returns the name of this cursor.static Cursor
getPredefinedCursor
(int type) Returns a cursor object with the specified predefined type.static Cursor
getSystemCustomCursor
(String name) Returns a system-specific custom cursor object matching the specified name.int
getType()
Returns the type for this cursor.toString()
Returns a string representation of this cursor.
-
Field Details
-
DEFAULT_CURSOR
public static final int DEFAULT_CURSORThe default cursor type (gets set if no cursor is defined).- See Also:
-
CROSSHAIR_CURSOR
public static final int CROSSHAIR_CURSORThe crosshair cursor type.- See Also:
-
TEXT_CURSOR
public static final int TEXT_CURSORThe text cursor type.- See Also:
-
WAIT_CURSOR
public static final int WAIT_CURSORThe wait cursor type.- See Also:
-
SW_RESIZE_CURSOR
public static final int SW_RESIZE_CURSORThe south-west-resize cursor type.- See Also:
-
SE_RESIZE_CURSOR
public static final int SE_RESIZE_CURSORThe south-east-resize cursor type.- See Also:
-
NW_RESIZE_CURSOR
public static final int NW_RESIZE_CURSORThe north-west-resize cursor type.- See Also:
-
NE_RESIZE_CURSOR
public static final int NE_RESIZE_CURSORThe north-east-resize cursor type.- See Also:
-
N_RESIZE_CURSOR
public static final int N_RESIZE_CURSORThe north-resize cursor type.- See Also:
-
S_RESIZE_CURSOR
public static final int S_RESIZE_CURSORThe south-resize cursor type.- See Also:
-
W_RESIZE_CURSOR
public static final int W_RESIZE_CURSORThe west-resize cursor type.- See Also:
-
E_RESIZE_CURSOR
public static final int E_RESIZE_CURSORThe east-resize cursor type.- See Also:
-
HAND_CURSOR
public static final int HAND_CURSORThe hand cursor type.- See Also:
-
MOVE_CURSOR
public static final int MOVE_CURSORThe move cursor type.- See Also:
-
predefined
Deprecated.As of JDK version 1.7, thegetPredefinedCursor(int)
method should be used instead. -
CUSTOM_CURSOR
public static final int CUSTOM_CURSORThe type associated with all custom cursors.- See Also:
-
name
The user-visible name of the cursor.- See Also:
-
-
Constructor Details
-
Cursor
Creates a new cursor object with the specified type.- Parameters:
type
- the type of cursor- Throws:
IllegalArgumentException
- if the specified cursor type is invalid
-
Cursor
Creates a new custom cursor object with the specified name.Note: this constructor should only be used by AWT implementations as part of their support for custom cursors. Applications should use Toolkit.createCustomCursor().
- Parameters:
name
- the user-visible name of the cursor.- See Also:
-
-
Method Details
-
getPredefinedCursor
Returns a cursor object with the specified predefined type.- Parameters:
type
- the type of predefined cursor- Returns:
- the specified predefined cursor
- Throws:
IllegalArgumentException
- if the specified cursor type is invalid
-
getSystemCustomCursor
Returns a system-specific custom cursor object matching the specified name. Cursor names are, for example: "Invalid.16x16"- Parameters:
name
- a string describing the desired system-specific custom cursor- Returns:
- the system specific custom cursor named
- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless
returns trueAWTException
- in case of erroneous retrieving of the cursor
-
getDefaultCursor
Return the system default cursor.- Returns:
- the default cursor
-
getType
public int getType()Returns the type for this cursor.- Returns:
- the cursor type
-
getName
Returns the name of this cursor.- Returns:
- a localized description of this cursor.
- Since:
- 1.2
-
toString
Returns a string representation of this cursor.
-
getPredefinedCursor(int)
method should be used instead.