java.awt

Class TrayIcon

java.lang.Object

java.awt.TrayIcon

public class TrayIcon
extends Object

一个 TrayIcon对象代表一个托盘图标，可以添加到 system tray。一个 TrayIcon可以提示（文字），一个形象，一个弹出式菜单，和一组与之相关的听众。

一个TrayIcon可以产生各种MouseEvents和支持添加相应的听众接收这些事件的通知。TrayIcon处理一些事件本身。例如，默认情况下，当鼠标右键单击，在弹出菜单显示指定的TrayIcon进行。当鼠标悬停在TrayIcon工具提示显示。

注：当MouseEvent派遣其注册的监听器的component属性将设置为null。（见ComponentEvent.getComponent()）的source属性将设置为这TrayIcon。（见EventObject.getSource()）

注：乖TrayIcon实施将分配不同的手势来显示一个弹出式菜单，选择托盘图标。

一个TrayIcon可以产生一个ActionEvent。在一些平台上，当用户选择使用鼠标或键盘来选择托盘图标时，会发生这种情况。

如果要安装，必须授予的awtpermission accessSystemTray为了创造一个TrayIcon。否则，构造函数将引发SecurityException。

看到SystemTray班为例介绍如何使用TrayIcon API。

从以下版本开始：

一点六

另请参见：

SystemTray.add(java.awt.TrayIcon)， ComponentEvent.getComponent()， EventObject.getSource()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrayIcon.MessageType 消息类型确定哪些图标将显示在消息的标题中，和一个可能的系统声音的消息可能会产生后显示。

构造方法摘要

构造方法

Constructor and Description
TrayIcon(Image image) 创建一个具有指定的图像 TrayIcon。
TrayIcon(Image image, String tooltip) 创建一个 TrayIcon用指定的图像和工具提示文本。
TrayIcon(Image image, String tooltip, PopupMenu popup) 创建一个具有指定的图像 TrayIcon，提示和弹出式菜单。

方法摘要

Modifier and Type	Method and Description
void	addActionListener(ActionListener listener) 添加指定的监听行动从这 TrayIcon收到 ActionEvents。
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工具提示字符串。

Methods inherited from class java.lang.Object

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

Constructor Detail

TrayIcon

public TrayIcon(Image image)

创建一个具有指定的图像 TrayIcon。

参数

image - Image用于

异常

如果是 null image IllegalArgumentException

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没有提示显示

异常

如果是 null image IllegalArgumentException

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没有弹出式菜单显示

异常

如果是 null image IllegalArgumentException

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用于

异常

如果是 null image NullPointerException

另请参见：

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删除。

的popup可以设置一TrayIcon只。设置多个TrayIcons同样会引起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。

注：the MOUSE_ENTERED和MOUSE_EXITED鼠标事件不支持。

指对AWT的线程模型的细节AWT Threading Issues。

参数

listener -鼠标监听器

另请参见：

MouseEvent， MouseListener， removeMouseListener(MouseListener)， getMouseListeners()

removeMouseListener

public void removeMouseListener(MouseListener listener)

移除指定的鼠标侦听器。与 null或无效值调用该方法没有效果。

参考AWT Threading Issues对AWT的线程模型的细节。

参数

listener -鼠标监听器

另请参见：

MouseEvent， MouseListener， addMouseListener(MouseListener)， getMouseListeners()

getMouseListeners

public MouseListener[] getMouseListeners()

返回所有鼠标监听器注册这 TrayIcon数组。

结果

所有的 MouseListeners注册这个 TrayIcon或空数组如果没有鼠标的听众正在注册

另请参见：

addMouseListener(MouseListener)， removeMouseListener(MouseListener)， MouseListener

addMouseMotionListener

public void addMouseMotionListener(MouseMotionListener listener)

添加指定的鼠标监听从这 TrayIcon接收鼠标移动事件。一个 null值调用该方法没有效果。

注：的MouseEvent坐标（从TrayIcon收到）是相对于屏幕，不TrayIcon。

注：the MOUSE_DRAGGED鼠标事件是不支持的。

指对AWT的线程模型的细节AWT Threading Issues。

参数

listener -鼠标监听器

另请参见：

MouseEvent， MouseMotionListener， removeMouseMotionListener(MouseMotionListener)， getMouseMotionListeners()

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener listener)

移除指定的鼠标移动侦听器。与 null或无效值调用该方法没有效果。

参考AWT Threading Issues对AWT的线程模型的细节。

参数

listener -鼠标监听器

另请参见：

MouseEvent， MouseMotionListener， addMouseMotionListener(MouseMotionListener)， getMouseMotionListeners()

getMouseMotionListeners

public MouseMotionListener[] getMouseMotionListeners()

返回所有的鼠标运动的听众对这 TrayIcon注册一个数组。

结果

所有的 MouseInputListeners注册这个 TrayIcon或空数组如果没有鼠标的听众正在注册

另请参见：

addMouseMotionListener(MouseMotionListener)， removeMouseMotionListener(MouseMotionListener)， MouseMotionListener

getActionCommand

public String getActionCommand()

返回由这个托盘图标发射的动作事件的命令名称。

结果

动作命令的名称，或 null如果不存在

另请参见：

addActionListener(ActionListener)， setActionCommand(String)

setActionCommand

public void setActionCommand(String command)

将由此托盘图标发射的动作事件的命令名设置。默认情况下，此命令将 null。

参数

command -一个用于设置托盘图标的动作命令字符串。

另请参见：

ActionEvent， addActionListener(ActionListener)， getActionCommand()

addActionListener

public void addActionListener(ActionListener listener)

添加指定的监听行动从这 TrayIcon收到 ActionEvents。动作事件通常发生在用户选择托盘图标，使用鼠标或键盘。产生的动作事件的条件是依赖于平台的。

一个null值调用该方法没有效果。

参考AWT Threading Issues对AWT的线程模型的细节。

参数

listener的监听行动

另请参见：

removeActionListener(java.awt.event.ActionListener)， getActionListeners()， ActionListener， setActionCommand(String)

removeActionListener

public void removeActionListener(ActionListener listener)

移除指定的动作侦听器。与 null或无效值调用该方法没有效果。

指对AWT的线程模型的细节AWT Threading Issues。

参数

listener的监听行动

另请参见：

ActionEvent， ActionListener， addActionListener(ActionListener)， getActionListeners()， setActionCommand(String)

getActionListeners

public ActionListener[] getActionListeners()

返回的所有行动的听众对这 TrayIcon注册一个数组。

结果

所有的 ActionListeners注册这个 TrayIcon或空数组如果没有行动的听众正在注册

另请参见：

addActionListener(ActionListener)， removeActionListener(ActionListener)， ActionListener

displayMessage

public void displayMessage(String caption,
                           String text,
                           TrayIcon.MessageType messageType)

附近显示托盘图标弹出信息。该消息将在一段时间后消失，或如果用户点击它。点击消息可能引发 ActionEvent。

无论是标题或文本可以null，但NullPointerException是如果都是null扔。当显示时，标题或文本字符串可能会被截断在一些平台上，可能显示的字符数是依赖于平台的。

注：有些平台可能不支持显示一个消息。

参数

caption上面显示的文本标题，通常可以 null大胆；

text -特定消息显示的文本；可以 null

messageType -枚举指示消息类型

异常

NullPointerException -如果 caption和 text是 null

getSize

public Dimension getSize()

返回托盘图标在系统托盘中占据的空间的大小，以像素为单位。的托盘图标，尚未添加到系统托盘中，返回的大小是相等的 SystemTray.getTrayIconSize()结果。

结果

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

另请参见：

setImageAutoSize(boolean)， Image， getSize()