org.eclipse.swt.graphics
Class Cursor

java.lang.Object
  |
  +--org.eclipse.swt.graphics.Cursor

public final class Cursor

extends 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

protected boolean

isIcon true, if the cursor was created as Icon

Constructor Summary

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").

Method Summary

void	dispose() Disposes of the operating system resources associated with the cursor.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, toString

Field Detail

isIcon

protected boolean isIcon

true, if the cursor was created as Icon

Constructor Detail

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.

Parameters:

device - the device on which to allocate the cursor

hotspotX - the x coordinate of the cursor's hotspot

hotspotY - the y coordinate of the cursor's hotspot

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if device is null and there is no current device
• ERROR_NULL_ARGUMENT - if the image is null
• ERROR_INVALID_ARGUMENT - if the hotspot is outside the bounds of the image

SWTError -

• ERROR_NO_HANDLES - if a handle could not be obtained for cursor creation

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.