This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.awt
class Cursor

java.lang.Object extended by java.awt.Cursor
All Implemented Interfaces:
Serializable
Most common way to construct:

Cursor baseCursor = Cursor.getDefaultCursor();

Based on 8 examples 

public class Cursor
extends Object
implements Serializable

A class to encapsulate the bitmap representation of the mouse cursor.

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.
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.
static int N_RESIZE_CURSOR
          The north-resize cursor type.
protected static Cursor[] predefined
          
static int SE_RESIZE_CURSOR
          The south-east-resize cursor type.
static int SW_RESIZE_CURSOR
          The south-west-resize cursor type.
static int S_RESIZE_CURSOR
          The south-resize cursor type.
static int TEXT_CURSOR
          The text cursor type.
static int WAIT_CURSOR
          The wait cursor type.
static int W_RESIZE_CURSOR
          The west-resize 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.
 
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)

          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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CROSSHAIR_CURSOR

public static final int CROSSHAIR_CURSOR
The crosshair cursor type.

CUSTOM_CURSOR

public static final int CUSTOM_CURSOR
The type associated with all custom cursors.

DEFAULT_CURSOR

public static final int DEFAULT_CURSOR
The default cursor type (gets set if no cursor is defined).

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.

name

protected String name
The user-visible name of the cursor.

NE_RESIZE_CURSOR

public static final int NE_RESIZE_CURSOR
The north-east-resize cursor type.

NW_RESIZE_CURSOR

public static final int NW_RESIZE_CURSOR
The north-west-resize cursor type.

N_RESIZE_CURSOR

public static final int N_RESIZE_CURSOR
The north-resize cursor type.

predefined

protected static Cursor[] predefined

SE_RESIZE_CURSOR

public static final int SE_RESIZE_CURSOR
The south-east-resize cursor type.

SW_RESIZE_CURSOR

public static final int SW_RESIZE_CURSOR
The south-west-resize cursor type.

S_RESIZE_CURSOR

public static final int S_RESIZE_CURSOR
The south-resize 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.

W_RESIZE_CURSOR

public static final int W_RESIZE_CURSOR
The west-resize cursor type.
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.
Method Detail

getDefaultCursor

public static Cursor getDefaultCursor()
Return the system default cursor.

getName

public String getName()
Returns the name of this cursor.

Returns:
a localized description of this cursor.

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

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

getType

public int getType()
Returns the type for this cursor.

toString

public String toString()
Returns a string representation of this cursor.

Overrides:
toString in class Object
Returns:
a string representation of this cursor.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.