javafx.scene.image

Класс Image

java.lang.Object

javafx.scene.image.Image

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

public class Image
extends Object

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

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

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

Все URL-адреса, поддерживаемые URL, могут быть переданы в конструктор. Если переданная строка не является допустимым URL-адресом, а является путем, то изображение ищется в классе.

Для отображения загруженных с помощью этого класса изображений используйте 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

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

Все методыМетоды экземпляровКонкретные методы
Тип	Свойство и описание
`ReadOnlyBooleanProperty`	`error` Указывает, была ли обнаружена ошибка при загрузке изображения.
`ReadOnlyObjectProperty<Exception>`	`exception` Исключение, вызвавшее сбой загрузки изображения.
`ReadOnlyDoubleProperty`	`height` Высота изображения или `0`, если загрузка изображения завершилась ошибкой.
`ReadOnlyDoubleProperty`	`progress` Приблизительный процент завершенной загрузки изображения.
`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` со значениями указанных параметров.
`Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)` Создаёт новый экземпляр `Image` со значениями указанных параметров.
`Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth, boolean backgroundLoading)` Создаёт новый экземпляр `Image` со значениями указанных параметров.

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

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

Подробное описание конструкторов
- Image
```
public Image(String url)
```
  Создает объект Image с содержимым, загруженным из указанного URL.
  
  Параметры:
  
  url - строка, представляющая URL для получения данных пикселей
  
  Исключения:
  
  NullPointerException - если URL равен null
  
  См. также:
  
  Image(java.lang.String, java.io.InputStream, double, double, boolean, boolean, boolean)
- Image
```
public Image(String url,
             boolean backgroundLoading)
```
  Создает новый объект Image со специфицированными параметрами.
  
  Параметры:
  
  url - строка, представляющая URL для получения данных пикселей
  
  Исключения:
  
  NullPointerException - если URL равен null
  
  См. также:
  
  Image(java.lang.String, java.io.InputStream, double, double, boolean, boolean, boolean)
- Image
```
public Image(String url,
             double requestedWidth,
             double requestedHeight,
             boolean preserveRatio,
             boolean smooth)
```
  Создает новый объект Image со специфицированными параметрами.
  
  Параметры:
  
  url - строка, представляющая URL для получения данных пикселей
  
  Исключения:
  
  NullPointerException - если URL равен null
  
  См. также:
  
  Image(java.lang.String, java.io.InputStream, double, double, boolean, boolean, boolean)
- Image
```
public Image(String url,
             double requestedWidth,
             double requestedHeight,
             boolean preserveRatio,
             boolean smooth,
             boolean backgroundLoading)
```
  Создает новый объект Image со специфицированными параметрами. url без схемы обрабатывается как относительный к classpath, url со схемой обрабатывается соответственно схеме с использованием URL.openStream()
  
  Параметры:
  
  url - строка, представляющая URL для получения данных пикселей
  
  Исключения:
  
  NullPointerException - если URL равен null
- Image
```
public Image(InputStream is)
```
  Создает объект Image с содержимым, загруженным из указанного потока.
  
  Параметры:
  
  is - поток, из которого нужно загрузить изображение
  
  Исключения:
  
  NullPointerException - если поток равен null
- Image
```
public Image(InputStream is,
             double requestedWidth,
             double requestedHeight,
             boolean preserveRatio,
             boolean smooth)
```
  Создаёт новый объект Image со специфицированными параметрами.
  
  Параметры:
  
  is - поток, из которого нужно загрузить изображение
  
  Исключения:
  
  NullPointerException - если поток равен null

Подробное описание методов
- getProgress
```
public final double getProgress()
```
  Получает значение свойства progress.
  
  Описание свойства:
  
  Приблизительный процент завершенной загрузки изображения. Положительное значение между 0 и 1, где 0 соответствует 0%, а 1 — 100%.
  
  Значение по умолчанию:
  
  0
- progressProperty
```
public final ReadOnlyDoubleProperty progressProperty()
```
  Приблизительный процент завершенной загрузки изображения. Положительное значение между 0 и 1, где 0 соответствует 0%, а 1 — 100%.
  
  Значение по умолчанию:
  
  0
  
  См. также:
  
  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.
  
  Описание свойства:
  
  Ширина изображения или 0 в случае ошибки загрузки изображения. Во время загрузки изображения устанавливается значение 0.
- widthProperty
```
public final ReadOnlyDoubleProperty widthProperty()
```
  Ширина изображения или 0 в случае ошибки загрузки изображения. Во время загрузки изображения устанавливается значение 0.
  
  См. также:
  
  getWidth()
- getHeight
```
public final double getHeight()
```
  Получает значение свойства height.
  
  Описание свойства:
  
  Высота изображения или 0 в случае ошибки загрузки изображения. Во время загрузки изображения устанавливается значение 0.
- heightProperty
```
public final ReadOnlyDoubleProperty heightProperty()
```
  Высота изображения или 0 в случае ошибки загрузки изображения. Во время загрузки изображения устанавливается значение 0.
  
  См. также:
  
  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
- errorProperty
```
public final ReadOnlyBooleanProperty errorProperty()
```
  Указывает, была ли обнаружена ошибка при загрузке изображения.
  
  Значение по умолчанию:
  
  false
  
  См. также:
  
  isError()
- getException
```
public final Exception getException()
```
  Получает значение свойства exception.
  
  Описание свойства:
  
  Исключение, которое привело к ошибке загрузки изображения. Содержит ненулевое значение только в том случае, если свойство error установлено в значение true.
  
  С момента:
  
  JavaFX 8.0
- exceptionProperty
```
public final ReadOnlyObjectProperty<Exception> exceptionProperty()
```
  Исключение, которое привело к ошибке загрузки изображения. Содержит ненулевое значение только в том случае, если свойство error установлено в значение true.
  
  С момента:
  
  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.

Класс Image

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

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

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

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

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

progress

width

height

error

exception

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

Image

Image

Image

Image

Image

Image

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

getProgress

progressProperty

getRequestedWidth

getRequestedHeight

getWidth

widthProperty

getHeight

heightProperty

isPreserveRatio

isSmooth

isBackgroundLoading

isError

errorProperty

getException

exceptionProperty

cancel

getPixelReader