Класс ImageIcon

java.lang.Object

javax.swing.ImageIcon

Все реализуемые интерфейсы:: Serializable, Accessible, Icon

public class ImageIcon extends Object implements Icon, Serializable, Accessible

Реализация интерфейса Icon, которая отображает значки из изображений. Изображения, созданные на основе URL, имени файла или массива байтов, предварительно загружаются с помощью MediaTracker для отслеживания состояния загрузки изображения.

Если параметр источника изображения, переданный конструктору или методу, не равен null, но не ссылается на допустимые доступные данные изображения, исключения не будут выброшены, однако изображение не будет отображено, хотя getImage() вернёт ненулевое значение, поскольку у изображения не будет размеров, а getImageLoadStatus() сообщит MediaTracker.ERRORED.

Дополнительные сведения и примеры использования значков изображений см. в разделе Как использовать значки в учебнике Java.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для кратковременного хранения или RMI между приложениями, работающими с одной и той же версией Swing. Начиная с версии 1.4, в пакет java.beans добавлена поддержка долгосрочного хранения всех JavaBeans. См. XMLEncoder.

Начиная с:: 1.2

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`protected class`	`ImageIcon.AccessibleImageIcon`	Этот класс реализует поддержку специальных возможностей для класса `ImageIcon`.

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

Модификатор и тип	Поле	Описание
`protected static final Component`	`component`	Устарело. начиная с версии 1.8
`protected static final MediaTracker`	`tracker`	Устарело. начиная с версии 1.8

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

Конструктор	Описание
`ImageIcon()`	Создаёт неинициализированный значок изображения.
`ImageIcon(byte[] imageData)`	Создаёт ImageIcon из массива байтов, считанных из файла изображения, содержащего поддерживаемый формат изображения, например GIF, JPEG или (начиная с версии 1.3) PNG.
`ImageIcon(byte[] imageData, String description)`	Создаёт ImageIcon из массива байтов, считанных из файла изображения, содержащего поддерживаемый формат изображения, например GIF, JPEG или (начиная с версии 1.3) PNG.
`ImageIcon(Image image)`	Создаёт ImageIcon из объекта изображения.
`ImageIcon(Image image, String description)`	Создаёт ImageIcon из изображения.
`ImageIcon(String filename)`	Создаёт ImageIcon из указанного файла.
`ImageIcon(String filename, String description)`	Создаёт ImageIcon из указанного файла.
`ImageIcon(URL location)`	Создаёт ImageIcon из указанного URL.
`ImageIcon(URL location, String description)`	Создаёт ImageIcon из указанного URL.

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

Модификатор и тип	Метод	Описание
`AccessibleContext`	`getAccessibleContext()`	Возвращает AccessibleContext, связанный с этим ImageIcon.
`String`	`getDescription()`	Возвращает описание изображения.
`int`	`getIconHeight()`	Возвращает высоту значка.
`int`	`getIconWidth()`	Возвращает ширину значка.
`Image`	`getImage()`	Возвращает `Image` этого значка.
`int`	`getImageLoadStatus()`	Возвращает состояние операции загрузки изображения.
`ImageObserver`	`getImageObserver()`	Возвращает наблюдатель изображения.
`protected void`	`loadImage(Image image)`	Загружает изображение и возвращает управление только после завершения загрузки.
`void`	`paintIcon(Component c, Graphics g, int x, int y)`	Отображает значок.
`void`	`setDescription(String description)`	Задаёт описание изображения.
`void`	`setImage(Image image)`	Задаёт изображение, отображаемое этим значком.
`void`	`setImageObserver(ImageObserver observer)`	Задаёт наблюдателя изображения.
`String`	`toString()`	Возвращает строковое представление этого изображения.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект некоторому другому объекту.
`protected void`	`finalize()`	Устарело, подлежит удалению: этот элемент API может быть удалён в будущей версии. Финализация устарела и может быть удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения определённого времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения определённого времени.

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

component

@Deprecated protected static final Component component

Устарело.

начиная с версии 1.8

Не используйте этот общий компонент, предназначенный для отслеживания загрузки изображений. Он оставлен только для обратной совместимости.

tracker

@Deprecated protected static final MediaTracker tracker

Устарело.

начиная с версии 1.8

Не используйте этот общий отслеживатель мультимедиа, предназначенный для загрузки изображений. Он оставлен только для обратной совместимости.

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

ImageIcon

public ImageIcon(String filename, String description)

Создаёт ImageIcon из указанного файла. Изображение будет предварительно загружено с помощью MediaTracker для отслеживания состояния его загрузки.

Параметры:

filename — имя файла, содержащего изображение

description — краткое текстовое описание изображения

См. также:

ImageIcon

@ConstructorProperties("description") public ImageIcon(String filename)

Создаёт ImageIcon из указанного файла. Изображение будет предварительно загружено с помощью MediaTracker для отслеживания состояния его загрузки. Указанная строка может быть именем файла или путём к файлу. При указании пути используйте стандартный для Интернета символ косой черты ("/") в качестве разделителя. (Строка преобразуется в URL, поэтому косая черта работает во всех системах.) Например, укажите:

   new ImageIcon("images/myImage.gif")

Описание инициализируется строковым значением filename.

Параметры:

filename — строка, задающая имя файла или путь к нему

См. также:

ImageIcon

public ImageIcon(URL location, String description)

Создаёт ImageIcon из указанного URL. Изображение будет предварительно загружено с помощью MediaTracker для отслеживания состояния его загрузки.

Параметры:

location — URL изображения

description — краткое текстовое описание изображения

Выбрасывает:

NullPointerException — если location равно null

См. также:

ImageIcon

public ImageIcon(URL location)

Создаёт ImageIcon из указанного URL. Изображение будет предварительно загружено с помощью MediaTracker для отслеживания состояния его загрузки. В качестве описания значка устанавливается строковое представление URL.

Параметры:

location — URL изображения

Выбрасывает:

NullPointerException — если location равно null

См. также:

ImageIcon

public ImageIcon(Image image, String description)

Создаёт ImageIcon из изображения.

Параметры:: image — изображение; description — краткое текстовое описание изображения
Выбрасывает:: NullPointerException — если image равно null

ImageIcon

public ImageIcon(Image image)

Создаёт ImageIcon из объекта изображения. Если изображение имеет свойство «comment», значение которого является строкой, эта строка используется в качестве описания значка.

Параметры:

image — изображение

Выбрасывает:

NullPointerException — если image равно null

См. также:

ImageIcon

public ImageIcon(byte[] imageData, String description)

Параметры:

imageData — массив пикселей в формате изображения, поддерживаемом AWT Toolkit, например GIF, JPEG или (начиная с версии 1.3) PNG

description — краткое текстовое описание изображения

Выбрасывает:

NullPointerException — если imageData равно null

См. также:

ImageIcon

public ImageIcon(byte[] imageData)

Создаёт ImageIcon из массива байтов, считанных из файла изображения, содержащего поддерживаемый формат изображения, например GIF, JPEG или (начиная с версии 1.3) PNG. Обычно этот массив создаётся путём чтения изображения с помощью Class.getResourceAsStream(), но массив байтов также может быть статически сохранён в классе. Если полученное изображение имеет свойство «comment», значение которого является строкой, эта строка используется в качестве описания значка.

Параметры:

Выбрасывает:

NullPointerException — если imageData равно null

См. также:

ImageIcon

public ImageIcon()

Создаёт неинициализированный значок изображения.

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

loadImage

protected void loadImage(Image image)

Загружает изображение и возвращает управление только после завершения загрузки.

Параметры:: image — изображение

getImageLoadStatus

public int getImageLoadStatus()

Возвращает состояние операции загрузки изображения.

Возвращает:

состояние загрузки, определённое в java.awt.MediaTracker

См. также:

getImage

public Image getImage()

Возвращает Image этого значка.

Возвращает:: объект Image для этого ImageIcon

setImage

public void setImage(Image image)

Задаёт изображение, отображаемое этим значком.

Параметры:: image — изображение
Выбрасывает:: NullPointerException — если image равно null

getDescription

public String getDescription()

Возвращает описание изображения. Предполагается, что это краткое текстовое описание объекта. Например, оно может быть представлено незрячему пользователю, чтобы дать ему представление о назначении изображения. Описание может быть null.

Возвращает:: краткое текстовое описание изображения

setDescription

public void setDescription(String description)

Задаёт описание изображения. Предполагается, что это краткое текстовое описание объекта. Например, оно может быть представлено незрячему пользователю, чтобы дать ему представление о назначении изображения.

Параметры:: description — краткое текстовое описание изображения

paintIcon

public void paintIcon(Component c, Graphics g, int x, int y)

Отображает значок. Верхний левый угол значка рисуется в точке (x, y) в системе координат графического контекста g. Если у этого значка нет наблюдателя изображения, этот метод использует компонент c в качестве наблюдателя.

Определён в:: paintIcon в интерфейсе Icon
Параметры:: c — компонент, используемый в качестве наблюдателя, если у этого значка нет наблюдателя изображения; g — графический контекст; x — координата X верхнего левого угла значка; y — координата Y верхнего левого угла значка

getIconWidth

public int getIconWidth()

Возвращает ширину значка.

Определён в:: getIconWidth в интерфейсе Icon
Возвращает:: ширину этого значка в пикселях

getIconHeight

public int getIconHeight()

Возвращает высоту значка.

Определён в:: getIconHeight в интерфейсе Icon
Возвращает:: высоту этого значка в пикселях

setImageObserver

public void setImageObserver(ImageObserver observer)

Задаёт наблюдателя изображения. Установите это свойство, если ImageIcon содержит анимированный GIF, чтобы наблюдатель получал уведомления для обновления отображения. Например:

    icon = new ImageIcon(...)
    button.setIcon(icon);
    icon.setImageObserver(button);

Параметры:: observer — наблюдатель изображения

getImageObserver

public ImageObserver getImageObserver()

Возвращает наблюдателя изображения.

Возвращает:: наблюдателя изображения или null

toString

public String toString()

Возвращает строковое представление этого изображения.

Переопределяет:: toString в классе Object
Возвращает:: строку, представляющую это изображение

getAccessibleContext

@BeanProperty(expert=true, description="The AccessibleContext associated with this ImageIcon.") public AccessibleContext getAccessibleContext()

Возвращает AccessibleContext, связанный с этим ImageIcon. Для значков изображений AccessibleContext имеет вид AccessibleImageIcon. При необходимости создаётся новый экземпляр AccessibleImageIcon.

Определён в:: getAccessibleContext в интерфейсе Accessible
Возвращает:: AccessibleImageIcon, выступающий в роли AccessibleContext этого ImageIcon
Начиная с:: 1.3

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.