Cursor (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.awt.Cursor
All Implemented Interfaces:
Serializable

public class Cursor
extends Object
implements Serializable
A class to encapsulate the bitmap representation of the mouse cursor.
See Also:
Component.setCursor(java.awt.Cursor), Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	CROSSHAIR_CURSOR	The crosshair cursor type.
static int	CUSTOM_CURSOR	The type associated with all custom cursors.
static int	DEFAULT_CURSOR	The default cursor type (gets set if no cursor is defined).
static int	E_RESIZE_CURSOR	The east-resize cursor type.
static int	HAND_CURSOR	The hand cursor type.
static int	MOVE_CURSOR	The move cursor type.
static int	N_RESIZE_CURSOR	The north-resize cursor type.
protected String	name	The user-visible name of the cursor.
static int	NE_RESIZE_CURSOR	The north-east-resize cursor type.
static int	NW_RESIZE_CURSOR	The north-west-resize cursor type.
protected static Cursor[]	predefined	Deprecated.
static int	S_RESIZE_CURSOR	The south-resize cursor type.
static int	SE_RESIZE_CURSOR	The south-east-resize cursor type.
static int	SW_RESIZE_CURSOR	The south-west-resize cursor type.
static int	TEXT_CURSOR	The text cursor type.
static int	W_RESIZE_CURSOR	The west-resize cursor type.
static int	WAIT_CURSOR	The wait cursor type.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Cursor(int type)	Creates a new cursor object with the specified type.
protected	Cursor(String name)	Creates a new custom cursor object with the specified name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
static Cursor	getDefaultCursor()	Return the system default cursor.
String	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.
String	toString()	Returns a string representation of this cursor.

   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

Field Detail

 * #### DEFAULT\_CURSOR  
 public static final int DEFAULT_CURSOR  
 The default cursor type (gets set if no cursor is defined).  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.DEFAULT%5FCURSOR)  
 * #### CROSSHAIR\_CURSOR  
 public static final int CROSSHAIR_CURSOR  
 The crosshair cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.CROSSHAIR%5FCURSOR)  
 * #### TEXT\_CURSOR  
 public static final int TEXT_CURSOR  
 The text cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.TEXT%5FCURSOR)  
 * #### WAIT\_CURSOR  
 public static final int WAIT_CURSOR  
 The wait cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.WAIT%5FCURSOR)  
 * #### SW\_RESIZE\_CURSOR  
 public static final int SW_RESIZE_CURSOR  
 The south-west-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.SW%5FRESIZE%5FCURSOR)  
 * #### SE\_RESIZE\_CURSOR  
 public static final int SE_RESIZE_CURSOR  
 The south-east-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.SE%5FRESIZE%5FCURSOR)  
 * #### NW\_RESIZE\_CURSOR  
 public static final int NW_RESIZE_CURSOR  
 The north-west-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.NW%5FRESIZE%5FCURSOR)  
 * #### NE\_RESIZE\_CURSOR  
 public static final int NE_RESIZE_CURSOR  
 The north-east-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.NE%5FRESIZE%5FCURSOR)  
 * #### N\_RESIZE\_CURSOR  
 public static final int N_RESIZE_CURSOR  
 The north-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.N%5FRESIZE%5FCURSOR)  
 * #### S\_RESIZE\_CURSOR  
 public static final int S_RESIZE_CURSOR  
 The south-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.S%5FRESIZE%5FCURSOR)  
 * #### W\_RESIZE\_CURSOR  
 public static final int W_RESIZE_CURSOR  
 The west-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.W%5FRESIZE%5FCURSOR)  
 * #### E\_RESIZE\_CURSOR  
 public static final int E_RESIZE_CURSOR  
 The east-resize cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.E%5FRESIZE%5FCURSOR)  
 * #### HAND\_CURSOR  
 public static final int HAND_CURSOR  
 The hand cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.HAND%5FCURSOR)  
 * #### MOVE\_CURSOR  
 public static final int MOVE_CURSOR  
 The move cursor type.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.MOVE%5FCURSOR)  
 * #### predefined  
 [@Deprecated](../../java/lang/Deprecated.html "annotation in java.lang")  
 protected static [Cursor](../../java/awt/Cursor.html "class in java.awt")[] predefined  
 * #### CUSTOM\_CURSOR  
 public static final int CUSTOM_CURSOR  
 The type associated with all custom cursors.  
 See Also:  
 [Constant Field Values](../../constant-values.html#java.awt.Cursor.CUSTOM%5FCURSOR)  
 * #### name  
 protected [String](../../java/lang/String.html "class in java.lang") name  
 The user-visible name of the cursor.  
 See Also:  
 [getName()](../../java/awt/Cursor.html#getName--)

Constructor Detail

* #### Cursor  
[@ConstructorProperties](../../java/beans/ConstructorProperties.html "annotation in java.beans")([value](../../java/beans/ConstructorProperties.html#value--)="type")  
public Cursor(int type)  
Creates a new cursor object with the specified type.  
Parameters:  
`type` \- the type of cursor  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the specified cursor type is invalid  
* #### Cursor  
protected Cursor([String](../../java/lang/String.html "class in java.lang") name)  
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:  
[Toolkit.createCustomCursor(java.awt.Image, java.awt.Point, java.lang.String)](../../java/awt/Toolkit.html#createCustomCursor-java.awt.Image-java.awt.Point-java.lang.String-)

Method Detail

* #### getPredefinedCursor  
public static [Cursor](../../java/awt/Cursor.html "class in java.awt") getPredefinedCursor(int type)  
Returns a cursor object with the specified predefined type.  
Parameters:  
`type` \- the type of predefined cursor  
Returns:  
the specified predefined cursor  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the specified cursor type is invalid  
* #### getSystemCustomCursor  
public static [Cursor](../../java/awt/Cursor.html "class in java.awt") getSystemCustomCursor([String](../../java/lang/String.html "class in java.lang") name)  
                                    throws [AWTException](../../java/awt/AWTException.html "class in java.awt"),  
                                           [HeadlessException](../../java/awt/HeadlessException.html "class in java.awt")  
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](../../java/awt/HeadlessException.html "class in java.awt")` \- if`GraphicsEnvironment.isHeadless` returns true  
`[AWTException](../../java/awt/AWTException.html "class in java.awt")`  
* #### getDefaultCursor  
public static [Cursor](../../java/awt/Cursor.html "class in java.awt") getDefaultCursor()  
Return the system default cursor.  
* #### getType  
public int getType()  
Returns the type for this cursor.  
* #### getName  
public [String](../../java/lang/String.html "class in java.lang") getName()  
Returns the name of this cursor.  
Returns:  
a localized description of this cursor.  
Since:  
1.2  
* #### toString  
public [String](../../java/lang/String.html "class in java.lang") toString()  
Returns a string representation of this cursor.  
Overrides:  
`[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Returns:  
a string representation of this cursor.  
Since:  
1.2

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Cursor (Java Platform SE 8 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail