Bug 339217

Description Marko Tomljenovic 2011-03-08 08:14:17 EST

Build Identifier: 2.0.3

I am using the following code to execute a context menu entry on a tree item ("open with" -> "xyz editor"). For that I am using the following code:

  /**
   * Clicks the context menu matching the text.<br>
   * ATTENTION: To have the proper context menu make sure that the right element of the control (e.g. tree item) is
   * selected before this method is called.
   * 
   * @param bot : Swt bot control ex: tree, table etc, not a tree item or menu item
   * @param texts the text on the context menu.
   * @throws WidgetNotFoundException if the widget is not found.
   */
  public static void clickContextMenu(final AbstractSWTBot<?> bot, final String... texts) {

    // show
    final MenuItem[] menuItem = new MenuItem[1];
    PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {

      @Override
      public void run() {
        MenuItem matchedMenuItem = null;
        Control control = (Control) bot.widget;
        Menu menu = control.getMenu();
        for (String text : texts) {
          Matcher<?> matcher = allOf(instanceOf(MenuItem.class), withMnemonic(text));
          matchedMenuItem = show(menu, matcher);
          if (matchedMenuItem != null) {
            menu = matchedMenuItem.getMenu();
          }
          else {
            hide(menu);
            break;
          }
        }
        menuItem[0] = matchedMenuItem;
      }
    });
    if (menuItem[0] == null) {
      System.err.println("Could not find menu: " + Arrays.asList(texts));
      throw new WidgetNotFoundException("Could not find menu: " + Arrays.asList(texts));
    }

    // Hide the parent menu first
    UIThreadRunnable.syncExec(new VoidResult() {

      @Override
      public void run() {
        hide(menuItem[0].getParent());
      }
    });

    new SWTBotMenu(menuItem[0]).click();
  }


  /**
   * Make the given menu visible
   * 
   * @param menu : Menu instance
   * @param matcher : matcher to find an menuitem with in the given Menu
   * @return : Menu item which matches
   */
  public static MenuItem show(final Menu menu, final Matcher<?> matcher) {
    if (menu != null) {
      menu.notifyListeners(SWT.Show, new Event());
      MenuItem[] items = menu.getItems();
      for (final MenuItem menuItem : items) {
        if (matcher.matches(menuItem)) {
          return menuItem;
        }
      }
      menu.notifyListeners(SWT.Hide, new Event());
    }
    return null;
  }

  /**
   * Hide the given menu
   * 
   * @param menu : Menu
   */
  private static void hide(final Menu menu) {
    menu.notifyListeners(SWT.Hide, new Event());
    if (menu.getParentMenu() != null) {
      hide(menu.getParentMenu());
    }
  }

The problem with this implementation is that SWTBotMenuItem.click always toggles the selection of the menu item. But each menu item might have a diffrent logic of defining the selection state. An example where this leads to a problem can be seen below.

What needs to be done is a way to specify whether the selection should be toggled or set to a specific selection state.

Reproducible: Always

Steps to Reproduce:
1. The current default editor for a c file is the C editor.
2. Now I use SWTBot to execute the context menu Open With -> Text Editor
3. Now I want to open the Text Editor again on the file using SWTBot. But this does not work any more because the selection state of the menu item is toggled again (to false) and the eclipse implementation of the open with command verifies that the selection state is set to true.