|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.emf.edit.provider.WrapperItemProvider
A basic implementation of IWrapperProvider
from which others can extend. This class provides
all the methods required to implement the following item provider iterfaces:
IStructuredItemContentProvider
ITreeItemContentProvider
IItemLabelProvider
IItemPropertySource
IEditingDomainItemProvider
Subclasses should declare which of these interfaces they are meant to implement, and override methods as needed.
In addition, a partial implementation for IUpdateableItemText
is provided, along with additional methods and
classes that are useful in implementing multiple subclasses.
Nested Class Summary | |
protected class |
WrapperItemProvider.ReplacementAffectedObjectCommand
A ReplacementAffectedObjectCommand wraps another command to return as its affected objects the single
wrapper that replaces this wrapper. |
protected class |
WrapperItemProvider.SimpleCopyCommand
A command base class for copying a simple value and the wrapper. |
protected class |
WrapperItemProvider.WrapperItemPropertyDescriptor
An item property descriptor for the single property of a wrapper for a simple value. |
protected class |
WrapperItemProvider.WrappingCopyCommand
A command base class for copying the wrapper for a value that is partly copied by another command. |
Field Summary | |
protected AdapterFactory |
adapterFactory
The adapter factory for the owner's item provider. |
protected static String |
COPY_COMMAND_DESCRIPTION
A description for copy command inner classes, the same as in CopyCommand . |
protected static String |
COPY_COMMAND_LABEL
A label for copy command inner classes, the same one used by CopyCommand . |
protected EStructuralFeature |
feature
The structural feature, if applicable, through which the value can be set and retrieved. |
protected int |
index
The index at which the value is located. |
protected Object |
owner
The object that owns the value. |
protected Object |
value
The wrapped value. |
Constructor Summary | |
WrapperItemProvider(Object value,
Object owner,
EStructuralFeature feature,
int index,
AdapterFactory adapterFactory)
Creates an instance. |
Method Summary | |
Command |
baseCreateCommand(Object object,
EditingDomain domain,
Class commandClass,
CommandParameter commandParameter)
Implements creation of a set, copy, or drag-and-drop command by calling out to createSetCommand , createCopyCommand , or createDragAndDropCommand . |
Command |
createCommand(Object object,
EditingDomain domain,
Class commandClass,
CommandParameter commandParameter)
{IEditingDomainItemProvider#createCommand IEditingDomainItemProvider.createCommand} is implemented via baseCreateCommand to create set, copy, and drag-and-drop commands, only. |
protected Command |
createCopyCommand(EditingDomain domain,
Object owner,
CopyCommand.Helper helper)
Returns an UnexecutableCommand . |
protected Command |
createDragAndDropCommand(EditingDomain domain,
Object owner,
float location,
int operations,
int operation,
Collection collection)
Creates a DragAndDropCommand . |
protected Command |
createSetCommand(EditingDomain domain,
Object owner,
Object feature,
Object value,
int index)
Return an UnexecutableCommand . |
void |
dispose()
Disposes the wrapper by deactivating any notification that this wrapper may provide. |
Collection |
getChildren(Object object)
ITreeItemContentProvider.getChildren is implemented to return an
empty list. |
Object |
getEditableValue(Object object)
IItemPropertySource.getEditableValue is implemented to return the
value, itself. |
Collection |
getElements(Object object)
IStructuredItemContentProvider.getElements is implemented by
forwarding the call to getChildren . |
EStructuralFeature |
getFeature()
Returns the structural feature through which the value can be set and retrieved, or null if the feature is unknown or not applicable. |
Object |
getImage(Object object)
IItemLabelProvider.getImage is implemented by returning the default icon for
an EMF.Edit item. |
int |
getIndex()
The index at which the value is located, or CommandParameter.NO_INDEX if the
index isn't known to the wrapper. |
Collection |
getNewChildDescriptors(Object object,
EditingDomain editingDomain,
Object sibling)
IEditingDomainItemProvider.getNewChildDescriptors is
implemented to return an empty list. |
Object |
getOwner()
Returns the object that owns the value. |
Object |
getParent(Object object)
ITreeItemContentProvider.getParent is implemented by returning the
owner . |
protected String |
getPropertyCategory()
Returns a category for a value's single property. |
protected String |
getPropertyDescription()
Returns a description for a value's single property. |
IItemPropertyDescriptor |
getPropertyDescriptor(Object object,
Object propertyId)
IItemPropertySource.getPropertyDescriptor is implemented by
iterating over the descriptors returned by getPropertyDescriptors , and returning
the first descriptor whose ID matches the specified ID, or null if none match. |
List |
getPropertyDescriptors(Object object)
IItemPropertySource.getPropertyDescriptors is implemented to
return an empty list. |
protected String[] |
getPropertyFilterFlags()
Returns filter flags for a value's single property. |
protected Object |
getPropertyImage()
Returns an image for a value's single property. |
protected Object |
getPropertyImage(Class typeClass)
Returns the property image for the specified type. |
protected String |
getPropertyName()
Returns a name for a value's single property. |
protected AdapterFactory |
getRootAdapterFactory()
Returns the adapterFactory , if non-composeable, otherwise, returns its root adapter factory. |
String |
getText(Object object)
IItemLabelProvider.getText is implemented by returning a non-null value, as a
string, or "null". |
String |
getUpdateableText(Object object)
IUpdateableItemText.getUpdateableText is implemented by forwarding
the call to getText . |
Object |
getValue()
Returns the wrapped value. |
boolean |
hasChildren(Object object)
ITreeItemContentProvider.hasChildren is implemented by testing
whether the collection returned by getChildren is non-empty. |
protected boolean |
isPropertyMultiLine()
Returns whether value's single property consists of multi-line text. |
protected boolean |
isPropertySettable()
Returns whether a value's single property is settable. |
protected boolean |
isPropertySortChoices()
Returns whether value's single property should sort its choices for selection. |
void |
setIndex(int index)
Sets the index. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Object value
protected Object owner
protected EStructuralFeature feature
protected int index
feature
is non-null, this index is within that feature.
protected AdapterFactory adapterFactory
protected static final String COPY_COMMAND_LABEL
CopyCommand
.
protected static final String COPY_COMMAND_DESCRIPTION
CopyCommand
.
Constructor Detail |
public WrapperItemProvider(Object value, Object owner, EStructuralFeature feature, int index, AdapterFactory adapterFactory)
Method Detail |
public void dispose()
dispose
in interface IDisposable
public Object getValue()
getValue
in interface IWrapperItemProvider
public Object getOwner()
getOwner
in interface IWrapperItemProvider
public EStructuralFeature getFeature()
getFeature
in interface IWrapperItemProvider
public int getIndex()
CommandParameter.NO_INDEX
if the
index isn't known to the wrapper. If feature
is non-null, this index is within that feature.
getIndex
in interface IWrapperItemProvider
public void setIndex(int index)
setIndex
in interface IWrapperItemProvider
public Collection getElements(Object object)
IStructuredItemContentProvider.getElements
is implemented by
forwarding the call to getChildren
.
public Collection getChildren(Object object)
ITreeItemContentProvider.getChildren
is implemented to return an
empty list. Subclasses may override it to return something else.
public boolean hasChildren(Object object)
ITreeItemContentProvider.hasChildren
is implemented by testing
whether the collection returned by getChildren
is non-empty.
public Object getParent(Object object)
ITreeItemContentProvider.getParent
is implemented by returning the
owner
.
public String getText(Object object)
IItemLabelProvider.getText
is implemented by returning a non-null value, as a
string, or "null".
public Object getImage(Object object)
IItemLabelProvider.getImage
is implemented by returning the default icon for
an EMF.Edit item.
public String getUpdateableText(Object object)
IUpdateableItemText.getUpdateableText
is implemented by forwarding
the call to getText
.
public List getPropertyDescriptors(Object object)
IItemPropertySource.getPropertyDescriptors
is implemented to
return an empty list. Subclasses may override it to return something else.
public IItemPropertyDescriptor getPropertyDescriptor(Object object, Object propertyId)
IItemPropertySource.getPropertyDescriptor
is implemented by
iterating over the descriptors returned by getPropertyDescriptors
, and returning
the first descriptor whose ID matches the specified ID, or null if none match.
public Object getEditableValue(Object object)
IItemPropertySource.getEditableValue
is implemented to return the
value, itself.
protected String getPropertyName()
protected String getPropertyDescription()
protected boolean isPropertySettable()
changeable
. Subclasses may use this in creating a
property descriptor, and user subclasses may override it to restrict or allow setting of the property.
protected boolean isPropertyMultiLine()
protected boolean isPropertySortChoices()
protected Object getPropertyImage()
protected Object getPropertyImage(Class typeClass)
getPropertyImage
typically call this method.
protected String getPropertyCategory()
protected String[] getPropertyFilterFlags()
public Collection getNewChildDescriptors(Object object, EditingDomain editingDomain, Object sibling)
IEditingDomainItemProvider.getNewChildDescriptors
is
implemented to return an empty list. Subclasses may override it to return something else.
public Command createCommand(Object object, EditingDomain domain, Class commandClass, CommandParameter commandParameter)
baseCreateCommand
to create set, copy, and drag-and-drop commands, only.
public Command baseCreateCommand(Object object, EditingDomain domain, Class commandClass, CommandParameter commandParameter)
createSetCommand
, createCopyCommand
, or createDragAndDropCommand
.
protected Command createSetCommand(EditingDomain domain, Object owner, Object feature, Object value, int index)
UnexecutableCommand
. Subclasses should override this to map this
into a real set on a model object.
protected Command createCopyCommand(EditingDomain domain, Object owner, CopyCommand.Helper helper)
UnexecutableCommand
. An ordinary CopyCommand
is only useful for copying model objects, so it would be inappropriate
here. Subclasses should override it to return something more useful, like a concrete subclass of a WrapperItemProvider.SimpleCopyCommand
or WrapperItemProvider.WrappingCopyCommand
.
protected Command createDragAndDropCommand(EditingDomain domain, Object owner, float location, int operations, int operation, Collection collection)
DragAndDropCommand
.
protected AdapterFactory getRootAdapterFactory()
adapterFactory
, if non-composeable, otherwise, returns its root adapter factory.
|
Copyright 2001-2006 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |