EGF Engine
Release 0.1.0

org.eclipse.egf.core.ui.workbench.action.open
Class OpenModelElementAction

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.open.OpenModelElementAction
Direct Known Subclasses:
OpenDomainAction, OpenMappingAction, OpenPatternAction

public abstract class OpenModelElementAction
extends AbstractModelElementAction

Base class to implement an action that opens an editor.


Field Summary
static String OPEN_ACTION_ID
          The 'open' retargetable action id.
 
Constructor Summary
OpenModelElementAction(Shell shell_p, ISelectionProvider selectionProvider_p, boolean readOnlyMode_p)
          Constructor.
 
Method Summary
protected  IEditorPart doOpenEditor(IEditorInput editorInput_p, String editorId_p)
          Do open related editor for specified parameters.
protected abstract  String getEditorId()
          Return the id of the editor to be opened.
protected abstract  IEditorInput getEditorInput()
          Return the input used by the open editor.
protected  Wizard getWizardFor(NamedModelElementWithId modelElement_p)
          Get the wizard that handles with given model element.
 void run()
           
protected  boolean shouldSaveEditorAfterOpening()
          Return whether or not the open editor has to be saved after opening.
 
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
getModelElementClass, getSelection, getSelectionProvider, getSharedImages, getShell, isSelectionCompatible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPEN_ACTION_ID

public static final String OPEN_ACTION_ID
The 'open' retargetable action id.

See Also:
Constant Field Values
Constructor Detail

OpenModelElementAction

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

Parameters:
shell_p -
selectionProvider_p -
readOnlyMode_p -
Method Detail

getWizardFor

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

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

run

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

shouldSaveEditorAfterOpening

protected boolean shouldSaveEditorAfterOpening()
Return whether or not the open editor has to be saved after opening.
Default implementation returns false.

Returns:
true means save it please.

doOpenEditor

protected IEditorPart doOpenEditor(IEditorInput editorInput_p,
                                   String editorId_p)
Do open related editor for specified parameters.

Parameters:
editorInput_p -
editorId_p -

getEditorId

protected abstract String getEditorId()
Return the id of the editor to be opened.

Returns:

getEditorInput

protected abstract IEditorInput getEditorInput()
Return the input used by the open editor.

Returns:

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.