public TrayIcon(Image image) 
{
        this();
        if (image == null) {
            throw new IllegalArgumentException("creating TrayIcon with null Image");
        }
        setImage(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

Also see:

SystemTray#add(TrayIcon)
TrayIcon#TrayIcon(Image, String, PopupMenu)
TrayIcon#TrayIcon(Image, String)
SecurityManager#checkPermission
AWTPermission

 public TrayIcon(Image image,
    String tooltip) 
{
        this(image);
        setToolTip(tooltip);
}

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

Also see:

SystemTray#add(TrayIcon)
TrayIcon#TrayIcon(Image)
TrayIcon#TrayIcon(Image, String, PopupMenu)
SecurityManager#checkPermission
AWTPermission

 public TrayIcon(Image image,
    String tooltip,
    PopupMenu popup) 
{
        this(image, tooltip);
        setPopupMenu(popup);
}

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

Also see:

SystemTray#add(TrayIcon)
TrayIcon#TrayIcon(Image, String)
TrayIcon#TrayIcon(Image)
PopupMenu
MouseListener
addMouseListener(MouseListener)
SecurityManager#checkPermission
AWTPermission

 public synchronized  void addActionListener(ActionListener listener) 
{
        if (listener == null) {
            return;
        }
        actionListener = AWTEventMulticaster.add(actionListener, listener);
}

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.

 public synchronized  void addMouseListener(MouseListener listener) 
{
        if (listener == null) {
            return;
        }
        mouseListener = AWTEventMulticaster.add(mouseListener, listener);
}

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

Note: The {@code MouseEvent}'s coordinates (received from the {@code TrayIcon}) are relative to the screen, not the {@code 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.

 public synchronized  void addMouseMotionListener(MouseMotionListener listener) 
{
        if (listener == null) {
            return;
        }
        mouseMotionListener = AWTEventMulticaster.add(mouseMotionListener, listener);
}

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 {@code MouseEvent}'s coordinates (received from the {@code TrayIcon}) are relative to the screen, not the {@code TrayIcon}.

Note: The MOUSE_DRAGGED mouse event is not supported.

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

  void addNotify() throws AWTException 
{
        synchronized (this) {
            if (peer == null) {
                Toolkit toolkit = Toolkit.getDefaultToolkit();
                if (toolkit instanceof SunToolkit) {
                    peer = ((SunToolkit)Toolkit.getDefaultToolkit()).createTrayIcon(this);
                } else if (toolkit instanceof HeadlessToolkit) {
                    peer = ((HeadlessToolkit)Toolkit.getDefaultToolkit()).createTrayIcon(this);
                }
            }
        }
        peer.setToolTip(tooltip);
}

  void dispatchEvent(AWTEvent e) 
{
        EventQueue.setCurrentEventAndMostRecentTime(e);
        Toolkit.getDefaultToolkit().notifyAWTEventListeners(e);
        processEvent(e);
}

 public  void displayMessage(String caption,
    String text,
    MessageType messageType) 
{
        if (caption == null && text == null) {
            throw new NullPointerException("displaying the message with both caption and text being null");
        }
        TrayIconPeer peer = this.peer;
        if (peer != null) {
            peer.displayMessage(caption, text, messageType.name());
        }
}

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 {@code 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.

 final AccessControlContext getAccessControlContext() 
{
        if (acc == null) {
            throw new SecurityException("TrayIcon is missing AccessControlContext");
        }
        return acc;
}

 public String getActionCommand() 
{
        return actionCommand;
}

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

 public synchronized ActionListener[] getActionListeners() 
{
        return AWTEventMulticaster.getListeners(actionListener, ActionListener.class);
}

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

 int getID() 
{
        return id;
}

 public Image getImage() 
{
        return image;
}

Returns the current image used for this TrayIcon.

 public synchronized MouseListener[] getMouseListeners() 
{
        return AWTEventMulticaster.getListeners(mouseListener, MouseListener.class);
}

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

 public synchronized MouseMotionListener[] getMouseMotionListeners() 
{
        return AWTEventMulticaster.getListeners(mouseMotionListener, MouseMotionListener.class);
}

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

 public PopupMenu getPopupMenu() 
{
        return popup;
}

Returns the popup menu associated with this TrayIcon.

 public Dimension getSize() 
{
        return SystemTray.getSystemTray().getTrayIconSize();
}

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 the SystemTray#getTrayIconSize .

 public String getToolTip() 
{
        return tooltip;
}

Returns the tooltip string associated with this TrayIcon.

 public boolean isImageAutoSize() 
{
        return autosize;
}

Returns the value of the auto-size property.

  void processActionEvent(ActionEvent e) 
{
        ActionListener listener = actionListener;
        if (listener != null) {
            listener.actionPerformed(e);
        }
}

  void processEvent(AWTEvent e) 
{
        if (e instanceof MouseEvent) {
            switch(e.getID()) {
            case MouseEvent.MOUSE_PRESSED:
            case MouseEvent.MOUSE_RELEASED:
            case MouseEvent.MOUSE_CLICKED:
                processMouseEvent((MouseEvent)e);
                break;
            case MouseEvent.MOUSE_MOVED:
                processMouseMotionEvent((MouseEvent)e);
                break;
            default:
                return;
            }
        } else if (e instanceof ActionEvent) {
            processActionEvent((ActionEvent)e);
        }
}

  void processMouseEvent(MouseEvent e) 
{
        MouseListener listener = mouseListener;
        if (listener != null) {
            int id = e.getID();
            switch(id) {
            case MouseEvent.MOUSE_PRESSED:
                listener.mousePressed(e);
                break;
            case MouseEvent.MOUSE_RELEASED:
                listener.mouseReleased(e);
                break;
            case MouseEvent.MOUSE_CLICKED:
                listener.mouseClicked(e);
                break;
            default:
                return;
            }
        }
}

  void processMouseMotionEvent(MouseEvent e) 
{
        MouseMotionListener listener = mouseMotionListener;
        if (listener != null &&
            e.getID() == MouseEvent.MOUSE_MOVED)
        {
            listener.mouseMoved(e);
        }
}

 public synchronized  void removeActionListener(ActionListener listener) 
{
        if (listener == null) {
            return;
        }
        actionListener = AWTEventMulticaster.remove(actionListener, 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.

 public synchronized  void removeMouseListener(MouseListener listener) 
{
        if (listener == null) {
            return;
        }
        mouseListener = AWTEventMulticaster.remove(mouseListener, 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.

 public synchronized  void removeMouseMotionListener(MouseMotionListener listener) 
{
        if (listener == null) {
            return;
        }
        mouseMotionListener = AWTEventMulticaster.remove(mouseMotionListener, 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.

  void removeNotify() 
{
        TrayIconPeer p = null;
        synchronized (this) {
            p = peer;
            peer = null;
        }
        if (p != null) {
            p.dispose();
        }
}

 public  void setActionCommand(String command) 
{
        actionCommand = command;
}

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

  void setID(int id) 
{
        this.id = id;
}

 public  void setImage(Image image) 
{
        if (image == null) {
            throw new NullPointerException("setting null Image");
        }
        this.image = image;
        TrayIconPeer peer = this.peer;
        if (peer != null) {
            peer.updateImage();
        }
}

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

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

See the #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.

 public  void setImageAutoSize(boolean autosize) 
{
        this.autosize = autosize;
        TrayIconPeer peer = this.peer;
        if (peer != null) {
            peer.updateImage();
        }
}

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.

 public  void setPopupMenu(PopupMenu popup) 
{
        if (popup == this.popup) {
            return;
        }
        synchronized (TrayIcon.class) {
            if (popup != null) {
                if (popup.isTrayIconPopup) {
                    throw new IllegalArgumentException("the PopupMenu is already set for another TrayIcon");
                }
                popup.isTrayIconPopup = true;
            }
            if (this.popup != null) {
                this.popup.isTrayIconPopup = false;
            }
            this.popup = popup;
        }
}

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 {@code popup} can be set on one {@code TrayIcon} only. Setting the same popup on multiple {@code TrayIcon}s will cause an {@code 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.

 public  void setToolTip(String tooltip) 
{
        this.tooltip = tooltip;
        TrayIconPeer peer = this.peer;
        if (peer != null) {
            peer.setToolTip(tooltip);
        }
}

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.