org.eclipse.sphinx.emf.ui.actions.providers

Class BasicActionProvider

java.lang.Object

org.eclipse.ui.actions.ActionGroup

org.eclipse.ui.navigator.CommonActionProvider

org.eclipse.sphinx.emf.ui.actions.providers.BasicActionProvider

All Implemented Interfaces:

org.eclipse.ui.navigator.IMementoAware

Direct Known Subclasses:

AbstractValidationActionProvider, BasicCheckValidationActionProvider, BasicCompareActionProvider, BasicEditorActionProvider, BasicModelEditActionProvider, BasicModelRefactorActionProvider, BasicModelUndoRedoActionProvider, BasicWorkflowActionProvider, CommonModelActionProvider, UndoRedoOverrideActionProvider

public class BasicActionProvider
extends org.eclipse.ui.navigator.CommonActionProvider

Basic implementation of action provider that provides default implementations for initialization and for filling (and emptying) the menu managed by this action provider.

Initialization is ensured by the method init(ICommonActionExtensionSite) that is not supposed to overridden by client implementations (override doInit() instead).

Filling and emptying contextual menu (maintained by manager) with actions are respectively supported by populateManager(IContributionManager, Collection, String) and depopulateManager(IContributionManager, Collection).

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jface.viewers.ISelectionProvider	selectionProvider
protected org.eclipse.jface.viewers.Viewer	viewer
protected java.lang.String	viewerId
protected org.eclipse.ui.IWorkbenchPart	workbenchPart

Constructor Summary

Constructors

Constructor and Description
BasicActionProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.eclipse.jface.action.IMenuManager	addSubMenu(org.eclipse.jface.action.IMenuManager contextMenuManager) Returns the sub menu into which the actions provided by this action provider implementation are to be placed.
protected void	depopulateManager(org.eclipse.jface.action.IContributionManager manager, java.util.Collection<? extends org.eclipse.jface.action.IAction> actions) Removes from the specified manager all contribution items based on the actions contained in the actions collection.
protected void	depopulateManager(org.eclipse.jface.action.IContributionManager manager, java.util.Map<java.lang.String,java.util.Collection<org.eclipse.jface.action.IAction>> submenuActions) This removes from the specified manager all MenuManagers and their ActionContributionItems based on the IActions contained in the submenuActions map.
protected void	doInit() Method to override in order to provide a custom initialization of this action provider.
protected java.util.Map<java.lang.String,java.util.Collection<org.eclipse.jface.action.IAction>>	extractSubmenuActions(java.util.Collection<org.eclipse.jface.action.IAction> createActions, org.eclipse.jface.viewers.ISelection selection) This extracts those actions in the submenuActions collection whose text is qualified and returns a map of these actions, keyed by submenu text (see GenModel option "Editor > Creation Sub-menus" for details).
void	fillContextMenu(org.eclipse.jface.action.IMenuManager contextMenuManager)
protected void	fillSubMenu(org.eclipse.jface.action.IMenuManager subMenuManager) Adds the applicable actions to the sub menu of the context menu resulting from previous invocation of addSubMenu(IMenuManager).
protected org.eclipse.emf.transaction.TransactionalEditingDomain	getEditingDomainFromSelection(org.eclipse.jface.viewers.ISelection selection) A convenience method to get the editing domain from an ISelection.
void	init(org.eclipse.ui.navigator.ICommonActionExtensionSite site)
protected boolean	isActivePropertySheet() Returns true when the property sheet is the current active page.
protected boolean	isTransient(java.lang.Object object) Returns true if the given object is a transient item provider i.e.
protected void	populateManager(org.eclipse.jface.action.IContributionManager manager, java.util.Collection<? extends org.eclipse.jface.action.IAction> actions, java.lang.String contributionId) Populates the specified manager with contribution items based on the actions contained in the actions collection, by inserting them before the specified contribution item contributionId. If contributionId is null, they are simply added.
protected void	populateManager(org.eclipse.jface.action.IContributionManager manager, java.util.Map<java.lang.String,java.util.Collection<org.eclipse.jface.action.IAction>> submenuActions, java.lang.String contributionId) This populates the specified manager with MenuManagers containing ActionContributionItems based on the IActions contained in the submenuActions collection, by inserting them before the specified contribution item contributionId.

Methods inherited from class org.eclipse.ui.navigator.CommonActionProvider

filterAction, getActionSite, restoreState, saveState

Methods inherited from class org.eclipse.ui.actions.ActionGroup

dispose, fillActionBars, getContext, setContext, updateActionBars

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

workbenchPart

protected org.eclipse.ui.IWorkbenchPart workbenchPart

viewer

protected org.eclipse.jface.viewers.Viewer viewer

viewerId

protected java.lang.String viewerId

selectionProvider

protected org.eclipse.jface.viewers.ISelectionProvider selectionProvider

Constructor Detail

BasicActionProvider

public BasicActionProvider()

Method Detail

init

public final void init(org.eclipse.ui.navigator.ICommonActionExtensionSite site)

Overrides:

init in class org.eclipse.ui.navigator.CommonActionProvider

fillContextMenu

public void fillContextMenu(org.eclipse.jface.action.IMenuManager contextMenuManager)

Overrides:

fillContextMenu in class org.eclipse.ui.actions.ActionGroup

doInit

protected void doInit()

Method to override in order to provide a custom initialization of this action provider.

isActivePropertySheet

protected boolean isActivePropertySheet()

Returns true when the property sheet is the current active page.

Returns:

as specified above.

addSubMenu

protected org.eclipse.jface.action.IMenuManager addSubMenu(org.eclipse.jface.action.IMenuManager contextMenuManager)

Returns the sub menu into which the actions provided by this action provider implementation are to be placed. Creates a new sub menu and appends it to specified context menu if no such is present yet. Returns null if the actions should go directly into the context menu. The default implementation returns null. Subclasses may override or extend this method.

Parameters:

contextMenuManager - The context menu for which the sub menu is to be retrieved or created.

Returns:

The sub menu into which the actions provided by this action provider implementation are to be placed or null if they should go directly into the context menu.

See Also:

fillSubMenu(IMenuManager)

fillSubMenu

protected void fillSubMenu(org.eclipse.jface.action.IMenuManager subMenuManager)

Adds the applicable actions to the sub menu of the context menu resulting from previous invocation of addSubMenu(IMenuManager). The default implementation does nothing. Subclasses may override or extend this method.

Parameters:

subMenu - The sub menu to which applicable actions are to be added.

See Also:

addSubMenu(IMenuManager)

getEditingDomainFromSelection

protected org.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomainFromSelection(org.eclipse.jface.viewers.ISelection selection)

A convenience method to get the editing domain from an ISelection. This method will return null in different cases :

• selection isn't instance of IStructuredSelection.
• selection is empty.
• selection contains unresolved model element(s).
• selection contains model elements which belong to more than one editing domain (In case of multi-selection).

Parameters:

selection -

Returns:

the editing domain from the selected model objects or null in either empty selection or when the selected model objects belong to more than one editing domain.

Since:

0.7.0

populateManager

protected void populateManager(org.eclipse.jface.action.IContributionManager manager,
                   java.util.Collection<? extends org.eclipse.jface.action.IAction> actions,
                   java.lang.String contributionId)

Populates the specified manager with contribution items based on the actions contained in the actions collection, by inserting them before the specified contribution item contributionId.
If contributionId is null, they are simply added.

Parameters:

manager - The contribution manager to which specified actions must be populated.

actions - The actions to insert in the menu described by the given manager.

contributionId - The identifier of the contribution before which actions must be inserted.

populateManager

protected void populateManager(org.eclipse.jface.action.IContributionManager manager,
                   java.util.Map<java.lang.String,java.util.Collection<org.eclipse.jface.action.IAction>> submenuActions,
                   java.lang.String contributionId)

This populates the specified manager with MenuManagers containing ActionContributionItems based on the IActions contained in the submenuActions collection, by inserting them before the specified contribution item contributionId. If contributionId is null, they are simply added.

Parameters:

manager - The contribution manager to which specified actions must be populated.

submenuActions - The submenu actionss to insert in the menu described by the given manager.

contributionId - The identifier of the contribution before which actions must be inserted.

Since:

0.7.0

depopulateManager

protected void depopulateManager(org.eclipse.jface.action.IContributionManager manager,
                     java.util.Collection<? extends org.eclipse.jface.action.IAction> actions)

Removes from the specified manager all contribution items based on the actions contained in the actions collection.

Parameters:

manager - The contribution manager from which specified actions must be removed.

actions - The actions to remove from the menu described by the given manager.

depopulateManager

protected void depopulateManager(org.eclipse.jface.action.IContributionManager manager,
                     java.util.Map<java.lang.String,java.util.Collection<org.eclipse.jface.action.IAction>> submenuActions)

This removes from the specified manager all MenuManagers and their ActionContributionItems based on the IActions contained in the submenuActions map.

Parameters:

manager - The contribution manager from which specified actions must be removed.

submenuActions - The submenu actionss to remove from the menu described by the given manager.

Since:

0.7.0

extractSubmenuActions

protected java.util.Map<java.lang.String,java.util.Collection<org.eclipse.jface.action.IAction>> extractSubmenuActions(java.util.Collection<org.eclipse.jface.action.IAction> createActions,
                                                                                                           org.eclipse.jface.viewers.ISelection selection)

This extracts those actions in the submenuActions collection whose text is qualified and returns a map of these actions, keyed by submenu text (see GenModel option "Editor > Creation Sub-menus" for details).

Since:

0.7.0

isTransient

protected boolean isTransient(java.lang.Object object)

Returns true if the given object is a transient item provider i.e. an intermediary node, false else.

Parameters:

object - an object.

Returns:

true if the given object is a transient item provider i.e. an intermediary node, false else.