Класс 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. На некоторых платформах это происходит, когда пользователь выбирает значок трея с помощью мыши или клавиатуры.

Если установлен SecurityManager, для создания объекта TrayIcon требуется разрешение AWTPermission accessSystemTray. В противном случае конструктор выбросит исключение SecurityException.

См. обзор класса SystemTray, чтобы узнать, как использовать API TrayIcon.

Implementation Note:

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

Since:

1.6

See Also:

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

Модификатор и тип	Класс	Описание
`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)`	Добавляет указанного слушателя событий действий для получения событий действий от этого `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)

Создаёт значок системного трея с указанным изображением.

Параметры:

image - используемое изображение

Исключения:

IllegalArgumentException - если image null

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

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

SecurityException - если разрешение accessSystemTray не предоставлено

См. также:

TrayIcon

public TrayIcon(Image image, String tooltip)

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

Параметры:

image - используемое изображение

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

Исключения:

IllegalArgumentException - если image null

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

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

SecurityException - если разрешение accessSystemTray не предоставлено

См. также:

TrayIcon

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

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

Параметры:

image - используемое изображение

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

Исключения:

IllegalArgumentException - если image null

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

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

SecurityException - если разрешение accessSystemTray не предоставлено

См. также:

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

setImage

public void setImage(Image image)

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

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

См. свойство setImageAutoSize(boolean) для получения подробной информации о размере отображаемого изображения.

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

Параметры:

image - используемое непустое изображение

Исключения:

NullPointerException - если image null

См. также:

getImage

public Image getImage()

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

Возвращает:

изображение

См. также:

setPopupMenu

public void setPopupMenu(PopupMenu popup)

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

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

Контекстное меню можно установить только на один значок системного трея. Установка одного и того же контекстного меню на несколько значков системного трея вызовет IllegalArgumentException.

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

Параметры:

popup - контекстное меню или null для удаления любого контекстного меню

Исключения:

IllegalArgumentException - если popup уже установлено для другого значка системного трея

См. также:

getPopupMenu

public PopupMenu getPopupMenu()

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

Возвращает:

контекстное меню или null, если его нет

См. также:

setToolTip

public void setToolTip(String tooltip)

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

Параметры:

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

См. также:

getToolTip

public String getToolTip()

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

Возвращает:

строка всплывающей подсказки или 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 Threading Issues.

Parameters:

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

See Also:

removeMouseListener

public void removeMouseListener(MouseListener listener)

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

Дополнительную информацию о модели потоков AWT см. в AWT Threading Issues.

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 Threading Issues.

Parameters:

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

See Also:

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener listener)

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

Дополнительную информацию о модели потоков AWT см. в AWT Threading Issues.

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 Threading Issues.

Parameters:

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

See Also:

removeActionListener

public void removeActionListener(ActionListener listener)

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

Дополнительную информацию о модели потоков AWT см. в AWT Threading Issues.

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, 2023, 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://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/TrayIcon.html