Класс 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

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

Тип	Свойство	Описание
`final ReadOnlyDoubleProperty`	`hotspotX`	Координата X точки привязки курсора.
`final ReadOnlyDoubleProperty`	`hotspotY`	Координата Y точки привязки курсора.
`final 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)`	Возвращает размер курсора, наиболее близкий к указанному предпочтительному размеру.
`final double`	`getHotspotX()`	Возвращает значение свойства `hotspotX`.
`final double`	`getHotspotY()`	Возвращает значение свойства `hotspotY`.
`final Image`	`getImage()`	Возвращает значение свойства `image`.
`static int`	`getMaximumColors()`	Возвращает максимальное количество цветов, поддерживаемых палитрой пользовательского курсора.
`final ReadOnlyDoubleProperty`	`hotspotXProperty()`	Координата X точки привязки курсора.
`final ReadOnlyDoubleProperty`	`hotspotYProperty()`	Координата Y точки привязки курсора.
`final 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

См. также:

hotspotX

public final ReadOnlyDoubleProperty hotspotXProperty

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

Значение по умолчанию:

См. также:

hotspotY

public final ReadOnlyDoubleProperty hotspotYProperty

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

Значение по умолчанию:

См. также:

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

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

Возвращает:

значение свойства image

См. также:

imageProperty

public final ReadOnlyObjectProperty<Image> imageProperty()

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

Значение по умолчанию:

null

Возвращает:

свойство image

См. также:

getHotspotX

public final double getHotspotX()

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

Описание свойства:

Значение по умолчанию:

Возвращает:

значение свойства hotspotX

См. также:

hotspotXProperty

public final ReadOnlyDoubleProperty hotspotXProperty()

Значение по умолчанию:

Возвращает:

свойство hotspotX

См. также:

getHotspotY

public final double getHotspotY()

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

Описание свойства:

Значение по умолчанию:

Возвращает:

значение свойства hotspotY

См. также:

hotspotYProperty

public final ReadOnlyDoubleProperty hotspotYProperty()

Значение по умолчанию:

Возвращает:

свойство hotspotY

См. также:

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 точки привязки внутри первого изображения в последовательности изображений; hotspotY - координата Y точки привязки внутри первого изображения в последовательности изображений
Возвращает:: курсор, созданный из лучшего изображения

© 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.