org.eclipse.sphinx.gmf.runtime.ui.editor

Class BasicDiagramDocumentEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.gef.ui.parts.GraphicalEditor

org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditor

org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditorWithFlyOutPalette

org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor

org.eclipse.sphinx.gmf.runtime.ui.editor.BasicDiagramDocumentEditor

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.gef.commands.CommandStackListener, org.eclipse.gmf.runtime.diagram.ui.parts.IDiagramWorkbenchPart, org.eclipse.gmf.runtime.diagram.ui.resources.editor.document.IDocumentEditor, org.eclipse.ui.IEditorPart, org.eclipse.ui.IReusableEditor, org.eclipse.ui.ISaveablePart, org.eclipse.ui.ISaveablesSource, org.eclipse.ui.ISelectionListener, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IShowInSource, org.eclipse.ui.part.IWorkbenchPartOrientation, org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor

public class BasicDiagramDocumentEditor
extends org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor
implements org.eclipse.ui.ISaveablesSource

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditorWithFlyOutPalette

org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditorWithFlyOutPalette.CustomPalettePage

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.ui.navigator.SaveablesProvider	modelSaveablesProvider
protected ModelEditorUndoContextManager	undoContextManager

Fields inherited from class org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor

fErrorLabel, statusLineContributions, statusLineLabelProvider

Fields inherited from class org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditorWithFlyOutPalette

COLLAPSED, UNCOLLAPSED_PINNED

Fields inherited from class org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditor

DIAGRAM_CONTEXT_ID, ID_OUTLINE, ID_OVERVIEW, workspaceViewerPreferenceStore

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
BasicDiagramDocumentEditor()
BasicDiagramDocumentEditor(boolean hasFlyoutPalette)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.eclipse.ui.ISaveablesLifecycleListener	createModelSaveablesLifecycleListener() Creates an ISaveablesLifecycleListener
protected org.eclipse.ui.navigator.SaveablesProvider	createModelSaveablesProvider()
void	dispose()
protected void	enableSanityChecking(boolean enable)
org.eclipse.ui.Saveable[]	getActiveSaveables()
java.lang.Object	getAdapter(java.lang.Class key)
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.
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.ui.Saveable[]	getSaveables()
void	init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput input)
boolean	isSaveOnCloseNeeded()

Methods inherited from class org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor

addStatusLineContributions, askUserReload, askUserSaveClose, askUserSaveOverwrite, close, configureDiagramEditDomain, createActionManager, createEditingDomain, createOperationHistory, createPartControl, disposeDocumentProvider, doSave, doSaveAs, doSetInput, editorSaved, enableStateValidation, firePropertyChange, getDefaultPaletteContent, getDiagram, getDiagramDocument, getDocumentProvider, getDocumentProvider, getEditingDomain, getEditingDomainID, getEditorDescriptor, getProgressMonitor, handleEditorInputChanged, handleElementContentAboutToBeReplaced, handleElementContentReplaced, handleExceptionOnSave, handleSelectionChanged, initializeGraphicalViewer, isDirty, isEditable, isEditorInputModifiable, isEditorInputReadOnly, isSaveAsAllowed, isStatusLineOn, performSave, performSaveAs, rebuildStatusLine, releaseInput, removeStatusLineContributions, reuseDiagramOnMove, safelySanityCheckState, sanityCheckState, selectionChanged, setDocumentProvider, setDocumentProvider, setInput, setSite, updateState, updateStatusLineMessageContribution, validateEditorInputState, validateState

Methods inherited from class org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditorWithFlyOutPalette

applyCustomizationsToPalette, configurePaletteViewer, constructPaletteViewer, createActivityManagerListener, createPaletteCustomizer, createPaletteRoot, createPaletteViewerProvider, getInitialDockLocation, getInitialPaletteSize, getInitialPaletteState, getPaletteViewerProvider, getPreferenceStore, handlePaletteDefaultStateChanged, handlePaletteResized, setEditDomain, setFocus, startListening, stopListening, toolSupportsAccessibility

Methods inherited from class org.eclipse.gmf.runtime.diagram.ui.parts.DiagramEditor

addDefaultPreferences, addDefaultPreferences, clearGraphicalViewerContents, closeEditor, configureGraphicalViewer, createActions, createDiagramEditDomain, createGraphicalViewer, createHistoryListener, createScrollingGraphicalViewer, createUndoContext, createUndoContextLabel, getActionManager, getContextID, getContributorId, getDefaultOutlineViewMode, getDiagramEditDomain, getDiagramEditPart, getDiagramGraphicalViewer, getElements, getGraphicalControl, getKeyHandler, getOperationHistory, getOutlineContextMenuProvider, getOutlineViewEditPartFactory, getPreferencesHint, getRulerComposite, getShowInContext, getSite, getUndoContext, getWorkspaceViewerPreferenceStore, getZoomManager, initializeGraphicalViewerContents, isWritable, persistViewerSettings, setRulerComposite, setUndoContext, shouldAddUndoContext

Methods inherited from class org.eclipse.gef.ui.parts.GraphicalEditor

commandStackChanged, getActionRegistry, getCommandStack, getEditDomain, getGraphicalViewer, getPropertyActions, getSelectionActions, getSelectionSynchronizer, getStackActions, hookGraphicalViewer, initializeActionRegistry, setActionRegistry, setGraphicalViewer, updateActions

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

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

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

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, 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.IEditorPart

getEditorInput, getEditorSite

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus

Field Detail

modelSaveablesProvider

protected org.eclipse.ui.navigator.SaveablesProvider modelSaveablesProvider

undoContextManager

protected ModelEditorUndoContextManager undoContextManager

Constructor Detail

BasicDiagramDocumentEditor

public BasicDiagramDocumentEditor()

BasicDiagramDocumentEditor

public BasicDiagramDocumentEditor(boolean hasFlyoutPalette)

Method Detail

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

Overrides:

init in class org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor

Throws:

org.eclipse.ui.PartInitException

createModelSaveablesProvider

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

createModelSaveablesLifecycleListener

protected org.eclipse.ui.ISaveablesLifecycleListener createModelSaveablesLifecycleListener()

Creates an ISaveablesLifecycleListener

Returns:

isSaveOnCloseNeeded

public boolean isSaveOnCloseNeeded()

Specified by:

isSaveOnCloseNeeded in interface org.eclipse.ui.ISaveablePart

Overrides:

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

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

getAdapter

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

Specified by:

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

Overrides:

getAdapter in class org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor

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)

enableSanityChecking

protected void enableSanityChecking(boolean enable)

Overrides:

enableSanityChecking in class org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchPart

Overrides:

dispose in class org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor