public class ImageCursor extends Cursor
Cursor.DEFAULT
will be used in place of the
specified ImageCursor.
Example:
import javafx.scene.*; import javafx.scene.image.*; Image image = new Image("mycursor.png"); Scene scene = new Scene(400, 300); scene.setCursor(new ImageCursor(image, image.getWidth() / 2, image.getHeight() /2));
- Since:
- JavaFX 2.0
-
Property Summary
Properties Type Property Description ReadOnlyDoubleProperty
hotspotX
The X coordinate of the cursor's hot spot.ReadOnlyDoubleProperty
hotspotY
The Y coordinate of the cursor's hot spot.ReadOnlyObjectProperty<Image>
image
The image to display when the cursor is active. -
Field Summary
-
Constructor Summary
Constructors Constructor Description ImageCursor()
Constructs a new emptyImageCursor
which will look asCursor.DEFAULT
.ImageCursor(Image image)
Constructs anImageCursor
from the specified image.ImageCursor(Image image, double hotspotX, double hotspotY)
Constructs anImageCursor
from the specified image and hotspot coordinates. -
Method Summary
Modifier and Type Method Description static ImageCursor
chooseBestCursor(Image[] images, double hotspotX, double hotspotY)
Creates a custom image cursor from one of the specified images.static Dimension2D
getBestSize(double preferredWidth, double preferredHeight)
Gets the supported cursor size that is closest to the specified preferred size.double
getHotspotX()
Gets the value of the property hotspotX.double
getHotspotY()
Gets the value of the property hotspotY.Image
getImage()
Gets the value of the property image.static int
getMaximumColors()
Returns the maximum number of colors supported in a custom image cursor palette.ReadOnlyDoubleProperty
hotspotXProperty()
The X coordinate of the cursor's hot spot.ReadOnlyDoubleProperty
hotspotYProperty()
The Y coordinate of the cursor's hot spot.ReadOnlyObjectProperty<Image>
imageProperty()
The image to display when the cursor is active.
-
Property Details
-
image
The image to display when the cursor is active. If the image is null,Cursor.DEFAULT
will be used.- Default value:
- null
- See Also:
getImage()
-
hotspotX
The X coordinate of the cursor's hot spot. This hotspot represents the location within the cursor image that will be displayed at the mouse position. This must be in the range of [0,image.width-1]. A value less than 0 will be set to 0. A value greater than image.width-1 will be set to image.width-1.- Default value:
- 0
- See Also:
getHotspotX()
-
hotspotY
The Y coordinate of the cursor's hot spot. This hotspot represents the location within the cursor image that will be displayed at the mouse position. This must be in the range of [0,image.height-1]. A value less than 0 will be set to 0. A value greater than image.height-1 will be set to image.height-1.- Default value:
- 0
- See Also:
getHotspotY()
-
-
Constructor Details
-
ImageCursor
public ImageCursor()Constructs a new emptyImageCursor
which will look asCursor.DEFAULT
. -
ImageCursor
Constructs anImageCursor
from the specified image. The cursor's hot spot will default to the upper left corner.- Parameters:
image
- the image
-
ImageCursor
Constructs anImageCursor
from the specified image and hotspot coordinates.- Parameters:
image
- the imagehotspotX
- the X coordinate of the cursor's hot spothotspotY
- the Y coordinate of the cursor's hot spot
-
-
Method Details
-
getImage
Gets the value of the property image.- Property description:
- The image to display when the cursor is active. If the image is null,
Cursor.DEFAULT
will be used. - Default value:
- null
-
imageProperty
The image to display when the cursor is active. If the image is null,Cursor.DEFAULT
will be used.- Default value:
- null
- See Also:
getImage()
-
getHotspotX
public final double getHotspotX()Gets the value of the property hotspotX.- Property description:
- The X coordinate of the cursor's hot spot. This hotspot represents the location within the cursor image that will be displayed at the mouse position. This must be in the range of [0,image.width-1]. A value less than 0 will be set to 0. A value greater than image.width-1 will be set to image.width-1.
- Default value:
- 0
-
hotspotXProperty
The X coordinate of the cursor's hot spot. This hotspot represents the location within the cursor image that will be displayed at the mouse position. This must be in the range of [0,image.width-1]. A value less than 0 will be set to 0. A value greater than image.width-1 will be set to image.width-1.- Default value:
- 0
- See Also:
getHotspotX()
-
getHotspotY
public final double getHotspotY()Gets the value of the property hotspotY.- Property description:
- The Y coordinate of the cursor's hot spot. This hotspot represents the location within the cursor image that will be displayed at the mouse position. This must be in the range of [0,image.height-1]. A value less than 0 will be set to 0. A value greater than image.height-1 will be set to image.height-1.
- Default value:
- 0
-
hotspotYProperty
The Y coordinate of the cursor's hot spot. This hotspot represents the location within the cursor image that will be displayed at the mouse position. This must be in the range of [0,image.height-1]. A value less than 0 will be set to 0. A value greater than image.height-1 will be set to image.height-1.- Default value:
- 0
- See Also:
getHotspotY()
-
getBestSize
Gets the supported cursor size that is closest to the specified preferred size. A value of (0,0) is returned if the platform does not support custom cursors.Note: if an image is used whose dimensions don't match a supported size (as returned by this method), the implementation will resize the image to a supported size. This may result in a loss of quality.
Note: These values can vary between operating systems, graphics cards and screen resolution, but at the time of this writing, a sample Windows Vista machine returned 32x32 for all requested sizes, while sample Mac and Linux machines returned the requested size up to a maximum of 64x64. Applications should provide a 32x32 cursor, which will work well on all platforms, and may optionally wish to provide a 64x64 cursor for those platforms on which it is supported.
- Parameters:
preferredWidth
- the preferred width of the cursorpreferredHeight
- the preferred height of the cursor- Returns:
- the supported cursor size
-
getMaximumColors
public static int getMaximumColors()Returns the maximum number of colors supported in a custom image cursor palette.Note: if an image is used which has more colors in its palette than the supported maximum, the implementation will attempt to flatten the palette to the maximum. This may result in a loss of quality.
Note: These values can vary between operating systems, graphics cards and screen resolution, but at the time of this writing, a sample Windows Vista machine returned 256, a sample Mac machine returned Integer.MAX_VALUE, indicating support for full color cursors, and a sample Linux machine returned 2. Applications may want to target these three color depths for an optimal cursor on each platform.
- Returns:
- the maximum number of colors supported in a custom image cursor palette
-
chooseBestCursor
Creates a custom image cursor from one of the specified images. This function will choose the image whose size most closely matched the best cursor size. The hotpotX of the returned ImageCursor is scaled by chosenImage.width/images[0].width and the hotspotY is scaled by chosenImage.height/images[0].height.On platforms that don't support custom cursors,
Cursor.DEFAULT
will be used in place of the returned ImageCursor.- Parameters:
images
- a sequence of images from which to choose, in order of preferencehotspotX
- the X coordinate of the hotspot within the first image in the images sequencehotspotY
- the Y coordinate of the hotspot within the first image in the images sequence- Returns:
- a cursor created from the best image
-