java.lang.Object
- org.eclipse.core.commands.common.EventManager
- - org.eclipse.ui.part.WorkbenchPart
  - - org.eclipse.ui.part.EditorPart
    - - org.eclipse.ui.part.MultiPageEditorPart
      - tools.mdsd.characteristics.api.presentation.ApiEditor

All Implemented Interfaces:

IAdaptable, IExecutableExtension, IViewerProvider, IEditingDomainProvider, IMenuListener, IPageChangeProvider, ISelectionProvider, IGotoMarker, IEditorPart, ISaveablePart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation
```
public class ApiEditor
extends MultiPageEditorPart
implements IEditingDomainProvider, ISelectionProvider, IMenuListener, IViewerProvider, IGotoMarker
```
This is an example of a Api model editor.

Generated class or method.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class ApiEditor.ReverseAdapterFactoryContentProvider

Field Summary

Fields
Modifier and Type	Field	Description
`protected ComposedAdapterFactory`	`adapterFactory`	This is the one adapter factory used for providing views of the model.
`protected java.util.Collection<Resource>`	`changedResources`	Resources that have been changed since last activation.
`protected IContentOutlinePage`	`contentOutlinePage`	This is the content outline page.
`protected IStatusLineManager`	`contentOutlineStatusLineManager`	This is a kludge...
`protected TreeViewer`	`contentOutlineViewer`	This is the content outline page's viewer.
`protected Viewer`	`currentViewer`	This keeps track of the active content viewer, which may be either one of the viewers in the pages or the content outline viewer.
`protected AdapterFactoryEditingDomain`	`editingDomain`	This keeps track of the editing domain that is used to track all changes to the model.
`protected ISelection`	`editorSelection`	This keeps track of the selection of the editor as a whole.
`protected MarkerHelper`	`markerHelper`	The MarkerHelper is responsible for creating workspace resource markers presented in Eclipse's Problems View.
`protected IPartListener`	`partListener`	This listens for when the outline becomes active
`protected EContentAdapter`	`problemIndicationAdapter`	Adapter used to update the problem indication when resources are demanded loaded.
`protected java.util.List<PropertySheetPage>`	`propertySheetPages`	This is the property sheet page.
`protected java.util.Collection<Resource>`	`removedResources`	Resources that have been removed since last activation.
`protected IResourceChangeListener`	`resourceChangeListener`	This listens for workspace changes.
`protected java.util.Map<Resource,Diagnostic>`	`resourceToDiagnosticMap`	Map to store the diagnostic associated with a resource.
`protected java.util.Collection<Resource>`	`savedResources`	Resources that have been saved.
`protected ISelectionChangedListener`	`selectionChangedListener`	This listens to which ever viewer is active.
`protected java.util.Collection<ISelectionChangedListener>`	`selectionChangedListeners`	This keeps track of all the `ISelectionChangedListener`s that are listening to this editor.
`protected TreeViewer`	`selectionViewer`	This is the viewer that shadows the selection in the content outline.
`protected boolean`	`updateProblemIndication`	Controls whether the problem indication should be updated.

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

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 Description

ApiEditor()
This creates a model editor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addSelectionChangedListener(ISelectionChangedListener listener)`	This implements `ISelectionProvider`.
`Diagnostic`	`analyzeResourceProblems(Resource resource, java.lang.Exception exception)`	Returns a diagnostic describing the errors and warnings listed in the resource and the specified exception (if any).
`protected void`	`createContextMenuFor(StructuredViewer viewer)`	This creates a context menu for the viewer and adds a listener as well registering the menu for extension.
`void`	`createModel()`	This is the method called to load a resource into the editing domain's resource set based on the editor's input.
`void`	`createPages()`	This is the method used by the framework to install your own controls.
`void`	`dispose()`
`void`	`doSave(IProgressMonitor progressMonitor)`	This is for implementing `IEditorPart` and simply saves the model file.
`void`	`doSaveAs()`	This also changes the editor's input.
`protected void`	`doSaveAs(URI uri, IEditorInput editorInput)`
`protected void`	`firePropertyChange(int action)`	This is here for the listener to be able to call it.
`EditingDomainActionBarContributor`	`getActionBarContributor()`
`IActionBars`	`getActionBars()`
`<T> T`	`getAdapter(java.lang.Class<T> key)`	This is how the framework determines which interfaces we implement.
`AdapterFactory`	`getAdapterFactory()`
`IContentOutlinePage`	`getContentOutlinePage()`	This accesses a cached version of the content outliner.
`EditingDomain`	`getEditingDomain()`	This returns the editing domain as required by the `IEditingDomainProvider` interface.
`IPropertySheetPage`	`getPropertySheetPage()`	This accesses a cached version of the property sheet.
`ISelection`	`getSelection()`	This implements `ISelectionProvider` to return this editor's overall selection.
`Viewer`	`getViewer()`	This returns the viewer as required by the `IViewerProvider` interface.
`void`	`gotoMarker(IMarker marker)`
`protected void`	`handleActivate()`	Handles activation of the editor or it's associated views.
`protected void`	`handleChangedResources()`	Handles what to do with changed resources on activation.
`void`	`handleContentOutlineSelection(ISelection selection)`	This deals with how we want selection in the outliner to affect the other views.
`protected boolean`	`handleDirtyConflict()`	Shows a dialog that asks if conflicting changes should be discarded.
`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(IEditorSite site, IEditorInput editorInput)`	This is called during startup.
`protected void`	`initializeEditingDomain()`	This sets up the editing domain for the model editor.
`boolean`	`isDirty()`	This is for implementing `IEditorPart` and simply tests the command stack.
`protected boolean`	`isPersisted(Resource resource)`	This returns whether something has been persisted to the URI of the specified resource.
`boolean`	`isSaveAsAllowed()`	This always returns true because it is not currently supported.
`void`	`menuAboutToShow(IMenuManager menuManager)`	This implements `IMenuListener` to help fill the context menus with contributions from the Edit menu.
`protected void`	`pageChange(int pageIndex)`	This is used to track the active viewer.
`void`	`removeSelectionChangedListener(ISelectionChangedListener listener)`	This implements `ISelectionProvider`.
`void`	`setCurrentViewer(Viewer viewer)`	This makes sure that one content viewer, either for the current page or the outline view, if it has focus, is the current one.
`void`	`setFocus()`
`void`	`setSelection(ISelection selection)`	This implements `ISelectionProvider` to set this editor's overall selection.
`void`	`setSelectionToViewer(java.util.Collection<?> collection)`	This sets the selection into whichever viewer is active.
`void`	`setStatusLineManager(ISelection selection)`
`protected boolean`	`showOutlineView()`	Returns whether the outline view should be presented to the user.
`protected void`	`showTabs()`	If there is more than one page in the multi-page editor part, this shows the tabs at the bottom.
`protected void`	`updateProblemIndication()`	Updates the problems indication with the information described in the specified diagnostic.

Methods inherited from class org.eclipse.ui.part.MultiPageEditorPart
activateSite, addPage, addPage, addPage, addPage, addPageChangedListener, createContainer, createItem, createPageContainer, createPartControl, createSite, deactivateSite, findEditors, getActiveEditor, getActivePage, getContainer, getControl, getEditor, getPageCount, getPageImage, getPageSite, getPageText, getSelectedPage, handlePropertyChange, initializePageSwitching, removePage, removePageChangedListener, setActiveEditor, setActivePage, setControl, setPageImage, setPageText

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, firePartPropertyChanged, 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, getSite, getTitle, getTitleImage, removePropertyListener

- Field Detail
  - editingDomain
```
protected AdapterFactoryEditingDomain editingDomain
```
    This keeps track of the editing domain that is used to track all changes to the model.
    
    Generated class or method.
  - adapterFactory
```
protected ComposedAdapterFactory adapterFactory
```
    This is the one adapter factory used for providing views of the model.
    
    Generated class or method.
  - contentOutlinePage
```
protected IContentOutlinePage contentOutlinePage
```
    This is the content outline page.
    
    Generated class or method.
  - contentOutlineStatusLineManager
```
protected IStatusLineManager contentOutlineStatusLineManager
```
    This is a kludge...
    
    Generated class or method.
  - contentOutlineViewer
```
protected TreeViewer contentOutlineViewer
```
    This is the content outline page's viewer.
    
    Generated class or method.
  - propertySheetPages
```
protected java.util.List<PropertySheetPage> propertySheetPages
```
    This is the property sheet page.
    
    Generated class or method.
  - selectionViewer
```
protected TreeViewer selectionViewer
```
    This is the viewer that shadows the selection in the content outline. The parent relation must be correctly defined for this to work.
    
    Generated class or method.
  - currentViewer
```
protected Viewer currentViewer
```
    This keeps track of the active content viewer, which may be either one of the viewers in the pages or the content outline viewer.
    
    Generated class or method.
  - selectionChangedListener
```
protected ISelectionChangedListener selectionChangedListener
```
    This listens to which ever viewer is active.
    
    Generated class or method.
  - selectionChangedListeners
```
protected java.util.Collection<ISelectionChangedListener> selectionChangedListeners
```
    This keeps track of all the ISelectionChangedListeners that are listening to this editor.
    
    Generated class or method.
  - editorSelection
```
protected ISelection editorSelection
```
    This keeps track of the selection of the editor as a whole.
    
    Generated class or method.
  - markerHelper
```
protected MarkerHelper markerHelper
```
    The MarkerHelper is responsible for creating workspace resource markers presented in Eclipse's Problems View.
    
    Generated class or method.
  - partListener
```
protected IPartListener partListener
```
    This listens for when the outline becomes active
    
    Generated class or method.
  - removedResources
```
protected java.util.Collection<Resource> removedResources
```
    Resources that have been removed since last activation.
    
    Generated class or method.
  - changedResources
```
protected java.util.Collection<Resource> changedResources
```
    Resources that have been changed since last activation.
    
    Generated class or method.
  - savedResources
```
protected java.util.Collection<Resource> savedResources
```
    Resources that have been saved.
    
    Generated class or method.
  - resourceToDiagnosticMap
```
protected java.util.Map<Resource,Diagnostic> resourceToDiagnosticMap
```
    Map to store the diagnostic associated with a resource.
    
    Generated class or method.
  - updateProblemIndication
```
protected boolean updateProblemIndication
```
    Controls whether the problem indication should be updated.
    
    Generated class or method.
  - problemIndicationAdapter
```
protected EContentAdapter problemIndicationAdapter
```
    Adapter used to update the problem indication when resources are demanded loaded.
    
    Generated class or method.
  - resourceChangeListener
```
protected IResourceChangeListener resourceChangeListener
```
    This listens for workspace changes.
    
    Generated class or method.
- Constructor Detail
  - ApiEditor
```
public ApiEditor()
```
    This creates a model editor.
    
    Generated class or method.
- Method Detail
  - handleActivate
```
protected void handleActivate()
```
    Handles activation of the editor or it's associated views.
    
    Generated class or method.
  - handleChangedResources
```
protected void handleChangedResources()
```
    Handles what to do with changed resources on activation.
    
    Generated class or method.
  - updateProblemIndication
```
protected void updateProblemIndication()
```
    Updates the problems indication with the information described in the specified diagnostic.
    
    Generated class or method.
  - handleDirtyConflict
```
protected boolean handleDirtyConflict()
```
    Shows a dialog that asks if conflicting changes should be discarded.
    
    Generated class or method.
  - initializeEditingDomain
```
protected void initializeEditingDomain()
```
    This sets up the editing domain for the model editor.
    
    Generated class or method.
  - firePropertyChange
```
protected void firePropertyChange(int action)
```
    This is here for the listener to be able to call it.
    
    Overrides:
    
    firePropertyChange in class WorkbenchPart
    
    Generated class or method.
  - setSelectionToViewer
```
public void setSelectionToViewer(java.util.Collection<?> collection)
```
    This sets the selection into whichever viewer is active.
    
    Generated class or method.
  - getEditingDomain
```
public 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 IEditingDomainProvider
    
    Generated class or method.
  - setCurrentViewer
```
public void setCurrentViewer(Viewer viewer)
```
    This makes sure that one content viewer, either for the current page or the outline view, if it has focus, is the current one.
    
    Generated class or method.
  - getViewer
```
public Viewer getViewer()
```
    This returns the viewer as required by the IViewerProvider interface.
    
    Specified by:
    
    getViewer in interface IViewerProvider
    
    Generated class or method.
  - createContextMenuFor
```
protected void createContextMenuFor(StructuredViewer viewer)
```
    This creates a context menu for the viewer and adds a listener as well registering the menu for extension.
    
    Generated class or method.
  - createModel
```
public void createModel()
```
    This is the method called to load a resource into the editing domain's resource set based on the editor's input.
    
    Generated class or method.
  - analyzeResourceProblems
```
public Diagnostic analyzeResourceProblems(Resource resource,
                                          java.lang.Exception exception)
```
    Returns a diagnostic describing the errors and warnings listed in the resource and the specified exception (if any).
    
    Generated class or method.
  - createPages
```
public void createPages()
```
    This is the method used by the framework to install your own controls.
    
    Specified by:
    
    createPages in class MultiPageEditorPart
    
    Generated class or method.
  - hideTabs
```
protected void hideTabs()
```
    If there is just one page in the multi-page editor part, this hides the single tab at the bottom.
    
    Generated class or method.
  - showTabs
```
protected void showTabs()
```
    If there is more than one page in the multi-page editor part, this shows the tabs at the bottom.
    
    Generated class or method.
  - pageChange
```
protected void pageChange(int pageIndex)
```
    This is used to track the active viewer.
    
    Overrides:
    
    pageChange in class MultiPageEditorPart
    
    Generated class or method.
  - getAdapter
```
public <T> T getAdapter(java.lang.Class<T> key)
```
    This is how the framework determines which interfaces we implement.
    
    Specified by:
    
    getAdapter in interface IAdaptable
    
    Overrides:
    
    getAdapter in class MultiPageEditorPart
    
    Generated class or method.
  - getContentOutlinePage
```
public IContentOutlinePage getContentOutlinePage()
```
    This accesses a cached version of the content outliner.
    
    Generated class or method.
  - getPropertySheetPage
```
public IPropertySheetPage getPropertySheetPage()
```
    This accesses a cached version of the property sheet.
    
    Generated class or method.
  - handleContentOutlineSelection
```
public void handleContentOutlineSelection(ISelection selection)
```
    This deals with how we want selection in the outliner to affect the other views.
    
    Generated class or method.
  - isDirty
```
public boolean isDirty()
```
    This is for implementing IEditorPart and simply tests the command stack.
    
    Specified by:
    
    isDirty in interface ISaveablePart
    
    Overrides:
    
    isDirty in class MultiPageEditorPart
    
    Generated class or method.
  - doSave
```
public void doSave(IProgressMonitor progressMonitor)
```
    This is for implementing IEditorPart and simply saves the model file.
    
    Specified by:
    
    doSave in interface ISaveablePart
    
    Specified by:
    
    doSave in class EditorPart
    
    Generated class or method.
  - isPersisted
```
protected boolean isPersisted(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.
    
    Generated class or method.
  - isSaveAsAllowed
```
public boolean isSaveAsAllowed()
```
    This always returns true because it is not currently supported.
    
    Specified by:
    
    isSaveAsAllowed in interface ISaveablePart
    
    Specified by:
    
    isSaveAsAllowed in class EditorPart
    
    Generated class or method.
  - doSaveAs
```
public void doSaveAs()
```
    This also changes the editor's input.
    
    Specified by:
    
    doSaveAs in interface ISaveablePart
    
    Specified by:
    
    doSaveAs in class EditorPart
    
    Generated class or method.
  - doSaveAs
```
protected void doSaveAs(URI uri,
                        IEditorInput editorInput)
```
    Generated class or method.
  - gotoMarker
```
public void gotoMarker(IMarker marker)
```
    Specified by:
    
    gotoMarker in interface IGotoMarker
    
    Generated class or method.
  - init
```
public void init(IEditorSite site,
                 IEditorInput editorInput)
```
    This is called during startup.
    
    Specified by:
    
    init in interface IEditorPart
    
    Overrides:
    
    init in class MultiPageEditorPart
    
    Generated class or method.
  - setFocus
```
public void setFocus()
```
    Specified by:
    
    setFocus in interface IWorkbenchPart
    
    Overrides:
    
    setFocus in class MultiPageEditorPart
    
    Generated class or method.
  - addSelectionChangedListener
```
public void addSelectionChangedListener(ISelectionChangedListener listener)
```
    This implements ISelectionProvider.
    
    Specified by:
    
    addSelectionChangedListener in interface ISelectionProvider
    
    Generated class or method.
  - removeSelectionChangedListener
```
public void removeSelectionChangedListener(ISelectionChangedListener listener)
```
    This implements ISelectionProvider.
    
    Specified by:
    
    removeSelectionChangedListener in interface ISelectionProvider
    
    Generated class or method.
  - getSelection
```
public ISelection getSelection()
```
    This implements ISelectionProvider to return this editor's overall selection.
    
    Specified by:
    
    getSelection in interface ISelectionProvider
    
    Generated class or method.
  - setSelection
```
public void setSelection(ISelection selection)
```
    This implements ISelectionProvider to set this editor's overall selection. Calling this result will notify the listeners.
    
    Specified by:
    
    setSelection in interface ISelectionProvider
    
    Generated class or method.
  - setStatusLineManager
```
public void setStatusLineManager(ISelection selection)
```
    Generated class or method.
  - menuAboutToShow
```
public void menuAboutToShow(IMenuManager menuManager)
```
    This implements IMenuListener to help fill the context menus with contributions from the Edit menu.
    
    Specified by:
    
    menuAboutToShow in interface IMenuListener
    
    Generated class or method.
  - getActionBarContributor
```
public EditingDomainActionBarContributor getActionBarContributor()
```
    Generated class or method.
  - getActionBars
```
public IActionBars getActionBars()
```
    Generated class or method.
  - getAdapterFactory
```
public AdapterFactory getAdapterFactory()
```
    Generated class or method.
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface IWorkbenchPart
    
    Overrides:
    
    dispose in class MultiPageEditorPart
    
    Generated class or method.
  - showOutlineView
```
protected boolean showOutlineView()
```
    Returns whether the outline view should be presented to the user.
    
    Generated class or method.

Class ApiEditor

Nested Class Summary

Field Summary

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

Fields inherited from interface org.eclipse.ui.IEditorPart

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

Field Detail

editingDomain

adapterFactory

contentOutlinePage

contentOutlineStatusLineManager

contentOutlineViewer

propertySheetPages

selectionViewer

currentViewer

selectionChangedListener

selectionChangedListeners

editorSelection

markerHelper

partListener

removedResources

changedResources

savedResources

resourceToDiagnosticMap

updateProblemIndication

problemIndicationAdapter

resourceChangeListener

Constructor Detail

ApiEditor

Method Detail

handleActivate

handleChangedResources

updateProblemIndication

handleDirtyConflict

initializeEditingDomain

firePropertyChange

setSelectionToViewer

getEditingDomain

setCurrentViewer

getViewer

createContextMenuFor

createModel

analyzeResourceProblems

createPages

hideTabs

showTabs

pageChange

getAdapter

getContentOutlinePage

getPropertySheetPage

handleContentOutlineSelection

isDirty

doSave

isPersisted

isSaveAsAllowed

doSaveAs

doSaveAs

gotoMarker

init

setFocus

addSelectionChangedListener

removeSelectionChangedListener

getSelection

setSelection

setStatusLineManager

menuAboutToShow

getActionBarContributor

getActionBars

getAdapterFactory

dispose

showOutlineView