|
EGF Engine Release 0.1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectWizard
org.eclipse.egf.core.ui.wizard.AbstractModelElementWizard
public abstract class AbstractModelElementWizard
Base class to implement wizards to create or edit EGF model element objects.
Constructor Summary | |
---|---|
protected |
AbstractModelElementWizard(EObject parent_p,
NamedModelElementWithId modelElement_p,
boolean readOnlyMode_p)
Constructor. |
Method Summary | |
---|---|
void |
addPages()
|
boolean |
canFinish()
|
protected boolean |
containsChanges(ChangeDescription changes_p)
Return whether or not specified change description contains changes. |
protected abstract NamedModelElementWithId |
doCreateModelElement()
Create concrete model element. |
protected ChangeDescription |
endChangesRecording()
End model element changes recording. |
protected abstract Command |
getAddCommandForCreatedElement(AdapterFactoryEditingDomain editingDomain_p,
EObject parent_p,
NamedModelElementWithId createdElement_p)
Get the command responsible of adding the created element to given parent when performing finish. |
protected ChangeDescription |
getChangeDescription()
Return the change description when perform finish is called. |
protected ChangeRecorder |
getChangeRecorder()
Get the change recorder that listens to model element changes. |
protected abstract String |
getCreationDescription()
Returns the description when this wizard creates the displayed object. |
String |
getDescription()
Get the wizard description. |
protected abstract String |
getEditDescription()
Returns the description when this wizard modifies the displayed object. |
NamedModelElementWithId |
getModelElement()
Get the model element object handled by this wizard. |
protected Couple<EStructuralFeature,Object> |
getModifiedFeature(ChangeDescription changes_p,
EObject modifiedObject_p)
Get the modified feature with its new value from specified change description and given object. |
EObject |
getParent()
Get the parent object of the handled model element. |
protected abstract PluginChangeWrapperCommand |
getPluginChangeCommand(EditingDomain editingDomain_p,
EObject modelElement_p,
EStructuralFeature feature_p,
Object value_p)
Get the plugin change command. |
protected abstract String |
getTitle()
Returns the title message of this wizard. |
protected ImageDescriptor |
getWizardDefaultPageImageDescriptor()
Get the wizard default image. |
protected boolean |
handleCanFinish()
Handle the canFinish condition in wizard mode (Read only or not) context. |
protected boolean |
handleChangeDescription()
Handle change description. |
boolean |
isInReadOnlyMode()
Whether or not this wizard is in read only. |
boolean |
performCancel()
|
boolean |
performFinish()
|
protected void |
startChangesRecording(EObject modelElement_p)
Start model element changes recording. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AbstractModelElementWizard(EObject parent_p, NamedModelElementWithId modelElement_p, boolean readOnlyMode_p)
parent_p
- model element used as parent of given model element can NOT be null.modelElement_p
- the model element to display, can not be null if readOnly is set to true
readOnlyMode_p
- Whether or not the wizard is in read only mode : data can not be changed.Method Detail |
---|
protected abstract NamedModelElementWithId doCreateModelElement()
NamedModelElementWithId
object.protected abstract String getCreationDescription()
String
instance.protected abstract String getEditDescription()
String
instance.protected abstract String getTitle()
protected void startChangesRecording(EObject modelElement_p)
modelElement_p
- protected ChangeDescription endChangesRecording()
public boolean performCancel()
org.eclipse.jface.wizard.Wizard#performCancel()
public boolean performFinish()
org.eclipse.jface.wizard.Wizard#performFinish()
public final boolean canFinish()
org.eclipse.jface.wizard.Wizard#canFinish()
protected boolean handleCanFinish()
performFinish()
method can be called); false otherwise.protected abstract Command getAddCommandForCreatedElement(AdapterFactoryEditingDomain editingDomain_p, EObject parent_p, NamedModelElementWithId createdElement_p)
parent_p
- protected boolean handleChangeDescription()
protected boolean containsChanges(ChangeDescription changes_p)
changes_p
-
protected Couple<EStructuralFeature,Object> getModifiedFeature(ChangeDescription changes_p, EObject modifiedObject_p)
changes_p
- modifiedObject_p
-
protected abstract PluginChangeWrapperCommand getPluginChangeCommand(EditingDomain editingDomain_p, EObject modelElement_p, EStructuralFeature feature_p, Object value_p)
editingDomain_p
- modelElement_p
- feature_p
- value_p
-
public void addPages()
org.eclipse.jface.wizard.Wizard#addPages()
protected ChangeRecorder getChangeRecorder()
public NamedModelElementWithId getModelElement()
public String getDescription()
protected ChangeDescription getChangeDescription()
public EObject getParent()
public boolean isInReadOnlyMode()
protected ImageDescriptor getWizardDefaultPageImageDescriptor()
null
means no image set on the wizard.
|
EGF Engine Release 0.1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.