Класс TrayIcon

java.lang.Object

java.awt.TrayIcon

public class TrayIcon extends Object

Объект TrayIcon представляет значок в области уведомлений, который можно добавить в system tray. У TrayIcon могут быть всплывающая подсказка (текст), изображение, всплывающее меню и набор связанных с ним слушателей.

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

Примечание: При отправке MouseEvent зарегистрированным слушателям его свойству component присваивается значение null. (См. ComponentEvent.getComponent()) Свойству source присваивается значение этого TrayIcon. (См. EventObject.getSource())

Примечание: Корректная реализация TrayIcon назначает разные жесты для отображения всплывающего меню и выбора значка в области уведомлений.

TrayIcon может генерировать ActionEvent. На некоторых платформах это происходит, когда пользователь выбирает значок в области уведомлений с помощью мыши или клавиатуры.

См. обзор класса SystemTray, где приведен пример использования API TrayIcon.

Примечание по реализации:

Если свойству apple.awt.enableTemplateImages присвоено значение, все изображения, связанные с экземплярами этого класса, рассматриваются собственной системой рабочего стола как шаблонные изображения. Это означает, что вся информация о цвете отбрасывается, а изображение автоматически адаптируется для отображения при изменении темы и/или цветов рабочего стола. Это свойство влияет только на MacOSX.

Начиная с:

1.6

См. также:

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

Модификатор и тип	Класс	Описание
`static enum`	`TrayIcon.MessageType`	Тип сообщения определяет, какой значок будет отображаться в заголовке сообщения, а также какой системный звук может сопровождать его отображение.

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

Конструктор	Описание
`TrayIcon(Image image)`	Создает `TrayIcon` с указанным изображением.
`TrayIcon(Image image, String tooltip)`	Создает `TrayIcon` с указанным изображением и текстом всплывающей подсказки.
`TrayIcon(Image image, String tooltip, PopupMenu popup)`	Создает `TrayIcon` с указанным изображением, текстом всплывающей подсказки и всплывающим меню.

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

Модификатор и тип	Метод	Описание
`void`	`addActionListener(ActionListener listener)`	Добавляет указанный слушатель действий для получения `ActionEvent` от этого `TrayIcon`.
`void`	`addMouseListener(MouseListener listener)`	Добавляет указанный слушатель мыши для получения событий мыши от этого `TrayIcon`.
`void`	`addMouseMotionListener(MouseMotionListener listener)`	Добавляет указанный слушатель мыши для получения событий перемещения мыши от этого `TrayIcon`.
`void`	`displayMessage(String caption, String text, TrayIcon.MessageType messageType)`	Отображает всплывающее сообщение рядом со значком в области уведомлений.
`String`	`getActionCommand()`	Возвращает имя команды события действия, инициированного этим значком в области уведомлений.
`ActionListener[]`	`getActionListeners()`	Возвращает массив всех слушателей действий, зарегистрированных для этого `TrayIcon`.
`Image`	`getImage()`	Возвращает текущее изображение, используемое для этого `TrayIcon`.
`MouseListener[]`	`getMouseListeners()`	Возвращает массив всех слушателей мыши, зарегистрированных для этого `TrayIcon`.
`MouseMotionListener[]`	`getMouseMotionListeners()`	Возвращает массив всех слушателей перемещения мыши, зарегистрированных для этого `TrayIcon`.
`PopupMenu`	`getPopupMenu()`	Возвращает всплывающее меню, связанное с этим `TrayIcon`.
`Dimension`	`getSize()`	Возвращает размер в пикселях области, занимаемой значком в области уведомлений.
`String`	`getToolTip()`	Возвращает строку всплывающей подсказки, связанную с этим `TrayIcon`.
`boolean`	`isImageAutoSize()`	Возвращает значение свойства автоматического изменения размера.
`void`	`removeActionListener(ActionListener listener)`	Удаляет указанный слушатель действий.
`void`	`removeMouseListener(MouseListener listener)`	Удаляет указанный слушатель мыши.
`void`	`removeMouseMotionListener(MouseMotionListener listener)`	Удаляет указанный слушатель перемещения мыши.
`void`	`setActionCommand(String command)`	Задает имя команды для события действия, инициированного этим значком в области уведомлений.
`void`	`setImage(Image image)`	Задает изображение для этого `TrayIcon`.
`void`	`setImageAutoSize(boolean autosize)`	Задает свойство автоматического изменения размера.
`void`	`setPopupMenu(PopupMenu popup)`	Задает всплывающее меню для этого `TrayIcon`.
`void`	`setToolTip(String tooltip)`	Задает строку всплывающей подсказки для этого `TrayIcon`.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

TrayIcon

public TrayIcon(Image image)

Создает TrayIcon с указанным изображением.

Параметры:

image — Image, которое будет использоваться

Исключения:

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

UnsupportedOperationException — если системный лоток не поддерживается текущей платформой

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true

См. также:

TrayIcon

public TrayIcon(Image image, String tooltip)

Создает TrayIcon с указанным изображением и текстом всплывающей подсказки. На некоторых платформах всплывающая подсказка может быть невидима.

Параметры:

image — Image, которое будет использоваться

tooltip — строка, используемая в качестве текста всплывающей подсказки; если значение равно null, подсказка не отображается

Исключения:

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

UnsupportedOperationException — если системный лоток не поддерживается текущей платформой

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true

См. также:

TrayIcon

public TrayIcon(Image image, String tooltip, PopupMenu popup)

Создает TrayIcon с указанным изображением, всплывающей подсказкой и всплывающим меню. На некоторых платформах всплывающая подсказка может быть невидима.

Параметры:

image — Image, которое будет использоваться

popup — меню, используемое в качестве всплывающего меню значка в системном лотке; если значение равно null, всплывающее меню не отображается

Исключения:

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

UnsupportedOperationException — если системный лоток не поддерживается текущей платформой

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true

См. также:

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

setImage

public void setImage(Image image)

Устанавливает изображение для этого TrayIcon. Предыдущее изображение значка в системном лотке отбрасывается без вызова метода Image.flush() — его необходимо вызвать вручную.

Если изображение является анимированным, анимация будет запущена автоматически.

Подробные сведения о размере отображаемого изображения см. в свойстве setImageAutoSize(boolean).

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

Параметры:

image — используемое ненулевое значение Image

Исключения:

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

См. также:

getImage

public Image getImage()

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

Возвращает:

изображение

См. также:

setPopupMenu

public void setPopupMenu(PopupMenu popup)

Устанавливает всплывающее меню для этого TrayIcon. Если popup равно null, с этим TrayIcon не будет связано всплывающее меню.

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

popup можно назначить только одному TrayIcon. Назначение одного и того же всплывающего меню нескольким TrayIcon приведет к IllegalArgumentException.

Примечание: Некоторые платформы могут не поддерживать отображение указанного пользователем компонента всплывающего меню при щелчке правой кнопкой мыши по значку в системном лотке. В этом случае меню либо не отображается, либо в некоторых системах отображается его встроенная версия.

Параметры:

popup — PopupMenu или null для удаления любого всплывающего меню

Исключения:

IllegalArgumentException — если popup уже назначен другому TrayIcon

См. также:

getPopupMenu

public PopupMenu getPopupMenu()

Возвращает всплывающее меню, связанное с этим TrayIcon.

Возвращает:

всплывающее меню или null, если оно отсутствует

См. также:

setToolTip

public void setToolTip(String tooltip)

Устанавливает строку всплывающей подсказки для этого TrayIcon. Подсказка автоматически отображается при наведении указателя мыши на значок. На некоторых платформах всплывающая подсказка может быть невидима. Если установить для подсказки значение null, текст подсказки удаляется. На некоторых платформах отображаемая строка подсказки может быть усечена; количество отображаемых символов зависит от платформы.

Параметры:

tooltip — строка подсказки; если значение равно null, подсказка не отображается

См. также:

getToolTip

public String getToolTip()

Возвращает строку всплывающей подсказки, связанную с этим TrayIcon.

Возвращает:

строку всплывающей подсказки или null, если она отсутствует

См. также:

setImageAutoSize

public void setImageAutoSize(boolean autosize)

Устанавливает свойство автоматического изменения размера. Автоматическое изменение размера определяет, будет ли размер изображения значка в системном лотке автоматически подгоняться под выделенное для него пространство. По умолчанию свойству автоматического изменения размера присваивается значение false.

Если автоматическое изменение размера равно false и размер изображения не соответствует пространству значка в системном лотке, изображение выводится без изменений внутри этого пространства; если оно больше выделенного пространства, оно будет обрезано.

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

Параметры:

autosize — true для автоматического изменения размера изображения, в противном случае false

См. также:

isImageAutoSize

public boolean isImageAutoSize()

Возвращает значение свойства автоматического изменения размера.

Возвращает:

true, если размер изображения будет изменен автоматически, в противном случае false

См. также:

addMouseListener

public void addMouseListener(MouseListener listener)

Добавляет указанный слушатель мыши для получения событий мыши от этого TrayIcon. Вызов этого метода со значением null не влияет на результат.

Примечание: координаты MouseEvent (полученные из TrayIcon) отсчитываются относительно экрана, а не TrayIcon.

Примечание: События мыши MOUSE_ENTERED и MOUSE_EXITED не поддерживаются.

Подробные сведения о модели потоков AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

listener — слушатель мыши

См. также:

removeMouseListener

public void removeMouseListener(MouseListener listener)

Удаляет указанный слушатель мыши. Вызов этого метода со значением null или недопустимым значением не влияет на результат.

Подробные сведения о модели потоков AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

listener — слушатель мыши

См. также:

getMouseListeners

public MouseListener[] getMouseListeners()

Возвращает массив всех слушателей мыши, зарегистрированных для этого TrayIcon.

Возвращает:

все MouseListeners, зарегистрированные для этого TrayIcon, или пустой массив, если в данный момент слушатели мыши не зарегистрированы

См. также:

addMouseMotionListener

public void addMouseMotionListener(MouseMotionListener listener)

Добавляет указанный слушатель мыши для получения событий перемещения мыши от этого TrayIcon. Вызов этого метода со значением null не влияет на результат.

Примечание: координаты MouseEvent (полученные из TrayIcon) отсчитываются относительно экрана, а не TrayIcon.

Примечание: Событие мыши MOUSE_DRAGGED не поддерживается.

Подробные сведения о модели потоков AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

listener — слушатель мыши

См. также:

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener listener)

Удаляет указанный слушатель перемещения мыши. Вызов этого метода со значением null или недопустимым значением не влияет на результат.

Подробные сведения о модели потоков AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

listener — слушатель мыши

См. также:

getMouseMotionListeners

public MouseMotionListener[] getMouseMotionListeners()

Возвращает массив всех слушателей перемещения мыши, зарегистрированных для этого TrayIcon.

Возвращает:

все MouseInputListeners, зарегистрированные для этого TrayIcon, или пустой массив, если в данный момент слушатели мыши не зарегистрированы

См. также:

getActionCommand

public String getActionCommand()

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

Возвращает:

имя команды действия или null, если оно отсутствует

См. также:

setActionCommand

public void setActionCommand(String command)

Устанавливает имя команды для события действия, генерируемого этим значком в системном лотке. По умолчанию этой команде действия присваивается значение null.

Параметры:

command — строка, используемая для установки команды действия значка в системном лотке.

См. также:

addActionListener

public void addActionListener(ActionListener listener)

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

Вызов этого метода со значением null не влияет на результат.

Подробные сведения о модели потоков AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

listener — слушатель действий

См. также:

removeActionListener

public void removeActionListener(ActionListener listener)

Удаляет указанный слушатель действий. Вызов этого метода со значением null или недопустимым значением не влияет на результат.

Подробные сведения о модели потоков AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

listener — слушатель действий

См. также:

getActionListeners

public ActionListener[] getActionListeners()

Возвращает массив всех слушателей действий, зарегистрированных для этого TrayIcon.

Возвращает:

все ActionListeners, зарегистрированные для этого TrayIcon, или пустой массив, если в данный момент слушатели действий не зарегистрированы

См. также:

displayMessage

public void displayMessage(String caption, String text, TrayIcon.MessageType messageType)

Отображает всплывающее сообщение рядом со значком в системном лотке. Сообщение исчезает через некоторое время или после щелчка пользователя по нему. Щелчок по сообщению может вызвать ActionEvent.

Подпись или текст могут иметь значение null, однако, если оба значения равны null, возникает NullPointerException. На некоторых платформах отображаемая строка подписи или текста может быть усечена; количество отображаемых символов зависит от платформы.

Примечание: Некоторые платформы могут не поддерживать отображение сообщений.

Параметры:: caption — подпись, отображаемая над текстом, обычно полужирным шрифтом; может иметь значение null; text — текст конкретного сообщения; может иметь значение null; messageType — перечисление, указывающее тип сообщения
Исключения:: NullPointerException — если и caption, и text имеют значение null

getSize

public Dimension getSize()

Возвращает размер в пикселях пространства, занимаемого значком в системном лотке. Для значка, который еще не добавлен в системный лоток, возвращаемый размер равен результату вызова SystemTray.getTrayIconSize().

Возвращает:

размер значка в системном лотке в пикселях

См. также:

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