Modifier and Type	Class and Description
private static class	ImageCursor.DelayedInitialization
private class	ImageCursor.DoublePropertyImpl
private class	ImageCursor.ObjectPropertyImpl<T>

Modifier and Type	Field and Description
private int	activeCounter Indicates whether the image cursor is currently in use.
private CursorFrame	currentCursorFrame
private ImageCursorFrame	firstCursorFrame Stores the first cursor frame.
private ImageCursor.DoublePropertyImpl	hotspotX The X coordinate of the cursor's hot spot.
private ImageCursor.DoublePropertyImpl	hotspotY The Y coordinate of the cursor's hot spot.
private ImageCursor.ObjectPropertyImpl<Image>	image The image to display when the cursor is active.
private InvalidationListener	imageListener
private Map<Object, ImageCursorFrame>	otherCursorFrames Maps platform images to cursor frames.

Access	Constructor and Description
public	ImageCursor() Constructs a new empty `ImageCursor` which will look as `Cursor.DEFAULT`.
public	ImageCursor(final Image the image image) Constructs an `ImageCursor` from the specified image.
public	ImageCursor(final Image the image image, double the X coordinate of the cursor's hot spot hotspotX, double the Y coordinate of the cursor's hot spot hotspotY) Constructs an `ImageCursor` from the specified image and hotspot coordinates.

Method Summary

Modifier and Type	Method and Description
pack-priv void	activate() Overrides javafx.scene.Cursor.activate. Activates the cursor.
private void	bindImage(final Image toImage)
public static ImageCursor	Returns: a cursor created from the best image chooseBestCursor(final Image[] a sequence of images from which to choose, in order of preference images, final double the X coordinate of the hotspot within the first image in the images sequence hotspotX, final double the Y coordinate of the hotspot within the first image in the images sequence hotspotY) Creates a custom image cursor from one of the specified images.
pack-priv void	deactivate() Overrides javafx.scene.Cursor.deactivate. Deactivates the cursor.
private static Image	findBestImage(final Image[] images)
public static Dimension2D	Returns: the supported cursor size getBestSize(double the preferred width of the cursor preferredWidth, double the preferred height of the cursor preferredHeight) Gets the supported cursor size that is closest to the specified preferred size.
pack-priv CursorFrame	getCurrentFrame() Implements abstract javafx.scene.Cursor.getCurrentFrame.
public final double	getHotspotX()
public final double	getHotspotY()
public final Image	getImage()
private InvalidationListener	getImageListener()
public static int	Returns: the maximum number of colors supported in a custom image cursor palette getMaximumColors() Returns the maximum number of colors supported in a custom image cursor palette.
public final ReadOnlyDoubleProperty	hotspotXProperty()
private ImageCursor.DoublePropertyImpl	hotspotXPropertyImpl()
public final ReadOnlyDoubleProperty	hotspotYProperty()
private ImageCursor.DoublePropertyImpl	hotspotYPropertyImpl()
public final ReadOnlyObjectProperty<Image>	imageProperty()
private ImageCursor.ObjectPropertyImpl<Image>	imagePropertyImpl()
private void	initialize(final Image[] images, final double hotspotX, final double hotspotY)
private void	initialize(Image newImage, double newHotspotX, double newHotspotY)
private void	invalidateCurrentFrame()
private static boolean	needsDelayedInitialization(final Image[] images)
private void	unbindImage(final Image fromImage)

Inherited from javafx.scene.Cursor:: cursor toString

Field Detail

activeCounter	back to summary
private int activeCounter Indicates whether the image cursor is currently in use. The active cursor is bound to the image and invalidates its platform cursor when the image changes.

currentCursorFrame	back to summary
private CursorFrame currentCursorFrame

firstCursorFrame	back to summary
private ImageCursorFrame firstCursorFrame Stores the first cursor frame. For non-animated cursors there is only one frame and so the `restCursorFrames` is `null`.

hotspotX	back to summary
private ImageCursor.DoublePropertyImpl 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

hotspotX

back to summary

private ImageCursor.DoublePropertyImpl 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

hotspotY	back to summary
private ImageCursor.DoublePropertyImpl 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

hotspotY

back to summary

private ImageCursor.DoublePropertyImpl 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

image back to summary

image	back to summary
private ImageCursor.ObjectPropertyImpl<Image> image The image to display when the cursor is active. If the image is null, `Cursor.DEFAULT` will be used. Default Value null

private ImageCursor.ObjectPropertyImpl<Image> image

The image to display when the cursor is active. If the image is null, Cursor.DEFAULT will be used.

Default Value: null

imageListener	back to summary
private InvalidationListener imageListener

otherCursorFrames	back to summary
private Map<Object, ImageCursorFrame> otherCursorFrames Maps platform images to cursor frames. It doesn't store the first cursor frame and so it needs to be created only for animated cursors.

Constructor Detail

ImageCursor	back to summary
public ImageCursor() Constructs a new empty `ImageCursor` which will look as `Cursor.DEFAULT`.

ImageCursor back to summary

ImageCursor	back to summary
public ImageCursor(final Image image) Constructs an `ImageCursor` from the specified image. The cursor's hot spot will default to the upper left corner. Parameters image:Image the image

public ImageCursor(final Image image)

Constructs an ImageCursor from the specified image. The cursor's hot spot will default to the upper left corner.

Parameters

image:Image: the image

ImageCursor back to summary

ImageCursor	back to summary
public ImageCursor(final Image image, double hotspotX, double hotspotY) Constructs an `ImageCursor` from the specified image and hotspot coordinates. Parameters image:Image the image hotspotX:double the X coordinate of the cursor's hot spot hotspotY:double the Y coordinate of the cursor's hot spot

public ImageCursor(final Image image, double hotspotX, double hotspotY)

Constructs an ImageCursor from the specified image and hotspot coordinates.

Parameters

image:Image: the image
hotspotX:double: the X coordinate of the cursor's hot spot
hotspotY:double: the Y coordinate of the cursor's hot spot

Method Detail

activate back to summary

activate	back to summary
pack-priv void activate() Overrides javafx.scene.Cursor.activate. Doc from javafx.scene.Cursor.activate. Activates the cursor. Cursor should be activated to make sure that the `getCurrentFrame` returns up-to date values. Annotations @Override

pack-priv void activate()

Overrides javafx.scene.Cursor.activate.

Doc from javafx.scene.Cursor.activate.

Activates the cursor. Cursor should be activated to make sure that the getCurrentFrame returns up-to date values.

Annotations

@Override

bindImage	back to summary
private void bindImage(final Image toImage)

chooseBestCursor back to summary

chooseBestCursor	back to summary
public static ImageCursor chooseBestCursor(final Image[] images, final double hotspotX, final double hotspotY) 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:Image[] a sequence of images from which to choose, in order of preference hotspotX:double the X coordinate of the hotspot within the first image in the images sequence hotspotY:double the Y coordinate of the hotspot within the first image in the images sequence Returns:ImageCursor a cursor created from the best image

public static ImageCursor chooseBestCursor(final Image[] images, final double hotspotX, final double hotspotY)

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:Image[]: a sequence of images from which to choose, in order of preference
hotspotX:double: the X coordinate of the hotspot within the first image in the images sequence
hotspotY:double: the Y coordinate of the hotspot within the first image in the images sequence

Returns:ImageCursor

a cursor created from the best image

deactivate	back to summary
pack-priv void deactivate() Overrides javafx.scene.Cursor.deactivate. Doc from javafx.scene.Cursor.deactivate. Deactivates the cursor. Cursor should be deactivated, when no longer in use to make it collectible by GC. Annotations @Override

deactivate

back to summary

pack-priv void deactivate()

Overrides javafx.scene.Cursor.deactivate.

Doc from javafx.scene.Cursor.deactivate.

Deactivates the cursor. Cursor should be deactivated, when no longer in use to make it collectible by GC.

Annotations

@Override

findBestImage	back to summary
private static Image findBestImage(final Image[] images)

getBestSize	back to summary
public static Dimension2D getBestSize(double preferredWidth, double preferredHeight) 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:double the preferred width of the cursor preferredHeight:double the preferred height of the cursor Returns:Dimension2D the supported cursor size

getBestSize

back to summary

public static Dimension2D getBestSize(double preferredWidth, double preferredHeight)

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:double: the preferred width of the cursor
preferredHeight:double: the preferred height of the cursor

Returns:Dimension2D

the supported cursor size

getCurrentFrame	back to summary
pack-priv CursorFrame getCurrentFrame() Implements abstract javafx.scene.Cursor.getCurrentFrame. Annotations @Override

getCurrentFrame

back to summary

pack-priv CursorFrame getCurrentFrame()

Implements abstract javafx.scene.Cursor.getCurrentFrame.

Annotations

@Override

getHotspotX	back to summary
public final double getHotspotX()

getHotspotY	back to summary
public final double getHotspotY()

getImage	back to summary
public final Image getImage()

getImageListener	back to summary
private InvalidationListener getImageListener()

getMaximumColors	back to summary
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:int the maximum number of colors supported in a custom image cursor palette

getMaximumColors

back to summary

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:int: the maximum number of colors supported in a custom image cursor palette

hotspotXProperty	back to summary
public final ReadOnlyDoubleProperty hotspotXProperty()

hotspotXPropertyImpl	back to summary
private ImageCursor.DoublePropertyImpl hotspotXPropertyImpl()

hotspotYProperty	back to summary
public final ReadOnlyDoubleProperty hotspotYProperty()

hotspotYPropertyImpl	back to summary
private ImageCursor.DoublePropertyImpl hotspotYPropertyImpl()

imageProperty	back to summary
public final ReadOnlyObjectProperty<Image> imageProperty()

imagePropertyImpl	back to summary
private ImageCursor.ObjectPropertyImpl<Image> imagePropertyImpl()

initialize	back to summary
private void initialize(final Image[] images, final double hotspotX, final double hotspotY)

initialize	back to summary
private void initialize(Image newImage, double newHotspotX, double newHotspotY)

invalidateCurrentFrame	back to summary
private void invalidateCurrentFrame()

needsDelayedInitialization	back to summary
private static boolean needsDelayedInitialization(final Image[] images)

unbindImage	back to summary
private void unbindImage(final Image fromImage)

javafx.scene back to summary

private final Class ImageCursor.DelayedInitialization

Class Inheritance

extends Object
implements InvalidationListener

java.lang.Object
javafx.scene.ImageCursor.DelayedInitialization

All Implemented Interfaces

javafx.beans.InvalidationListener

Field Summary

Modifier and Type	Field and Description
private final double	hotspotX
private final double	hotspotY
private final Image[]	images
private final boolean	initAsSingle
private final ImageCursor	targetCursor
private int	waitForImages

Constructor Summary

Access	Constructor and Description
private	DelayedInitialization(final ImageCursor targetCursor, final Image[] images, final double hotspotX, final double hotspotY, final boolean initAsSingle)

Method Summary

Modifier and Type	Method and Description
public static void	applyTo(final ImageCursor imageCursor, final Image[] images, final double hotspotX, final double hotspotY)
public static void	applyTo(final ImageCursor imageCursor, final Image image, final double hotspotX, final double hotspotY)
private void	cleanupAndFinishInitialization()
public void	invalidated(Observable The `Observable` that became invalid valueModel) Implements javafx.beans.InvalidationListener.invalidated. This method needs to be provided by an implementation of `InvalidationListener`.
private void	start()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

hotspotX	back to summary
private final double hotspotX

hotspotY	back to summary
private final double hotspotY

images	back to summary
private final Image[] images

initAsSingle	back to summary
private final boolean initAsSingle

targetCursor	back to summary
private final ImageCursor targetCursor

waitForImages	back to summary
private int waitForImages

Constructor Detail

DelayedInitialization	back to summary
private DelayedInitialization(final ImageCursor targetCursor, final Image[] images, final double hotspotX, final double hotspotY, final boolean initAsSingle)

Method Detail

applyTo	back to summary
public static void applyTo(final ImageCursor imageCursor, final Image[] images, final double hotspotX, final double hotspotY)

applyTo	back to summary
public static void applyTo(final ImageCursor imageCursor, final Image image, final double hotspotX, final double hotspotY)

cleanupAndFinishInitialization	back to summary
private void cleanupAndFinishInitialization()

invalidated back to summary

public void invalidated(Observable valueModel)

Implements javafx.beans.InvalidationListener.invalidated.

Doc from javafx.beans.InvalidationListener.invalidated.

This method needs to be provided by an implementation of InvalidationListener. It is called if an Observable becomes invalid.

In general, it is considered bad practice to modify the observed value in this method.

Parameters

valueModel:Observable: The Observable that became invalid

Annotations

@Override

start	back to summary
private void start()

javafx.scene back to summary

private final Class ImageCursor.DoublePropertyImpl

Class Inheritance

extends ReadOnlyDoublePropertyBase

java.lang.Object
javafx.beans.binding.NumberExpressionBase
javafx.beans.binding.DoubleExpression
javafx.beans.property.ReadOnlyDoubleProperty
javafx.beans.property.ReadOnlyDoublePropertyBase
javafx.scene.ImageCursor.DoublePropertyImpl

Field Summary

Modifier and Type	Field and Description
private final String	name
private double	value

Constructor Summary

Access	Constructor and Description
public	DoublePropertyImpl(final String name)

Method Summary

Modifier and Type	Method and Description
public void	fireValueChangedEvent() Overrides javafx.beans.property.ReadOnlyDoublePropertyBase.fireValueChangedEvent. Sends notifications to all attached `InvalidationListeners` and `ChangeListeners`.
public double	get() Implements javafx.beans.value.ObservableDoubleValue.get. Returns the current value of this `ObservableDoubleValue`.
public Object	getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property.
public String	getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property.
public void	store(final double value)

Inherited from javafx.beans.property.ReadOnlyDoublePropertyBase:: addListener addListener removeListener removeListener

Field Detail

name	back to summary
private final String name

value	back to summary
private double value

Constructor Detail

DoublePropertyImpl	back to summary
public DoublePropertyImpl(final String name)

Method Detail

fireValueChangedEvent back to summary

public void fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyDoublePropertyBase.fireValueChangedEvent.

Doc from javafx.beans.property.ReadOnlyDoublePropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method needs to be called, if the value of this property changes.

Annotations

@Override

get back to summary

public double get()

Implements javafx.beans.value.ObservableDoubleValue.get.

Doc from javafx.beans.value.ObservableDoubleValue.get.

Returns the current value of this ObservableDoubleValue.

Returns:double

The current value

Annotations

@Override

getBean back to summary

public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Returns:Object

the containing Object or null

Annotations

@Override

getName back to summary

public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Returns:String

the name or an empty String

Annotations

@Override

store	back to summary
public void store(final double value)

javafx.scene back to summary

private final Class ImageCursor.ObjectPropertyImpl<T>

Class Inheritance

extends ReadOnlyObjectPropertyBase<T>

java.lang.Object
javafx.beans.binding.ObjectExpression
javafx.beans.property.ReadOnlyObjectProperty
javafx.beans.property.ReadOnlyObjectPropertyBase
javafx.scene.ImageCursor.ObjectPropertyImpl

Field Summary

Modifier and Type	Field and Description
private final String	name
private T	value

Constructor Summary

Access	Constructor and Description
public	ObjectPropertyImpl(final String name)

Method Summary

Modifier and Type	Method and Description
public void	fireValueChangedEvent() Overrides javafx.beans.property.ReadOnlyObjectPropertyBase.fireValueChangedEvent. Sends notifications to all attached `InvalidationListeners` and `ChangeListeners`.
public T	get() Implements javafx.beans.value.ObservableObjectValue.get. Returns the current value of this `ObservableObjectValue<T>`.
public Object	getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property.
public String	getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property.
public void	store(final T value)

Inherited from javafx.beans.property.ReadOnlyObjectPropertyBase:: addListener addListener removeListener removeListener

Field Detail

name	back to summary
private final String name

value	back to summary
private T value

Constructor Detail

ObjectPropertyImpl	back to summary
public ObjectPropertyImpl(final String name)

Method Detail

fireValueChangedEvent back to summary

public void fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyObjectPropertyBase.fireValueChangedEvent.

Doc from javafx.beans.property.ReadOnlyObjectPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method needs to be called, if the value of this property changes.

Annotations

@Override

get back to summary

public T get()

Implements javafx.beans.value.ObservableObjectValue.get.

Doc from javafx.beans.value.ObservableObjectValue.get.

Returns the current value of this ObservableObjectValue<T>.

Returns:T

The current value

Annotations

@Override

getBean back to summary

public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Returns:Object

the containing Object or null

Annotations

@Override

getName back to summary

public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Returns:String

the name or an empty String

Annotations

@Override

store	back to summary
public void store(final T value)

public Class ImageCursor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ImageCursor.DelayedInitialization

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ImageCursor.DoublePropertyImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ImageCursor.ObjectPropertyImpl<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail