Package placementDescription.presentation

Class PlacementDescriptionEditor

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.EditorPart
org.eclipse.ui.part.MultiPageEditorPart
placementDescription.presentation.PlacementDescriptionEditor
All Implemented Interfaces:
IAdaptable, IExecutableExtension, IViewerProvider, IEditingDomainProvider, IMenuListener, IPageChangeProvider, ISelectionProvider, IGotoMarker, IEditorPart, ISaveablePart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation
public class PlacementDescriptionEditor extends MultiPageEditorPart implements IEditingDomainProvider, ISelectionProvider, IMenuListener, IViewerProvider, IGotoMarker
This is an example of a PlacementDescription model editor.
Generated class or method.

  • Field Details

    • 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 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.

    • parentViewer

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

    • treeViewer

      protected TreeViewer treeViewer
      This shows how a tree view works.
      Generated class or method.

    • listViewer

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

    • tableViewer

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

    • treeViewerWithColumns

      protected TreeViewer treeViewerWithColumns
      This shows how a tree view with columns works.
      Generated class or method.

    • currentViewerPane

      protected ViewerPane currentViewerPane
      This keeps track of the active viewer pane, in the book.
      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 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 Collection<Resource> removedResources
      Resources that have been removed since last activation.
      Generated class or method.

    • changedResources

      protected Collection<Resource> changedResources
      Resources that have been changed since last activation.
      Generated class or method.

    • savedResources

      protected Collection<Resource> savedResources
      Resources that have been saved.
      Generated class or method.

    • resourceToDiagnosticMap

      protected 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 Details

    • PlacementDescriptionEditor

      public PlacementDescriptionEditor()
      This creates a model editor.
      Generated class or method.

  • Method Details

    • 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(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.

    • setCurrentViewerPane

      public void setCurrentViewerPane(ViewerPane viewerPane)
      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, 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(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.

    • 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.