Cursor (ocap-api 1.2.3 API)

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.

Version:

1.39, 01/23/03

Author:

Amy Fowler

See Also:
Component.setCursor(java.awt.Cursor), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CROSSHAIR_CURSOR` The crosshair cursor type.
`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.
`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

Constructors
Constructor and Description

Cursor(int type)
Creates a new cursor object with the specified type.

Constructors
Constructor and Description
`Cursor(int type)` Creates a new cursor object with the specified type.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`static Cursor`	`getDefaultCursor()` Return the system default cursor.
`static Cursor`	`getPredefinedCursor(int type)` Returns a cursor object with the specified predefined type.
`int`	`getType()` Returns the type for this cursor.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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
  - CROSSHAIR_CURSOR
```
public static final int CROSSHAIR_CURSOR
```
    The crosshair cursor type.
    
    See Also:
    Constant Field Values
  - TEXT_CURSOR
```
public static final int TEXT_CURSOR
```
    The text cursor type.
    
    See Also:
    Constant Field Values
  - WAIT_CURSOR
```
public static final int WAIT_CURSOR
```
    The wait cursor type.
    
    See Also:
    Constant Field Values
  - SW_RESIZE_CURSOR
```
public static final int SW_RESIZE_CURSOR
```
    The south-west-resize cursor type.
    
    See Also:
    Constant Field Values
  - SE_RESIZE_CURSOR
```
public static final int SE_RESIZE_CURSOR
```
    The south-east-resize cursor type.
    
    See Also:
    Constant Field Values
  - NW_RESIZE_CURSOR
```
public static final int NW_RESIZE_CURSOR
```
    The north-west-resize cursor type.
    
    See Also:
    Constant Field Values
  - NE_RESIZE_CURSOR
```
public static final int NE_RESIZE_CURSOR
```
    The north-east-resize cursor type.
    
    See Also:
    Constant Field Values
  - N_RESIZE_CURSOR
```
public static final int N_RESIZE_CURSOR
```
    The north-resize cursor type.
    
    See Also:
    Constant Field Values
  - S_RESIZE_CURSOR
```
public static final int S_RESIZE_CURSOR
```
    The south-resize cursor type.
    
    See Also:
    Constant Field Values
  - W_RESIZE_CURSOR
```
public static final int W_RESIZE_CURSOR
```
    The west-resize cursor type.
    
    See Also:
    Constant Field Values
  - E_RESIZE_CURSOR
```
public static final int E_RESIZE_CURSOR
```
    The east-resize cursor type.
    
    See Also:
    Constant Field Values
  - HAND_CURSOR
```
public static final int HAND_CURSOR
```
    The hand cursor type.
    
    See Also:
    Constant Field Values
  - MOVE_CURSOR
```
public static final int MOVE_CURSOR
```
    The move cursor type.
    
    See Also:
    Constant Field Values
  - predefined
```
protected static Cursor[] predefined
```
- Constructor Detail
  - Cursor
```
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
- 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
    
    Returns:
    the specified predefined cursor
    
    Throws:
    
    IllegalArgumentException - if the specified cursor type is invalid
  - getDefaultCursor
```
public static Cursor getDefaultCursor()
```
    Return the system default cursor.
  - getType
```
public int getType()
```
    Returns the type for this cursor.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java^TM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - the Exception raised by this method

Class Cursor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CURSOR

CROSSHAIR_CURSOR

TEXT_CURSOR

WAIT_CURSOR

SW_RESIZE_CURSOR

SE_RESIZE_CURSOR

NW_RESIZE_CURSOR

NE_RESIZE_CURSOR

N_RESIZE_CURSOR

S_RESIZE_CURSOR

W_RESIZE_CURSOR

E_RESIZE_CURSOR

HAND_CURSOR

MOVE_CURSOR

predefined

Constructor Detail

Cursor

Method Detail

getPredefinedCursor

getDefaultCursor

getType

finalize