Класс ImageCursor

java.lang.Object

javafx.scene.Cursor

javafx.scene.ImageCursor

public class ImageCursor
extends Cursor

Настраиваемое изображение курсора мыши. На платформах, не поддерживающих настраиваемые курсоры, Cursor.DEFAULT будет использоваться вместо указанного ImageCursor.

Пример:

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

Краткое описание свойств

Свойства
Тип	Свойство	Описание
`ReadOnlyDoubleProperty`	`hotspotX`	Координата X точки привязки курсора.
`ReadOnlyDoubleProperty`	`hotspotY`	Координата Y точки привязки курсора.
`ReadOnlyObjectProperty<Image>`	`image`	Изображение, отображаемое при активном курсоре.

Краткое описание полей

Поля, объявленные в классе javafx.scene.Cursor

CLOSED_HAND, CROSSHAIR, DEFAULT, DISAPPEAR, E_RESIZE, H_RESIZE, HAND, MOVE, N_RESIZE, NE_RESIZE, NONE, NW_RESIZE, OPEN_HAND, S_RESIZE, SE_RESIZE, SW_RESIZE, TEXT, V_RESIZE, W_RESIZE, WAIT

Краткое описание конструкторов

Конструкторы
Конструктор	Описание
`ImageCursor()`	Создаёт новый пустой `ImageCursor`, который будет выглядеть как `Cursor.DEFAULT`.
`ImageCursor(Image image)`	Создаёт `ImageCursor` из указанного изображения.
`ImageCursor(Image image, double hotspotX, double hotspotY)`	Создаёт `ImageCursor` из указанного изображения и координат точки привязки.

Краткое описание методов

Модификатор и тип	Метод	Описание
`static ImageCursor`	`chooseBestCursor(Image[] images, double hotspotX, double hotspotY)`	Создаёт настраиваемый курсор из одного из указанных изображений.
`static Dimension2D`	`getBestSize(double preferredWidth, double preferredHeight)`	Возвращает поддерживаемый размер курсора, наиболее близкий к заданному предпочтительному размеру.
`double`	`getHotspotX()`	Возвращает значение свойства hotspotX.
`double`	`getHotspotY()`	Возвращает значение свойства hotspotY.
`Image`	`getImage()`	Возвращает значение свойства image.
`static int`	`getMaximumColors()`	Возвращает максимальное количество цветов, поддерживаемое палитрой настраиваемого курсора.
`ReadOnlyDoubleProperty`	`hotspotXProperty()`	Координата X точки привязки курсора.
`ReadOnlyDoubleProperty`	`hotspotYProperty()`	Координата Y точки привязки курсора.
`ReadOnlyObjectProperty<Image>`	`imageProperty()`	Изображение, отображаемое при активном курсоре.

Методы, объявленные в классе javafx.scene.Cursor

cursor, toString

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробности свойства

image

public final ReadOnlyObjectProperty<Image> imageProperty

Изображение, отображаемое при активном курсоре. Если изображение равно null, Cursor.DEFAULT будет использоваться.

Значение по умолчанию:: null
См. также:: getImage()

hotspotX

public final ReadOnlyDoubleProperty hotspotXProperty

Координата X горячей точки курсора. Эта горячая точка представляет собой положение в изображении курсора, которое будет отображаться в позиции мыши. Она должна быть в диапазоне [0,image.width-1]. Значение меньше 0 будет установлено в 0. Значение больше image.width-1 будет установлено в image.width-1.

Значение по умолчанию:: 0
См. также:: getHotspotX()

hotspotY

public final ReadOnlyDoubleProperty hotspotYProperty

Координата Y горячей точки курсора. Эта горячая точка представляет собой положение в изображении курсора, которое будет отображаться в позиции мыши. Она должна быть в диапазоне [0,image.height-1]. Значение меньше 0 будет установлено в 0. Значение больше image.height-1 будет установлено в image.height-1.

Значение по умолчанию:: 0
См. также:: getHotspotY()

Подробности конструктора

ImageCursor

public ImageCursor()

Создаёт новый пустой ImageCursor, который будет выглядеть как Cursor.DEFAULT.

ImageCursor

public ImageCursor(Image image)

Создаёт ImageCursor на основе заданного изображения. Горячая точка курсора будет установлена по умолчанию в верхний левый угол.

Параметры:: image - изображение

ImageCursor

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

Создаёт ImageCursor на основе заданного изображения и координат горячей точки.

Параметры:: image - изображение; hotspotX - координата X горячей точки курсора; hotspotY - координата Y горячей точки курсора

Подробности метода

getImage

public final Image getImage()

Получает значение свойства image.

Описание свойства:: Изображение, отображаемое при активном курсоре. Если изображение равно null, Cursor.DEFAULT будет использоваться.
Значение по умолчанию:: null

imageProperty

public final ReadOnlyObjectProperty<Image> imageProperty()

Изображение, отображаемое при активном курсоре. Если изображение равно null, Cursor.DEFAULT будет использоваться.

Значение по умолчанию:: null
См. также:: getImage()

getHotspotX

public final double getHotspotX()

Получает значение свойства hotspotX.

Описание свойства:: Координата X горячей точки курсора. Эта горячая точка представляет собой положение в изображении курсора, которое будет отображаться в позиции мыши. Она должна быть в диапазоне [0,image.width-1]. Значение меньше 0 будет установлено в 0. Значение больше image.width-1 будет установлено в image.width-1.
Значение по умолчанию:: 0

hotspotXProperty

public final ReadOnlyDoubleProperty hotspotXProperty()

Значение по умолчанию:: 0
См. также:: getHotspotX()

getHotspotY

public final double getHotspotY()

Получает значение свойства hotspotY.

Описание свойства:: Координата Y горячей точки курсора. Эта горячая точка представляет собой положение в изображении курсора, которое будет отображаться в позиции мыши. Она должна быть в диапазоне [0,image.height-1]. Значение меньше 0 будет установлено в 0. Значение больше image.height-1 будет установлено в image.height-1.
Значение по умолчанию:: 0

hotspotYProperty

public final ReadOnlyDoubleProperty hotspotYProperty()

Значение по умолчанию:: 0
См. также:: getHotspotY()

getBestSize

public static Dimension2D getBestSize(double preferredWidth, double preferredHeight)

Получает поддерживаемый размер курсора, наиболее близкий к указанному предпочтительному размеру. Возвращает значение (0,0), если платформа не поддерживает пользовательские курсоры.

Примечание: если используется изображение, размеры которого не соответствуют поддерживаемому размеру (как возвращает этот метод), реализация изменит размер изображения на поддерживаемый размер. Это может привести к потере качества.

Примечание: Эти значения могут различаться в зависимости от операционной системы, графической карты и разрешения экрана, но на момент написания этой статьи образец машины Windows Vista возвращал 32x32 для всех запрашиваемых размеров, в то время как образцы машин Mac и Linux возвращали запрашиваемый размер до максимального значения 64x64. Приложения должны предоставить курсор 32x32, который будет хорошо работать на всех платформах, и могут по желанию предоставить курсор 64x64 для тех платформ, которые его поддерживают.

Параметры:: preferredWidth - предпочтительная ширина курсора; preferredHeight - предпочтительная высота курсора
Возвращает:: поддерживаемый размер курсора

getMaximumColors

public static int getMaximumColors()

Возвращает максимальное количество цветов, поддерживаемых в палитре пользовательского курсора изображения.

Примечание: если используется изображение, палитра которого содержит больше цветов, чем максимальное значение, реализация попытается сжать палитру до максимума. Это может привести к потере качества.

Примечание: Эти значения могут различаться в зависимости от операционной системы, графической карты и разрешения экрана, но на момент написания этой статьи образец машины Windows Vista возвращал 256, образец машины Mac возвращал Integer.MAX_VALUE, указывая на поддержку курсоров с полным цветом, а образец машины Linux возвращал 2. Приложения могут захотеть нацелиться на эти три глубины цвета для оптимального курсора на каждой платформе.

Возвращает:: максимальное количество цветов, поддерживаемых в палитре пользовательского курсора изображения

chooseBestCursor

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

Создаёт пользовательский курсор изображения из одного из указанных изображений. Эта функция выберет изображение, размер которого наиболее точно соответствует оптимальному размеру курсора. hotpotX возвращаемого ImageCursor масштабируется по chosenImage.width/images[0].width, а hotspotY масштабируется по chosenImage.height/images[0].height.

На платформах, которые не поддерживают пользовательские курсоры, Cursor.DEFAULT будет использоваться вместо возвращаемого ImageCursor.

Параметры:: images - последовательность изображений для выбора, в порядке предпочтения; hotspotX - координата X горячей точки внутри первого изображения в последовательности images; hotspotY - координата Y горячей точки внутри первого изображения в последовательности images
Возвращает:: курсор, созданный из лучшего изображения

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.