$search

org::best_of_robotics::model::datatypes::presentation::DatatypesEditor Class Reference

Inheritance diagram for org::best_of_robotics::model::datatypes::presentation::DatatypesEditor:
Inheritance graph
[legend]

List of all members.

Classes

class  ReverseAdapterFactoryContentProvider

Public Member Functions

void addSelectionChangedListener (ISelectionChangedListener listener)
Diagnostic analyzeResourceProblems (Resource resource, Exception exception)
void createModel ()
void createPages ()
 DatatypesEditor ()
void dispose ()
void doSave (IProgressMonitor progressMonitor)
void doSaveAs ()
EditingDomainActionBarContributor getActionBarContributor ()
IActionBars getActionBars ()
Object getAdapter (Class key)
AdapterFactory getAdapterFactory ()
IContentOutlinePage getContentOutlinePage ()
EditingDomain getEditingDomain ()
IPropertySheetPage getPropertySheetPage ()
ISelection getSelection ()
Viewer getViewer ()
void gotoMarker (IMarker marker)
void handleContentOutlineSelection (ISelection selection)
void init (IEditorSite site, IEditorInput editorInput)
boolean isDirty ()
boolean isSaveAsAllowed ()
void menuAboutToShow (IMenuManager menuManager)
void removeSelectionChangedListener (ISelectionChangedListener listener)
void setCurrentViewer (Viewer viewer)
void setFocus ()
void setSelection (ISelection selection)
void setSelectionToViewer (Collection<?> collection)
void setStatusLineManager (ISelection selection)

Protected Member Functions

void createContextMenuFor (StructuredViewer viewer)
void doSaveAs (URI uri, IEditorInput editorInput)
void firePropertyChange (int action)
void handleActivate ()
void handleChangedResources ()
boolean handleDirtyConflict ()
void hideTabs ()
void initializeEditingDomain ()
boolean isPersisted (Resource resource)
void pageChange (int pageIndex)
boolean showOutlineView ()
void showTabs ()
void updateProblemIndication ()

Protected Attributes

ComposedAdapterFactory adapterFactory
Collection< Resource > changedResources = new ArrayList<Resource>()
IContentOutlinePage contentOutlinePage
IStatusLineManager contentOutlineStatusLineManager
TreeViewer contentOutlineViewer
Viewer currentViewer
AdapterFactoryEditingDomain editingDomain
ISelection editorSelection = StructuredSelection.EMPTY
MarkerHelper markerHelper = new EditUIMarkerHelper()
IPartListener partListener
EContentAdapter problemIndicationAdapter
PropertySheetPage propertySheetPage
Collection< Resource > removedResources = new ArrayList<Resource>()
IResourceChangeListener resourceChangeListener
Map< Resource, Diagnostic > resourceToDiagnosticMap = new LinkedHashMap<Resource, Diagnostic>()
Collection< Resource > savedResources = new ArrayList<Resource>()
ISelectionChangedListener selectionChangedListener
Collection
< ISelectionChangedListener > 
selectionChangedListeners = new ArrayList<ISelectionChangedListener>()
TreeViewer selectionViewer
boolean updateProblemIndication = true

Static Private Member Functions

static String getString (String key, Object s1)
static String getString (String key)

Detailed Description

This is an example of a Datatypes model editor.

Definition at line 161 of file DatatypesEditor.java.


Constructor & Destructor Documentation

org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::DatatypesEditor (  )  [inline]

This creates a model editor.

Definition at line 620 of file DatatypesEditor.java.


Member Function Documentation

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::addSelectionChangedListener ( ISelectionChangedListener  listener  )  [inline]

This implements org.eclipse.jface.viewers.ISelectionProvider.

Definition at line 1370 of file DatatypesEditor.java.

Diagnostic org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::analyzeResourceProblems ( Resource  resource,
Exception  exception 
) [inline]

Returns a diagnostic describing the errors and warnings listed in the resource and the specified exception (if any).

Definition at line 891 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::createContextMenuFor ( StructuredViewer  viewer  )  [inline, protected]

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

Definition at line 842 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::createModel (  )  [inline]

This is the method called to load a resource into the editing domain's resource set based on the editor's input.

Definition at line 863 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::createPages (  )  [inline]

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

Definition at line 924 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::dispose (  )  [inline]

Definition at line 1507 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::doSave ( IProgressMonitor  progressMonitor  )  [inline]

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

Definition at line 1192 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::doSaveAs ( URI  uri,
IEditorInput  editorInput 
) [inline, protected]

Definition at line 1304 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::doSaveAs (  )  [inline]

This also changes the editor's input.

Definition at line 1287 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::firePropertyChange ( int  action  )  [inline, protected]

This is here for the listener to be able to call it.

Definition at line 680 of file DatatypesEditor.java.

EditingDomainActionBarContributor org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getActionBarContributor (  )  [inline]

Definition at line 1479 of file DatatypesEditor.java.

IActionBars org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getActionBars (  )  [inline]

Definition at line 1488 of file DatatypesEditor.java.

Object org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getAdapter ( Class  key  )  [inline]

This is how the framework determines which interfaces we implement.

Definition at line 1040 of file DatatypesEditor.java.

AdapterFactory org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getAdapterFactory (  )  [inline]

Definition at line 1497 of file DatatypesEditor.java.

IContentOutlinePage org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getContentOutlinePage (  )  [inline]

This accesses a cached version of the content outliner.

Definition at line 1061 of file DatatypesEditor.java.

EditingDomain org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getEditingDomain (  )  [inline]

This returns the editing domain as required by the IEditingDomainProvider interface. This is important for implementing the static methods of AdapterFactoryEditingDomain and for supporting org.eclipse.emf.edit.ui.action.CommandAction.

Definition at line 717 of file DatatypesEditor.java.

IPropertySheetPage org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getPropertySheetPage (  )  [inline]

This accesses a cached version of the property sheet.

Definition at line 1125 of file DatatypesEditor.java.

ISelection org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getSelection (  )  [inline]

This implements org.eclipse.jface.viewers.ISelectionProvider to return this editor's overall selection.

Definition at line 1390 of file DatatypesEditor.java.

static String org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getString ( String  key,
Object  s1 
) [inline, static, private]

This looks up a string in plugin.properties, making a substitution.

Definition at line 1460 of file DatatypesEditor.java.

static String org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getString ( String  key  )  [inline, static, private]

This looks up a string in the plugin's plugin.properties file.

Definition at line 1450 of file DatatypesEditor.java.

Viewer org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::getViewer (  )  [inline]

This returns the viewer as required by the IViewerProvider interface.

Definition at line 832 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::gotoMarker ( IMarker  marker  )  [inline]

Definition at line 1320 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::handleActivate (  )  [inline, protected]

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

Definition at line 477 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::handleChangedResources (  )  [inline, protected]

Handles what to do with changed resources on activation.

Definition at line 512 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::handleContentOutlineSelection ( ISelection  selection  )  [inline]

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

Definition at line 1153 of file DatatypesEditor.java.

boolean org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::handleDirtyConflict (  )  [inline, protected]

Shows a dialog that asks if conflicting changes should be discarded.

Definition at line 606 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::hideTabs (  )  [inline, protected]

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

Definition at line 988 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::init ( IEditorSite  site,
IEditorInput  editorInput 
) [inline]

This is called during startup.

Definition at line 1345 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::initializeEditingDomain (  )  [inline, protected]

This sets up the editing domain for the model editor.

Definition at line 631 of file DatatypesEditor.java.

boolean org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::isDirty (  )  [inline]

This is for implementing IEditorPart and simply tests the command stack.

Definition at line 1181 of file DatatypesEditor.java.

boolean org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::isPersisted ( Resource  resource  )  [inline, protected]

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.

Definition at line 1254 of file DatatypesEditor.java.

boolean org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::isSaveAsAllowed (  )  [inline]

This always returns true because it is not currently supported.

Definition at line 1276 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::menuAboutToShow ( IMenuManager  menuManager  )  [inline]

This implements org.eclipse.jface.action.IMenuListener to help fill the context menus with contributions from the Edit menu.

Definition at line 1470 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::pageChange ( int  pageIndex  )  [inline, protected]

This is used to track the active viewer.

Definition at line 1024 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::removeSelectionChangedListener ( ISelectionChangedListener  listener  )  [inline]

This implements org.eclipse.jface.viewers.ISelectionProvider.

Definition at line 1380 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::setCurrentViewer ( Viewer  viewer  )  [inline]

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

Definition at line 787 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::setFocus (  )  [inline]

Definition at line 1360 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::setSelection ( ISelection  selection  )  [inline]

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

Definition at line 1401 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::setSelectionToViewer ( Collection<?>  collection  )  [inline]

This sets the selection into whichever viewer is active.

Definition at line 690 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::setStatusLineManager ( ISelection  selection  )  [inline]

Definition at line 1415 of file DatatypesEditor.java.

boolean org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::showOutlineView (  )  [inline, protected]

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

Definition at line 1537 of file DatatypesEditor.java.

void org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::showTabs (  )  [inline, protected]

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

Definition at line 1006 of file DatatypesEditor.java.

Updates the problems indication with the information described in the specified diagnostic.

Definition at line 549 of file DatatypesEditor.java.


Member Data Documentation

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

Definition at line 178 of file DatatypesEditor.java.

Collection<Resource> org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::changedResources = new ArrayList<Resource>() [protected]

Resources that have been changed since last activation.

Definition at line 316 of file DatatypesEditor.java.

This is the content outline page.

Definition at line 186 of file DatatypesEditor.java.

This is a kludge...

Definition at line 194 of file DatatypesEditor.java.

This is the content outline page's viewer.

Definition at line 202 of file DatatypesEditor.java.

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

Definition at line 227 of file DatatypesEditor.java.

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

Definition at line 170 of file DatatypesEditor.java.

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

Definition at line 251 of file DatatypesEditor.java.

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

Definition at line 260 of file DatatypesEditor.java.

This listens for when the outline becomes active

Definition at line 268 of file DatatypesEditor.java.

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

Definition at line 348 of file DatatypesEditor.java.

This is the property sheet page.

Definition at line 210 of file DatatypesEditor.java.

Collection<Resource> org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::removedResources = new ArrayList<Resource>() [protected]

Resources that have been removed since last activation.

Definition at line 308 of file DatatypesEditor.java.

This listens for workspace changes.

Definition at line 400 of file DatatypesEditor.java.

Map<Resource, Diagnostic> org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::resourceToDiagnosticMap = new LinkedHashMap<Resource, Diagnostic>() [protected]

Map to store the diagnostic associated with a resource.

Definition at line 332 of file DatatypesEditor.java.

Collection<Resource> org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::savedResources = new ArrayList<Resource>() [protected]

Resources that have been saved.

Definition at line 324 of file DatatypesEditor.java.

This listens to which ever viewer is active.

Definition at line 235 of file DatatypesEditor.java.

Collection<ISelectionChangedListener> org::best_of_robotics::model::datatypes::presentation::DatatypesEditor::selectionChangedListeners = new ArrayList<ISelectionChangedListener>() [protected]

This keeps track of all the org.eclipse.jface.viewers.ISelectionChangedListeners that are listening to this editor.

Definition at line 243 of file DatatypesEditor.java.

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

Definition at line 219 of file DatatypesEditor.java.

Controls whether the problem indication should be updated.

Definition at line 340 of file DatatypesEditor.java.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends


bride_plugin_source
Author(s): Alexander Bubeck
autogenerated on Tue Mar 5 11:39:51 2013