Package org.eclipse.ui.actions

Class BaseNewWizardMenu

java.lang.Object
org.eclipse.jface.action.ContributionItem
org.eclipse.ui.actions.CompoundContributionItem
org.eclipse.ui.actions.BaseNewWizardMenu
All Implemented Interfaces:
IContributionItem
Direct Known Subclasses:
NewWizardMenu
public class BaseNewWizardMenu extends CompoundContributionItem
A BaseNewWizardMenu is used to populate a menu manager with New Wizard actions for the current perspective's new wizard shortcuts, including an Other... action to open the new wizard dialog.

Note: Clients must dispose this menu when it is no longer required.

Since:
3.1

  • Constructor Details

    • BaseNewWizardMenu

      public BaseNewWizardMenu(IWorkbenchWindow window, String id)
      Creates a new wizard shortcut menu for the IDE.

      Note: Clients must dispose this menu when it is no longer required.

      Parameters:
      window - the window containing the menu
      id - the contribution item identifier, or null

  • Method Details

    • addItems

      protected void addItems(List<IContributionItem> list)
      Adds the contribution items to show to the given list.
      Parameters:
      list - the list to add contribution items to

    • addShortcuts

      protected boolean addShortcuts(List<IContributionItem> list)
      Adds the new wizard shortcuts for the current perspective to the given list.
      Parameters:
      list - the list to add contribution items to
      Returns:
      true if any items were added, false if none were added

    • dispose

      public void dispose()
      Description copied from class: ContributionItem
      The default implementation of this IContributionItem method does nothing. Subclasses may override.
      Specified by:
      dispose in interface IContributionItem
      Overrides:
      dispose in class CompoundContributionItem

    • getContributionItems

      protected IContributionItem[] getContributionItems()
      Description copied from class: CompoundContributionItem
      Return a list of contributions items that will replace this item in the parent manager. The list must contain new contribution items every call since the old ones will be disposed.
      Specified by:
      getContributionItems in class CompoundContributionItem
      Returns:
      an array list of items to display. Must not be null.

    • getShowDialogAction

      protected IAction getShowDialogAction()
      Returns the "Other..." action, used to show the new wizards dialog.
      Returns:
      the action used to show the new wizards dialog

    • getWindow

      protected IWorkbenchWindow getWindow()
      Returns the window in which this menu appears.
      Returns:
      the window in which this menu appears

    • registryHasCategory

      protected boolean registryHasCategory(String categoryId)
      Returns whether the new wizards registry has a non-empty category with the given identifier.
      Parameters:
      categoryId - the identifier for the category
      Returns:
      true if there is a non-empty category with the given identifier, false otherwise