| org.eclipse.ui.navigator.WizardActionGroup
WizardActionGroup | final public class WizardActionGroup extends ActionGroup (Code) | | 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:
- Declare all new/import/export wizards from the extension points above,
or locate the existing wizards that you intend to reuse.
- Declare org.eclipse.ui.navigator.navigatorContent/commonWizard
elements to identify which wizards should be associated with what items in
your viewer or navigator.
- 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.
- 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
WizardActionGroup.fillContextMenu(IMenuManager) .
Clients may instantiate, but not subclass WizardActionGroup.
See Also: PlatformUI.getWorkbench See Also: IWorkbench.getNewWizardRegistry See Also: IWorkbench.getImportWizardRegistry See Also: IWorkbench.getExportWizardRegistry since: 3.2 |
Field Summary | |
final public static String | TYPE_EXPORT The type for commonWizard extensions with the value "new" for their type
attribute. | final public static String | TYPE_IMPORT The type for commonWizard extensions with the value "new" for their type
attribute. | final public static String | TYPE_NEW The type for commonWizard extensions with the value "new" for their type
attribute. |
Constructor Summary | |
public | WizardActionGroup(IWorkbenchWindow aWindow, IWizardRegistry aWizardRegistry, String aType) Parameters: aWindow - The window that will be used to acquire a Shell and aSelection Service Parameters: aWizardRegistry - The wizard registry will be used to locate the correct wizarddescriptions. Parameters: aType - Indicates the value of the type attribute of the commonWizardextension point. | public | WizardActionGroup(IWorkbenchWindow aWindow, IWizardRegistry aWizardRegistry, String aType, INavigatorContentService aContentService) Parameters: aWindow - The window that will be used to acquire a Shell and aSelection Service Parameters: aWizardRegistry - The wizard registry will be used to locate the correct wizarddescriptions. Parameters: aType - Indicates the value of the type attribute of the commonWizardextension point. |
TYPE_EXPORT | final public static String TYPE_EXPORT(Code) | | The type for commonWizard extensions with the value "new" for their type
attribute.
|
TYPE_IMPORT | final public static String TYPE_IMPORT(Code) | | The type for commonWizard extensions with the value "new" for their type
attribute.
|
TYPE_NEW | final public static String TYPE_NEW(Code) | | The type for commonWizard extensions with the value "new" for their type
attribute.
|
WizardActionGroup | public WizardActionGroup(IWorkbenchWindow aWindow, IWizardRegistry aWizardRegistry, String aType)(Code) | | Parameters: aWindow - The window that will be used to acquire a Shell and aSelection Service Parameters: aWizardRegistry - The wizard registry will be used to locate the correct wizarddescriptions. Parameters: aType - Indicates the value of the type attribute of the commonWizardextension point. Use any of the TYPE_XXX constants defined onthis class. See Also: PlatformUI.getWorkbench See Also: IWorkbench.getNewWizardRegistry See Also: IWorkbench.getImportWizardRegistry See Also: IWorkbench.getExportWizardRegistry |
WizardActionGroup | public WizardActionGroup(IWorkbenchWindow aWindow, IWizardRegistry aWizardRegistry, String aType, INavigatorContentService aContentService)(Code) | | Parameters: aWindow - The window that will be used to acquire a Shell and aSelection Service Parameters: aWizardRegistry - The wizard registry will be used to locate the correct wizarddescriptions. Parameters: aType - Indicates the value of the type attribute of the commonWizardextension point. Use any of the TYPE_XXX constants defined onthis class. Parameters: aContentService - The content service to use when deciding visibility. See Also: PlatformUI.getWorkbench See Also: IWorkbench.getNewWizardRegistry See Also: IWorkbench.getImportWizardRegistry See Also: IWorkbench.getExportWizardRegistry |
dispose | public void dispose()(Code) | | |
fillContextMenu | public void fillContextMenu(IMenuManager menu)(Code) | | |
getActions | protected Map getActions()(Code) | | a map of (id, IAction)-pairs. |
getWizardActionIds | public synchronized String[] getWizardActionIds()(Code) | | Returns the wizardActionIds. |
setContext | public void setContext(ActionContext aContext)(Code) | | |
setWizardActionDescriptors | protected synchronized void setWizardActionDescriptors(CommonWizardDescriptor[] theWizardDescriptors)(Code) | | Parameters: theWizardDescriptors - The wizard action ids to set. These should be defined throughorg.eclipse.ui.xxxWizards |
|
|