javafx.scene

Класс 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 — изображение

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

© 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

ImageCursor

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

getImage

imageProperty

getHotspotX

hotspotXProperty

getHotspotY

hotspotYProperty

getBestSize

getMaximumColors

chooseBestCursor