EGF Engine
Release 0.1.0

org.eclipse.egf.core.ui.workbench.action.navigator
Class ValidateElementAction

java.lang.Object
  extended by Action
      extended by org.eclipse.egf.core.ui.workbench.action.navigator.AbstractNavigatorAction
          extended by org.eclipse.egf.core.ui.workbench.action.navigator.AbstractModelElementAction
              extended by org.eclipse.egf.core.ui.workbench.action.navigator.ValidateElementAction

public class ValidateElementAction
extends AbstractModelElementAction

Implement an action to validate the NamedModelElementWithId selected element.


Constructor Summary
ValidateElementAction(Shell shell_p, ISelectionProvider selectionProvider_p, boolean readOnlyMode_p)
          Constructor.
ValidateElementAction(Shell shell_p, ISelectionProvider selectionProvider_p, boolean readOnlyMode_p, boolean reportSuccessfulValidation_p)
          Constructor.
 
Method Summary
protected  String getDefaultErrorDialogTitle()
          Return the default error dialog title.
protected  String getErrorDialogTitle()
          Return the error title to use when reporting validation errors.
protected  Class<?> getModelElementClass()
          Get the model element class for which this action is enabled for.
protected  Wizard getWizardFor(NamedModelElementWithId selectedModelElement_p)
          Get the wizard that handles with given model element.
 boolean isEnabled()
           
 boolean isValid()
          Return whether or not the validation is successful.
 void run()
           
 void setErrorDialogTitle(String errorDialogTitle_p)
          Set the error dialog title with the specified value.
 
Methods inherited from class org.eclipse.egf.core.ui.workbench.action.navigator.AbstractModelElementAction
computeImageDescriptorForModelElement, executeCommand, getEditingDomain, getModelElement, isReadOnly, openWizardDialog, setSelectedElement
 
Methods inherited from class org.eclipse.egf.core.ui.workbench.action.navigator.AbstractNavigatorAction
getSelection, getSelectionProvider, getSharedImages, getShell, isSelectionCompatible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValidateElementAction

public ValidateElementAction(Shell shell_p,
                             ISelectionProvider selectionProvider_p,
                             boolean readOnlyMode_p)
Constructor.

Parameters:
shell_p -
selectionProvider_p -
readOnlyMode_p -

ValidateElementAction

public ValidateElementAction(Shell shell_p,
                             ISelectionProvider selectionProvider_p,
                             boolean readOnlyMode_p,
                             boolean reportSuccessfulValidation_p)
Constructor.

Parameters:
shell_p -
selectionProvider_p -
readOnlyMode_p -
reportSuccessfulValidation_p -
Method Detail

getWizardFor

protected Wizard getWizardFor(NamedModelElementWithId selectedModelElement_p)
Description copied from class: AbstractModelElementAction
Get the wizard that handles with given model element.

Specified by:
getWizardFor in class AbstractModelElementAction
Parameters:
selectedModelElement_p - the selected element that triggers this action.
Returns:
a not null Wizard instance.
See Also:
AbstractModelElementAction.getWizardFor(org.eclipse.egf.model.NamedModelElementWithId)

getModelElementClass

protected Class<?> getModelElementClass()
Description copied from class: AbstractNavigatorAction
Get the model element class for which this action is enabled for.

Specified by:
getModelElementClass in class AbstractNavigatorAction
Returns:
See Also:
AbstractNavigatorAction.getModelElementClass()

run

public void run()
See Also:
org.eclipse.jface.action.Action#run()

getErrorDialogTitle

protected String getErrorDialogTitle()
Return the error title to use when reporting validation errors.

Returns:
a not null string.

getDefaultErrorDialogTitle

protected String getDefaultErrorDialogTitle()
Return the default error dialog title.
getErrorDialogTitle()

Returns:

isValid

public boolean isValid()
Return whether or not the validation is successful.
Must be called after run() method.

Returns:
the isValid

isEnabled

public boolean isEnabled()
See Also:
org.eclipse.jface.action.Action#isEnabled()

setErrorDialogTitle

public void setErrorDialogTitle(String errorDialogTitle_p)
Set the error dialog title with the specified value.

Parameters:
errorDialogTitle_p - the errorDialogTitle to set

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.