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

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

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

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

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.

Parameters:

listener - обработчик событий мыши

See Also:

removeMouseListener

public void removeMouseListener(MouseListener listener)

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

См. Проблемы с потоками AWT для получения подробной информации о модели потоков AWT.

Parameters:

listener - обработчик событий мыши

See Also:

getMouseListeners

public MouseListener[] getMouseListeners()

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

Returns:

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

See Also:

addMouseMotionListener

public void addMouseMotionListener(MouseMotionListener listener)

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

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

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

См. Проблемы с потоками AWT для получения подробной информации о модели потоков AWT.

Parameters:

listener - обработчик событий перемещения мыши

See Also:

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener listener)

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

См. Проблемы с потоками AWT для получения подробной информации о модели потоков AWT.

Parameters:

listener - обработчик событий перемещения мыши

See Also:

getMouseMotionListeners

public MouseMotionListener[] getMouseMotionListeners()

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

Returns:

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

See Also:

getActionCommand

public String getActionCommand()

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

Returns:

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

See Also:

setActionCommand

public void setActionCommand(String command)

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

Parameters:

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

See Also:

addActionListener

public void addActionListener(ActionListener listener)

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

Вызов этого метода со значением null не имеет эффекта.

См. Проблемы с потоками AWT для получения подробной информации о модели потоков AWT.

Parameters:

listener - обработчик событий действия

See Also:

removeActionListener

public void removeActionListener(ActionListener listener)

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

См. Проблемы с потоками AWT для получения подробной информации о модели потоков AWT.

Parameters:

listener - обработчик событий действия

See Also:

getActionListeners

public ActionListener[] getActionListeners()

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

Returns:

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

See Also:

displayMessage

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

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

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

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

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

getSize

public Dimension getSize()

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

Returns:

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

See Also:

© 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/TrayIcon.html