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));
 
```
С момента:

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()
```
  Координата X горячей точки курсора. Эта горячая точка представляет положение внутри изображения курсора, которое будет отображаться в позиции мыши. Должно быть в диапазоне [0,image.width-1]. Значение меньше 0 будет установлено в 0. Значение больше image.width-1 будет установлено в image.width-1.
  
  Значение по умолчанию:
  
  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()
```
  Координата Y горячей точки курсора. Эта горячая точка представляет положение внутри изображения курсора, которое будет отображаться в позиции мыши. Должно быть в диапазоне [0,image.height-1]. Значение меньше 0 будет установлено в 0. Значение больше image.height-1 будет установлено в image.height-1.
  
  Значение по умолчанию:
  
  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.

Класс ImageCursor

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

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

Поля, унаследованные от класса javafx.scene.Cursor

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

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

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

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

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

image

hotspotX

hotspotY

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

ImageCursor

ImageCursor

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

getImage

imageProperty

getHotspotX

hotspotXProperty

getHotspotY

hotspotYProperty

getBestSize

getMaximumColors

chooseBestCursor