Spec-Zone.ru › OpenJDK 17

Класс TrayIcon

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

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

Примечание: При отправке события зарегистрированным слушателям его свойство 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:
  • SystemTray.add(java.awt.TrayIcon)
  • ComponentEvent.getComponent()
  • EventObject.getSource()

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

Модификатор и тип Класс Описание
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
SecurityException - если разрешение на accessSystemTray не предоставлено
См. также:
  • SystemTray.add(TrayIcon)
  • TrayIcon(Image, String, PopupMenu)
  • TrayIcon(Image, String)
  • SecurityManager.checkPermission(java.security.Permission)
  • AWTPermission

TrayIcon

public TrayIcon(Image image, String tooltip)
Создаёт TrayIcon с указанным изображением и текстом всплывающей подсказки. Всплывающая подсказка может быть невидимой на некоторых платформах.
Параметры:
image - используемое Image
tooltip - строка, используемая в качестве текста всплывающей подсказки; если значение null, всплывающая подсказка не отображается
Исключения:
IllegalArgumentException - если image null
UnsupportedOperationException - если системный лоток не поддерживается текущей платформой
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
SecurityException - если разрешение на accessSystemTray не предоставлено
См. также:
  • SystemTray.add(TrayIcon)
  • TrayIcon(Image)
  • TrayIcon(Image, String, PopupMenu)
  • SecurityManager.checkPermission(java.security.Permission)
  • AWTPermission

TrayIcon

public TrayIcon(Image image, String tooltip, PopupMenu popup)
Создаёт TrayIcon с указанным изображением, всплывающей подсказкой и контекстным меню. Всплывающая подсказка может быть невидимой на некоторых платформах.
Параметры:
image - используемое Image
tooltip - строка, используемая в качестве текста всплывающей подсказки; если значение null, всплывающая подсказка не отображается
popup - используемое меню для контекстного меню значка лотка; если значение null, контекстное меню не отображается
Исключения:
IllegalArgumentException - если image null
UnsupportedOperationException - если системный лоток не поддерживается текущей платформой
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
SecurityException - если разрешение на accessSystemTray не предоставлено
См. также:
  • SystemTray.add(TrayIcon)
  • TrayIcon(Image, String)
  • TrayIcon(Image)
  • PopupMenu
  • MouseListener
  • addMouseListener(MouseListener)
  • SecurityManager.checkPermission(java.security.Permission)
  • AWTPermission

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

setImage

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

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

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

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

Параметры:
image - используемое непустое Image
Исключения:
NullPointerException - если image null
См. также:
  • getImage()
  • Image
  • SystemTray.add(TrayIcon)
  • TrayIcon(Image, String)

getImage

public Image getImage()
Возвращает текущее изображение, используемое для этого TrayIcon.
Возвращает:
изображение
См. также:
  • setImage(Image)
  • Image

setPopupMenu

public void setPopupMenu(PopupMenu popup)
Устанавливает контекстное меню для этого TrayIcon. Если popup null, контекстное меню не будет ассоциировано с этим TrayIcon.

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

Контекстное меню может быть установлено только для одного TrayIcon. Установка одного и того же контекстного меню для нескольких TrayIcon приведёт к IllegalArgumentException.

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

Параметры:
popup - PopupMenu или null для удаления контекстного меню
Исключения:
IllegalArgumentException - если popup уже установлено для другого TrayIcon
См. также:
  • getPopupMenu()

getPopupMenu

public PopupMenu getPopupMenu()
Возвращает контекстное меню, связанное с этим TrayIcon.
Возвращает:
контекстное меню или null, если оно не существует
См. также:
  • setPopupMenu(PopupMenu)

setToolTip

public void setToolTip(String tooltip)
Устанавливает строку всплывающей подсказки для этого TrayIcon. Всплывающая подсказка отображается автоматически при наведении курсора на значок. Всплывающая подсказка может быть невидимой на некоторых платформах. Установка всплывающей подсказки в null удаляет любой текст всплывающей подсказки. При отображении текст всплывающей подсказки может быть усечён на некоторых платформах; количество отображаемых символов зависит от платформы.
Параметры:
tooltip - строка для всплывающей подсказки; если значение null, всплывающая подсказка не отображается
См. также:
  • getToolTip()

getToolTip

public String getToolTip()
Возвращает строку всплывающей подсказки, связанную с этим TrayIcon.
Возвращает:
строку всплывающей подсказки или null, если она не существует
См. также:
  • setToolTip(String)

setImageAutoSize

public void setImageAutoSize(boolean autosize)
Устанавливает свойство автоматического размера. Автоматический размер определяет, будет ли размер изображения значка лотка автоматически изменён для соответствия месту, выделенному для изображения в лотке. По умолчанию свойство автоматического размера установлено в false.

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

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

Параметры:
autosize - true для автоматического изменения размера изображения, false в противном случае
См. также:
  • isImageAutoSize()

isImageAutoSize

public boolean isImageAutoSize()
Возвращает значение свойства автоматического размера.
Возвращает:
true если изображение будет автоматически изменять размер, false в противном случае
См. также:
  • setImageAutoSize(boolean)

addMouseListener

public void addMouseListener(MouseListener listener)
Добавляет указанный обработчик событий мыши для получения событий мыши от этого TrayIcon. Вызов этого метода со значением null не оказывает никакого влияния.

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

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

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

Parameters:
listener - обработчик событий мыши
See Also:
  • MouseEvent
  • MouseListener
  • removeMouseListener(MouseListener)
  • getMouseListeners()

removeMouseListener

public void removeMouseListener(MouseListener listener)
Удаляет указанный обработчик событий мыши. Вызов этого метода со значением null или недопустимым значением не оказывает никакого влияния.

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

Parameters:
listener - обработчик событий мыши
See Also:
  • MouseEvent
  • MouseListener
  • addMouseListener(MouseListener)
  • getMouseListeners()

getMouseListeners

public MouseListener[] getMouseListeners()
Возвращает массив всех зарегистрированных обработчиков событий мыши для этого TrayIcon.
Returns:
все зарегистрированные MouseListeners для этого TrayIcon или пустой массив, если обработчики событий мыши не зарегистрированы
See Also:
  • addMouseListener(MouseListener)
  • removeMouseListener(MouseListener)
  • MouseListener

addMouseMotionListener

public void addMouseMotionListener(MouseMotionListener listener)
Добавляет указанный обработчик событий движения мыши для получения событий движения мыши от этого TrayIcon. Вызов этого метода со значением null не оказывает никакого влияния.

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

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

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

Parameters:
listener - обработчик событий движения мыши
See Also:
  • MouseEvent
  • MouseMotionListener
  • removeMouseMotionListener(MouseMotionListener)
  • getMouseMotionListeners()

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener listener)
Удаляет указанный обработчик событий движения мыши. Вызов этого метода со значением null или недопустимым значением не оказывает никакого влияния.

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

Parameters:
listener - обработчик событий движения мыши
See Also:
  • MouseEvent
  • MouseMotionListener
  • addMouseMotionListener(MouseMotionListener)
  • getMouseMotionListeners()

getMouseMotionListeners

public MouseMotionListener[] getMouseMotionListeners()
Возвращает массив всех зарегистрированных обработчиков событий движения мыши для этого TrayIcon.
Returns:
все зарегистрированные MouseInputListeners для этого TrayIcon или пустой массив, если обработчики событий мыши не зарегистрированы
See Also:
  • addMouseMotionListener(MouseMotionListener)
  • removeMouseMotionListener(MouseMotionListener)
  • MouseMotionListener

getActionCommand

public String getActionCommand()
Возвращает имя команды события действия, сгенерированного этим значком системного трея.
Returns:
имя команды действия или null если оно отсутствует
See Also:
  • addActionListener(ActionListener)
  • setActionCommand(String)

setActionCommand

public void setActionCommand(String command)
Устанавливает имя команды для события действия, генерируемого этим значком системного трея. По умолчанию эта команда действия установлена в null.
Parameters:
command - строка, используемая для установки команды действия значка системного трея.
See Also:
  • ActionEvent
  • addActionListener(ActionListener)
  • getActionCommand()

addActionListener

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

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

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

Parameters:
listener - обработчик событий действия
See Also:
  • removeActionListener(java.awt.event.ActionListener)
  • getActionListeners()
  • ActionListener
  • setActionCommand(String)

removeActionListener

public void removeActionListener(ActionListener listener)
Удаляет указанного обработчика событий действия. Вызов этого метода со значением null или недопустимым значением не оказывает никакого влияния.

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

Parameters:
listener - обработчик событий действия
See Also:
  • ActionEvent
  • ActionListener
  • addActionListener(ActionListener)
  • getActionListeners()
  • setActionCommand(String)

getActionListeners

public ActionListener[] getActionListeners()
Возвращает массив всех зарегистрированных обработчиков событий действия для этого TrayIcon.
Returns:
все зарегистрированные ActionListeners для этого TrayIcon или пустой массив, если обработчики событий действия не зарегистрированы
See Also:
  • addActionListener(ActionListener)
  • removeActionListener(ActionListener)
  • ActionListener

displayMessage

public void displayMessage(String caption, String text, TrayIcon.MessageType messageType)
Отображает всплывающее сообщение рядом с значком системного трея. Сообщение исчезнет через некоторое время или если пользователь нажмет на него. Нажатие на сообщение может вызвать ActionEvent.

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

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

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

getSize

public Dimension getSize()
Возвращает размер, в пикселях, занимаемого значком в системном трее. Для значка, который еще не добавлен в системный трей, возвращаемый размер равен результату вызова SystemTray.getTrayIconSize().
Возвращает:
размер значка в системном трее, в пикселях
См. также:
  • setImageAutoSize(boolean)
  • Image
  • getSize()

© 1993, 2021, 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/17/docs/api/java.desktop/java/awt/TrayIcon.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API