org.eclipse.sphinx.emf.edit

Class ExtendedItemProviderAdapter

java.lang.Object

org.eclipse.emf.common.notify.impl.AdapterImpl

org.eclipse.emf.edit.provider.ItemProviderAdapter

org.eclipse.sphinx.emf.edit.ExtendedItemProviderAdapter

All Implemented Interfaces:

org.eclipse.emf.common.notify.Adapter, org.eclipse.emf.common.notify.Adapter.Internal, org.eclipse.emf.common.util.ResourceLocator, org.eclipse.emf.edit.command.CreateChildCommand.Helper, org.eclipse.emf.edit.provider.IChangeNotifier, org.eclipse.emf.edit.provider.IDisposable

Direct Known Subclasses:

TransientItemProvider

public class ExtendedItemProviderAdapter
extends org.eclipse.emf.edit.provider.ItemProviderAdapter

Extension of the default item provider adapter implementation provided by EMF Edit.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.emf.edit.provider.ItemProviderAdapter

org.eclipse.emf.edit.provider.ItemProviderAdapter.ChildrenStore, org.eclipse.emf.edit.provider.ItemProviderAdapter.ModifiableSingletonEList<E>, org.eclipse.emf.edit.provider.ItemProviderAdapter.ResultAndAffectedObjectsWrappingCommand, org.eclipse.emf.edit.provider.ItemProviderAdapter.ResultAndAffectedObjectsWrappingCommandActionDelegate

Nested classes/interfaces inherited from interface org.eclipse.emf.common.notify.Adapter

org.eclipse.emf.common.notify.Adapter.Internal

Field Summary

Fields inherited from class org.eclipse.emf.edit.provider.ItemProviderAdapter

adapterFactory, changeNotifier, childrenFeatures, childrenReferences, childrenStoreMap, itemPropertyDescriptors, targets, wrappers, wrappingNeeded

Fields inherited from class org.eclipse.emf.common.notify.impl.AdapterImpl

target

Constructor Summary

Constructors

Constructor and Description
ExtendedItemProviderAdapter(org.eclipse.emf.common.notify.AdapterFactory adapterFactory) An instance is created from an adapter factory.

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.emf.common.command.Command	createAddCommand(org.eclipse.emf.edit.domain.EditingDomain domain, org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EStructuralFeature feature, java.util.Collection<?> collection, int index)
protected org.eclipse.emf.common.command.Command	createCreateChildCommand(org.eclipse.emf.edit.domain.EditingDomain domain, org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EStructuralFeature feature, java.lang.Object value, int index, java.util.Collection<?> collection)
protected org.eclipse.emf.edit.provider.ItemPropertyDescriptor	createItemPropertyDescriptor(org.eclipse.emf.common.notify.AdapterFactory adapterFactory, org.eclipse.emf.common.util.ResourceLocator resourceLocator, java.lang.String displayName, java.lang.String description, org.eclipse.emf.ecore.EStructuralFeature feature, boolean isSettable, boolean multiLine, boolean sortChoices, java.lang.Object staticImage, java.lang.String category, java.lang.String[] filterFlags)
protected org.eclipse.emf.common.command.Command	createRemoveCommand(org.eclipse.emf.edit.domain.EditingDomain domain, org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EStructuralFeature feature, java.util.Collection<?> collection)
protected org.eclipse.emf.common.command.Command	createSetCommand(org.eclipse.emf.edit.domain.EditingDomain domain, org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EStructuralFeature feature, java.lang.Object value, int index)
protected ITreeItemAncestorProvider	createTreeItemContentProviderHelper()
protected java.lang.Object	createWrapper(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.ecore.EStructuralFeature feature, java.lang.Object value, int index)
protected org.eclipse.emf.common.command.Command	factorAddCommand(org.eclipse.emf.edit.domain.EditingDomain domain, org.eclipse.emf.edit.command.CommandParameter commandParameter)
protected org.eclipse.emf.common.command.Command	factorRemoveCommand(org.eclipse.emf.edit.domain.EditingDomain domain, org.eclipse.emf.edit.command.CommandParameter commandParameter)
java.lang.Object	findAncestor(java.lang.Object object, java.lang.Class<?> ancestorType, boolean unwrap)
java.util.List<java.lang.Object>	getAncestorPath(java.lang.Object object, boolean unwrap)
java.util.List<java.lang.Object>	getAncestorPath(java.lang.Object beginObject, java.lang.Class<?> endType, boolean unwrap)
java.util.Collection<?>	getChoiceOfValues(java.lang.Object object, org.eclipse.emf.ecore.EReference[] parentReferences, org.eclipse.emf.ecore.EStructuralFeature feature)
java.lang.Object	getCreateChildImage(java.lang.Object owner, java.lang.Object feature, java.lang.Object child, java.util.Collection<?> selection)
java.lang.String	getCreateChildText(java.lang.Object owner, java.lang.Object feature, java.lang.Object child, java.util.Collection<?> selection)
java.lang.String	getCreateChildText(java.lang.Object owner, java.lang.Object feature, java.lang.Object child, java.util.Collection<?> selection, boolean qualified) Returns the text to be used as label or text of CreateChildCommand or ExtendedCreateChildCommand.
protected EcoreTraversalHelper	getTraversalHelper() Returns the right traversal helper this item provider must use.
protected ITreeItemAncestorProvider	getTreeItemContentProviderHelper()
protected boolean	isWrappingNeeded(java.lang.Object object)
protected java.lang.Object	overlayImage(java.lang.Object object, java.lang.Object image)

Methods inherited from class org.eclipse.emf.edit.provider.ItemProviderAdapter

addListener, adjustWrapperIndex, adjustWrapperIndices, adjustWrapperIndices, collectNewChildDescriptors, createAddCommand, createChildParameter, createChildrenStore, createCommand, createCopyCommand, createCreateChildCommand, createCreateCopyCommand, createDragAndDropCommand, createDragAndDropCommand, createInitializeCopyCommand, createItemPropertyDescriptor, createMoveCommand, createMoveCommand, createRemoveCommand, createReplaceCommand, createReplaceCommand, createReplaceCommand, createSetCommand, crop, dispose, disposeWrapper, disposeWrappers, factorMoveCommand, fireNotifyChanged, getAdapterFactory, getBackground, getBackground, getBaseURL, getChildFeature, getChildReference, getChildren, getChildrenFeatures, getChildrenReferences, getChildrenStore, getColumnImage, getColumnText, getCreateChildDescription, getCreateChildResult, getCreateChildToolTipText, getEditableValue, getElements, getFeatureText, getFeatureValue, getFont, getFont, getForeground, getForeground, getImage, getImage, getNewChildDescriptors, getParent, getPropertyDescriptor, getPropertyDescriptors, getPropertyValue, getReferenceValue, getResourceLocator, getResourceLocator, getRootAdapterFactory, getSetFeature, getSetFeatures, getString, getString, getString, getString, getString, getString, getString, getString, getStyledText, getText, getTypeText, getTypeText, getUpdateableText, getValue, getWrappedValues, hasChildren, hasChildren, isAdapterForType, isEquivalentValue, isPropertySet, isResolveProxies, isValidValue, removeListener, resetPropertyValue, setPropertyValue, setTarget, shouldComposeCreationImage, shouldTranslate, unsetTarget, unwrap, unwrapCommandValues, updateChildren, wrap, wrapCommand

Methods inherited from class org.eclipse.emf.common.notify.impl.AdapterImpl

getTarget, notifyChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtendedItemProviderAdapter

public ExtendedItemProviderAdapter(org.eclipse.emf.common.notify.AdapterFactory adapterFactory)

An instance is created from an adapter factory. The factory is used as a key so that we always know which factory created this adapter.

Parameters:

adapterFactory - The factory which created the Adapter.

Method Detail

getTreeItemContentProviderHelper

protected ITreeItemAncestorProvider getTreeItemContentProviderHelper()

createTreeItemContentProviderHelper

protected ITreeItemAncestorProvider createTreeItemContentProviderHelper()

getAncestorPath

public java.util.List<java.lang.Object> getAncestorPath(java.lang.Object object,
                                                        boolean unwrap)

getAncestorPath

public java.util.List<java.lang.Object> getAncestorPath(java.lang.Object beginObject,
                                                        java.lang.Class<?> endType,
                                                        boolean unwrap)

findAncestor

public java.lang.Object findAncestor(java.lang.Object object,
                                     java.lang.Class<?> ancestorType,
                                     boolean unwrap)

isWrappingNeeded

protected boolean isWrappingNeeded(java.lang.Object object)

Overrides:

isWrappingNeeded in class org.eclipse.emf.edit.provider.ItemProviderAdapter

createWrapper

protected java.lang.Object createWrapper(org.eclipse.emf.ecore.EObject object,
                                         org.eclipse.emf.ecore.EStructuralFeature feature,
                                         java.lang.Object value,
                                         int index)

Overrides:

createWrapper in class org.eclipse.emf.edit.provider.ItemProviderAdapter

createItemPropertyDescriptor

protected org.eclipse.emf.edit.provider.ItemPropertyDescriptor createItemPropertyDescriptor(org.eclipse.emf.common.notify.AdapterFactory adapterFactory,
                                                                                            org.eclipse.emf.common.util.ResourceLocator resourceLocator,
                                                                                            java.lang.String displayName,
                                                                                            java.lang.String description,
                                                                                            org.eclipse.emf.ecore.EStructuralFeature feature,
                                                                                            boolean isSettable,
                                                                                            boolean multiLine,
                                                                                            boolean sortChoices,
                                                                                            java.lang.Object staticImage,
                                                                                            java.lang.String category,
                                                                                            java.lang.String[] filterFlags)

Overrides:

createItemPropertyDescriptor in class org.eclipse.emf.edit.provider.ItemProviderAdapter

getChoiceOfValues

public java.util.Collection<?> getChoiceOfValues(java.lang.Object object,
                                                 org.eclipse.emf.ecore.EReference[] parentReferences,
                                                 org.eclipse.emf.ecore.EStructuralFeature feature)

getTraversalHelper

protected EcoreTraversalHelper getTraversalHelper()

Returns the right traversal helper this item provider must use.

Returns:

The traversal helper

Since:

0.7.0

factorRemoveCommand

protected org.eclipse.emf.common.command.Command factorRemoveCommand(org.eclipse.emf.edit.domain.EditingDomain domain,
                                                                     org.eclipse.emf.edit.command.CommandParameter commandParameter)

Overrides:

factorRemoveCommand in class org.eclipse.emf.edit.provider.ItemProviderAdapter

factorAddCommand

protected org.eclipse.emf.common.command.Command factorAddCommand(org.eclipse.emf.edit.domain.EditingDomain domain,
                                                                  org.eclipse.emf.edit.command.CommandParameter commandParameter)

Overrides:

factorAddCommand in class org.eclipse.emf.edit.provider.ItemProviderAdapter

createSetCommand

protected org.eclipse.emf.common.command.Command createSetCommand(org.eclipse.emf.edit.domain.EditingDomain domain,
                                                                  org.eclipse.emf.ecore.EObject owner,
                                                                  org.eclipse.emf.ecore.EStructuralFeature feature,
                                                                  java.lang.Object value,
                                                                  int index)

Overrides:

createSetCommand in class org.eclipse.emf.edit.provider.ItemProviderAdapter

createAddCommand

protected org.eclipse.emf.common.command.Command createAddCommand(org.eclipse.emf.edit.domain.EditingDomain domain,
                                                                  org.eclipse.emf.ecore.EObject owner,
                                                                  org.eclipse.emf.ecore.EStructuralFeature feature,
                                                                  java.util.Collection<?> collection,
                                                                  int index)

Overrides:

createAddCommand in class org.eclipse.emf.edit.provider.ItemProviderAdapter

createRemoveCommand

protected org.eclipse.emf.common.command.Command createRemoveCommand(org.eclipse.emf.edit.domain.EditingDomain domain,
                                                                     org.eclipse.emf.ecore.EObject owner,
                                                                     org.eclipse.emf.ecore.EStructuralFeature feature,
                                                                     java.util.Collection<?> collection)

Overrides:

createRemoveCommand in class org.eclipse.emf.edit.provider.ItemProviderAdapter

getCreateChildText

public java.lang.String getCreateChildText(java.lang.Object owner,
                                           java.lang.Object feature,
                                           java.lang.Object child,
                                           java.util.Collection<?> selection)

Specified by:

getCreateChildText in interface org.eclipse.emf.edit.command.CreateChildCommand.Helper

Overrides:

getCreateChildText in class org.eclipse.emf.edit.provider.ItemProviderAdapter

getCreateChildText

public java.lang.String getCreateChildText(java.lang.Object owner,
                                           java.lang.Object feature,
                                           java.lang.Object child,
                                           java.util.Collection<?> selection,
                                           boolean qualified)

Returns the text to be used as label or text of CreateChildCommand or ExtendedCreateChildCommand. Enables the create child text to be retrieved in qualified form provided that the underlying metamodel's EMF Edit implementation includes supports for that (requires the metamodel's EMF Edit implementation to be generated with generator model option "Editor > Creation Sub-menus" set to true). Qualified create child texts are expected to consist of two segments separated by a vertical bar. The leading segment typically corresponds to the name of feature on the owner object that holds the child object and the trailing segment to the type of the child object to be created. They are leveraged by org.eclipse.sphinx.emf.ui.actions.providers.BasicActionProvider#extractSubmenuActions(Collection, ISelection) and org.eclipse.sphinx.emf.editors.forms.BasicTransactionalEditorActionBarContributor#extractSubmenuActions (Collection, ISelection) so as to group the corresponding create child actions in submenus according to the qualified create child texts' leading segments.

Qualified create child texts are requested by ExtendedCreateChildCommand.getText() and returned to CreateChildAction#configureAction(ISelection) so as to make their action texts qualified and prepare them for being grouped in creation submenus. Simple create child action texts are requested by CreateChildCommand.CreateChildCommand(EditingDomain, EObject, EStructuralFeature, Object, int, Collection<?>, Helper) and used to initialize the command label by which the command is displayed in any location outside the creation menus or submenus (e.g., undo and redo menus).

Parameters:

owner - The owner object to which the new child object will be added.

feature - The feature of the owner object that is going to hold the new child object.

child - The new, i.e., still unassigned child object that will be added to the owner object.

qualified - true if a qualified create child text should be returned for metamodels whose EMF Edit implementation support that, false otherwise.

Returns:

The qualified or simple text to be used as label or text of CreateChildCommand or ExtendedCreateChildCommand.

getCreateChildImage

public java.lang.Object getCreateChildImage(java.lang.Object owner,
                                            java.lang.Object feature,
                                            java.lang.Object child,
                                            java.util.Collection<?> selection)

Specified by:

getCreateChildImage in interface org.eclipse.emf.edit.command.CreateChildCommand.Helper

Overrides:

getCreateChildImage in class org.eclipse.emf.edit.provider.ItemProviderAdapter

createCreateChildCommand

protected org.eclipse.emf.common.command.Command createCreateChildCommand(org.eclipse.emf.edit.domain.EditingDomain domain,
                                                                          org.eclipse.emf.ecore.EObject owner,
                                                                          org.eclipse.emf.ecore.EStructuralFeature feature,
                                                                          java.lang.Object value,
                                                                          int index,
                                                                          java.util.Collection<?> collection)

Overrides:

createCreateChildCommand in class org.eclipse.emf.edit.provider.ItemProviderAdapter

overlayImage

protected java.lang.Object overlayImage(java.lang.Object object,
                                        java.lang.Object image)

Overrides:

overlayImage in class org.eclipse.emf.edit.provider.ItemProviderAdapter