Класс Image

java.lang.Object

fx.scene.image.Image

Прямые известные подклассы:: WritableImage

public class Image extends Object

Класс Image представляет графические изображения и используется для загрузки изображений из указанного URL-адреса.

Поддерживаемые форматы изображений:

Изображения могут быть изменены в размерах во время загрузки (например, для уменьшения потребления памяти). Приложение может указать качество фильтрации, используемой при масштабировании, и сохранить или нет исходные пропорции изображения.

Если строка URL передается в конструктор, она может быть любой из следующих:

имя ресурса, которое может быть разрешено контекстом ClassLoader для данного потока
путь к файлу, который может быть разрешен с помощью File
URL, который может быть разрешен с помощью URL и для которого существует обработчик протокола

Схема URL "data" из RFC 2397 поддерживается дополнительно к обработчикам протоколов, зарегистрированным для приложения. Если URL использует схему "data", данные должны быть закодированы в base64, а тип MIME должен быть подтипом типа image. Тип MIME должен соответствовать формату изображения данных, содержащихся в URL. В случае несовпадения между типом MIME и форматом изображения, изображение будет загружено, если формат изображения может быть определен JavaFX, и будет зарегистрировано предупреждение.

Используйте ImageView для отображения загруженных с помощью этого класса изображений. Один и тот же экземпляр Image может быть отображён несколькими экземплярами ImageView.

Пример кода для загрузки изображений:

import javafx.scene.image.Image;

// load an image in background, displaying a placeholder while it's loading
// (assuming there's an ImageView node somewhere displaying this image)
// The image is located in default package of the classpath
Image image1 = new Image("/flower.png", true);

// load an image and resize it to 100x150 without preserving its original
// aspect ratio
// The image is located in my.res package of the classpath
Image image2 = new Image("my/res/flower.png", 100, 150, false, false);

// load an image and resize it to width of 100 while preserving its
// original aspect ratio, using faster filtering method
// The image is downloaded from the supplied URL through http protocol
Image image3 = new Image("http://sample.com/res/flower.png", 100, 0, false, false);

// load an image and resize it only in one dimension, to the height of 100 and
// the original width, without preserving original aspect ratio
// The image is located in the current working directory
Image image4 = new Image("file:flower.png", 0, 100, false, false);

С:: JavaFX 2.0

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

Тип	Свойство	Описание
`final ReadOnlyBooleanProperty`	`error`	Указывает, было ли обнаружено какое-либо ошибку при загрузке изображения.
`final ReadOnlyObjectProperty<Exception>`	`exception`	Исключение, которое привело к сбою загрузки изображения.
`final ReadOnlyDoubleProperty`	`height`	Высота изображения или `0`, если произошел сбой загрузки изображения.
`final ReadOnlyDoubleProperty`	`progress`	Приблизительный процент завершенности загрузки изображения.
`final ReadOnlyDoubleProperty`	`width`	Ширина изображения или `0`, если произошел сбой загрузки изображения.

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

Конструктор	Описание
`Image(InputStream is)`	Создает `Image` с содержимым, загруженным из указанного потока ввода.
`Image(InputStream is, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)`	Создает новый `Image` с указанными параметрами.
`Image(String url)`	Создает `Image` с содержимым, загруженным с указанного URL.
`Image(String url, boolean backgroundLoading)`	Создает `Image` с содержимым, загруженным с указанного URL с указанными параметрами.
`Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)`	Создает `Image` с содержимым, загруженным с указанного URL с указанными параметрами.
`Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth, boolean backgroundLoading)`	Создает `Image` с содержимым, загруженным с указанного URL с указанными параметрами.

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

Модификатор и тип	Метод	Описание
`void`	`cancel()`	Отменяет фоновую загрузку этого изображения.
`final ReadOnlyBooleanProperty`	`errorProperty()`	Указывает, было ли обнаружено какое-либо ошибку при загрузке изображения.
`final ReadOnlyObjectProperty<Exception>`	`exceptionProperty()`	Исключение, которое привело к сбою загрузки изображения.
`final Exception`	`getException()`	Возвращает значение свойства `exception`.
`final double`	`getHeight()`	Возвращает значение свойства `height`.
`final PixelReader`	`getPixelReader()`	Этот метод возвращает `PixelReader`, который предоставляет доступ для чтения пикселей изображения, если изображение доступно для чтения.
`final double`	`getProgress()`	Возвращает значение свойства `progress`.
`final double`	`getRequestedHeight()`	Возвращает высоту ограничивающей рамки, в рамках которой исходное изображение масштабируется, если необходимо, для размещения.
`final double`	`getRequestedWidth()`	Возвращает ширину ограничивающей рамки, в рамках которой исходное изображение масштабируется, если необходимо, для размещения.
`final String`	`getUrl()`	Возвращает URL, используемый для получения данных пикселей, содержащихся в экземпляре Image, если он был указан в конструкторе.
`final double`	`getWidth()`	Возвращает значение свойства `width`.
`final ReadOnlyDoubleProperty`	`heightProperty()`	Высота изображения или `0`, если произошел сбой загрузки изображения.
`final boolean`	`isBackgroundLoading()`	Указывает, загружается ли изображение в фоновом режиме.
`final boolean`	`isError()`	Возвращает значение свойства `error`.
`final boolean`	`isPreserveRatio()`	Указывает, следует ли сохранять пропорции исходного изображения при масштабировании для размещения изображения в рамках ограничивающей рамки, заданной `width` и `height`.
`final boolean`	`isSmooth()`	Указывает, следует ли использовать алгоритм фильтрации с более высоким качеством или более быстрый при масштабировании этого изображения для размещения в рамках ограничивающей рамки, заданной `width` и `height`.
`final ReadOnlyDoubleProperty`	`progressProperty()`	Приблизительный процент завершенности загрузки изображения.
`final ReadOnlyDoubleProperty`	`widthProperty()`	Ширина изображения или `0`, если произошел сбой загрузки изображения.

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

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

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

progress

public final ReadOnlyDoubleProperty progressProperty

Приблизительный процент завершенной загрузки изображения. Положительное значение от 0 до 1, где 0 — 0%, а 1 — 100%.

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

См. также:

getProgress()
progressProperty()

width

public final ReadOnlyDoubleProperty widthProperty

Ширина изображения или 0 в случае сбоя загрузки изображения. Во время загрузки изображения она устанавливается в значение 0.

См. также:

getWidth()
widthProperty()

height

public final ReadOnlyDoubleProperty heightProperty

Высота изображения или 0 в случае сбоя загрузки изображения. Во время загрузки изображения она устанавливается в значение 0.

См. также:

getHeight()
heightProperty()

error

public final ReadOnlyBooleanProperty errorProperty

Указывает, было ли обнаружено какое-либо ошибку при загрузке изображения.

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

false

См. также:

isError()
errorProperty()

exception

public final ReadOnlyObjectProperty<Exception> exceptionProperty

Исключение, которое вызвало сбой загрузки изображения. Содержит ненулевое значение только если свойство error установлено в true.

С:

JavaFX 8.0

См. также:

getException()
exceptionProperty()

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

Image

public Image(String url)

Создает Image с содержимым, загруженным из указанного URL.

Параметры:: url - путь к ресурсу, путь к файлу или URL
Исключения:: NullPointerException - если url равно null; IllegalArgumentException - если url недействителен или не поддерживается

Image

public Image(String url, boolean backgroundLoading)

Создает Image с содержимым, загруженным из указанного URL с использованием указанных параметров.

Параметры:: url - путь к ресурсу, путь к файлу или URL; backgroundLoading - указывает, загружается ли изображение в фоновом режиме
Исключения:: NullPointerException - если url равно null; IllegalArgumentException - если url недействителен или не поддерживается

Image

public Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)

Создаёт Image с содержимым, загруженным из указанного URL с использованием указанных параметров.

Параметры:: url - путь к ресурсу, путь к файлу или URL; requestedWidth - ширина области обрезки изображения; requestedHeight - высота области обрезки изображения; preserveRatio - указывает, сохранять ли пропорции исходного изображения при масштабировании для помещения изображения в указанную область обрезки; smooth - указывает, использовать ли алгоритм фильтрации лучшего качества или более быстрый алгоритм при масштабировании этого изображения для помещения его в указанную область обрезки
Исключения:: NullPointerException - если url равно null; IllegalArgumentException - если url недействителен или не поддерживается

Image

public Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth, boolean backgroundLoading)

Создаёт Image с содержимым, загруженным из указанного URL с использованием указанных параметров.

Параметры:: url - путь к ресурсу, путь к файлу или URL; requestedWidth - ширина области обрезки изображения; requestedHeight - высота области обрезки изображения; preserveRatio - указывает, сохранять ли пропорции исходного изображения при масштабировании для помещения изображения в указанную область обрезки; smooth - указывает, использовать ли алгоритм фильтрации лучшего качества или более быстрый алгоритм при масштабировании этого изображения для помещения его в указанную область обрезки; backgroundLoading - указывает, загружается ли изображение в фоновом режиме
Исключения:: NullPointerException - если url равно null; IllegalArgumentException - если url недействителен или не поддерживается

Image

public Image(InputStream is)

Создаёт Image с содержимым, загруженным из указанного потока ввода.

Параметры:: is - поток ввода, из которого загрузить изображение
Исключения:: NullPointerException - если поток ввода null

Image

public Image(InputStream is, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)

Создает новый Image с указанными параметрами.

Параметры:: is - поток ввода, из которого загрузить изображение; requestedWidth - ширина области обрезки изображения; requestedHeight - высота области обрезки изображения; preserveRatio - указывает, сохранять ли пропорции исходного изображения при масштабировании для помещения изображения в указанную область обрезки; smooth - указывает, использовать ли алгоритм фильтрации лучшего качества или более быстрый алгоритм при масштабировании этого изображения для помещения его в указанную область обрезки
Исключения:: NullPointerException - если поток ввода null

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

getUrl

public final String getUrl()

Возвращает URL, используемый для получения пиксельных данных, содержащихся в экземпляре Image, если он был указан в конструкторе. Если URL не был предоставлен в конструкторе (например, если Image создан из InputStream), этот метод вернёт null.

Возвращает:: Строка, содержащая URL, используемый для получения пиксельных данных для данного экземпляра Image.
С:: 9

getProgress

public final double getProgress()

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

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

Приблизительный процент завершенной загрузки изображения. Положительное значение от 0 до 1, где 0 — 0%, а 1 — 100%.

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

Возвращает:

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

См. также:

progressProperty()

progressProperty

public final ReadOnlyDoubleProperty progressProperty()

Приблизительный процент завершенной загрузки изображения. Положительное значение от 0 до 1, где 0 — 0%, а 1 — 100%.

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

Возвращает:

свойство progress

См. также:

getProgress()

getRequestedWidth

public final double getRequestedWidth()

Получает ширину области обрезки, в пределах которой исходное изображение масштабируется по мере необходимости для размещения. Если задано значение <= 0, используется внутренняя ширина изображения.

См. preserveRatio для получения информации о взаимодействии свойств изображения requestedWidth, requestedHeight и preserveRatio.

Возвращает:: Запрошенная ширина

getRequestedHeight

public final double getRequestedHeight()

Получает высоту области обрезки, в пределах которой исходное изображение масштабируется по мере необходимости для размещения. Если задано значение <= 0, используется внутренняя высота изображения.

См. preserveRatio для получения информации о взаимодействии свойств изображения requestedWidth, requestedHeight и preserveRatio.

Возвращает:: Запрошенная высота

getWidth

public final double getWidth()

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

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

Возвращает:

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

См. также:

widthProperty()

widthProperty

public final ReadOnlyDoubleProperty widthProperty()

Возвращает:

свойство width

См. также:

getWidth()

getHeight

public final double getHeight()

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

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

Высота изображения или 0, если загрузка изображения завершилась ошибкой. Во время загрузки изображения оно устанавливается в 0.

Возвращает:

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

См. также:

heightProperty()

heightProperty

public final ReadOnlyDoubleProperty heightProperty()

Возвращает:

свойство height

См. также:

getHeight()

isPreserveRatio

public final boolean isPreserveRatio()

Указывает, нужно ли сохранять соотношение сторон исходного изображения при масштабировании, чтобы изображение поместилось в область, заданную width и height.

Если установлено в true, это влияет на размеры этого Image следующим образом:

Если установлено только width, высота масштабируется для сохранения соотношения сторон
Если установлена только height, ширина масштабируется для сохранения соотношения сторон
Если оба установлены, оба могут быть масштабированы для наилучшего соответствия прямоугольнику шириной по высоте, сохраняя при этом исходное соотношение сторон

Сообщенные width и height могут отличаться от первоначально заданных значений, если их нужно было скорректировать для сохранения соотношения сторон. Если не задано или установлено в false, это влияет на размеры этого ImageView следующим образом:

Если установлена только width, ширина изображения масштабируется для соответствия, а высота остается неизменной
Если установлена только height, высота изображения масштабируется для соответствия, а ширина остается неизменной
Если оба установлены, изображение масштабируется для соответствия обоим размерам.

Возвращает:: true, если соотношение сторон исходного изображения должно сохраняться при масштабировании для помещения изображения в область, заданную width и height.

isSmooth

public final boolean isSmooth()

Указывает, использовать ли алгоритм фильтрации лучшего качества или более быстрый при масштабировании этого изображения для помещения его в область, заданную width и height.

Если не инициализировано или установлено в true, будет использоваться фильтрация лучшего качества, в противном случае — более быстрая, но с меньшим качеством.

Возвращает:: true, если для масштабирования для помещения в область, заданную width и height, используется алгоритм фильтрации лучшего качества (но медленнее).

isBackgroundLoading

public final boolean isBackgroundLoading()

Указывает, загружается ли изображение в фоновом режиме.

Возвращает:: true, если изображение загружается в фоновом режиме

isError

public final boolean isError()

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

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

Указывает, была ли обнаружена ошибка при загрузке изображения.

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

false

Возвращает:

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

См. также:

errorProperty()

errorProperty

public final ReadOnlyBooleanProperty errorProperty()

Указывает, была ли обнаружена ошибка при загрузке изображения.

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

false

Возвращает:

свойство error

См. также:

isError()

getException

public final Exception getException()

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

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

Исключение, которое привело к ошибке загрузки изображения. Содержит ненулевое значение только в том случае, если свойство error установлено в true.

Возвращает:

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

С момента:

JavaFX 8.0

См. также:

exceptionProperty()

exceptionProperty

public final ReadOnlyObjectProperty<Exception> exceptionProperty()

Возвращает:

свойство exception

С момента:

JavaFX 8.0

См. также:

getException()

cancel

public void cancel()

Отменяет фоновую загрузку этого изображения.

Не имеет эффекта, если это изображение не загружается в фоновом режиме или если загрузка уже завершена.

getPixelReader

public final PixelReader getPixelReader()

Этот метод возвращает PixelReader, который предоставляет доступ для чтения пикселей изображения, если изображение доступно для чтения. Если этот метод возвращает null, это изображение в данный момент не поддерживает чтение. Этот метод вернет null, если изображение загружается из источника и все еще не завершено (прогресс все еще <1.0) или если произошла ошибка. Этот метод также может вернуть null для некоторых изображений в формате, который не поддерживает чтение и запись пикселей.

Возвращает:: PixelReader для чтения пиксельных данных изображения
С момента:: JavaFX 2.2

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