|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A descriptor for a property to be presented by a standard property sheet page
(PropertySheetPage
). These descriptors originate with property
sources (IPropertySource
).
A property descriptor carries the following information:
Clients may implement this interface to provide specialized property descriptors; however, there are standard implementations declared in this package that take care of the most common cases:
PropertyDescriptor - read-only property
TextPropertyDescriptor
- edits with a
TextCellEditor
CheckboxPropertyDescriptor - edits with a
CheckboxCellEditor
ComboBoxPropertyDescriptor - edits with a
ComboBoxCellEditor
ColorPropertyDescriptor - edits with a
ColorCellEditor
IPropertySource.getPropertyDescriptors()
Method Summary | |
CellEditor |
createPropertyEditor(Composite parent)
Creates and returns a new cell editor for editing this property. |
String |
getCategory()
Returns the name of the category to which this property belongs. |
String |
getDescription()
Returns a brief description of this property. |
String |
getDisplayName()
Returns the display name for this property. |
String[] |
getFilterFlags()
Returns a list of filter types to which this property belongs. |
Object |
getHelpContextIds()
Returns the help context id for this property or null if this property has no help context id. |
Object |
getId()
Returns the id for this property. |
ILabelProvider |
getLabelProvider()
Returns the label provider for this property. |
boolean |
isCompatibleWith(IPropertyDescriptor anotherProperty)
Returns whether this property descriptor and the given one are compatible. |
Method Detail |
public CellEditor createPropertyEditor(Composite parent)
null
if the property is not editable.
parent
- the parent widget for the cell editor
null
if this
property cannot be editedpublic String getCategory()
null
if the default category is to
be usedpublic String getDescription()
null
if nonepublic String getDisplayName()
public String[] getFilterFlags()
Valid values for these flags are declared as constants on
IPropertySheetEntry
null
if nonepublic Object getHelpContextIds()
null
if this property has no help context id.
NOTE: Help support system API's changed since 2.0 and arrays of contexts are no longer supported.
Thus the only valid non-null
return type for this method
is a String
representing a context id. The previously
valid return types are deprecated. The plural name for this method
is unfortunate.
public Object getId()
public ILabelProvider getLabelProvider()
public boolean isCompatibleWith(IPropertyDescriptor anotherProperty)
The property sheet uses this method during multiple selection to determine whether two property descriptors with the same id are in fact the same property and can be displayed as a single entry in the property sheet.
anotherProperty
- the other property descriptor
true
if the property descriptors are compatible, and
false
otherwise
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |