java.awt

Class SystemTray

java.lang.Object

java.awt.SystemTray

public class SystemTray
extends Object

的 SystemTray类别代表一个桌面系统托盘。在微软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);
     }
     // ...
 

从以下版本开始：

一点六

另请参见：

TrayIcon

方法摘要

Modifier and Type	Method and Description
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) 从 SystemTray移除指定的 TrayIcon。
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) 删除一个 PropertyChangeListener从监听器列表的特定属性。

Methods inherited from class java.lang.Object

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

方法详细信息

getSystemTray

public static SystemTray getSystemTray()

获取表示桌面托盘区的 SystemTray实例。这总是返回每个应用程序的同一个实例。在某些平台上，系统托盘可能不被支持。你可以使用 isSupported()方法检查系统托盘支持。

如果要安装，必须授予的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的 SystemTray。当添加到系统托盘中时，托盘图标会在系统托盘中可见。图标显示在一个托盘中的顺序没有被指定-它是平台和实现依赖。

所有的图标添加到应用程序会自动从SystemTray删除应用程序退出时，也当桌面系统托盘不可用。

参数

trayIcon - TrayIcon加以补充

异常

如果是 null trayIcon NullPointerException

IllegalArgumentException -如果一个 TrayIcon相同的实例加入不止一次

AWTException如果桌面系统盘丢失

另请参见：

remove(TrayIcon)， getSystemTray()， TrayIcon， Image

remove

public void remove(TrayIcon trayIcon)

从 SystemTray移除指定的 TrayIcon。

所有的图标添加到应用程序会自动从SystemTray删除应用程序退出时，也当桌面系统托盘不可用。

如果trayIcon是null或不添加到系统托盘，不引发异常，则不执行行动。

参数

trayIcon - TrayIcon被删除

另请参见：

add(TrayIcon)， TrayIcon

getTrayIcons

public TrayIcon[] getTrayIcons()

通过此应用程序返回添加到托盘中的所有图标的数组。您无法访问由另一个应用程序添加的图标。一些浏览器的分区程序在不同的代码库为独立的语境，这些语境的墙壁之间建立。在这样的情况下，只有从这个上下文添加的托盘图标将被返回。

返回的数组是一个实际数组的副本，并可以以任何方式修改，而不影响系统托盘。从SystemTray删除TrayIcon，使用remove(TrayIcon)方法。

结果

一个数组的所有托盘图标添加到这个托盘，或一个空数组，如果没有被添加

另请参见：

add(TrayIcon)， TrayIcon

getTrayIconSize

public Dimension getTrayIconSize()

返回一个托盘图标在系统托盘中占据的空间的大小，以像素为单位。开发人员可以使用此方法在创建之前获取托盘图标的图像属性的首选大小。为方便起见，在 TrayIcon类类似的方法 TrayIcon.getSize()。

结果

托盘图标的默认大小，以像素为单位

另请参见：

TrayIcon.setImageAutoSize(boolean)， Image， TrayIcon.getSize()

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

增加了一个 PropertyChangeListener对特定财产的听众名单。目前支持以下特性：

Property	描述
trayIcons	The SystemTray's array of TrayIcon objects. The array is accessed via the getTrayIcons() method. This property is changed when a tray icon is added to (or removed from) the system tray. For example, this property is changed when the system tray becomes unavailable on the desktop and the tray icons are automatically removed.
systemTray	This property contains SystemTray instance when the system tray is available or null otherwise. This property is changed when the system tray becomes available or unavailable on the desktop. The property is accessed by the getSystemTray() method.

的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 -指定的属性

结果

所有与指定的属性关联的 PropertyChangeListeners；如果没有这样的听众已经添加或者 propertyName是 null或无效，则返回一个空数组

另请参见：

addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)， removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)