Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.swt.graphics
Class Cursor  view Cursor download Cursor.java

java.lang.Object
  extended byorg.eclipse.swt.graphics.Cursor

public final class Cursor
extends java.lang.Object

Instances of this class manage operating system resources that specify the appearance of the on-screen pointer. To create a cursor you specify the device and either a simple cursor style describing one of the standard operating system provided cursors or the image and mask data for the desired appearance.

Application code must explicitly invoke the Cursor.dispose() method to release the operating system resources managed by each instance when those instances are no longer required.

Styles:
CURSOR_ARROW, CURSOR_WAIT, CURSOR_CROSS, CURSOR_APPSTARTING, CURSOR_HELP, CURSOR_SIZEALL, CURSOR_SIZENESW, CURSOR_SIZENS, CURSOR_SIZENWSE, CURSOR_SIZEWE, CURSOR_SIZEN, CURSOR_SIZES, CURSOR_SIZEE, CURSOR_SIZEW, CURSOR_SIZENE, CURSOR_SIZESE, CURSOR_SIZESW, CURSOR_SIZENW, CURSOR_UPARROW, CURSOR_IBEAM, CURSOR_NO, CURSOR_HAND

Note: Only one of the above styles may be specified.


Field Summary
(package private)  Device device
          The device where this cursor was created.
 long handle
          the handle to the OS cursor resource (Warning: This field is platform dependent)
 
Constructor Summary
(package private) Cursor()
           
  Cursor(Device device, ImageData source, ImageData mask, int hotspotX, int hotspotY)
          Constructs a new cursor given a device, image and mask data describing the desired cursor appearance, and the x and y coordinates of the hotspot (that is, the point within the area covered by the cursor which is considered to be where the on-screen pointer is "pointing").
  Cursor(Device device, ImageData source, int hotspotX, int hotspotY)
          Constructs a new cursor given a device, image data describing the desired cursor appearance, and the x and y coordinates of the hotspot (that is, the point within the area covered by the cursor which is considered to be where the on-screen pointer is "pointing").
  Cursor(Device device, int style)
          Constructs a new cursor given a device and a style constant describing the desired cursor appearance.
 
Method Summary
 void dispose()
          Disposes of the operating system resources associated with the cursor.
 boolean equals(java.lang.Object object)
          Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
static Cursor gtk_new(Device device, long handle)
          Invokes platform specific functionality to allocate a new cursor.
 int hashCode()
          Returns an integer hash code for the receiver.
 boolean isDisposed()
          Returns true if the cursor has been disposed, and false otherwise.
 java.lang.String toString()
          Returns a string containing a concise, human-readable description of the receiver.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

handle

public long handle
the handle to the OS cursor resource (Warning: This field is platform dependent)


device

Device device
The device where this cursor was created.

Constructor Detail

Cursor

Cursor()

Cursor

public Cursor(Device device,
              int style)
Constructs a new cursor given a device and a style constant describing the desired cursor appearance.

You must dispose the cursor when it is no longer required.


Cursor

public Cursor(Device device,
              ImageData source,
              ImageData mask,
              int hotspotX,
              int hotspotY)
Constructs a new cursor given a device, image and mask data describing the desired cursor appearance, and the x and y coordinates of the hotspot (that is, the point within the area covered by the cursor which is considered to be where the on-screen pointer is "pointing").

The mask data is allowed to be null, but in this case the source must be an ImageData representing an icon that specifies both color data and mask data.

You must dispose the cursor when it is no longer required.


Cursor

public Cursor(Device device,
              ImageData source,
              int hotspotX,
              int hotspotY)
Constructs a new cursor given a device, image data describing the desired cursor appearance, and the x and y coordinates of the hotspot (that is, the point within the area covered by the cursor which is considered to be where the on-screen pointer is "pointing").

You must dispose the cursor when it is no longer required.

Since:
3.0
Method Detail

dispose

public void dispose()
Disposes of the operating system resources associated with the cursor. Applications must dispose of all cursors which they allocate.


equals

public boolean equals(java.lang.Object object)
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.


gtk_new

public static Cursor gtk_new(Device device,
                             long handle)
Invokes platform specific functionality to allocate a new cursor.

IMPORTANT: This method is not part of the public API for Cursor. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.


hashCode

public int hashCode()
Returns an integer hash code for the receiver. Any two objects which return true when passed to equals must return the same value for this method.


isDisposed

public boolean isDisposed()
Returns true if the cursor has been disposed, and false otherwise.

This method gets the dispose state for the cursor. When a cursor has been disposed, it is an error to invoke any other method using the cursor.


toString

public java.lang.String toString()
Returns a string containing a concise, human-readable description of the receiver.