org.eclipse.emf.mapping.ecore2xml.presentation
Class Ecore2XMLActionBarContributor

java.lang.Object
  extended by org.eclipse.ui.part.EditorActionBarContributor
      extended by org.eclipse.ui.part.MultiPageEditorActionBarContributor
          extended by org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor
              extended by org.eclipse.emf.mapping.ecore2xml.presentation.Ecore2XMLActionBarContributor
All Implemented Interfaces:
IMenuListener, ISelectionChangedListener, IEditorActionBarContributor, IPropertyListener

public class Ecore2XMLActionBarContributor
extends EditingDomainActionBarContributor
implements ISelectionChangedListener

This is the action bar contributor for the Ecore2XML model editor.


Field Summary
protected  IEditorPart activeEditorPart
          This keeps track of the active editor
protected  java.util.Collection<IAction> createChildActions
          This will contain one CreateChildAction corresponding to each descriptor generated for the current selection by the item provider
protected  IMenuManager createChildMenuManager
          This is the menu manager into which menu contribution items should be added for CreateChild actions
protected  java.util.Collection<IAction> createSiblingActions
          This will contain one CreateSiblingAction corresponding to each descriptor generated for the current selection by the item provider
protected  IMenuManager createSiblingMenuManager
          This is the menu manager into which menu contribution items should be added for CreateSibling actions
protected  IAction refreshViewerAction
          This action refreshes the viewer of the current editor if the editor implements IViewerProvider
protected  ISelectionProvider selectionProvider
          This keeps track of the current selection provider
protected  IAction showPropertiesViewAction
          This action opens the Properties view
 
Fields inherited from class org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor
activeEditor, ADDITIONS_LAST_STYLE, controlAction, copyAction, cutAction, deleteAction, loadResourceAction, pasteAction, redoAction, style, undoAction, validateAction
 
Constructor Summary
Ecore2XMLActionBarContributor()
          This creates an instance of the contributor
 
Method Summary
protected  void addGlobalActions(IMenuManager menuManager)
          This inserts global actions before the "additions-end" separator
 void contributeToMenu(IMenuManager menuManager)
          This adds to the menu bar a menu and some separators for editor additions, as well as the sub-menus for object creation items
 void contributeToToolBar(IToolBarManager toolBarManager)
          This adds Separators for editor additions to the tool bar
protected  void depopulateManager(IContributionManager manager, java.util.Collection<? extends IAction> actions)
          This removes from the specified manager all ActionContributionItems based on the IActions contained in the actions collection
protected  java.util.Collection<IAction> generateCreateChildActions(java.util.Collection<?> descriptors, ISelection selection)
          This generates a CreateChildAction for each object in descriptors, and returns the collection of these actions
protected  java.util.Collection<IAction> generateCreateSiblingActions(java.util.Collection<?> descriptors, ISelection selection)
          This generates a CreateSiblingAction for each object in descriptors, and returns the collection of these actions
 void menuAboutToShow(IMenuManager menuManager)
          This populates the pop-up menu before it appears
protected  void populateManager(IContributionManager manager, java.util.Collection<? extends IAction> actions, java.lang.String contributionID)
          This populates the specified manager with ActionContributionItems based on the IActions contained in the actions collection, by inserting them before the specified contribution item contributionID.
protected  boolean removeAllReferencesOnDelete()
          This ensures that a delete action will clean up all references to deleted objects
 void selectionChanged(SelectionChangedEvent event)
          This implements ISelectionChangedListener, handling SelectionChangedEvents by querying for the children and siblings that can be added to the selected object and updating the menus accordingly
 void setActiveEditor(IEditorPart part)
          When the active editor changes, this remembers the change and registers with it as a selection provider
 
Methods inherited from class org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor
activate, contributeToStatusLine, createCopyAction, createCutAction, createDeleteAction, createPasteAction, createRedoAction, createUndoAction, deactivate, getActiveEditor, init, propertyChanged, setActivePage, setActiveView, shareGlobalActions, update
 
Methods inherited from class org.eclipse.ui.part.EditorActionBarContributor
contributeToCoolBar, dispose, getActionBars, getPage, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

activeEditorPart

protected IEditorPart activeEditorPart
This keeps track of the active editor.


selectionProvider

protected ISelectionProvider selectionProvider
This keeps track of the current selection provider.


showPropertiesViewAction

protected IAction showPropertiesViewAction
This action opens the Properties view.


refreshViewerAction

protected IAction refreshViewerAction
This action refreshes the viewer of the current editor if the editor implements IViewerProvider.


createChildActions

protected java.util.Collection<IAction> createChildActions
This will contain one CreateChildAction corresponding to each descriptor generated for the current selection by the item provider.


createChildMenuManager

protected IMenuManager createChildMenuManager
This is the menu manager into which menu contribution items should be added for CreateChild actions.


createSiblingActions

protected java.util.Collection<IAction> createSiblingActions
This will contain one CreateSiblingAction corresponding to each descriptor generated for the current selection by the item provider.


createSiblingMenuManager

protected IMenuManager createSiblingMenuManager
This is the menu manager into which menu contribution items should be added for CreateSibling actions.

Constructor Detail

Ecore2XMLActionBarContributor

public Ecore2XMLActionBarContributor()
This creates an instance of the contributor.

Method Detail

contributeToToolBar

public void contributeToToolBar(IToolBarManager toolBarManager)
This adds Separators for editor additions to the tool bar.

Overrides:
contributeToToolBar in class EditingDomainActionBarContributor

contributeToMenu

public void contributeToMenu(IMenuManager menuManager)
This adds to the menu bar a menu and some separators for editor additions, as well as the sub-menus for object creation items.

Overrides:
contributeToMenu in class EditingDomainActionBarContributor

setActiveEditor

public void setActiveEditor(IEditorPart part)
When the active editor changes, this remembers the change and registers with it as a selection provider.

Specified by:
setActiveEditor in interface IEditorActionBarContributor
Overrides:
setActiveEditor in class EditingDomainActionBarContributor

selectionChanged

public void selectionChanged(SelectionChangedEvent event)
This implements ISelectionChangedListener, handling SelectionChangedEvents by querying for the children and siblings that can be added to the selected object and updating the menus accordingly.

Specified by:
selectionChanged in interface ISelectionChangedListener

generateCreateChildActions

protected java.util.Collection<IAction> generateCreateChildActions(java.util.Collection<?> descriptors,
                                                                   ISelection selection)
This generates a CreateChildAction for each object in descriptors, and returns the collection of these actions.


generateCreateSiblingActions

protected java.util.Collection<IAction> generateCreateSiblingActions(java.util.Collection<?> descriptors,
                                                                     ISelection selection)
This generates a CreateSiblingAction for each object in descriptors, and returns the collection of these actions.


populateManager

protected void populateManager(IContributionManager manager,
                               java.util.Collection<? extends IAction> actions,
                               java.lang.String contributionID)
This populates the specified manager with ActionContributionItems based on the IActions contained in the actions collection, by inserting them before the specified contribution item contributionID. If contributionID is null, they are simply added.


depopulateManager

protected void depopulateManager(IContributionManager manager,
                                 java.util.Collection<? extends IAction> actions)
This removes from the specified manager all ActionContributionItems based on the IActions contained in the actions collection.


menuAboutToShow

public void menuAboutToShow(IMenuManager menuManager)
This populates the pop-up menu before it appears.

Specified by:
menuAboutToShow in interface IMenuListener
Overrides:
menuAboutToShow in class EditingDomainActionBarContributor

addGlobalActions

protected void addGlobalActions(IMenuManager menuManager)
This inserts global actions before the "additions-end" separator.

Overrides:
addGlobalActions in class EditingDomainActionBarContributor

removeAllReferencesOnDelete

protected boolean removeAllReferencesOnDelete()
This ensures that a delete action will clean up all references to deleted objects.

Overrides:
removeAllReferencesOnDelete in class EditingDomainActionBarContributor

Copyright 2001-2006 IBM Corporation and others.
All Rights Reserved.