|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.actions.ActionGroup
org.eclipse.ui.navigator.WizardActionGroup
Populates context menus with shortcut actions for defined wizards. Wizards may be defined by any of the following extension points:
Here are the required steps for using this feature correctly:
fillContextMenu(IMenuManager)
.Clients may instantiate, but not subclass WizardActionGroup.
PlatformUI.getWorkbench()
,
IWorkbench.getNewWizardRegistry()
,
IWorkbench.getImportWizardRegistry()
,
IWorkbench.getExportWizardRegistry()
Field Summary | |
---|---|
static String |
TYPE_EXPORT
The type for commonWizard extensions with the value "new" for their type attribute. |
static String |
TYPE_IMPORT
The type for commonWizard extensions with the value "new" for their type attribute. |
static String |
TYPE_NEW
The type for commonWizard extensions with the value "new" for their type attribute. |
Constructor Summary | |
---|---|
WizardActionGroup(IWorkbenchWindow aWindow,
IWizardRegistry aWizardRegistry,
String aType)
|
|
WizardActionGroup(IWorkbenchWindow aWindow,
IWizardRegistry aWizardRegistry,
String aType,
INavigatorContentService aContentService)
|
Method Summary | |
---|---|
void |
dispose()
This method is called by the user of an action group to signal that the group is no longer needed. |
void |
fillContextMenu(IMenuManager menu)
Adds the applicable actions to a context menu, based on the state of the ActionContext .
|
protected IAction |
getAction(String id)
|
protected Map |
getActions()
|
String[] |
getWizardActionIds()
|
void |
setContext(ActionContext aContext)
Sets the context used to determine which actions are added, and what their enabled state should be. |
protected void |
setWizardActionDescriptors(org.eclipse.ui.internal.navigator.wizards.CommonWizardDescriptor[] theWizardDescriptors)
|
Methods inherited from class org.eclipse.ui.actions.ActionGroup |
---|
fillActionBars, getContext, updateActionBars |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String TYPE_NEW
public static final String TYPE_IMPORT
public static final String TYPE_EXPORT
Constructor Detail |
public WizardActionGroup(IWorkbenchWindow aWindow, IWizardRegistry aWizardRegistry, String aType)
aWindow
- The window that will be used to acquire a Shell and a
Selection ServiceaWizardRegistry
- The wizard registry will be used to locate the correct wizard
descriptions.aType
- Indicates the value of the type attribute of the commonWizard
extension point. Use any of the TYPE_XXX constants defined on
this class.PlatformUI.getWorkbench()
,
IWorkbench.getNewWizardRegistry()
,
IWorkbench.getImportWizardRegistry()
,
IWorkbench.getExportWizardRegistry()
public WizardActionGroup(IWorkbenchWindow aWindow, IWizardRegistry aWizardRegistry, String aType, INavigatorContentService aContentService)
aWindow
- The window that will be used to acquire a Shell and a
Selection ServiceaWizardRegistry
- The wizard registry will be used to locate the correct wizard
descriptions.aType
- Indicates the value of the type attribute of the commonWizard
extension point. Use any of the TYPE_XXX constants defined on
this class.aContentService
- The content service to use when deciding visibility.PlatformUI.getWorkbench()
,
IWorkbench.getNewWizardRegistry()
,
IWorkbench.getImportWizardRegistry()
,
IWorkbench.getExportWizardRegistry()
Method Detail |
public void setContext(ActionContext aContext)
ActionGroup
setContext
in class ActionGroup
aContext
- the context to usepublic void fillContextMenu(IMenuManager menu)
ActionGroup
ActionContext
.
The default implementation does nothing. Subclasses may override or extend this method.
fillContextMenu
in class ActionGroup
menu
- the context menu managerpublic void dispose()
ActionGroup
The default implementation calls setContext(null)
.
Subclasses may extend this method.
dispose
in class ActionGroup
protected IAction getAction(String id)
protected Map getActions()
public String[] getWizardActionIds()
protected void setWizardActionDescriptors(org.eclipse.ui.internal.navigator.wizards.CommonWizardDescriptor[] theWizardDescriptors)
theWizardDescriptors
- The wizard action ids to set. These should be defined through
org.eclipse.ui.xxxWizards
|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.