org.eclipse.emfforms.spi.editor

Class GenericEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.emfforms.spi.editor.GenericEditor

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.emf.edit.domain.IEditingDomainProvider, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

Direct Known Subclasses:

EcoreEditor, GenModelEditor, TemplateModelEditorPart, ViewModelEditor

public class GenericEditor
extends org.eclipse.ui.part.EditorPart
implements org.eclipse.emf.edit.domain.IEditingDomainProvider

The Class GenericEditor it is the generic part for editing any EObject.

Field Summary

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
GenericEditor()

Method Summary

Modifier and Type	Method and Description
void	createPartControl(org.eclipse.swt.widgets.Composite parent)
protected TreeMasterDetailComposite	createTreeMasterDetail(org.eclipse.swt.widgets.Composite composite, Object editorInput, CreateElementCallback createElementCallback) This method creates a tree master detail.
void	doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
void	doSaveAs()
protected String	getContextId() Returns the context id set for this editor.
protected CreateElementCallback	getCreateElementCallback() Returns the createElementCallback for this editor.
org.eclipse.emf.edit.domain.EditingDomain	getEditingDomain()
protected String	getEditorTitle() Returns the title for the currently displayed editor.
org.eclipse.emf.ecore.resource.ResourceSet	getResourceSet() Returns the ResouceSet of this Editor.
protected void	handleResourceChange(Collection<org.eclipse.emf.ecore.resource.Resource> changedResources, Collection<org.eclipse.emf.ecore.resource.Resource> removedResources) Handles filesystem changes.
protected boolean	hasShortcuts() Returns true, if the editor should have shortcuts.
void	init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput input)
boolean	isDirty()
boolean	isSaveAsAllowed()
protected org.eclipse.emf.ecore.resource.ResourceSet	loadResource(org.eclipse.ui.IEditorInput editorInput) Creates a resource set and loads all required resources for the editor input.
protected Object	modifyEditorInput(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Allows to modify the input object for the editor.
void	setFocus()

Methods inherited from class org.eclipse.ui.part.EditorPart

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, dispose, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, dispose, getSite, getTitle, getTitleImage, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Constructor Detail

GenericEditor

public GenericEditor()

Method Detail

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)

Specified by:

doSave in interface org.eclipse.ui.ISaveablePart

Specified by:

doSave in class org.eclipse.ui.part.EditorPart

handleResourceChange

protected void handleResourceChange(Collection<org.eclipse.emf.ecore.resource.Resource> changedResources,
                                    Collection<org.eclipse.emf.ecore.resource.Resource> removedResources)

Handles filesystem changes.

Parameters:

changedResources - A List of changed Resources

removedResources - A List of removed Resources

doSaveAs

public void doSaveAs()

Specified by:

doSaveAs in interface org.eclipse.ui.ISaveablePart

Specified by:

doSaveAs in class org.eclipse.ui.part.EditorPart

init

public void init(org.eclipse.ui.IEditorSite site,
                 org.eclipse.ui.IEditorInput input)
          throws org.eclipse.ui.PartInitException

Specified by:

init in interface org.eclipse.ui.IEditorPart

Specified by:

init in class org.eclipse.ui.part.EditorPart

Throws:

org.eclipse.ui.PartInitException

getContextId

protected String getContextId()

Returns the context id set for this editor.

Returns:

the context id

isDirty

public boolean isDirty()

Specified by:

isDirty in interface org.eclipse.ui.ISaveablePart

Specified by:

isDirty in class org.eclipse.ui.part.EditorPart

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface org.eclipse.ui.ISaveablePart

Specified by:

isSaveAsAllowed in class org.eclipse.ui.part.EditorPart

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createPartControl in interface org.eclipse.ui.IWorkbenchPart

Specified by:

createPartControl in class org.eclipse.ui.part.WorkbenchPart

createTreeMasterDetail

protected TreeMasterDetailComposite createTreeMasterDetail(org.eclipse.swt.widgets.Composite composite,
                                                           Object editorInput,
                                                           CreateElementCallback createElementCallback)

This method creates a tree master detail. Override this method if you want to customize the tree.

Parameters:

composite - the parent composite

editorInput - the editor input

createElementCallback - the create element callback to add

Returns:

the TreeMasterDetailComposite

modifyEditorInput

protected Object modifyEditorInput(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Allows to modify the input object for the editor.

Parameters:

resourceSet - the resourceSet which is the default editor input

Returns:

the object to set as the input

loadResource

protected org.eclipse.emf.ecore.resource.ResourceSet loadResource(org.eclipse.ui.IEditorInput editorInput)

Creates a resource set and loads all required resources for the editor input.

Parameters:

editorInput - the editor input

Returns:

the resource set

setFocus

public void setFocus()

Specified by:

setFocus in interface org.eclipse.ui.IWorkbenchPart

Specified by:

setFocus in class org.eclipse.ui.part.WorkbenchPart

hasShortcuts

protected boolean hasShortcuts()

Returns true, if the editor should have shortcuts.

Returns:

true, if the editor has shortcuts

getEditorTitle

protected String getEditorTitle()

Returns the title for the currently displayed editor. Subclasses should override this function to change the Editor's title

Returns:

the title

getCreateElementCallback

protected CreateElementCallback getCreateElementCallback()

Returns the createElementCallback for this editor. By default, there is none.

Returns:

the callback

getEditingDomain

public org.eclipse.emf.edit.domain.EditingDomain getEditingDomain()

Specified by:

getEditingDomain in interface org.eclipse.emf.edit.domain.IEditingDomainProvider

getResourceSet

public org.eclipse.emf.ecore.resource.ResourceSet getResourceSet()

Returns the ResouceSet of this Editor.

Returns:

The resource set