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.
Note: Only one of the above styles may be specified.
| field | type | note |
|---|---|---|
| handle | NSCursor | the handle to the OS cursor resource
(Warning: This field is platform dependent)
IMPORTANT: This field is not part of the SWT public API. 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 accessed from application code. |
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.
NOTE: It is recommended to useorg.eclipse.swt.widgets.Display#getSystemCursor(int)
instead of using this constructor. This way you can avoid the
overhead of disposing the Cursor resource.
| name | type | description |
|---|---|---|
| device | org.eclipse.swt.graphics.Device | the device on which to allocate the cursor |
| style | int | the style of cursor to allocate |
| IllegalArgumentException |
|
|
| SWTError |
|
|
<init>(org.eclipse.swt.graphics.Device device, org.eclipse.swt.graphics.ImageData source, org.eclipse.swt.graphics.ImageData mask, int hotspotX, int hotspotY)#Cursor(Device, ImageDataProvider, int, int) instead.
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.
| name | type | description |
|---|---|---|
| device | org.eclipse.swt.graphics.Device | the device on which to allocate the cursor |
| source | org.eclipse.swt.graphics.ImageData | the color data for the cursor |
| mask | org.eclipse.swt.graphics.ImageData | the mask data for the cursor (or null) |
| hotspot_x | int | the x coordinate of the cursor's hotspot |
| hotspot_y | int | the y coordinate of the cursor's hotspot |
| IllegalArgumentException |
|
|
| SWTError |
|
|
<init>(org.eclipse.swt.graphics.Device device, org.eclipse.swt.graphics.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.
| name | type | description |
|---|---|---|
| device | org.eclipse.swt.graphics.Device | the device on which to allocate the cursor |
| source | org.eclipse.swt.graphics.ImageData | the image data for the cursor |
| hotspot_x | int | the x coordinate of the cursor's hotspot |
| hotspot_y | int | the y coordinate of the cursor's hotspot |
| IllegalArgumentException |
|
|
| SWTError |
|
|
<init>(org.eclipse.swt.graphics.Device device, org.eclipse.swt.graphics.ImageDataProvider imageDataProvider, int hotspotX, int hotspotY)Constructs a new cursor given a device, image 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.
| name | type | description |
|---|---|---|
| device | org.eclipse.swt.graphics.Device | the device on which to allocate the cursor |
| image_data_provider | org.eclipse.swt.graphics.ImageDataProvider | the ImageDataProvider for the cursor |
| hotspot_x | int | the x coordinate of the cursor's hotspot |
| hotspot_y | int | the y coordinate of the cursor's hotspot |
| IllegalArgumentException |
|
|
| SWTError |
|
|
cocoa_new(org.eclipse.swt.graphics.Device device, org.eclipse.swt.internal.cocoa.NSCursor 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.
| name | type | description |
|---|---|---|
| device | org.eclipse.swt.graphics.Device | the device on which to allocate the color |
| handle | org.eclipse.swt.internal.cocoa.NSCursor | the handle for the cursor |
isDisposed() · also: is_disposedReturns 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 (except #dispose()) using the cursor.
Returns: true when the cursor is disposed and false otherwise
equals(Object object)Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
| name | type | description |
|---|---|---|
| object | Object | the object to compare with this object |
Returns: true if the object is the same as this object and false otherwise
hashCode()Returns an integer hash code for the receiver. Any two
objects that return true when passed to
equals must return the same value for this
method.
Returns: the receiver's hash
toString()Returns a string containing a concise, human-readable description of the receiver.
Returns: a string representation of the receiver
Returns the Device where this resource was
created.
Returns: Device the device of the receiver
dispose()Disposes of the operating system resources associated with this resource. Applications must dispose of all resources which they allocate. This method does nothing if the resource is already disposed.