org.eclipse.emf.edit.provider
Class ItemPropertyDescriptorDecorator

java.lang.Object
  extended byorg.eclipse.emf.edit.provider.ItemPropertyDescriptorDecorator
All Implemented Interfaces:
IItemPropertyDescriptor
Direct Known Subclasses:
DelegatingWrapperItemProvider.DelegatingWrapperItemPropertyDescriptor

public class ItemPropertyDescriptorDecorator
extends Object
implements IItemPropertyDescriptor


Nested Class Summary
 
Nested classes inherited from class org.eclipse.emf.edit.provider.IItemPropertyDescriptor
IItemPropertyDescriptor.OverrideableCommandOwner
 
Field Summary
protected  IItemPropertyDescriptor itemPropertyDescriptor
           
protected  Object object
           
 
Constructor Summary
ItemPropertyDescriptorDecorator(Object object, IItemPropertyDescriptor itemPropertyDescriptor)
           
 
Method Summary
 boolean canSetProperty(Object thisObject)
          This does the delegated job of determining whether the property value from the given object supports set (and reset).
 String getCategory(Object thisObject)
          This returns the group of propertiesk into which this one should be placed.
 Collection getChoiceOfValues(Object thisObject)
           
 String getDescription(Object thisObject)
          This returns the description to be displayed in the property sheet when this property is selected.
 String getDisplayName(Object thisObject)
          This returns the name of the property to be displayed in the property sheet.
 Object getFeature(Object thisObject)
          Returns the feature.
 String[] getFilterFlags(Object thisObject)
          This returns the flags used as filters in the property sheet.
 Object getHelpContextIds(Object thisObject)
           
 String getId(Object thisObject)
          This returns the interface name of this property.
 IItemLabelProvider getLabelProvider(Object thisObject)
          This does the delegated job of getting the label provider for the given object
 Object getPropertyValue(Object thisObject)
          This does the delegated job of getting the property value from the given object
 boolean isCompatibleWith(Object object, Object anotherObject, IItemPropertyDescriptor anotherItemPropertyDescriptor)
          This indicates whether these two property descriptors are equal.
 boolean isMany(Object thisObject)
          This does the delegated job of determing whether the property represents multiple values.
 boolean isMultiLine(Object object)
          This does the delegated job of determing whether the property's value consists of multi-line text.
 boolean isPropertySet(Object thisObject)
          This does the delegated job of determining whether the property value from the given object is set.
 boolean isSortChoices(Object object)
          This does the delegated job of determing the choices for this property should be sorted for display.
 void resetPropertyValue(Object thisObject)
          This does the delegated job of resetting property value back to it's default value.
 void setPropertyValue(Object thisObject, Object value)
          This does the delegated job of setting the property to the given value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

object

protected Object object

itemPropertyDescriptor

protected IItemPropertyDescriptor itemPropertyDescriptor
Constructor Detail

ItemPropertyDescriptorDecorator

public ItemPropertyDescriptorDecorator(Object object,
                                       IItemPropertyDescriptor itemPropertyDescriptor)
Method Detail

getCategory

public String getCategory(Object thisObject)
This returns the group of propertiesk into which this one should be placed.

Specified by:
getCategory in interface IItemPropertyDescriptor

getDescription

public String getDescription(Object thisObject)
This returns the description to be displayed in the property sheet when this property is selected.

Specified by:
getDescription in interface IItemPropertyDescriptor

getDisplayName

public String getDisplayName(Object thisObject)
This returns the name of the property to be displayed in the property sheet.

Specified by:
getDisplayName in interface IItemPropertyDescriptor

getFilterFlags

public String[] getFilterFlags(Object thisObject)
This returns the flags used as filters in the property sheet.

Specified by:
getFilterFlags in interface IItemPropertyDescriptor

getId

public String getId(Object thisObject)
This returns the interface name of this property. This is the key that is passed around and must uniquely identifiy this descriptor.

Specified by:
getId in interface IItemPropertyDescriptor

getHelpContextIds

public Object getHelpContextIds(Object thisObject)
Specified by:
getHelpContextIds in interface IItemPropertyDescriptor

getLabelProvider

public IItemLabelProvider getLabelProvider(Object thisObject)
This does the delegated job of getting the label provider for the given object

Specified by:
getLabelProvider in interface IItemPropertyDescriptor

isCompatibleWith

public boolean isCompatibleWith(Object object,
                                Object anotherObject,
                                IItemPropertyDescriptor anotherItemPropertyDescriptor)
This indicates whether these two property descriptors are equal. It's not really clear to me how this is meant to be used, but it's a little bit like an equals test.

Specified by:
isCompatibleWith in interface IItemPropertyDescriptor

getPropertyValue

public Object getPropertyValue(Object thisObject)
This does the delegated job of getting the property value from the given object

Specified by:
getPropertyValue in interface IItemPropertyDescriptor

isPropertySet

public boolean isPropertySet(Object thisObject)
This does the delegated job of determining whether the property value from the given object is set.

Specified by:
isPropertySet in interface IItemPropertyDescriptor

canSetProperty

public boolean canSetProperty(Object thisObject)
This does the delegated job of determining whether the property value from the given object supports set (and reset).

Specified by:
canSetProperty in interface IItemPropertyDescriptor

resetPropertyValue

public void resetPropertyValue(Object thisObject)
This does the delegated job of resetting property value back to it's default value.

Specified by:
resetPropertyValue in interface IItemPropertyDescriptor

setPropertyValue

public void setPropertyValue(Object thisObject,
                             Object value)
This does the delegated job of setting the property to the given value.

Specified by:
setPropertyValue in interface IItemPropertyDescriptor

getFeature

public Object getFeature(Object thisObject)
Description copied from interface: IItemPropertyDescriptor
Returns the feature.

Specified by:
getFeature in interface IItemPropertyDescriptor

getChoiceOfValues

public Collection getChoiceOfValues(Object thisObject)
Specified by:
getChoiceOfValues in interface IItemPropertyDescriptor

isMany

public boolean isMany(Object thisObject)
This does the delegated job of determing whether the property represents multiple values.

Specified by:
isMany in interface IItemPropertyDescriptor

isMultiLine

public boolean isMultiLine(Object object)
This does the delegated job of determing whether the property's value consists of multi-line text.

Specified by:
isMultiLine in interface IItemPropertyDescriptor
Since:
2.2.0

isSortChoices

public boolean isSortChoices(Object object)
This does the delegated job of determing the choices for this property should be sorted for display.

Specified by:
isSortChoices in interface IItemPropertyDescriptor
Since:
2.2.0

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