Class Cursor

• 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

Fields

DEFAULT_CURSOR

public static final int DEFAULT_CURSOR

The default cursor type (gets set if no cursor is defined).

CROSSHAIR_CURSOR

public static final int CROSSHAIR_CURSOR

The crosshair cursor type.

TEXT_CURSOR

public static final int TEXT_CURSOR

The text cursor type.

WAIT_CURSOR

public static final int WAIT_CURSOR

The wait cursor type.

SW_RESIZE_CURSOR

public static final int SW_RESIZE_CURSOR

The south-west-resize cursor type.

SE_RESIZE_CURSOR

public static final int SE_RESIZE_CURSOR

The south-east-resize cursor type.

NW_RESIZE_CURSOR

public static final int NW_RESIZE_CURSOR

The north-west-resize cursor type.

NE_RESIZE_CURSOR

public static final int NE_RESIZE_CURSOR

The north-east-resize cursor type.

N_RESIZE_CURSOR

public static final int N_RESIZE_CURSOR

The north-resize cursor type.

S_RESIZE_CURSOR

public static final int S_RESIZE_CURSOR

The south-resize cursor type.

W_RESIZE_CURSOR

public static final int W_RESIZE_CURSOR

The west-resize cursor type.

E_RESIZE_CURSOR

public static final int E_RESIZE_CURSOR

The east-resize cursor type.

HAND_CURSOR

public static final int HAND_CURSOR

The hand cursor type.

MOVE_CURSOR

public static final int MOVE_CURSOR

The move cursor type.

predefined

@Deprecated
protected static Cursor[] predefined

Deprecated. As of JDK version 1.7, the getPredefinedCursor(int) method should be used instead.

CUSTOM_CURSOR

public static final int CUSTOM_CURSOR

The type associated with all custom cursors.

name

protected String name

The user-visible name of the cursor.

See Also:

getName()

Constructors

Cursor

@ConstructorProperties(value="type")
public Cursor(int type)

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

protected Cursor(String name)

Parameters:

name - the user-visible name of the cursor.

See Also:

Toolkit.createCustomCursor(java.awt.Image, java.awt.Point, java.lang.String)

Methods

getPredefinedCursor

public static Cursor 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 - if the specified cursor type is invalid

getSystemCustomCursor

public static Cursor getSystemCustomCursor(String name)
                                    throws AWTException,
                                           HeadlessException

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 - if GraphicsEnvironment.isHeadless returns true

AWTException

getDefaultCursor

public static Cursor getDefaultCursor()

Return the system default cursor.

getType

public int getType()

Returns the type for this cursor.

getName

public String getName()

Returns the name of this cursor.

Returns:

a localized description of this cursor.

Since:

1.2

toString

public String toString()

Returns a string representation of this cursor.

Overrides:

toString in class Object

Returns:

a string representation of this cursor.

Since:

1.2