Class WizardActionGroup

java.lang.Object
org.eclipse.ui.actions.ActionGroup
org.eclipse.ui.navigator.WizardActionGroup

public final class WizardActionGroup extends ActionGroup
Populates context menus with shortcut actions for defined wizards. Wizards may be defined by any of the following extension points:
  • org.eclipse.ui.newWizards
  • org.eclipse.ui.importWizards
  • org.eclipse.ui.exportWizards

Here are the required steps for using this feature correctly:

  1. Declare all new/import/export wizards from the extension points above, or locate the existing wizards that you intend to reuse.
  2. Declare org.eclipse.ui.navigator.navigatorContent/commonWizard elements to identify which wizards should be associated with what items in your viewer or navigator.
  3. If you are using Resources in your viewer and have bound the resource extension declared in org.eclipse.ui.navigator.resources, then you will get most of this functionality for free.
  4. Otherwise, you may choose to build your own custom menu. In which case, you may instantiate this class, and hand it the menu or submenu that you want to list out the available wizard shortcuts via fillContextMenu(IMenuManager).
Since:
3.2
See Also:
  • Field Details

    • TYPE_NEW

      public static final String TYPE_NEW
      The type for commonWizard extensions with the value "new" for their type attribute.
      See Also:
    • TYPE_IMPORT

      public static final String TYPE_IMPORT
      The type for commonWizard extensions with the value "new" for their type attribute.
      See Also:
    • TYPE_EXPORT

      public static final String TYPE_EXPORT
      The type for commonWizard extensions with the value "new" for their type attribute.
      See Also:
  • Constructor Details

  • Method Details

    • setContext

      public void setContext(ActionContext aContext)
      Description copied from class: ActionGroup
      Sets the context used to determine which actions are added, and what their enabled state should be.
      Overrides:
      setContext in class ActionGroup
      Parameters:
      aContext - the context to use
    • fillContextMenu

      public void fillContextMenu(IMenuManager menu)
      Description copied from class: ActionGroup
      Adds the applicable actions to a context menu, based on the state of the ActionContext.

      The default implementation does nothing. Subclasses may override or extend this method.

      Overrides:
      fillContextMenu in class ActionGroup
      Parameters:
      menu - the context menu manager
    • dispose

      public void dispose()
      Description copied from class: ActionGroup
      This method is called by the user of an action group to signal that the group is no longer needed. Subclasses typically implement this method to deregister any listeners or to free other resources.

      The default implementation calls setContext(null). Subclasses may extend this method.

      Overrides:
      dispose in class ActionGroup
    • getAction

      protected IAction getAction(String id)
    • getActions

      protected Map<String,IAction> getActions()
      Returns:
      a map of (id, IAction)-pairs.
    • getWizardActionIds

      public String[] getWizardActionIds()
      Returns:
      Returns the wizardActionIds.