System Tray

In the following we will add an icon to the system tray.

We also add the functionality that if the window is minimized then the program is not visible in the taskpane (only via the tray icon) and we will add a menu with one entry to system tray icon.

Create a new project "de.vogella.rcp.intro.traytest". Use the "Hello RCP" as a template.

Create a command which the id "de.vogella.rcp.intro.traytest.exitCommand" which exists the application (see Eclipse commands for details).

Maintain the following code in class ApplicationWorkbenchWindowAdvisor.

   
package de.vogella.rcp.intro.traytest;

import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ShellAdapter;
import org.eclipse.swt.events.ShellEvent;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Tray;
import org.eclipse.swt.widgets.TrayItem;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.application.ActionBarAdvisor;
import org.eclipse.ui.application.IActionBarConfigurer;
import org.eclipse.ui.application.IWorkbenchWindowConfigurer;
import org.eclipse.ui.application.WorkbenchWindowAdvisor;
import org.eclipse.ui.handlers.IHandlerService;
import org.eclipse.ui.plugin.AbstractUIPlugin;

public class ApplicationWorkbenchWindowAdvisor extends WorkbenchWindowAdvisor {
 private IWorkbenchWindow window;
 private TrayItem trayItem;
 private Image trayImage;
 private  final static String COMMAND_ID = "de.vogella.rcp.intro.traytest.exitCommand";

   public ApplicationWorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer) {
       super(configurer);
   }

   @Override
   public ActionBarAdvisor createActionBarAdvisor(IActionBarConfigurer configurer) {
       return new ApplicationActionBarAdvisor(configurer);
   }
  
   @Override
   public void preWindowOpen() {
       IWorkbenchWindowConfigurer configurer = getWindowConfigurer();
       configurer.setInitialSize(new Point(400, 300));
       configurer.setShowCoolBar(false);
       configurer.setShowStatusLine(false);
       configurer.setTitle("Hello RCP");
   }
  
   @Override
 public void postWindowOpen() {
  super.postWindowOpen();
  window = getWindowConfigurer().getWindow();
  trayItem = initTaskItem(window);
  if (trayItem != null) {
   createMinimize();
   // Create exit and about action on the icon
   hookPopupMenu();
  }
 }

   // Add a listener to the shell
   // If the window is minimized hide the window
 private void createMinimize() {
  window.getShell().addShellListener(new ShellAdapter() {
   public void shellIconified(ShellEvent e) {
    window.getShell().setVisible(false);
   }
  });
 // If user double-clicks on the tray icons the application will be visible again
  trayItem.addListener(SWT.DefaultSelection, new Listener() {
   public void handleEvent(Event event) {
    Shell shell = window.getShell();
    if (!shell.isVisible()) {
     shell.setVisible(true);
     window.getShell().setMinimized(false);
    }
   }
  });
 }

 // We hook up on menu entry which allows to close the application
 private void hookPopupMenu() {
  trayItem.addListener(SWT.MenuDetect, new Listener() {
   public void handleEvent(Event event) {
    Menu menu = new Menu(window.getShell(), SWT.POP_UP);

    // Creates a new menu item that terminates the program
    // when selected
    MenuItem exit = new MenuItem(menu, SWT.NONE);
    exit.setText("Goodbye!");
    exit.addListener(SWT.Selection, new Listener() {
     public void handleEvent(Event event) {
      // Lets call our command
      IHandlerService handlerService = (IHandlerService) window
        .getService(IHandlerService.class);
      try {
       handlerService.executeCommand(COMMAND_ID, null);
      } catch (Exception ex) {
       throw new RuntimeException(COMMAND_ID);
      }
     }
    });
    // We need to make the menu visible
    menu.setVisible(true);
   }
  });
 }

 private TrayItem initTaskItem(IWorkbenchWindow window) {
  final Tray tray = window.getShell().getDisplay().getSystemTray();
  TrayItem trayItem = new TrayItem(tray, SWT.NONE);
  trayImage = AbstractUIPlugin.imageDescriptorFromPlugin(
    "de.vogella.rcp.intro.traytest", "/icons/alt_about.gif").createImage();
  trayItem.setImage(trayImage);
  trayItem.setToolTipText("TrayItem");
  return trayItem;

 }

 // We need to clean-up after ourself
 @Override
 public void dispose() {
  if (trayImage != null) {
   trayImage.dispose();
   trayItem.dispose();
  }
 }

}

  

Run your application and see that you have a system tray icon. Test the menu and the minimized behavior. If the application is minized it should not be vislble in the taskbar but only in the system tray.