org.eclipse.sphinx.emf.editors.forms

Class BasicTransactionalFormEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.ui.part.MultiPageEditorPart

org.eclipse.ui.forms.editor.FormEditor

org.eclipse.sphinx.emf.editors.forms.BasicTransactionalFormEditor

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.emf.common.ui.viewer.IViewerProvider, org.eclipse.emf.edit.domain.IEditingDomainProvider, org.eclipse.jface.action.IMenuListener, org.eclipse.jface.dialogs.IPageChangeProvider, org.eclipse.jface.viewers.ISelectionProvider, IModelEditorInputChangeAnalyzer, org.eclipse.ui.ide.IGotoMarker, org.eclipse.ui.IEditorPart, org.eclipse.ui.IPersistable, org.eclipse.ui.IPersistableEditor, org.eclipse.ui.ISaveablePart, org.eclipse.ui.ISaveablePart2, org.eclipse.ui.ISaveablesSource, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation, org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor

public class BasicTransactionalFormEditor
extends org.eclipse.ui.forms.editor.FormEditor
implements IModelEditorInputChangeAnalyzer, org.eclipse.emf.edit.domain.IEditingDomainProvider, org.eclipse.jface.viewers.ISelectionProvider, org.eclipse.jface.action.IMenuListener, org.eclipse.emf.common.ui.viewer.IViewerProvider, org.eclipse.ui.ide.IGotoMarker, org.eclipse.ui.IPersistableEditor, org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor, org.eclipse.ui.ISaveablesSource, org.eclipse.ui.ISaveablePart2

A basic Eclipse Forms-based model editor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BasicTransactionalFormEditor.BasicTransactionalFormEditorInputChangeHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.ui.views.contentoutline.IContentOutlinePage	contentOutlinePage This is the content outline page.
protected org.eclipse.jface.action.IStatusLineManager	contentOutlineStatusLineManager This is a kludge...
protected org.eclipse.jface.viewers.TreeViewer	contentOutlineViewer This is the content outline page's viewer.
protected org.eclipse.jface.viewers.ISelectionProvider	currentSelectionProvider This keeps track of the active selection provider, which may be either one of the viewers in the pages or the content outline viewer.
protected ModelEditorInputSynchronizer	editorInputSynchronizer The model editor input synchronizer.
protected org.eclipse.jface.viewers.ISelection	editorSelection This keeps track of the selection of the editor as a whole.
protected boolean	finishCreatePagesOnActivation Indicated if the page creation of this editor needs finished upon activation due to editor input object change while editor has been inactive.
protected org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator	itemDelegator
protected org.eclipse.ui.forms.editor.IFormPage	messagePage
protected org.eclipse.ui.navigator.SaveablesProvider	modelSaveablesProvider
protected org.eclipse.ui.IPartListener	partListener This listens for when Outline and Properties view become active/inactive
protected java.util.Set<org.eclipse.ui.views.properties.IPropertySheetPage>	propertySheetPages This is collection of the property sheet pages.
protected org.eclipse.jface.viewers.ISelectionChangedListener	selectionChangedListener This listens to which ever viewer is active.
protected java.util.Collection<org.eclipse.jface.viewers.ISelectionChangedListener>	selectionChangedListeners This keeps track of all the ISelectionChangedListeners that are listening to this editor.
protected org.eclipse.jface.viewers.ISelectionProvider	selectionProvider This is the selection provider that shadows the selection in the content outline.
protected ModelEditorUndoContextManager	undoContextManager The model editor undo context manager.

Fields inherited from class org.eclipse.ui.forms.editor.FormEditor

pages

Fields inherited from class org.eclipse.ui.part.MultiPageEditorPart

PAGE_CONTAINER_SITE

Fields inherited from interface org.eclipse.ui.ISaveablePart2

CANCEL, DEFAULT, NO, YES

Fields inherited from interface org.eclipse.ui.ISaveablePart

PROP_DIRTY

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
BasicTransactionalFormEditor() This creates a model editor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addPages() This is the method used by the framework to install your own pages.
void	addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener) This implements ISelectionProvider.
boolean	containsEditorInputObject(org.eclipse.ui.IEditorInput editorInput, java.util.Set<org.eclipse.emf.ecore.EObject> objects)
boolean	containsEditorInputResourceURI(org.eclipse.ui.IEditorInput editorInput, java.util.Set<org.eclipse.emf.common.util.URI> resourceURIs)
void	createContextMenuFor(org.eclipse.jface.viewers.StructuredViewer viewer) This creates a context menu for the viewer and adds a listener as well registering the menu for extension.
protected org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator	createItemDelegator()
protected org.eclipse.ui.forms.editor.IFormPage	createLoadingEditorInputPage()
protected ModelEditorUndoContextManager	createModelEditorUndoContextManager()
protected org.eclipse.ui.ISaveablesLifecycleListener	createModelSaveablesLifecycleListener() Creates an ISaveablesLifecycleListener
protected org.eclipse.ui.navigator.SaveablesProvider	createModelSaveablesProvider()
protected org.eclipse.ui.forms.editor.IFormPage	createNoEditorInputPage()
protected void	createPages() Creates the common toolkit for this editor and adds pages to the editor.
void	dispose()
void	doSave(org.eclipse.core.runtime.IProgressMonitor monitor) This is for implementing IEditorPart and simply saves the model file.
void	doSaveAs() This also changes the editor's input.
protected void	finishCreatePages()
org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor	getActionBarContributor()
org.eclipse.ui.IActionBars	getActionBars()
org.eclipse.ui.forms.editor.IFormPage	getActivePageInstance()
org.eclipse.ui.Saveable[]	getActiveSaveables()
java.lang.Object	getAdapter(java.lang.Class key) This is how the framework determines which interfaces we implement.
org.eclipse.emf.common.notify.AdapterFactory	getAdapterFactory() Returns the adapter factory to be used by this form editor for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.
org.eclipse.ui.views.contentoutline.IContentOutlinePage	getContentOutlinePage() This accesses a cached version of the content outliner.
java.lang.String	getContributorId()
protected org.eclipse.emf.common.notify.AdapterFactory	getCustomAdapterFactory() Returns a custom adapter factory to be used by this form editor for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.
org.eclipse.jface.viewers.ISelection	getDefaultSelection()
org.eclipse.emf.edit.domain.EditingDomain	getEditingDomain() This returns the editing domain as required by the IEditingDomainProvider interface.
protected org.eclipse.emf.transaction.TransactionalEditingDomain	getEditingDomain(org.eclipse.emf.common.util.URI uri)
protected org.eclipse.ui.IEditorPart	getEditor(int pageIndex)
protected org.eclipse.swt.graphics.Image	getEditorInputImage()
protected java.lang.String	getEditorInputName()
java.lang.Object	getEditorInputObject()
org.eclipse.emf.ecore.resource.Resource	getEditorInputResource()
org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator	getItemDelegator()
protected java.util.Map<?,?>	getLoadOptions()
protected ModelEditorUndoContextManager	getModelEditorUndoContextManager()
java.lang.Object	getModelRoot() Deprecated. Use getEditorInputObject() instead.
org.eclipse.emf.ecore.resource.Resource	getModelRootResource() Deprecated. Use getEditorInputResource() instead.
java.lang.Object	getOldEditorInputObject()
java.lang.Object	getOldModelRoot() Deprecated. Use getOldEditorInputObject() instead.
org.eclipse.core.commands.operations.IOperationHistory	getOperationHistory()
org.eclipse.ui.views.properties.IPropertySheetPage	getPropertySheetPage() This creates a new property sheet page instance and manages it in the cache.
org.eclipse.ui.Saveable[]	getSaveables()
protected java.util.Map<?,?>	getSaveOptions()
org.eclipse.jface.viewers.ISelection	getSelection() This implements ISelectionProvider to return this editor's overall selection.
org.eclipse.jface.viewers.Viewer	getViewer() This returns the viewer as required by the IViewerProvider interface.
void	gotoMarker(org.eclipse.core.resources.IMarker marker)
protected void	handleActivate() Handles activation of the editor or it's associated views.
void	handleContentOutlineSelection(org.eclipse.jface.viewers.ISelection selection) This deals with how we want selection in the outliner to affect the other views.
protected void	hideTabs() If there is just one page in the multi-page editor part, this hides the single tab at the bottom.
void	init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput editorInput) This is called during startup.
protected boolean	isActivePart()
protected boolean	isActivePropertySheetPage()
boolean	isDirty()
protected boolean	isDisposed() Tests if this editor has already been disposed.
protected boolean	isEditorInputObjectStale() Returns whether the object behind the editor input is something that likely represents a stale object, e.g., an EObject that has become a proxy object or a Resource that has been unloaded.
protected boolean	isPersisted(org.eclipse.emf.ecore.resource.Resource resource) This returns whether something has been persisted to the URI of the specified resource.
boolean	isSaveAsAllowed()
boolean	isSaveOnCloseNeeded()
void	menuAboutToShow(org.eclipse.jface.action.IMenuManager menuManager) This implements IMenuListener to help fill the context menus with contributions from the Edit menu.
int	promptToSaveOnClose()
void	removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener) This implements ISelectionProvider.
protected void	reset()
void	restoreState(org.eclipse.ui.IMemento memento)
protected void	saveResource() Saves the resource on which the editor is opened.
void	saveState(org.eclipse.ui.IMemento memento)
protected void	setActivePage(int pageIndex)
protected void	setCurrentSelectionProvider(org.eclipse.jface.viewers.ISelectionProvider selectionProvider) This makes sure that one selection provider, either for the current page or the outline view, if it has focus, is the current one.
void	setFocus()
protected void	setMessagePage(org.eclipse.ui.forms.editor.IFormPage messagePage)
void	setSelection(org.eclipse.jface.viewers.ISelection selection) This implements ISelectionProvider to set this editor's overall selection.
void	setSelectionProvider(org.eclipse.jface.viewers.ISelectionProvider selectionProvider) This is to make sure that one of the selection providers in one of the pages can shadows the selection in the content outline.
void	setSelectionToViewer(java.util.Collection<?> collection) This sets the selection into whichever viewer is active.
void	setStatusLineManager(org.eclipse.jface.viewers.ISelection selection)
protected boolean	showOutlineView() Returns whether the outline view should be presented to the user.
protected void	showProblemsView()
protected void	showTabs() If there is more than one page in the multi-page editor part, this shows the tabs at the bottom.
java.lang.String	toString()
protected void	updateEditorInput(org.eclipse.emf.common.util.URI newURI)

Methods inherited from class org.eclipse.ui.forms.editor.FormEditor

addPage, addPage, addPage, addPage, addPage, addPage, close, commitPages, configurePage, createPageContainer, createToolkit, editorDirtyStateChanged, findPage, getActiveEditor, getCurrentPage, getSelectedPage, getToolkit, pageChange, removePage, selectReveal, setActivePage, setActivePage, updateActionBarContributor

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

activateSite, addPageChangedListener, createPartControl, createSite, deactivateSite, findEditors, getActivePage, getContainer, getControl, getPageCount, getPageImage, getPageSite, getPageText, handlePropertyChange, initializePageSwitching, removePageChangedListener, setActiveEditor, setControl, setPageImage, setPageText

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

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

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

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, 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, wait, wait, wait

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener

Field Detail

contentOutlinePage

protected org.eclipse.ui.views.contentoutline.IContentOutlinePage contentOutlinePage

This is the content outline page.

contentOutlineStatusLineManager

protected org.eclipse.jface.action.IStatusLineManager contentOutlineStatusLineManager

This is a kludge...

contentOutlineViewer

protected org.eclipse.jface.viewers.TreeViewer contentOutlineViewer

This is the content outline page's viewer.

propertySheetPages

protected java.util.Set<org.eclipse.ui.views.properties.IPropertySheetPage> propertySheetPages

This is collection of the property sheet pages.

selectionProvider

protected org.eclipse.jface.viewers.ISelectionProvider selectionProvider

This is the selection provider that shadows the selection in the content outline. The parent relation must be correctly defined for this to work.

currentSelectionProvider

protected org.eclipse.jface.viewers.ISelectionProvider currentSelectionProvider

This keeps track of the active selection provider, which may be either one of the viewers in the pages or the content outline viewer.

selectionChangedListener

protected org.eclipse.jface.viewers.ISelectionChangedListener selectionChangedListener

This listens to which ever viewer is active.

selectionChangedListeners

protected java.util.Collection<org.eclipse.jface.viewers.ISelectionChangedListener> selectionChangedListeners

This keeps track of all the ISelectionChangedListeners that are listening to this editor.

editorSelection

protected org.eclipse.jface.viewers.ISelection editorSelection

This keeps track of the selection of the editor as a whole.

finishCreatePagesOnActivation

protected boolean finishCreatePagesOnActivation

Indicated if the page creation of this editor needs finished upon activation due to editor input object change while editor has been inactive.

messagePage

protected org.eclipse.ui.forms.editor.IFormPage messagePage

modelSaveablesProvider

protected org.eclipse.ui.navigator.SaveablesProvider modelSaveablesProvider

itemDelegator

protected org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator itemDelegator

undoContextManager

protected ModelEditorUndoContextManager undoContextManager

The model editor undo context manager.

editorInputSynchronizer

protected ModelEditorInputSynchronizer editorInputSynchronizer

The model editor input synchronizer.

partListener

protected org.eclipse.ui.IPartListener partListener

This listens for when Outline and Properties view become active/inactive

Constructor Detail

BasicTransactionalFormEditor

public BasicTransactionalFormEditor()

This creates a model editor.

Method Detail

init

public void init(org.eclipse.ui.IEditorSite site,
        org.eclipse.ui.IEditorInput editorInput)

This is called during startup.

Specified by:

init in interface org.eclipse.ui.IEditorPart

Overrides:

init in class org.eclipse.ui.forms.editor.FormEditor

setSelectionToViewer

public void setSelectionToViewer(java.util.Collection<?> collection)

This sets the selection into whichever viewer is active.

getLoadOptions

protected java.util.Map<?,?> getLoadOptions()

getSaveOptions

protected java.util.Map<?,?> getSaveOptions()

handleActivate

protected void handleActivate()

Handles activation of the editor or it's associated views.

setSelectionProvider

public void setSelectionProvider(org.eclipse.jface.viewers.ISelectionProvider selectionProvider)

This is to make sure that one of the selection providers in one of the pages can shadows the selection in the content outline. The parent relation must be correctly defined for this to work.

setCurrentSelectionProvider

protected void setCurrentSelectionProvider(org.eclipse.jface.viewers.ISelectionProvider selectionProvider)

This makes sure that one selection provider, either for the current page or the outline view, if it has focus, is the current one.

getViewer

public org.eclipse.jface.viewers.Viewer getViewer()

This returns the viewer as required by the IViewerProvider interface.

Specified by:

getViewer in interface org.eclipse.emf.common.ui.viewer.IViewerProvider

createContextMenuFor

public void createContextMenuFor(org.eclipse.jface.viewers.StructuredViewer viewer)

This creates a context menu for the viewer and adds a listener as well registering the menu for extension.

updateEditorInput

protected void updateEditorInput(org.eclipse.emf.common.util.URI newURI)

getModelRoot

@Deprecated
public java.lang.Object getModelRoot()

Deprecated. Use getEditorInputObject() instead.

getOldModelRoot

@Deprecated
public java.lang.Object getOldModelRoot()

Deprecated. Use getOldEditorInputObject() instead.

getModelRootResource

@Deprecated
public org.eclipse.emf.ecore.resource.Resource getModelRootResource()

Deprecated. Use getEditorInputResource() instead.

isEditorInputObjectStale

protected boolean isEditorInputObjectStale()

Returns whether the object behind the editor input is something that likely represents a stale object, e.g., an EObject that has become a proxy object or a Resource that has been unloaded.

getEditorInputObject

public java.lang.Object getEditorInputObject()

Returns:

The object behind the editor input that is currently being edited in this editor or null if no such is available.

See Also:

getOldEditorInputObject()

getOldEditorInputObject

public java.lang.Object getOldEditorInputObject()

Returns:

The object behind the editor input that has been edited before in case that actual editor input object has become unavailable, or null if actual editor input object is still available.

See Also:

getEditorInputObject()

getEditorInputResource

public org.eclipse.emf.ecore.resource.Resource getEditorInputResource()

getEditorInputName

protected java.lang.String getEditorInputName()

getEditorInputImage

protected org.eclipse.swt.graphics.Image getEditorInputImage()

hideTabs

protected void hideTabs()

If there is just one page in the multi-page editor part, this hides the single tab at the bottom.

showTabs

protected void showTabs()

If there is more than one page in the multi-page editor part, this shows the tabs at the bottom.

getAdapter

public java.lang.Object getAdapter(java.lang.Class key)

This is how the framework determines which interfaces we implement.

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

Overrides:

getAdapter in class org.eclipse.ui.part.MultiPageEditorPart

getContentOutlinePage

public org.eclipse.ui.views.contentoutline.IContentOutlinePage getContentOutlinePage()

This accesses a cached version of the content outliner.

getPropertySheetPage

public org.eclipse.ui.views.properties.IPropertySheetPage getPropertySheetPage()

This creates a new property sheet page instance and manages it in the cache.

getContributorId

public java.lang.String getContributorId()

Specified by:

getContributorId in interface org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor

handleContentOutlineSelection

public void handleContentOutlineSelection(org.eclipse.jface.viewers.ISelection selection)

This deals with how we want selection in the outliner to affect the other views.

isDirty

public boolean isDirty()

Specified by:

isDirty in interface org.eclipse.ui.ISaveablePart

Overrides:

isDirty in class org.eclipse.ui.forms.editor.FormEditor

isSaveOnCloseNeeded

public boolean isSaveOnCloseNeeded()

Specified by:

isSaveOnCloseNeeded in interface org.eclipse.ui.ISaveablePart

Overrides:

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

promptToSaveOnClose

public int promptToSaveOnClose()

Specified by:

promptToSaveOnClose in interface org.eclipse.ui.ISaveablePart2

doSave

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

This is for implementing IEditorPart and simply saves the model file.

Specified by:

doSave in interface org.eclipse.ui.ISaveablePart

Specified by:

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

saveResource

protected void saveResource()

Saves the resource on which the editor is opened.

isPersisted

protected boolean isPersisted(org.eclipse.emf.ecore.resource.Resource resource)

This returns whether something has been persisted to the URI of the specified resource. The implementation uses the URI converter from the editor's resource set to try to open an input stream.

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface org.eclipse.ui.ISaveablePart

Specified by:

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

doSaveAs

public void doSaveAs()

This also changes the editor's input.

Specified by:

doSaveAs in interface org.eclipse.ui.ISaveablePart

Specified by:

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

gotoMarker

public void gotoMarker(org.eclipse.core.resources.IMarker marker)

Specified by:

gotoMarker in interface org.eclipse.ui.ide.IGotoMarker

reset

protected void reset()

setFocus

public void setFocus()

Specified by:

setFocus in interface org.eclipse.ui.IWorkbenchPart

Overrides:

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

addSelectionChangedListener

public void addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)

This implements ISelectionProvider.

Specified by:

addSelectionChangedListener in interface org.eclipse.jface.viewers.ISelectionProvider

removeSelectionChangedListener

public void removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)

This implements ISelectionProvider.

Specified by:

removeSelectionChangedListener in interface org.eclipse.jface.viewers.ISelectionProvider

getSelection

public org.eclipse.jface.viewers.ISelection getSelection()

This implements ISelectionProvider to return this editor's overall selection.

Specified by:

getSelection in interface org.eclipse.jface.viewers.ISelectionProvider

setSelection

public void setSelection(org.eclipse.jface.viewers.ISelection selection)

This implements ISelectionProvider to set this editor's overall selection. Calling this result will notify the listeners.

Specified by:

setSelection in interface org.eclipse.jface.viewers.ISelectionProvider

getDefaultSelection

public org.eclipse.jface.viewers.ISelection getDefaultSelection()

setStatusLineManager

public void setStatusLineManager(org.eclipse.jface.viewers.ISelection selection)

menuAboutToShow

public void menuAboutToShow(org.eclipse.jface.action.IMenuManager menuManager)

This implements IMenuListener to help fill the context menus with contributions from the Edit menu.

Specified by:

menuAboutToShow in interface org.eclipse.jface.action.IMenuListener

getActionBarContributor

public org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor getActionBarContributor()

getActionBars

public org.eclipse.ui.IActionBars getActionBars()

getOperationHistory

public org.eclipse.core.commands.operations.IOperationHistory getOperationHistory()

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchPart

Overrides:

dispose in class org.eclipse.ui.forms.editor.FormEditor

isDisposed

protected boolean isDisposed()

Tests if this editor has already been disposed.

This implementation determines the disposed state of the editor by checking if the FormEditor.pages field is null or not. When the editor has been disposed, it is an error to invoke any other method using the editor.

Returns:

true when the editor is disposed and false otherwise.

showOutlineView

protected boolean showOutlineView()

Returns whether the outline view should be presented to the user.

getModelEditorUndoContextManager

protected ModelEditorUndoContextManager getModelEditorUndoContextManager()

createModelEditorUndoContextManager

protected ModelEditorUndoContextManager createModelEditorUndoContextManager()

isActivePart

protected boolean isActivePart()

isActivePropertySheetPage

protected boolean isActivePropertySheetPage()

createModelSaveablesProvider

protected org.eclipse.ui.navigator.SaveablesProvider createModelSaveablesProvider()

createModelSaveablesLifecycleListener

protected org.eclipse.ui.ISaveablesLifecycleListener createModelSaveablesLifecycleListener()

Creates an ISaveablesLifecycleListener

Returns:

getEditingDomain

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

This returns the editing domain as required by the IEditingDomainProvider interface. This is important for implementing the static methods of AdapterFactoryEditingDomain and for supporting CommandAction.

Specified by:

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

getEditingDomain

protected org.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomain(org.eclipse.emf.common.util.URI uri)

getAdapterFactory

public org.eclipse.emf.common.notify.AdapterFactory getAdapterFactory()

Returns the adapter factory to be used by this form editor for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.

This implementation returns the adapter factory which is embedded in the given editingDomain by default. Clients which want to use an alternative adapter factory (e.g., an adapter factory that creates item providers which are specifically designed for the editor in which this form editor is used) may override getCustomAdapterFactory() and return any adapter factory of their choice. This custom adapter factory will then be returned as result by this method.

Parameters:

editingDomain - The editing domain whose embedded adapter factory is to be returned as default. May be left null if getCustomAdapterFactory() has been overridden and returns a non-null result.

Returns:

The adapter factory that will be used by this form editor. null if no custom adapter factory is provided through getCustomAdapterFactory() and no editingDomain has been specified.

See Also:

getCustomAdapterFactory()

getCustomAdapterFactory

protected org.eclipse.emf.common.notify.AdapterFactory getCustomAdapterFactory()

Returns a custom adapter factory to be used by this form editor for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.

This implementation returns null as default. Clients which want to use their own adapter factory (e.g., an adapter factory that creates item providers which are specifically designed for the editor in which this form editor is used) may override this method and return any adapter factory of their choice. This custom adapter factory will then be returned as result by #getAdapterFactory(TransactionalEditingDomain).

Returns:

The custom adapter factory that is to be used by this form editor. null the default adapter factory returned by #getAdapterFactory(TransactionalEditingDomain) should be used instead.

See Also:

#getAdapterFactory(TransactionalEditingDomain)

getItemDelegator

public org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator getItemDelegator()

createItemDelegator

protected org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator createItemDelegator()

createPages

protected void createPages()

Creates the common toolkit for this editor and adds pages to the editor.

Overrides:

createPages in class org.eclipse.ui.forms.editor.FormEditor

setMessagePage

protected void setMessagePage(org.eclipse.ui.forms.editor.IFormPage messagePage)

showProblemsView

protected void showProblemsView()

createLoadingEditorInputPage

protected org.eclipse.ui.forms.editor.IFormPage createLoadingEditorInputPage()

createNoEditorInputPage

protected org.eclipse.ui.forms.editor.IFormPage createNoEditorInputPage()

finishCreatePages

protected void finishCreatePages()

addPages

protected void addPages()

This is the method used by the framework to install your own pages.

This implementation add a single page that displays the editor input object and its contents in a tree viewer.

Specified by:

addPages in class org.eclipse.ui.forms.editor.FormEditor

getActivePageInstance

public org.eclipse.ui.forms.editor.IFormPage getActivePageInstance()

Overrides:

getActivePageInstance in class org.eclipse.ui.forms.editor.FormEditor

setActivePage

protected void setActivePage(int pageIndex)

Overrides:

setActivePage in class org.eclipse.ui.forms.editor.FormEditor

getEditor

protected org.eclipse.ui.IEditorPart getEditor(int pageIndex)

Overrides:

getEditor in class org.eclipse.ui.part.MultiPageEditorPart

saveState

public void saveState(org.eclipse.ui.IMemento memento)

Specified by:

saveState in interface org.eclipse.ui.IPersistable

restoreState

public void restoreState(org.eclipse.ui.IMemento memento)

Specified by:

restoreState in interface org.eclipse.ui.IPersistableEditor

getActiveSaveables

public org.eclipse.ui.Saveable[] getActiveSaveables()

Specified by:

getActiveSaveables in interface org.eclipse.ui.ISaveablesSource

getSaveables

public org.eclipse.ui.Saveable[] getSaveables()

Specified by:

getSaveables in interface org.eclipse.ui.ISaveablesSource

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

containsEditorInputObject

public boolean containsEditorInputObject(org.eclipse.ui.IEditorInput editorInput,
                                java.util.Set<org.eclipse.emf.ecore.EObject> objects)

Specified by:

containsEditorInputObject in interface IModelEditorInputChangeAnalyzer

containsEditorInputResourceURI

public boolean containsEditorInputResourceURI(org.eclipse.ui.IEditorInput editorInput,
                                     java.util.Set<org.eclipse.emf.common.util.URI> resourceURIs)

Specified by:

containsEditorInputResourceURI in interface IModelEditorInputChangeAnalyzer