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

Class BasicValidationActionProvider

java.lang.Object

org.eclipse.ui.actions.ActionGroup

org.eclipse.ui.navigator.CommonActionProvider

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

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

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

All Implemented Interfaces:

org.eclipse.ui.navigator.IMementoAware

public class BasicValidationActionProvider
extends AbstractValidationActionProvider

A basic implementation of action provider dedicated to actions that are validation related. It provides three actions:

• a validate action that is responsible for launching a batch validation of the selected model;
• a clean problem markers action that has the capability for cleaning all the markers that may exist for the elements on the selected model;

Actions are populated to contextual menu under item "Validation".

Note	This action provider is not contributed by the hosting plug-in in order to avoid duplicate entries of actions. If any client application is really interested in this action provider, it should contribute it by itself.

Field Summary

Fields

Modifier and Type	Field and Description
protected BasicCleanProblemMarkersAction	cleanProblemMarkersAction Action responsible for cleaning existing problem markers on model's elements.
protected BasicValidateAction	validateAction Action responsible for the batch validation of a selected model.

Fields inherited from class org.eclipse.sphinx.emf.ui.actions.providers.BasicActionProvider

selectionProvider, viewer, viewerId, workbenchPart

Constructor Summary

Constructors

Constructor and Description
BasicValidationActionProvider()

Method Summary

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 BasicCleanProblemMarkersAction	createCleanProblemMarkersAction()
protected BasicValidateAction	createValidateAction()
void	doInit() Method to override in order to provide a custom initialization of this action provider.
protected void	populateActions(org.eclipse.jface.action.IMenuManager menu, org.eclipse.jface.viewers.IStructuredSelection selection, boolean enabled) Populates specified menu with the actions provided by this action provider implementation.

Methods inherited from class org.eclipse.sphinx.emf.validation.ui.actions.providers.AbstractValidationActionProvider

fillSubMenu, isEnabled, isEnabled

Methods inherited from class org.eclipse.sphinx.emf.ui.actions.providers.BasicActionProvider

depopulateManager, depopulateManager, extractSubmenuActions, fillContextMenu, getEditingDomainFromSelection, init, isActivePropertySheet, isTransient, populateManager, populateManager

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

validateAction

protected BasicValidateAction validateAction

Action responsible for the batch validation of a selected model.

cleanProblemMarkersAction

protected BasicCleanProblemMarkersAction cleanProblemMarkersAction

Action responsible for cleaning existing problem markers on model's elements.

Constructor Detail

BasicValidationActionProvider

public BasicValidationActionProvider()

Method Detail

doInit

public void doInit()

Description copied from class: BasicActionProvider

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

Overrides:

doInit in class BasicActionProvider

createValidateAction

protected BasicValidateAction createValidateAction()

createCleanProblemMarkersAction

protected BasicCleanProblemMarkersAction createCleanProblemMarkersAction()

addSubMenu

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

Description copied from class: BasicActionProvider

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.

Overrides:

addSubMenu in class BasicActionProvider

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:

BasicActionProvider.fillSubMenu(IMenuManager)

populateActions

protected void populateActions(org.eclipse.jface.action.IMenuManager menu,
                               org.eclipse.jface.viewers.IStructuredSelection selection,
                               boolean enabled)

Description copied from class: AbstractValidationActionProvider

Populates specified menu with the actions provided by this action provider implementation. Initializes actions with given selection and enabled status.

Specified by:

populateActions in class AbstractValidationActionProvider

Parameters:

menu - The menu actions should be added to.

selection - The selection actions must act upon.

enabled - Enablement status indicating if actions should be enabled or not.