Spec-Zone.ru › OpenJDK 17

Класс SystemTray

java.lang.Object
java.awt.SystemTray
public class SystemTray extends Object
Класс SystemTray представляет системный лоток на рабочем столе. В Microsoft Windows он называется "Область статуса панели задач", в Gnome — "Область уведомлений", а в KDE — "Системный лоток". Системный лоток общий для всех приложений, работающих на рабочем столе.

На некоторых платформах системный лоток может отсутствовать или не поддерживаться, в этом случае getSystemTray() выбрасывает исключение UnsupportedOperationException. Чтобы определить, поддерживается ли системный лоток, используйте isSupported().

SystemTray может содержать один или несколько TrayIcons, которые добавляются в лоток с помощью метода add(java.awt.TrayIcon), а удаляются при необходимости с помощью remove(java.awt.TrayIcon). TrayIcon состоит из изображения, всплывающего меню и набора связанных слушателей. Подробности см. в классе TrayIcon.

В каждом приложении Java есть единственный экземпляр SystemTray , который позволяет приложению взаимодействовать с системным лотком рабочего стола во время работы приложения. Экземпляр SystemTray можно получить из метода getSystemTray(). Приложение не может создать свой собственный экземпляр SystemTray.

Следующий фрагмент кода демонстрирует, как получить доступ к системному лотку и настроить его:

 
     TrayIcon trayIcon = null;
     if (SystemTray.isSupported()) {
         // get the SystemTray instance
         SystemTray tray = SystemTray.getSystemTray();
         // load an image
         Image image = Toolkit.getDefaultToolkit().getImage(...);
         // create a action listener to listen for default action executed on the tray icon
         ActionListener listener = new ActionListener() {
             public void actionPerformed(ActionEvent e) {
                 // execute default action of the application
                 // ...
             }
         };
         // create a popup menu
         PopupMenu popup = new PopupMenu();
         // create menu item for the default action
         MenuItem defaultItem = new MenuItem(...);
         defaultItem.addActionListener(listener);
         popup.add(defaultItem);
         /// ... add other items
         // construct a TrayIcon
         trayIcon = new TrayIcon(image, "Tray Demo", popup);
         // set the TrayIcon properties
         trayIcon.addActionListener(listener);
         // ...
         // add the tray image
         try {
             tray.add(trayIcon);
         } catch (AWTException e) {
             System.err.println(e);
         }
         // ...
     } else {
         // disable tray option in your application or
         // perform other actions
         ...
     }
     // ...
     // some time later
     // the application state has changed - update the image
     if (trayIcon != null) {
         trayIcon.setImage(updatedImage);
     }
     // ...
 
 
Since:
1.6
See Also:
  • TrayIcon

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

Модификатор и тип Метод Описание
void add(TrayIcon trayIcon)
Добавляет TrayIcon в SystemTray.
void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Добавляет PropertyChangeListener в список слушателей для определенного свойства.
PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Возвращает массив всех слушателей, связанных с заданным свойством.
static SystemTray getSystemTray()
Возвращает экземпляр SystemTray, представляющий область лотка рабочего стола.
TrayIcon[] getTrayIcons()
Возвращает массив всех значков, добавленных в лоток этим приложением.
Dimension getTrayIconSize()
Возвращает размер, в пикселях, занимаемый значком в системном лотке.
static boolean isSupported()
Возвращает, поддерживается ли системный лоток на текущей платформе.
void remove(TrayIcon trayIcon)
Удаляет указанный TrayIcon из SystemTray.
void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Удаляет PropertyChangeListener из списка слушателей для определенного свойства.

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

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

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

getSystemTray

public static SystemTray getSystemTray()
Получает экземпляр SystemTray, представляющий область системного трея на рабочем столе. Возвращает один и тот же экземпляр для каждого приложения. На некоторых платформах системный трей может быть не поддерживается. Используйте метод isSupported(), чтобы проверить поддержку системного трея.

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

Возвращает:
экземпляр SystemTray, представляющий область системного трея на рабочем столе
Использует:
UnsupportedOperationException - если системный трей не поддерживается текущей платформой
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
SecurityException - если разрешение accessSystemTray не предоставлено
См. также:
  • add(TrayIcon)
  • TrayIcon
  • isSupported()
  • SecurityManager.checkPermission(java.security.Permission)
  • AWTPermission

isSupported

public static boolean isSupported()
Возвращает значение, указывающее, поддерживается ли системный трей на текущей платформе. Помимо отображения значка трея, минимальная поддержка системного трея включает либо всплывающее меню (см. TrayIcon.setPopupMenu(PopupMenu)), либо событие действия (см. TrayIcon.addActionListener(ActionListener)).

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

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

Возвращает:
false если доступ к системному трею не поддерживается; этот метод возвращает true, если минимальный доступ к системному трею поддерживается, но не гарантирует, что все функциональные возможности системного трея поддерживаются для текущей платформы
См. также:
  • getSystemTray()

add

public void add(TrayIcon trayIcon) throws AWTException
Добавляет TrayIcon в системный трей. Значок трея становится видимым в системном трее после добавления. Порядок отображения значков в трее не определен — он зависит от платформы и реализации.

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

Параметры:
trayIcon - добавляемый TrayIcon
Использует:
NullPointerException - если trayIcon является null
IllegalArgumentException - если один и тот же экземпляр TrayIcon добавляется более одного раза
AWTException - если системный трей на рабочем столе отсутствует
См. также:
  • remove(TrayIcon)
  • getSystemTray()
  • TrayIcon
  • Image

remove

public void remove(TrayIcon trayIcon)
Удаляет указанный TrayIcon из системного трея.

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

Если trayIcon является null или не был добавлен в системный трей, исключение не генерируется, и никаких действий не выполняется.

Параметры:
trayIcon - удаляемый TrayIcon
См. также:
  • add(TrayIcon)
  • TrayIcon

getTrayIcons

public TrayIcon[] getTrayIcons()
Возвращает массив всех значков, добавленных в трей данным приложением. Вы не можете получить доступ к значкам, добавленным другим приложением. Некоторые браузеры разделяют апплеты в разных кодовых базах на отдельные контексты и устанавливают барьеры между этими контекстами. В такой ситуации будут возвращены только значки трея, добавленные из данного контекста.

Возвращаемый массив — копия фактического массива и может быть изменён любым способом без влияния на системный трей. Для удаления TrayIcon из SystemTray используйте метод remove(TrayIcon).

Возвращает:
массив всех значков трея, добавленных в трей, или пустой массив, если значки не добавлены
См. также:
  • add(TrayIcon)
  • TrayIcon

getTrayIconSize

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

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Добавляет PropertyChangeListener в список слушателей для указанного свойства. В настоящее время поддерживаются следующие свойства:
Свойства SystemTray
Свойство Описание
trayIcons Массив объектов TrayIcon значка трея. К массиву можно получить доступ через метод getTrayIcons(). Это свойство изменяется при добавлении (или удалении) значка трея в системный трей. Например, это свойство изменяется, когда системный трей становится недоступным на рабочем столе, и значки трея автоматически удаляются.
systemTray Это свойство содержит экземпляр SystemTray когда системный трей доступен или null в противном случае. Это свойство изменяется, когда системный трей становится доступным или недоступным на рабочем столе. К свойству можно получить доступ через метод getSystemTray().

Слушатель listener реагирует на изменения свойств только в этом контексте.

Если listener является null, исключение не генерируется, и никаких действий не выполняется.

Параметры:
propertyName - указанное свойство
listener - слушатель изменений свойства для добавления
См. также:
  • removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
  • getPropertyChangeListeners(java.lang.String)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Удаляет PropertyChangeListener из списка слушателей для указанного свойства.

Слушатель PropertyChangeListener должен быть из этого контекста.

Если propertyName или listener является null или недействительным, исключение не генерируется, и никаких действий не выполняется.

Параметры:
propertyName - указанное свойство
listener - удаляемый слушатель PropertyChangeListener
См. также:
  • addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
  • getPropertyChangeListeners(java.lang.String)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Возвращает массив всех слушателей, связанных с указанным свойством.

Возвращаются только слушатели в данном контексте.

Параметры:
propertyName - указанное свойство
Возвращает:
все PropertyChangeListenerы, связанные с указанным свойством; если такие слушатели не были добавлены или propertyName является null или недействительным, возвращается пустой массив
См. также:
  • addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
  • removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)

© 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/SystemTray.html

Spec-Zone.ru

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