Package com.github.ushiosan23.javafx.system

Class TrayIconFX

  • public class TrayIconFX
extends java.lang.Object
    System tray icon used to display icon in system bar. This class add support to tray icon in JavaFX

    • Constructor Summary

      Constructors 
      Constructor Description
      TrayIconFX​(@NotNull javafx.scene.image.Image image, @Nullable java.lang.String tooltip, @Nullable java.awt.PopupMenu menu)
      Create system tray icon
      TrayIconFX​(javafx.scene.image.Image image)
      Create system tray icon
      TrayIconFX​(javafx.scene.image.Image image, java.lang.String tooltip)
      Create system tray icon

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addActionListener​(java.awt.event.ActionListener listener)
      Add action mouse listener
      void addMouseListener​(java.awt.event.MouseListener listener)
      Add mouse listener
      void addPopupItemSelectionListener​(java.awt.event.ActionListener listener)
      Add popup menu action listener
      void attachToSystem()
      Attach tray icon to system
      void detachToSystem()
      Remove tray icon from system
      void displayMessage​(java.lang.String caption, java.lang.String text, java.awt.TrayIcon.MessageType messageType)
      Display system messages.
      javafx.scene.image.Image getImage()
      Get tray image
      @Nullable java.awt.PopupMenu getPopupMenu()
      Get current popup menu
      @Nullable java.lang.String getToolTip()
      Get tooltip
      static boolean isPlatformSupport()
      Check if current platform, supports system tray
      void removeActionListener​(java.awt.event.ActionListener listener)
      Remove action mouse listener
      void removeMouseListener​(java.awt.event.MouseListener listener)
      Remove mouse listener
      void removeMouseMotionListener​(java.awt.event.MouseMotionListener listener)
      Remove mouse motion listener
      void removePopupItemSelectionListener​(java.awt.event.ActionListener listener)
      Remove popup menu action listener
      void setImage​(javafx.scene.image.Image image)
      Set tray image
      void setPopupMenu​(java.awt.PopupMenu popup)
      Set tray popup menu
      void setToolTip​(java.lang.String tooltip)
      Set tray tooltip

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TrayIconFX

        public TrayIconFX​(@NotNull
                  @NotNull javafx.scene.image.Image image,
                  @Nullable
                  @Nullable java.lang.String tooltip,
                  @Nullable
                  @Nullable java.awt.PopupMenu menu)
        Create system tray icon
        Parameters:
        image - Target image to display
        tooltip - Tooltip message (when tray icon is hovered)
        menu - Tray menu

      • TrayIconFX

        public TrayIconFX​(javafx.scene.image.Image image,
                  java.lang.String tooltip)
        Create system tray icon
        Parameters:
        image - Target image to display
        tooltip - Tooltip message (when tray icon is hovered)

      • TrayIconFX

        public TrayIconFX​(javafx.scene.image.Image image)
        Create system tray icon
        Parameters:
        image - Target image to display

    • Method Detail

      • addPopupItemSelectionListener

        public void addPopupItemSelectionListener​(java.awt.event.ActionListener listener)
        Add popup menu action listener
        Parameters:
        listener - Target object listener

      • removePopupItemSelectionListener

        public void removePopupItemSelectionListener​(java.awt.event.ActionListener listener)
        Remove popup menu action listener
        Parameters:
        listener - Target object listener

      • setImage

        public void setImage​(javafx.scene.image.Image image)
        Set tray image
        Parameters:
        image - Javafx image

      • getImage

        public javafx.scene.image.Image getImage()
        Get tray image
        Returns:
        Image Target javafx image

      • setPopupMenu

        public void setPopupMenu​(java.awt.PopupMenu popup)
        Set tray popup menu
        Parameters:
        popup - Target popup menu

      • getPopupMenu

        @Nullable
public @Nullable java.awt.PopupMenu getPopupMenu()
        Get current popup menu
        Returns:
        Current popup menu or null if not exists

      • setToolTip

        public void setToolTip​(java.lang.String tooltip)
        Set tray tooltip
        Parameters:
        tooltip - Target message tooltip

      • getToolTip

        @Nullable
public @Nullable java.lang.String getToolTip()
        Get tooltip
        Returns:
        String tooltip message or null if not exists

      • addMouseListener

        public void addMouseListener​(java.awt.event.MouseListener listener)
        Add mouse listener
        Parameters:
        listener - Target object listener

      • removeMouseListener

        public void removeMouseListener​(java.awt.event.MouseListener listener)
        Remove mouse listener
        Parameters:
        listener - Target object listener

      • removeMouseMotionListener

        public void removeMouseMotionListener​(java.awt.event.MouseMotionListener listener)
        Remove mouse motion listener
        Parameters:
        listener - Target object listener

      • addActionListener

        public void addActionListener​(java.awt.event.ActionListener listener)
        Add action mouse listener
        Parameters:
        listener - Target object listener

      • removeActionListener

        public void removeActionListener​(java.awt.event.ActionListener listener)
        Remove action mouse listener
        Parameters:
        listener - Target object listener

      • displayMessage

        public void displayMessage​(java.lang.String caption,
                           java.lang.String text,
                           java.awt.TrayIcon.MessageType messageType)
        Display system messages.
        Parameters:
        caption - Message title
        text - Message body
        messageType - Message type

      • attachToSystem

        public void attachToSystem()
        Attach tray icon to system

      • detachToSystem

        public void detachToSystem()
        Remove tray icon from system

      • isPlatformSupport

        public static boolean isPlatformSupport()
        Check if current platform, supports system tray
        Returns:
        Boolean support result