Nested Class Summary

Constructor Summary

Method Summary

Constructor Details

• TrayIcon

  public TrayIcon(Image image)

  Creates aTrayIcon with the specified image.

  Parameters:

  image - theImage to be used

  Throws:

  IllegalArgumentException - ifimage isnull

  UnsupportedOperationException - if the system tray isn't supported by the current platform

  HeadlessException - ifGraphicsEnvironment.isHeadless() returnstrue

  See Also:

  • SystemTray.add(TrayIcon)
  • TrayIcon(Image, String, PopupMenu)
  • TrayIcon(Image, String)

• TrayIcon

  public TrayIcon(Image image,String tooltip)

  Creates aTrayIcon with the specified image and tooltip text. Tooltip may be not visible on some platforms.

  Parameters:

  image - theImage to be used

  tooltip - the string to be used as tooltip text; if the value isnull no tooltip is shown

  Throws:

  IllegalArgumentException - ifimage isnull

  UnsupportedOperationException - if the system tray isn't supported by the current platform

  HeadlessException - ifGraphicsEnvironment.isHeadless() returnstrue

  See Also:

  • SystemTray.add(TrayIcon)
  • TrayIcon(Image)
  • TrayIcon(Image, String, PopupMenu)

• TrayIcon

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

  Creates aTrayIcon with the specified image, tooltip and popup menu. Tooltip may be not visible on some platforms.

  Parameters:

  image - theImage to be used

  tooltip - the string to be used as tooltip text; if the value isnull no tooltip is shown

  popup - the menu to be used for the tray icon's popup menu; if the value isnull no popup menu is shown

  Throws:

  IllegalArgumentException - ifimage isnull

  UnsupportedOperationException - if the system tray isn't supported by the current platform

  HeadlessException - ifGraphicsEnvironment.isHeadless() returnstrue

  See Also:

  • SystemTray.add(TrayIcon)
  • TrayIcon(Image, String)
  • TrayIcon(Image)
  • PopupMenu
  • MouseListener
  • addMouseListener(MouseListener)

Method Details

• setImage

  public void setImage(Image image)

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

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

  See thesetImageAutoSize(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-nullImage to be used

  Throws:

  NullPointerException - ifimage isnull

  See Also:

  • getImage()
  • Image
  • SystemTray.add(TrayIcon)
  • TrayIcon(Image, String)

• getImage

  public Image getImage()

  Returns the current image used for thisTrayIcon.

  Returns:

  the image

  See Also:

  • setImage(Image)
  • Image

• setPopupMenu

  public void setPopupMenu(PopupMenu popup)

  Sets the popup menu for thisTrayIcon. Ifpopup isnull, no popup menu will be associated with thisTrayIcon.

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

  Thepopup can be set on oneTrayIcon only. Setting the same popup on multipleTrayIcons will cause anIllegalArgumentException.

  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 - aPopupMenu ornull to remove any popup menu

  Throws:

  IllegalArgumentException - if thepopup is already set for anotherTrayIcon

  See Also:

  • getPopupMenu()

• getPopupMenu

  public PopupMenu getPopupMenu()

  Returns the popup menu associated with thisTrayIcon.

  Returns:

  the popup menu ornull if none exists

  See Also:

  • setPopupMenu(PopupMenu)

• setToolTip

  public void setToolTip(String tooltip)

  Sets the tooltip string for thisTrayIcon. The tooltip is displayed automatically when the mouse hovers over the icon. Tooltip may be not visible on some platforms. Setting the tooltip tonull 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 isnull no tooltip is shown

  See Also:

  • getToolTip()

• getToolTip

  public String getToolTip()

  Returns the tooltip string associated with thisTrayIcon.

  Returns:

  the tooltip string ornull if none exists

  See Also:

  • setToolTip(String)

• setImageAutoSize

  public void setImageAutoSize(boolean autosize)

  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 tofalse.

  If auto-size isfalse, 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 istrue, the image is stretched or shrunk to fit the tray icon space.

  Parameters:

  autosize -true to auto-size the image,false otherwise

  See Also:

  • isImageAutoSize()

• isImageAutoSize

  public boolean isImageAutoSize()

  Returns the value of the auto-size property.

  Returns:

  true if the image will be auto-sized,false otherwise

  See Also:

  • setImageAutoSize(boolean)

• addMouseListener

  public void addMouseListener(MouseListener listener)

  Adds the specified mouse listener to receive mouse events from thisTrayIcon. Calling this method with anull value has no effect.

  Note: TheMouseEvent's coordinates (received from theTrayIcon) are relative to the screen, not theTrayIcon.

  Note:TheMOUSE_ENTERED andMOUSE_EXITED mouse events are not supported.

  Refer toAWT Threading Issues for details on AWT's threading model.

  Parameters:

  listener - the mouse listener

  See Also:

  • MouseEvent
  • MouseListener
  • removeMouseListener(MouseListener)
  • getMouseListeners()

• removeMouseListener

  public void removeMouseListener(MouseListener listener)

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

  Refer toAWT Threading Issues for details on AWT's threading model.

  Parameters:

  listener - the mouse listener

  See Also:

  • MouseEvent
  • MouseListener
  • addMouseListener(MouseListener)
  • getMouseListeners()

• getMouseListeners

  public MouseListener[] getMouseListeners()

  Returns an array of all the mouse listeners registered on thisTrayIcon.

  Returns:

  all of theMouseListeners registered on thisTrayIcon or an empty array if no mouse listeners are currently registered

  See Also:

  • addMouseListener(MouseListener)
  • removeMouseListener(MouseListener)
  • MouseListener

• addMouseMotionListener

  public void addMouseMotionListener(MouseMotionListener listener)

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

  Note: TheMouseEvent's coordinates (received from theTrayIcon) are relative to the screen, not theTrayIcon.

  Note:TheMOUSE_DRAGGED mouse event is not supported.

  Refer toAWT Threading Issues for details on AWT's threading model.

  Parameters:

  listener - the mouse listener

  See Also:

  • MouseEvent
  • MouseMotionListener
  • removeMouseMotionListener(MouseMotionListener)
  • getMouseMotionListeners()

• removeMouseMotionListener

  public void removeMouseMotionListener(MouseMotionListener listener)

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

  Refer toAWT Threading Issues for details on AWT's threading model.

  Parameters:

  listener - the mouse listener

  See Also:

  • MouseEvent
  • MouseMotionListener
  • addMouseMotionListener(MouseMotionListener)
  • getMouseMotionListeners()

• getMouseMotionListeners

  public MouseMotionListener[] getMouseMotionListeners()

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

  Returns:

  all of theMouseInputListeners registered on thisTrayIcon or an empty array if no mouse listeners are currently registered

  See Also:

  • addMouseMotionListener(MouseMotionListener)
  • removeMouseMotionListener(MouseMotionListener)
  • MouseMotionListener

• getActionCommand

  public String getActionCommand()

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

  Returns:

  the action command name, ornull if none exists

  See Also:

  • addActionListener(ActionListener)
  • setActionCommand(String)

• setActionCommand

  public void setActionCommand(String command)

  Sets the command name for the action event fired by this tray icon. By default, this action command is set tonull.

  Parameters:

  command - a string used to set the tray icon's action command.

  See Also:

  • ActionEvent
  • addActionListener(ActionListener)
  • getActionCommand()

• addActionListener

  public void addActionListener(ActionListener listener)

  Adds the specified action listener to receiveActionEvents from thisTrayIcon. 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 anull value has no effect.

  Refer toAWT Threading Issues for details on AWT's threading model.

  Parameters:

  listener - the action listener

  See Also:

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

• removeActionListener

  public void removeActionListener(ActionListener listener)

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

  Refer toAWT Threading Issues for details on AWT's threading model.

  Parameters:

  listener - the action listener

  See Also:

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

• getActionListeners

  public ActionListener[] getActionListeners()

  Returns an array of all the action listeners registered on thisTrayIcon.

  Returns:

  all of theActionListeners registered on thisTrayIcon or an empty array if no action listeners are currently registered

  See Also:

  • addActionListener(ActionListener)
  • removeActionListener(ActionListener)
  • ActionListener

• displayMessage

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

  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 anActionEvent.

  Either the caption or the text may benull, but anNullPointerException is thrown if both arenull. 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 benull

  text - the text displayed for the particular message; may benull

  messageType - an enum indicating the message type

  Throws:

  NullPointerException - if bothcaption andtext arenull

• getSize

  public Dimension getSize()

  Returns the size, in pixels, of the space that the tray icon occupies in the system tray. For the tray icon that is not yet added to the system tray, the returned size is equal to the result of theSystemTray.getTrayIconSize().

  Returns:

  the size of the tray icon, in pixels

  See Also:

  • setImageAutoSize(boolean)
  • Image
  • getSize()