Package org.eclipse.gef.ui.actions
Class ActionBarContributor
- java.lang.Object
-
- org.eclipse.ui.part.EditorActionBarContributor
-
- org.eclipse.gef.ui.actions.ActionBarContributor
-
- All Implemented Interfaces:
IEditorActionBarContributor
public abstract class ActionBarContributor extends EditorActionBarContributor
Contributes actions to the workbench. !!Warning: This class is subject to change.
-
-
Constructor Summary
Constructors Constructor Description ActionBarContributor()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
addAction(IAction action)
Adds the given action to the action registry.protected void
addGlobalActionKey(java.lang.String key)
Indicates the existence of a global action identified by the specified key.protected void
addRetargetAction(RetargetAction action)
Adds the specified RetargetAction to this contributorsActionRegistry
.protected abstract void
buildActions()
Creates and initializes Actions managed by this contributor.protected abstract void
declareGlobalActionKeys()
Subclasses must implement to declare additional global actions IDs.void
dispose()
Disposes the contributor.protected IAction
getAction(java.lang.String id)
Retrieves an action from the action registry using the given ID.protected ActionRegistry
getActionRegistry()
returns this contributor's ActionRegsitry.void
init(IActionBars bars)
void
setActiveEditor(IEditorPart editor)
-
Methods inherited from class org.eclipse.ui.part.EditorActionBarContributor
contributeToCoolBar, contributeToMenu, contributeToStatusLine, contributeToToolBar, getActionBars, getPage, init
-
-
-
-
Method Detail
-
addAction
protected void addAction(IAction action)
Adds the given action to the action registry.- Parameters:
action
- the action to add
-
addGlobalActionKey
protected void addGlobalActionKey(java.lang.String key)
Indicates the existence of a global action identified by the specified key. This global action is defined outside the scope of this contributor, such as the Workbench's undo action, or an action provided by a workbench ActionSet. The list of global action keys is used whenever the active editor is changed (setActiveEditor(IEditorPart)
). Keys provided here will result in corresponding actions being obtained from the active editor'sActionRegistry
, and those actions will be registered with the ActionBars for this contributor. The editor's action handler and the global action must have the same key.- Parameters:
key
- the key identifying the global action
-
addRetargetAction
protected void addRetargetAction(RetargetAction action)
Adds the specified RetargetAction to this contributorsActionRegistry
. The RetargetAction is also added as aIPartListener
of the contributor's page. Also, the retarget action's ID is flagged as a global action key, by callingaddGlobalActionKey(String)
.- Parameters:
action
- the retarget action being added
-
buildActions
protected abstract void buildActions()
Creates and initializes Actions managed by this contributor.
-
declareGlobalActionKeys
protected abstract void declareGlobalActionKeys()
Subclasses must implement to declare additional global actions IDs. Only IDs which were not already added directly or indirectly usingaddGlobalActionKey(String)
need to be added.- See Also:
addGlobalActionKey(String)
-
dispose
public void dispose()
Disposes the contributor. Removes allRetargetAction
s that wereIPartListener
s on theIWorkbenchPage
and disposes them. Also disposes the action registry.Subclasses may extend this method to perform additional cleanup.
- Specified by:
dispose
in interfaceIEditorActionBarContributor
- Overrides:
dispose
in classEditorActionBarContributor
- See Also:
EditorActionBarContributor.dispose()
-
getAction
protected IAction getAction(java.lang.String id)
Retrieves an action from the action registry using the given ID.- Parameters:
id
- the ID of the sought action- Returns:
null
or the action if found
-
getActionRegistry
protected ActionRegistry getActionRegistry()
returns this contributor's ActionRegsitry.- Returns:
- the ActionRegistry
-
init
public void init(IActionBars bars)
- Overrides:
init
in classEditorActionBarContributor
- See Also:
EditorActionBarContributor.init(IActionBars)
-
setActiveEditor
public void setActiveEditor(IEditorPart editor)
- Specified by:
setActiveEditor
in interfaceIEditorActionBarContributor
- Overrides:
setActiveEditor
in classEditorActionBarContributor
- See Also:
IEditorActionBarContributor.setActiveEditor(IEditorPart)
-
-