TrayIcon JDK 1.6)

Constructors

private TrayIcon () throws UnsupportedOperationException HeadlessException SecurityException

public TrayIcon (Image image)

Creates a TrayIcon with the specified image.

Creates a TrayIcon with the specified image.
Parameters:
- image - the Image to be used
Throws:
- IllegalArgumentException - if image is null
- UnsupportedOperationException - if the system tray isn't supported by the current platform
- HeadlessException - if {@code GraphicsEnvironment.isHeadless()} returns {@code true}
- SecurityException - if {@code accessSystemTray} permission is not granted
See Also: SystemTray.add(TrayIcon), TrayIcon.TrayIcon(Image, String, PopupMenu), TrayIcon.TrayIcon(Image, String), SecurityManager.checkPermission(java.security.Permission), AWTPermission,

public TrayIcon (Image image, String tooltip)

Creates a TrayIcon with the specified image and tooltip text.

Creates a TrayIcon with the specified image and
tooltip text.
Parameters:
- image - the Image to be used
- tooltip - the string to be used as tooltip text; if the value is null no tooltip is shown
Throws:
- IllegalArgumentException - if image is null
- UnsupportedOperationException - if the system tray isn't supported by the current platform
- HeadlessException - if {@code GraphicsEnvironment.isHeadless()} returns {@code true}
- SecurityException - if {@code accessSystemTray} permission is not granted
See Also: SystemTray.add(TrayIcon), TrayIcon.TrayIcon(Image), TrayIcon.TrayIcon(Image, String, PopupMenu), SecurityManager.checkPermission(java.security.Permission), AWTPermission,

public TrayIcon (Image image, String tooltip, PopupMenu popup)

Creates a TrayIcon with the specified image, tooltip and popup menu.

Creates a TrayIcon with the specified image,
tooltip and popup menu.
Parameters:
- image - the Image to be used
- tooltip - the string to be used as tooltip text; if the value is null no tooltip is shown
- popup - the menu to be used for the tray icon's popup menu; if the value is null no popup menu is shown
Throws:
- IllegalArgumentException - if image is null
- UnsupportedOperationException - if the system tray isn't supported by the current platform
- HeadlessException - if {@code GraphicsEnvironment.isHeadless()} returns {@code true}
- SecurityException - if {@code accessSystemTray} permission is not granted
See Also: SystemTray.add(TrayIcon), TrayIcon.TrayIcon(Image, String), TrayIcon.TrayIcon(Image), PopupMenu, MouseListener, TrayIcon.addMouseListener(MouseListener), SecurityManager.checkPermission(java.security.Permission), AWTPermission,

Methods

Hide/Show inherited methods

publicsynchronized void addActionListener (ActionListener listener)

Adds the specified action listener to receive ActionEvents from this TrayIcon.

Adds the specified action listener to receive ActionEvents from this TrayIcon. Action events usually occur when a user selects the tray icon, using either the mouse or keyboard. The conditions in which action events are generated are platform-dependent.

Calling this method with a null value has no effect.

Refer to AWT Threading Issues for details on AWT's threading model.
Parameters:
- listener - the action listener
See Also: TrayIcon.removeActionListener(java.awt.event.ActionListener), TrayIcon.getActionListeners(), ActionListener, TrayIcon.setActionCommand(String),

publicsynchronized void addMouseListener (MouseListener listener)

Adds the specified mouse listener to receive mouse events from this TrayIcon.

Adds the specified mouse listener to receive mouse events from this TrayIcon. Calling this method with a null value has no effect.

Note: The MouseEvent's coordinates (received from the TrayIcon) are relative to the screen, not the TrayIcon.

Note: The MOUSE_ENTERED and MOUSE_EXITED mouse events are not supported.

Refer to AWT Threading Issues for details on AWT's threading model.
Parameters:
- listener - the mouse listener
See Also: MouseEvent, MouseListener, TrayIcon.removeMouseListener(MouseListener), TrayIcon.getMouseListeners(),

publicsynchronized void addMouseMotionListener (MouseMotionListener listener)

Adds the specified mouse listener to receive mouse-motion events from this TrayIcon.

Adds the specified mouse listener to receive mouse-motion events from this TrayIcon. Calling this method with a null value has no effect.

Note: The MouseEvent's coordinates (received from the TrayIcon) are relative to the screen, not the TrayIcon.

Note: The MOUSE_DRAGGED mouse event is not supported.

Refer to AWT Threading Issues for details on AWT's threading model.
Parameters:
- listener - the mouse listener
See Also: MouseEvent, MouseMotionListener, TrayIcon.removeMouseMotionListener(MouseMotionListener), TrayIcon.getMouseMotionListeners(),

pack-private void addNotify () throws AWTException

pack-private void dispatchEvent (AWTEvent e)

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

Displays a popup message near the tray icon.

Displays a popup message near the tray icon. The message will disappear after a time or if the user clicks on it. Clicking on the message may trigger an ActionEvent.

Either the caption or the text may be null, but an NullPointerException is thrown if both are null. When displayed, the caption or text strings may be truncated on some platforms; the number of characters that may be displayed is platform-dependent.

Note: Some platforms may not support showing a message.
Parameters:
- caption - the caption displayed above the text, usually in bold; may be null
- text - the text displayed for the particular message; may be null
- messageType - an enum indicating the message type
Throws:
- NullPointerException - if both caption and text are null

public String getActionCommand ()

Returns the command name of the action event fired by this tray icon.

Returns the command name of the action event fired by this tray icon.
Returns: the action command name, or null if none exists
See Also: TrayIcon.addActionListener(ActionListener), TrayIcon.setActionCommand(String),

publicsynchronized ActionListener getActionListeners ()

Returns an array of all the action listeners registered on this TrayIcon.

Returns an array of all the action listeners
registered on this TrayIcon.
Returns: all of the ActionListeners registered on this TrayIcon or an empty array if no action listeners are currently registered
See Also: TrayIcon.addActionListener(ActionListener), TrayIcon.removeActionListener(ActionListener), ActionListener,

pack-private int getID ()

public Image getImage ()

Returns the current image used for this TrayIcon.

Returns the current image used for this TrayIcon.
Returns: the image
See Also: TrayIcon.setImage(Image), Image,

pack-private T getListeners (Class< T> listenerType)

publicsynchronized MouseListener getMouseListeners ()

Returns an array of all the mouse listeners registered on this TrayIcon.

Returns an array of all the mouse listeners
registered on this TrayIcon.
Returns: all of the MouseListeners registered on this TrayIcon or an empty array if no mouse listeners are currently registered
See Also: TrayIcon.addMouseListener(MouseListener), TrayIcon.removeMouseListener(MouseListener), MouseListener,

publicsynchronized MouseMotionListener getMouseMotionListeners ()

Returns an array of all the mouse-motion listeners registered on this TrayIcon.

Returns an array of all the mouse-motion listeners
registered on this TrayIcon.
Returns: all of the MouseInputListeners registered on this TrayIcon or an empty array if no mouse listeners are currently registered
See Also: TrayIcon.addMouseMotionListener(MouseMotionListener), TrayIcon.removeMouseMotionListener(MouseMotionListener), MouseMotionListener,

public PopupMenu getPopupMenu ()

Returns the popup menu associated with this TrayIcon.

Returns the popup menu associated with this TrayIcon.
Returns: the popup menu or null if none exists
See Also: TrayIcon.setPopupMenu(PopupMenu),

public Dimension getSize ()

Returns the size, in pixels, of the space that the tray icon occupies in the system tray.

public String getToolTip ()

Returns the tooltip string associated with this TrayIcon.

Returns the tooltip string associated with this
TrayIcon.
Returns: the tooltip string or null if none exists
See Also: TrayIcon.setToolTip(String),

public boolean isImageAutoSize ()

Returns the value of the auto-size property.

Returns the value of the auto-size property.
Returns: true if the image will be auto-sized, false otherwise
See Also: TrayIcon.setImageAutoSize(boolean),

pack-private void processActionEvent (ActionEvent e)

pack-private void processEvent (AWTEvent e)

pack-private void processMouseEvent (MouseEvent e)

pack-private void processMouseMotionEvent (MouseEvent e)

publicsynchronized void removeActionListener (ActionListener listener)

Removes the specified action listener.

Removes the specified action listener. Calling this method with null or an invalid value has no effect.

Refer to AWT Threading Issues for details on AWT's threading model.
Parameters:
- listener - the action listener
See Also: ActionEvent, ActionListener, TrayIcon.addActionListener(ActionListener), TrayIcon.getActionListeners(), TrayIcon.setActionCommand(String),

publicsynchronized void removeMouseListener (MouseListener listener)

Removes the specified mouse listener.

Removes the specified mouse listener. Calling this method with null or an invalid value has no effect.

Refer to AWT Threading Issues for details on AWT's threading model.
Parameters:
- listener - the mouse listener
See Also: MouseEvent, MouseListener, TrayIcon.addMouseListener(MouseListener), TrayIcon.getMouseListeners(),

publicsynchronized void removeMouseMotionListener (MouseMotionListener listener)

Removes the specified mouse-motion listener.

Removes the specified mouse-motion listener. Calling this method with null or an invalid value has no effect.

Refer to AWT Threading Issues for details on AWT's threading model.
Parameters:
- listener - the mouse listener
See Also: MouseEvent, MouseMotionListener, TrayIcon.addMouseMotionListener(MouseMotionListener), TrayIcon.getMouseMotionListeners(),

pack-private void removeNotify ()

public void setActionCommand (String command)

Sets the command name for the action event fired by this tray icon.

Sets the command name for the action event fired by this tray
icon. By default, this action command is set to
null.
Parameters:
- command - a string used to set the tray icon's action command.
See Also: ActionEvent, TrayIcon.addActionListener(ActionListener), TrayIcon.getActionCommand(),

pack-private void setID (int id)

public void setImage (Image image)

Sets the image for this TrayIcon.

Sets the image for this TrayIcon. The previous tray icon image is discarded without calling the Image.flush() method — you will need to call it manually.

If the image represents an animated image, it will be animated automatically.

See the TrayIcon.setImageAutoSize(boolean) property for details on the size of the displayed image.

Calling this method with the same image that is currently being used has no effect.
Parameters:
- image - the non-null Image to be used
Throws:
- NullPointerException - if image is null
See Also: TrayIcon.getImage(), Image, SystemTray.add(TrayIcon), TrayIcon.TrayIcon(Image, String),

public void setImageAutoSize (boolean autosize)

Sets the auto-size property.

Sets the auto-size property. Auto-size determines whether the tray image is automatically sized to fit the space allocated for the image on the tray. By default, the auto-size property is set to false.

If auto-size is false, and the image size doesn't match the tray icon space, the image is painted as-is inside that space — if larger than the allocated space, it will be cropped.

If auto-size is true, the image is stretched or shrunk to fit the tray icon space.
Parameters:
- autosize - true to auto-size the image, false otherwise
See Also: TrayIcon.isImageAutoSize(),

public void setPopupMenu (PopupMenu popup)

Sets the popup menu for this TrayIcon.

Sets the popup menu for this TrayIcon. If popup is null, no popup menu will be associated with this TrayIcon.

Note that this popup must not be added to any parent before or after it is set on the tray icon. If you add it to some parent, the popup may be removed from that parent.

The popup can be set on one TrayIcon only. Setting the same popup on multiple TrayIcons will cause an IllegalArgumentException.

Note: Some platforms may not support showing the user-specified popup menu component when the user right-clicks the tray icon. In this situation, either no menu will be displayed or, on some systems, a native version of the menu may be displayed.
Parameters:
- popup - a PopupMenu or null to remove any popup menu
Throws:
- IllegalArgumentException - if the {@code popup} is already set for another {@code TrayIcon}
See Also: TrayIcon.getPopupMenu(),

public void setToolTip (String tooltip)

Sets the tooltip string for this TrayIcon.

Sets the tooltip string for this TrayIcon. The
tooltip is displayed automatically when the mouse hovers over
the icon. Setting the tooltip to null removes any
tooltip text.

When displayed, the tooltip string may be truncated on some platforms;
the number of characters that may be displayed is platform-dependent.
Parameters:
- tooltip - the string for the tooltip; if the value is null no tooltip is shown
See Also: TrayIcon.getToolTip(),