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
ABaseNewWizardMenuis 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 Summary
Constructors Constructor Description BaseNewWizardMenu(IWorkbenchWindow window, String id)Creates a new wizard shortcut menu for the IDE.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddItems(List<IContributionItem> list)Adds the contribution items to show to the given list.protected booleanaddShortcuts(List<IContributionItem> list)Adds the new wizard shortcuts for the current perspective to the given list.voiddispose()The default implementation of thisIContributionItemmethod does nothing.protected IContributionItem[]getContributionItems()Return a list of contributions items that will replace this item in the parent manager.protected IActiongetShowDialogAction()Returns the "Other..." action, used to show the new wizards dialog.protected IWorkbenchWindowgetWindow()Returns the window in which this menu appears.protected booleanregistryHasCategory(String categoryId)Returns whether the new wizards registry has a non-empty category with the given identifier.-
Methods inherited from class org.eclipse.ui.actions.CompoundContributionItem
fill, isDirty, isDynamic, setParent
-
Methods inherited from class org.eclipse.jface.action.ContributionItem
fill, fill, fill, getId, getParent, isEnabled, isGroupMarker, isSeparator, isVisible, saveWidgetState, setId, setVisible, toString, update, update
-
-
-
-
Constructor Detail
-
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 menuid- the contribution item identifier, ornull
-
-
Method Detail
-
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:
trueif any items were added,falseif none were added
-
dispose
public void dispose()
Description copied from class:ContributionItemThe default implementation of thisIContributionItemmethod does nothing. Subclasses may override.- Specified by:
disposein interfaceIContributionItem- Overrides:
disposein classCompoundContributionItem
-
getContributionItems
protected IContributionItem[] getContributionItems()
Description copied from class:CompoundContributionItemReturn 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:
getContributionItemsin classCompoundContributionItem- 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:
trueif there is a non-empty category with the given identifier,falseotherwise
-
-