de.cau.cs.kieler.synccharts.presentation
Class SyncchartsEditor

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.ui.part.WorkbenchPart
          extended by org.eclipse.ui.part.EditorPart
              extended by org.eclipse.ui.part.MultiPageEditorPart
                  extended by de.cau.cs.kieler.synccharts.presentation.SyncchartsEditor
All Implemented Interfaces:
IAdaptable, IExecutableExtension, IViewerProvider, IEditingDomainProvider, IMenuListener, IPageChangeProvider, ISelectionProvider, IGotoMarker, IEditorPart, ISaveablePart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class SyncchartsEditor
extends MultiPageEditorPart
implements IEditingDomainProvider, ISelectionProvider, IMenuListener, IViewerProvider, IGotoMarker

This is an example of a Synccharts model editor.

Rating red
Generated:
This code was automatically generated.

Nested Class Summary
 class SyncchartsEditor.ReverseAdapterFactoryContentProvider
           
 
Field Summary
protected  ComposedAdapterFactory adapterFactory
          This is the one adapter factory used for providing views of the model.
protected  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.
static String copyright
           
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  ViewerPane currentViewerPane
          This keeps track of the active viewer pane, in the book.
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  ListViewer listViewer
          This shows how a list view works.
protected  MarkerHelper markerHelper
          The MarkerHelper is responsible for creating workspace resource markers presented in Eclipse's Problems View.
protected  TreeViewer parentViewer
          This inverts the roll of parent and child in the content provider and show parents as a tree.
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  PropertySheetPage propertySheetPage
          This is the property sheet page.
protected  Collection<Resource> removedResources
          Resources that have been removed since last activation.
protected  IResourceChangeListener resourceChangeListener
          This listens for workspace changes.
protected  Map<Resource,Diagnostic> resourceToDiagnosticMap
          Map to store the diagnostic associated with a resource.
protected  Collection<Resource> savedResources
          Resources that have been saved.
protected  ISelectionChangedListener selectionChangedListener
          This listens to which ever viewer is active.
protected  Collection<ISelectionChangedListener> selectionChangedListeners
          This keeps track of all the ISelectionChangedListeners that are listening to this editor.
protected  TreeViewer selectionViewer
          This is the viewer that shadows the selection in the content outline.
protected  TableViewer tableViewer
          This shows how a table view works.
protected  TreeViewer treeViewer
          This shows how a tree view works.
protected  TreeViewer treeViewerWithColumns
          This shows how a tree view with columns works.
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
SyncchartsEditor()
          This creates a model editor.
 
Method Summary
 void addSelectionChangedListener(ISelectionChangedListener listener)
          This implements ISelectionProvider.
 Diagnostic analyzeResourceProblems(Resource resource, 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()
           
 Object getAdapter(Class 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 setCurrentViewerPane(ViewerPane viewerPane)
           
 void setFocus()
           
 void setSelection(ISelection selection)
          This implements ISelectionProvider to set this editor's overall selection.
 void setSelectionToViewer(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, 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

copyright

public static final String copyright

See Also:
Constant Field Values
Generated:
This code was automatically generated.

editingDomain

protected AdapterFactoryEditingDomain editingDomain
This keeps track of the editing domain that is used to track all changes to the model.

Generated:
This code was automatically generated.

adapterFactory

protected ComposedAdapterFactory adapterFactory
This is the one adapter factory used for providing views of the model.

Generated:
This code was automatically generated.

contentOutlinePage

protected IContentOutlinePage contentOutlinePage
This is the content outline page.

Generated:
This code was automatically generated.

contentOutlineStatusLineManager

protected IStatusLineManager contentOutlineStatusLineManager
This is a kludge...

Generated:
This code was automatically generated.

contentOutlineViewer

protected TreeViewer contentOutlineViewer
This is the content outline page's viewer.

Generated:
This code was automatically generated.

propertySheetPage

protected PropertySheetPage propertySheetPage
This is the property sheet page.

Generated:
This code was automatically generated.

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:
This code was automatically generated.

parentViewer

protected TreeViewer parentViewer
This inverts the roll of parent and child in the content provider and show parents as a tree.

Generated:
This code was automatically generated.

treeViewer

protected TreeViewer treeViewer
This shows how a tree view works.

Generated:
This code was automatically generated.

listViewer

protected ListViewer listViewer
This shows how a list view works. A list viewer doesn't support icons.

Generated:
This code was automatically generated.

tableViewer

protected TableViewer tableViewer
This shows how a table view works. A table can be used as a list with icons.

Generated:
This code was automatically generated.

treeViewerWithColumns

protected TreeViewer treeViewerWithColumns
This shows how a tree view with columns works.

Generated:
This code was automatically generated.

currentViewerPane

protected ViewerPane currentViewerPane
This keeps track of the active viewer pane, in the book.

Generated:
This code was automatically generated.

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:
This code was automatically generated.

selectionChangedListener

protected ISelectionChangedListener selectionChangedListener
This listens to which ever viewer is active.

Generated:
This code was automatically generated.

selectionChangedListeners

protected Collection<ISelectionChangedListener> selectionChangedListeners
This keeps track of all the ISelectionChangedListeners that are listening to this editor.

Generated:
This code was automatically generated.

editorSelection

protected ISelection editorSelection
This keeps track of the selection of the editor as a whole.

Generated:
This code was automatically generated.

markerHelper

protected MarkerHelper markerHelper
The MarkerHelper is responsible for creating workspace resource markers presented in Eclipse's Problems View.

Generated:
This code was automatically generated.

partListener

protected IPartListener partListener
This listens for when the outline becomes active

Generated:
This code was automatically generated.

removedResources

protected Collection<Resource> removedResources
Resources that have been removed since last activation.

Generated:
This code was automatically generated.

changedResources

protected Collection<Resource> changedResources
Resources that have been changed since last activation.

Generated:
This code was automatically generated.

savedResources

protected Collection<Resource> savedResources
Resources that have been saved.

Generated:
This code was automatically generated.

resourceToDiagnosticMap

protected Map<Resource,Diagnostic> resourceToDiagnosticMap
Map to store the diagnostic associated with a resource.

Generated:
This code was automatically generated.

updateProblemIndication

protected boolean updateProblemIndication
Controls whether the problem indication should be updated.

Generated:
This code was automatically generated.

problemIndicationAdapter

protected EContentAdapter problemIndicationAdapter
Adapter used to update the problem indication when resources are demanded loaded.

Generated:
This code was automatically generated.

resourceChangeListener

protected IResourceChangeListener resourceChangeListener
This listens for workspace changes.

Generated:
This code was automatically generated.
Constructor Detail

SyncchartsEditor

public SyncchartsEditor()
This creates a model editor.

Generated:
This code was automatically generated.
Method Detail

handleActivate

protected void handleActivate()
Handles activation of the editor or it's associated views.

Generated:
This code was automatically generated.

handleChangedResources

protected void handleChangedResources()
Handles what to do with changed resources on activation.

Generated:
This code was automatically generated.

updateProblemIndication

protected void updateProblemIndication()
Updates the problems indication with the information described in the specified diagnostic.

Generated:
This code was automatically generated.

handleDirtyConflict

protected boolean handleDirtyConflict()
Shows a dialog that asks if conflicting changes should be discarded.

Generated:
This code was automatically generated.

initializeEditingDomain

protected void initializeEditingDomain()
This sets up the editing domain for the model editor.

Generated:
This code was automatically generated.

firePropertyChange

protected void firePropertyChange(int action)
This is here for the listener to be able to call it.

Overrides:
firePropertyChange in class WorkbenchPart
Generated:
This code was automatically generated.

setSelectionToViewer

public void setSelectionToViewer(Collection<?> collection)
This sets the selection into whichever viewer is active.

Generated:
This code was automatically generated.

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:
This code was automatically generated.

setCurrentViewerPane

public void setCurrentViewerPane(ViewerPane viewerPane)

Generated:
This code was automatically generated.

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:
This code was automatically generated.

getViewer

public Viewer getViewer()
This returns the viewer as required by the IViewerProvider interface.

Specified by:
getViewer in interface IViewerProvider
Generated:
This code was automatically generated.

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:
This code was automatically generated.

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:
This code was automatically generated.

analyzeResourceProblems

public Diagnostic analyzeResourceProblems(Resource resource,
                                          Exception exception)
Returns a diagnostic describing the errors and warnings listed in the resource and the specified exception (if any).

Generated:
This code was automatically generated.

createPages

public void createPages()
This is the method used by the framework to install your own controls.

Specified by:
createPages in class MultiPageEditorPart
Generated:
This code was automatically generated.

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:
This code was automatically generated.

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:
This code was automatically generated.

pageChange

protected void pageChange(int pageIndex)
This is used to track the active viewer.

Overrides:
pageChange in class MultiPageEditorPart
Generated:
This code was automatically generated.

getAdapter

public Object getAdapter(Class key)
This is how the framework determines which interfaces we implement.

Specified by:
getAdapter in interface IAdaptable
Overrides:
getAdapter in class MultiPageEditorPart
Generated:
This code was automatically generated.

getContentOutlinePage

public IContentOutlinePage getContentOutlinePage()
This accesses a cached version of the content outliner.

Generated:
This code was automatically generated.

getPropertySheetPage

public IPropertySheetPage getPropertySheetPage()
This accesses a cached version of the property sheet.

Generated:
This code was automatically generated.

handleContentOutlineSelection

public void handleContentOutlineSelection(ISelection selection)
This deals with how we want selection in the outliner to affect the other views.

Generated:
This code was automatically generated.

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:
This code was automatically generated.

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:
This code was automatically generated.

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:
This code was automatically generated.

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:
This code was automatically generated.

doSaveAs

public void doSaveAs()
This also changes the editor's input.

Specified by:
doSaveAs in interface ISaveablePart
Specified by:
doSaveAs in class EditorPart
Generated:
This code was automatically generated.

doSaveAs

protected void doSaveAs(URI uri,
                        IEditorInput editorInput)

Generated:
This code was automatically generated.

gotoMarker

public void gotoMarker(IMarker marker)

Specified by:
gotoMarker in interface IGotoMarker
Generated:
This code was automatically generated.

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:
This code was automatically generated.

setFocus

public void setFocus()

Specified by:
setFocus in interface IWorkbenchPart
Overrides:
setFocus in class MultiPageEditorPart
Generated:
This code was automatically generated.

addSelectionChangedListener

public void addSelectionChangedListener(ISelectionChangedListener listener)
This implements ISelectionProvider.

Specified by:
addSelectionChangedListener in interface ISelectionProvider
Generated:
This code was automatically generated.

removeSelectionChangedListener

public void removeSelectionChangedListener(ISelectionChangedListener listener)
This implements ISelectionProvider.

Specified by:
removeSelectionChangedListener in interface ISelectionProvider
Generated:
This code was automatically generated.

getSelection

public ISelection getSelection()
This implements ISelectionProvider to return this editor's overall selection.

Specified by:
getSelection in interface ISelectionProvider
Generated:
This code was automatically generated.

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:
This code was automatically generated.

setStatusLineManager

public void setStatusLineManager(ISelection selection)

Generated:
This code was automatically generated.

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:
This code was automatically generated.

getActionBarContributor

public EditingDomainActionBarContributor getActionBarContributor()

Generated:
This code was automatically generated.

getActionBars

public IActionBars getActionBars()

Generated:
This code was automatically generated.

getAdapterFactory

public AdapterFactory getAdapterFactory()

Generated:
This code was automatically generated.

dispose

public void dispose()

Specified by:
dispose in interface IWorkbenchPart
Overrides:
dispose in class MultiPageEditorPart
Generated:
This code was automatically generated.

showOutlineView

protected boolean showOutlineView()
Returns whether the outline view should be presented to the user.

Generated:
This code was automatically generated.