|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.ui.views.properties.PropertyDescriptor
Standard implementation for property descriptors.
The required attributes of property descriptors (id and display name) are passed to the constructor; the optional attributes can be configured using the various set methods (all have reasonable default values):
setDescription
setCategory
setLabelProvider
setHelpContexts
getPropertyEditor
to provide a
cell editor for changing the value; otherwise the property will be
effectively read only.
There are several concrete subclasses provided in this package that cover the most common cases:
TextPropertyDescriptor
- edits with a
TextCellEditor
ComboBoxPropertyDescriptor - edits with a
ComboBoxCellEditor
ColorPropertyDescriptor - edits with a
ColorCellEditor
Constructor Summary | |
PropertyDescriptor(Object id,
String displayName)
Creates a new property descriptor with the given id and display name |
Method Summary | |
CellEditor |
createPropertyEditor(Composite parent)
The PropertyDescriptor implementation of this
IPropertyDescriptor method returns null . |
protected boolean |
getAlwaysIncompatible()
Returns true if this property descriptor is to be always
considered incompatible with any other property descriptor. |
String |
getCategory()
The PropertyDescriptor implementation of this
IPropertyDescriptor method returns the value set by
the setCategory method. |
String |
getDescription()
The PropertyDescriptor implementation of this
IPropertyDescriptor method returns the value set by
the setDescription method. |
String |
getDisplayName()
The SimplePropertyDescriptor implementation of this
IPropertyDescriptor method returns the value supplied
on the constructor. |
String[] |
getFilterFlags()
The SimplePropertyDescriptor implementation of this
IPropertyDescriptor method returns the value set by
the setFilterFlags method. |
Object |
getHelpContextIds()
The SimplePropertyDescriptor implementation of this
IPropertyDescriptor method returns the value set by
the setHelpContextId method. |
Object |
getId()
The PropertyDescriptor implementation of this
IPropertyDescriptor method returns the value supplied
on the constructor. |
ILabelProvider |
getLabelProvider()
The PropertyDescriptor implementation of this
IPropertyDescriptor method returns the value set by
the setProvider method or, if no value has been set
it returns a LabelProvider |
protected ICellEditorValidator |
getValidator()
Returns the input validator for editing the property. |
boolean |
isCompatibleWith(IPropertyDescriptor anotherProperty)
The SimplePropertyDescriptor implementation of this
IPropertyDescriptor method returns true if the other
property has the same id and category and getAlwaysIncompatible()
returns false |
void |
setAlwaysIncompatible(boolean flag)
Sets a flag indicating whether this property descriptor is to be always considered incompatible with any other property descriptor. |
void |
setCategory(String category)
Sets the category for this property descriptor. |
void |
setDescription(String description)
Sets the description for this property descriptor. |
void |
setFilterFlags(String[] value)
Sets the the filter flags for this property descriptor. |
void |
setHelpContextIds(Object contextIds)
Sets the help context id for this property descriptor. |
void |
setLabelProvider(ILabelProvider provider)
Sets the label provider for this property descriptor. |
void |
setValidator(ICellEditorValidator validator)
Sets the input validator for the cell editor for this property descriptor. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PropertyDescriptor(Object id, String displayName)
Method Detail |
public CellEditor createPropertyEditor(Composite parent)
PropertyDescriptor
implementation of this
IPropertyDescriptor
method returns null
.
Since no cell editor is returned, the property is read only.
createPropertyEditor
in interface IPropertyDescriptor
parent
- the parent widget for the cell editor
null
if this
property cannot be editedprotected boolean getAlwaysIncompatible()
true
if this property descriptor is to be always
considered incompatible with any other property descriptor.
This prevents a property from displaying during multiple
selection.
true
to indicate always incompatiblepublic String getCategory()
PropertyDescriptor
implementation of this
IPropertyDescriptor
method returns the value set by
the setCategory
method. If unset, this method returns
null
indicating the default category.
getCategory
in interface IPropertyDescriptor
null
if the default category is to
be usedsetCategory(java.lang.String)
public String getDescription()
PropertyDescriptor
implementation of this
IPropertyDescriptor
method returns the value set by
the setDescription
method. If unset, this method returns
null
indicating no description.
getDescription
in interface IPropertyDescriptor
null
if nonesetDescription(java.lang.String)
public String getDisplayName()
SimplePropertyDescriptor
implementation of this
IPropertyDescriptor
method returns the value supplied
on the constructor.
getDisplayName
in interface IPropertyDescriptor
public String[] getFilterFlags()
SimplePropertyDescriptor
implementation of this
IPropertyDescriptor
method returns the value set by
the setFilterFlags
method. If unset, this method returns
null
.
Valid values for these flags are declared as constants on
IPropertySheetEntry
getFilterFlags
in interface IPropertyDescriptor
null
if nonepublic Object getHelpContextIds()
SimplePropertyDescriptor
implementation of this
IPropertyDescriptor
method returns the value set by
the setHelpContextId
method. If unset, this method returns
null
.
getHelpContextIds
in interface IPropertyDescriptor
setHelpContextIds(java.lang.Object)
public Object getId()
PropertyDescriptor
implementation of this
IPropertyDescriptor
method returns the value supplied
on the constructor.
getId
in interface IPropertyDescriptor
public ILabelProvider getLabelProvider()
PropertyDescriptor
implementation of this
IPropertyDescriptor
method returns the value set by
the setProvider
method or, if no value has been set
it returns a LabelProvider
getLabelProvider
in interface IPropertyDescriptor
setLabelProvider(org.eclipse.jface.viewers.ILabelProvider)
protected ICellEditorValidator getValidator()
null
public boolean isCompatibleWith(IPropertyDescriptor anotherProperty)
SimplePropertyDescriptor
implementation of this
IPropertyDescriptor
method returns true if the other
property has the same id and category and getAlwaysIncompatible()
returns false
isCompatibleWith
in interface IPropertyDescriptor
anotherProperty
- the other property descriptor
true
if the property descriptors are compatible, and
false
otherwisepublic void setAlwaysIncompatible(boolean flag)
flag
- true
to indicate always incompatiblepublic void setCategory(String category)
category
- the category for the descriptor, or null
if nonegetCategory()
public void setDescription(String description)
description
- the description, or null
if nonegetDescription()
public void setFilterFlags(String[] value)
Valid values for these flags are declared as constants on
IPropertySheetEntry
value
- the filter flagsgetFilterFlags()
public void setHelpContextIds(Object contextIds)
Thus the only valid parameter type for this method
is a String
representing a context id.
The previously valid parameter types are deprecated.
The plural name for this method is unfortunate.
getHelpContextIds()
public void setLabelProvider(ILabelProvider provider)
If no label provider is set an instance of LabelProvider
will be created as the default when needed.
getLabelProvider()
public void setValidator(ICellEditorValidator validator)
[Issue: This method should be unnecessary is the cell editor's own validator is used. ]
validator
- the cell input validator, or null
if none
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |