Класс 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:
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
add |
Добавляет TrayIcon в SystemTray. |
void |
addPropertyChangeListener |
Добавляет PropertyChangeListener в список слушателей для определенного свойства. |
PropertyChangeListener[] |
getPropertyChangeListeners |
Возвращает массив всех слушателей, связанных с заданным свойством. |
static SystemTray |
getSystemTray() |
Возвращает экземпляр SystemTray, представляющий область лотка рабочего стола. |
TrayIcon[] |
getTrayIcons() |
Возвращает массив всех значков, добавленных в лоток данным приложением. |
Dimension |
getTrayIconSize() |
Возвращает размер, в пикселях, занимаемый значком в системном лотке. |
static boolean |
isSupported() |
Возвращает, поддерживается ли системный лоток на текущей платформе. |
void |
remove |
Удаляет указанный TrayIcon из SystemTray. |
void |
removePropertyChangeListener |
Удаляет PropertyChangeListener из списка слушателей для определенного свойства. |
Подробное описание методов
getSystemTray
public static SystemTray getSystemTray()
SystemTray, представляющий область системного трея рабочего стола. Этот метод всегда возвращает один и тот же экземпляр на применение. На некоторых платформах системный трей может быть не поддерживается. Можно использовать метод isSupported(), чтобы проверить поддержку системного трея. Если установлен SecurityManager, необходимо предоставить разрешение AWTPermission accessSystemTray, чтобы получить экземпляр SystemTray. В противном случае этот метод выбросит SecurityException.
- Возвращает:
- экземпляр
SystemTray, представляющий область системного трея рабочего стола - Исключения:
-
UnsupportedOperationException- если системный трей не поддерживается текущей платформой -
HeadlessException- еслиGraphicsEnvironment.isHeadless()возвращаетtrue -
SecurityException- если разрешениеaccessSystemTrayне предоставлено - См. также:
isSupported
public static boolean isSupported()
TrayIcon.setPopupMenu(PopupMenu)), либо событие действия (см. TrayIcon.addActionListener(ActionListener)). Разработчики не должны предполагать, что поддерживаются все функции системного трея. Чтобы гарантировать, что стандартное действие значка трея всегда доступно, добавьте стандартное действие как в обработчик событий, так и в всплывающее меню. См. example для примера того, как это сделать.
Примечание: При реализации SystemTray и TrayIcon настоятельно рекомендуется назначать разные жесты для всплывающего меню и события действия. Перегрузка жеста для обеих целей сбивает с толку и может помешать пользователю получить доступ к одному или другому.
- Возвращает:
-
falseесли доступ к системному трею не поддерживается; этот метод возвращаетtrueесли минимальный доступ к системному трею поддерживается, но не гарантирует, что все функции системного трея поддерживаются для текущей платформы - См. также:
add
public void add(TrayIcon trayIcon) throws AWTException
TrayIcon в SystemTray. Значок трея становится видимым в системном трее после его добавления. Порядок отображения значков в трее не определен — он зависит от платформы и реализации. Все значки, добавленные приложением, автоматически удаляются из SystemTray при завершении работы приложения, а также при недоступности системного трея рабочего стола.
- Параметры:
-
trayIcon- добавляемыйTrayIcon - Исключения:
-
NullPointerException- еслиtrayIconявляетсяnull -
IllegalArgumentException- если один и тот же экземплярTrayIconдобавлен более одного раза -
AWTException- если системный трей рабочего стола отсутствует - См. также:
remove
public void remove(TrayIcon trayIcon)
TrayIcon из SystemTray. Все значки, добавленные приложением, автоматически удаляются из SystemTray при завершении работы приложения, а также при недоступности системного трея рабочего стола.
Если trayIcon является null или не был добавлен в системный трей, исключение не выбрасывается и действие не выполняется.
- Параметры:
-
trayIcon- удаляемыйTrayIcon - См. также:
getTrayIcons
public TrayIcon[] getTrayIcons()
Возвращаемый массив — копия фактического массива и может быть изменён любым способом без влияния на системный трей. Для удаления TrayIcon из SystemTray, используйте метод remove(TrayIcon).
- Возвращает:
- массив всех значков трея, добавленных в этот трей, или пустой массив, если значки не добавлены
- См. также:
getTrayIconSize
public Dimension getTrayIconSize()
TrayIcon.getSize() в классе TrayIcon. - Возвращает:
- стандартный размер значка трея в пикселях
- См. также:
addPropertyChangeListener
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
PropertyChangeListener в список слушателей для указанного свойства. В настоящее время поддерживаются следующие свойства: | Свойство | Описание |
|---|---|
trayIcons |
Массив объектов SystemTray, хранящийся в свойстве TrayIcon. Доступ к массиву осуществляется через метод getTrayIcons(). Это свойство изменяется при добавлении или удалении значка трея в системный трей. Например, это свойство изменяется, когда системный трей становится недоступным на рабочем столе, и значки трея автоматически удаляются. |
systemTray |
Это свойство содержит экземпляр SystemTray, если системный трей доступен, или null в противном случае. Это свойство изменяется, когда системный трей становится доступным или недоступным на рабочем столе. К свойству можно обратиться с помощью метода getSystemTray(). |
Слушатель listener реагирует на изменения свойств только в данном контексте.
Если listener является null, исключение не выбрасывается, и действие не выполняется.
- Параметры:
-
propertyName- указанное свойство -
listener- слушатель изменений свойств для добавления - См. также:
removePropertyChangeListener
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
PropertyChangeListener из списка слушателей для указанного свойства. Слушатель PropertyChangeListener должен относиться к этому контексту.
Если propertyName или listener является null или недействительным, исключение не выбрасывается, и действие не выполняется.
- Параметры:
-
propertyName- указанное свойство -
listener- удаляемый PropertyChangeListener - См. также:
getPropertyChangeListeners
public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Возвращаются только слушатели в этом контексте.
- Параметры:
-
propertyName- указанное свойство - Возвращает:
- все
PropertyChangeListenerы, связанные с указанным свойством; если такие слушатели не добавлены илиpropertyNameявляетсяnullили недействительным, возвращается пустой массив - См. также:
© 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/SystemTray.html