java.awt

Class Cursor

Implemented Interfaces:
Serializable
Known Direct Subclasses:
GtkCursor

public class Cursor
extends Object
implements Serializable

This class represents various predefined cursor types.
See Also:
Serialized Form

Field Summary

static int
CROSSHAIR_CURSOR
Constant for a cross-hair cursor.
static int
CUSTOM_CURSOR
static int
DEFAULT_CURSOR
Constant for the system default cursor type
static int
E_RESIZE_CURSOR
Cursor used over E edge of window decorations.
static int
HAND_CURSOR
Constant for a hand cursor.
static int
MOVE_CURSOR
Constant for a cursor used during window move operations.
static int
NE_RESIZE_CURSOR
Cursor used over NE corner of window decorations.
static int
NW_RESIZE_CURSOR
Cursor used over NW corner of window decorations.
static int
N_RESIZE_CURSOR
Cursor used over N edge of window decorations.
static int
SE_RESIZE_CURSOR
Cursor used over SE corner of window decorations.
static int
SW_RESIZE_CURSOR
Cursor used over SW corner of window decorations.
static int
S_RESIZE_CURSOR
Cursor used over S edge of window decorations.
static int
TEXT_CURSOR
Constant for a cursor over a text field.
static int
WAIT_CURSOR
Constant for a cursor to display while waiting for an action to complete.
static int
W_RESIZE_CURSOR
Cursor used over W edge of window decorations.
protected String
name
protected static Cursor[]
predefined

Constructor Summary

Cursor(int type)
Initializes a new instance of Cursor with the specified type.
Cursor(String name)
This constructor is used internally only.

Method Summary

static Cursor
getDefaultCursor()
Returns an instance of the system default cursor type.
String
getName()
static Cursor
getPredefinedCursor(int type)
Returns an instance of Cursor for one of the specified predetermined types.
static Cursor
getSystemCustomCursor(String name)
Retrieves the system specific custom Cursor named Cursor names are, for example: "Invalid.16x16".
int
getType()
Returns the numeric type identifier for this cursor.
String
toString()

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CROSSHAIR_CURSOR

public static final int CROSSHAIR_CURSOR
Constant for a cross-hair cursor.
Field Value:
1

CUSTOM_CURSOR

public static final int CUSTOM_CURSOR
Field Value:
-1

DEFAULT_CURSOR

public static final int DEFAULT_CURSOR
Constant for the system default cursor type
Field Value:
0

E_RESIZE_CURSOR

public static final int E_RESIZE_CURSOR
Cursor used over E edge of window decorations.
Field Value:
11

HAND_CURSOR

public static final int HAND_CURSOR
Constant for a hand cursor.
Field Value:
12

MOVE_CURSOR

public static final int MOVE_CURSOR
Constant for a cursor used during window move operations.
Field Value:
13

NE_RESIZE_CURSOR

public static final int NE_RESIZE_CURSOR
Cursor used over NE corner of window decorations.
Field Value:
7

NW_RESIZE_CURSOR

public static final int NW_RESIZE_CURSOR
Cursor used over NW corner of window decorations.
Field Value:
6

N_RESIZE_CURSOR

public static final int N_RESIZE_CURSOR
Cursor used over N edge of window decorations.
Field Value:
8

SE_RESIZE_CURSOR

public static final int SE_RESIZE_CURSOR
Cursor used over SE corner of window decorations.
Field Value:
5

SW_RESIZE_CURSOR

public static final int SW_RESIZE_CURSOR
Cursor used over SW corner of window decorations.
Field Value:
4

S_RESIZE_CURSOR

public static final int S_RESIZE_CURSOR
Cursor used over S edge of window decorations.
Field Value:
9

TEXT_CURSOR

public static final int TEXT_CURSOR
Constant for a cursor over a text field.
Field Value:
2

WAIT_CURSOR

public static final int WAIT_CURSOR
Constant for a cursor to display while waiting for an action to complete.
Field Value:
3

W_RESIZE_CURSOR

public static final int W_RESIZE_CURSOR
Cursor used over W edge of window decorations.
Field Value:
10

name

protected String name

predefined

protected static Cursor[] predefined

Constructor Details

Cursor

public Cursor(int type)
Initializes a new instance of Cursor with the specified type.
Parameters:
type - The cursor type.
Throws:
IllegalArgumentException - If the specified cursor type is invalid

Cursor

protected Cursor(String name)
This constructor is used internally only. Application code should call Toolkit.createCustomCursor().

Method Details

getDefaultCursor

public static Cursor getDefaultCursor()
Returns an instance of the system default cursor type.
Returns:
The system default cursor.

getName

public String getName()

getPredefinedCursor

public static Cursor getPredefinedCursor(int type)
Returns an instance of Cursor for one of the specified predetermined types.
Parameters:
type - The type contant from this class.
Returns:
The requested predefined cursor.
Throws:
IllegalArgumentException - If the constant is not one of the predefined cursor type constants from this class.

getSystemCustomCursor

public static Cursor getSystemCustomCursor(String name)
            throws AWTException
Retrieves the system specific custom Cursor named Cursor names are, for example: "Invalid.16x16".
Throws:
AWTException -
HeadlessException - If GraphicsEnvironment.isHeadless() returns true.

getType

public int getType()
Returns the numeric type identifier for this cursor.
Returns:
The cursor id.

toString

public String toString()
Overrides:
toString in interface Object

Copyright (C) 1999, 2000, 2002 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.