Java Platform 1.2

java.awt
Class Cursor

java.lang.Object
  |
  +--java.awt.Cursor

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
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
           
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
  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. Note: this constructor should only be used by AWT implementations as part of their support for custom cursors.
 
Method Summary
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)
           
 int getType()
          Returns the type for this cursor.
 String toString()
          Returns a string representation of this cursor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

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

protected static Cursor[] predefined

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()
Constructor Detail

Cursor

public Cursor(int type)
Creates a new cursor object with the specified type.
Parameters:
type - the type of cursor

Cursor

protected Cursor(String 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)
Method Detail

getPredefinedCursor

public static Cursor getPredefinedCursor(int type)
Returns a cursor object with the specified predefined type.
Parameters:
type - the type of predefined cursor

getSystemCustomCursor

public static Cursor getSystemCustomCursor(String name)
                                    throws AWTException
Returns:
the system specific custom Cursor named Cursor names are, for example: "Invalid.16x16"

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:
JDK1.2

toString

public String toString()
Returns a string representation of this cursor.
Returns:
a string representation of this cursor.
Overrides:
toString in class Object
Since:
JDK1.2

Java Platform 1.2

Submit a bug or feature Version 1.2 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.