Класс 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);
     }
     // ...

Методы

getSystemTray

public static SystemTray getSystemTray()

Возвращает:

экземпляр, представляющий область трея рабочего стола

Исключение:

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

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

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

См. также:

add(TrayIcon), TrayIcon, isSupported(), SecurityManager.checkPermission(java.security.Permission), AWTPermission

isSupported

public static boolean isSupported()

Возвращает:

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

См. также:

getSystemTray()

add

public void add(TrayIcon trayIcon)
         throws AWTException

Параметры:

trayIcon - добавляемый TrayIcon

Исключение:

NullPointerException - если trayIcon является null

IllegalArgumentException - если один и тот же экземпляр TrayIcon добавляется более одного раза

AWTException - если трей рабочего стола отсутствует

См. также:

remove(TrayIcon), getSystemTray(), TrayIcon, Image

remove

public void remove(TrayIcon trayIcon)

Параметры:

trayIcon - удаляемый TrayIcon

См. также:

add(TrayIcon), TrayIcon

getTrayIcons

public TrayIcon[] getTrayIcons()

Возвращает:

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

См. также:

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)

Параметры:

propertyName - указанное свойство

listener - слушатель изменений свойств для добавления

См. также:

removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Параметры:

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)