Spec-Zone.ru › OpenJavaFX 21

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

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

Тип Свойство Описание
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
См. также:
  • getImage()
  • imageProperty()

hotspotX

public final ReadOnlyDoubleProperty hotspotXProperty
Координата X горячей точки курсора. Эта горячая точка представляет собой позицию внутри изображения курсора, которая будет отображаться в позиции мыши. Должно находиться в диапазоне [0,image.width-1]. Значение меньше 0 будет установлено в 0. Значение больше image.width-1 будет установлено в image.width-1.
Значение по умолчанию:
0
См. также:
  • getHotspotX()
  • hotspotXProperty()

hotspotY

public final ReadOnlyDoubleProperty hotspotYProperty
Координата Y горячей точки курсора. Эта горячая точка представляет собой позицию внутри изображения курсора, которая будет отображаться в позиции мыши. Должно находиться в диапазоне [0,image.height-1]. Значение меньше 0 будет установлено в 0. Значение больше image.height-1 будет установлено в image.height-1.
Значение по умолчанию:
0
См. также:
  • getHotspotY()
  • hotspotYProperty()

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

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()

imageProperty

public final ReadOnlyObjectProperty<Image> imageProperty()
Изображение, отображаемое при активном курсоре. Если изображение null, будет использовано Cursor.DEFAULT.
Значение по умолчанию:
null
Возвращает:
свойство image
См. также:
  • getImage()

getHotspotX

public final double getHotspotX()
Возвращает значение свойства hotspotX.
Описание свойства:
Координата X горячей точки курсора. Эта горячая точка представляет собой позицию внутри изображения курсора, которая будет отображаться в позиции мыши. Должно находиться в диапазоне [0,image.width-1]. Значение меньше 0 будет установлено в 0. Значение больше image.width-1 будет установлено в image.width-1.
Значение по умолчанию:
0
Возвращает:
значение свойства hotspotX
См. также:
  • hotspotXProperty()

hotspotXProperty

public final ReadOnlyDoubleProperty hotspotXProperty()
Координата X горячей точки курсора. Эта горячая точка представляет собой позицию внутри изображения курсора, которая будет отображаться в позиции мыши. Должно находиться в диапазоне [0,image.width-1]. Значение меньше 0 будет установлено в 0. Значение больше image.width-1 будет установлено в image.width-1.
Значение по умолчанию:
0
Возвращает:
свойство hotspotX
См. также:
  • getHotspotX()

getHotspotY

public final double getHotspotY()
Возвращает значение свойства hotspotY.
Описание свойства:
Координата Y горячей точки курсора. Эта горячая точка представляет собой позицию внутри изображения курсора, которая будет отображаться в позиции мыши. Должно находиться в диапазоне [0,image.height-1]. Значение меньше 0 будет установлено в 0. Значение больше image.height-1 будет установлено в image.height-1.
Значение по умолчанию:
0
Возвращает:
значение свойства hotspotY
См. также:
  • hotspotYProperty()

hotspotYProperty

public final ReadOnlyDoubleProperty hotspotYProperty()
Координата Y горячей точки курсора. Эта горячая точка представляет собой позицию внутри изображения курсора, которая будет отображаться в позиции мыши. Должно находиться в диапазоне [0,image.height-1]. Значение меньше 0 будет установлено в 0. Значение больше image.height-1 будет установлено в image.height-1.
Значение по умолчанию:
0
Возвращает:
свойство hotspotY
См. также:
  • 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API