org.eclipse.emf.edit.provider.resource
Class ResourceItemProvider

java.lang.Object
  extended by org.eclipse.emf.common.notify.impl.AdapterImpl
      extended by org.eclipse.emf.edit.provider.ItemProviderAdapter
          extended by org.eclipse.emf.edit.provider.resource.ResourceItemProvider
All Implemented Interfaces:
Adapter, Adapter.Internal, ResourceLocator, CreateChildCommand.Helper, IChangeNotifier, IDisposable, IEditingDomainItemProvider, IItemLabelProvider, IItemPropertySource, IStructuredItemContentProvider, ITreeItemContentProvider

public class ResourceItemProvider
extends ItemProviderAdapter
implements IEditingDomainItemProvider, IStructuredItemContentProvider, ITreeItemContentProvider, IItemLabelProvider, IItemPropertySource

This is the item provider adapter for a Resource object.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.emf.edit.provider.ItemProviderAdapter
ItemProviderAdapter.ChildrenStore, ItemProviderAdapter.ModifiableSingletonEList<E>, ItemProviderAdapter.ResultAndAffectedObjectsWrappingCommand, ItemProviderAdapter.ResultAndAffectedObjectsWrappingCommandActionDelegate
 
Nested classes/interfaces inherited from interface org.eclipse.emf.common.notify.Adapter
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
ResourceItemProvider(AdapterFactory adapterFactory)
          This constructs an instance from a factory and a notifier.
 
Method Summary
protected  void collectNewChildDescriptors(java.util.Collection<java.lang.Object> newChildDescriptors, java.lang.Object object)
          This adds CommandParameters describing the children that can be created under this object.
 java.util.Collection<?> getChildren(java.lang.Object object)
          This implements ITreeItemContentProvider.getChildren.
 java.util.Collection<? extends EStructuralFeature> getChildrenFeatures(java.lang.Object object)
          This specifies how to implement getChildren(java.lang.Object) and is used to deduce an appropriate feature for an AddCommand, RemoveCommand or MoveCommand in createCommand.
 java.lang.Object getImage(java.lang.Object object)
          This returns Resource.gif.
 java.util.Collection<?> getNewChildDescriptors(java.lang.Object object, EditingDomain editingDomain, java.lang.Object sibling)
          This implements IEditingDomainItemProvider.getNewChildDescriptors, returning descriptors for all the possible children that can be added to the specified object.
 java.lang.Object getParent(java.lang.Object object)
          This returns the parent of the Resource.
 java.util.List<IItemPropertyDescriptor> getPropertyDescriptors(java.lang.Object object)
          This returns the property descriptors for the adapted class.
 ResourceLocator getResourceLocator()
          Return the resource locator for this item provider's resources.
 java.lang.String getText(java.lang.Object object)
          This returns the label text for the adapted class.
 void notifyChanged(Notification notification)
          This handles notification by calling fireNotifyChanged.
 
Methods inherited from class org.eclipse.emf.edit.provider.ItemProviderAdapter
addListener, adjustWrapperIndex, adjustWrapperIndices, adjustWrapperIndices, createAddCommand, createAddCommand, createChildParameter, createChildrenStore, createCommand, createCopyCommand, createCreateChildCommand, createCreateChildCommand, createCreateCopyCommand, createDragAndDropCommand, createInitializeCopyCommand, createItemPropertyDescriptor, createItemPropertyDescriptor, createMoveCommand, createMoveCommand, createRemoveCommand, createRemoveCommand, createReplaceCommand, createReplaceCommand, createSetCommand, createSetCommand, createWrapper, crop, dispose, disposeWrapper, disposeWrappers, factorAddCommand, factorMoveCommand, factorRemoveCommand, fireNotifyChanged, getAdapterFactory, getBackground, getBackground, getBaseURL, getChildFeature, getChildReference, getChildrenReferences, getChildrenStore, getColumnImage, getColumnText, getCreateChildDescription, getCreateChildImage, getCreateChildResult, getCreateChildText, getCreateChildToolTipText, getEditableValue, getElements, getFeatureText, getFeatureValue, getFont, getFont, getForeground, getForeground, getImage, getPropertyDescriptor, getPropertyValue, getReferenceValue, getResourceLocator, getRootAdapterFactory, getSetFeature, getSetFeatures, getString, getString, getString, getString, getString, getString, getString, getString, getTypeText, getTypeText, getUpdateableText, getWrappedValues, hasChildren, hasChildren, isAdapterForType, isEquivalentValue, isPropertySet, isValidValue, isWrappingNeeded, overlayImage, removeListener, resetPropertyValue, setPropertyValue, setTarget, shouldTranslate, unsetTarget, unwrap, unwrapCommandValues, updateChildren, wrap, wrapCommand
 
Methods inherited from class org.eclipse.emf.common.notify.impl.AdapterImpl
getTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.emf.edit.provider.IEditingDomainItemProvider
createCommand
 
Methods inherited from interface org.eclipse.emf.edit.provider.ITreeItemContentProvider
hasChildren
 
Methods inherited from interface org.eclipse.emf.edit.provider.IItemPropertySource
getEditableValue, getPropertyDescriptor
 

Constructor Detail

ResourceItemProvider

public ResourceItemProvider(AdapterFactory adapterFactory)
This constructs an instance from a factory and a notifier.

Method Detail

getPropertyDescriptors

public java.util.List<IItemPropertyDescriptor> getPropertyDescriptors(java.lang.Object object)
This returns the property descriptors for the adapted class.

Specified by:
getPropertyDescriptors in interface IItemPropertySource
Overrides:
getPropertyDescriptors in class ItemProviderAdapter

getChildren

public java.util.Collection<?> getChildren(java.lang.Object object)
Description copied from class: ItemProviderAdapter
This implements ITreeItemContentProvider.getChildren. If children are already cached in a ItemProviderAdapter.ChildrenStore, they are returned. Otherwise, children are collected from the features returned by getChildrenFeatures. The collected children may or may not be cached, depending on the result of createChildrenStore; by default, no store is returned if getChildrenFeatures returns only containment references. All children are optionally wrapped before being cached and returned. Subclasses may override createWrapper to specify when and with what to wrap children.

Specified by:
getChildren in interface IEditingDomainItemProvider
Specified by:
getChildren in interface ITreeItemContentProvider
Overrides:
getChildren in class ItemProviderAdapter

getChildrenFeatures

public java.util.Collection<? extends EStructuralFeature> getChildrenFeatures(java.lang.Object object)
This specifies how to implement getChildren(java.lang.Object) and is used to deduce an appropriate feature for an AddCommand, RemoveCommand or MoveCommand in createCommand.

Overrides:
getChildrenFeatures in class ItemProviderAdapter

getParent

public java.lang.Object getParent(java.lang.Object object)
This returns the parent of the Resource.

Specified by:
getParent in interface IEditingDomainItemProvider
Specified by:
getParent in interface ITreeItemContentProvider
Overrides:
getParent in class ItemProviderAdapter

getImage

public java.lang.Object getImage(java.lang.Object object)
This returns Resource.gif.

Specified by:
getImage in interface IItemLabelProvider
Overrides:
getImage in class ItemProviderAdapter

getText

public java.lang.String getText(java.lang.Object object)
This returns the label text for the adapted class.

Specified by:
getText in interface IItemLabelProvider
Overrides:
getText in class ItemProviderAdapter

notifyChanged

public void notifyChanged(Notification notification)
This handles notification by calling fireNotifyChanged.

Specified by:
notifyChanged in interface Adapter
Overrides:
notifyChanged in class AdapterImpl
Parameters:
notification - a description of the change.

getNewChildDescriptors

public java.util.Collection<?> getNewChildDescriptors(java.lang.Object object,
                                                      EditingDomain editingDomain,
                                                      java.lang.Object sibling)
Description copied from class: ItemProviderAdapter
This implements IEditingDomainItemProvider.getNewChildDescriptors, returning descriptors for all the possible children that can be added to the specified object. Usually, these descriptors will be instances of CommandParameters, containing at least the child object and the feature under which it should be added.

This implementation invokes collectNewChildDescriptors, which should be overridden by derived classes, to build this collection.

If sibling is non-null, an index is added to each CommandParameter with a multi-valued feature, to ensure that the new child object gets added in the right position.

Specified by:
getNewChildDescriptors in interface IEditingDomainItemProvider
Overrides:
getNewChildDescriptors in class ItemProviderAdapter

collectNewChildDescriptors

protected void collectNewChildDescriptors(java.util.Collection<java.lang.Object> newChildDescriptors,
                                          java.lang.Object object)
This adds CommandParameters describing the children that can be created under this object.

Overrides:
collectNewChildDescriptors in class ItemProviderAdapter

getResourceLocator

public ResourceLocator getResourceLocator()
Return the resource locator for this item provider's resources.

Overrides:
getResourceLocator in class ItemProviderAdapter

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