public interface IPropertySheetEntry
IPropertySheetEntry
describes the model interface for the
property sheet.
May be implemented when supplying a custom root entry to a property page.
Modifier and Type | Field and Description |
---|---|
static String |
FILTER_ID_EXPERT
The filter id for expert properties
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertySheetEntryListener(IPropertySheetEntryListener listener)
Adds the given listener to this entry's collection of listeners.
|
void |
applyEditorValue()
Apply the current cell editor value.
|
void |
dispose()
Called when the entry is no longer needed
|
String |
getCategory()
Returns the entry's category.
|
IPropertySheetEntry[] |
getChildEntries()
Returns the child entries for this entry.
|
String |
getDescription()
Return a short description of the property sheet entry.
|
String |
getDisplayName()
Returns the name used to display the property.
|
CellEditor |
getEditor(Composite parent)
Return the
CellEditor used to edit the property. |
String |
getErrorText()
Returns the error text to display if the value is invalid.
|
String[] |
getFilters()
Return the filter ids used to group entries into levels such as Expert.
|
Object |
getHelpContextIds()
Returns the help context id for this entry, or
null if
this entry has no help context id. |
Image |
getImage()
Returns the image for the property value, if there is one.
|
String |
getValueAsString()
Returns the value of the objects expressed as a String.
|
boolean |
hasChildEntries()
Returns
true if the entry has children. |
void |
removePropertySheetEntryListener(IPropertySheetEntryListener listener)
Removes the given listener from this entry's collection of listeners.
|
void |
resetPropertyValue()
Resets the property value to its default value if it has been changed.
|
void |
setValues(Object[] values)
Sets the objects which represent the property values for this entry.
|
static final String FILTER_ID_EXPERT
void addPropertySheetEntryListener(IPropertySheetEntryListener listener)
listener
- the listener to addvoid applyEditorValue()
void dispose()
String getCategory()
IPropertySheetEntry[] getChildEntries()
String getDescription()
String getDisplayName()
CellEditor getEditor(Composite parent)
CellEditor
used to edit the property.parent
- the parent widget for the editorCellEditor
used to edit the propertyString getErrorText()
null
String[] getFilters()
Object getHelpContextIds()
null
if
this entry 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.
Image getImage()
null
String getValueAsString()
boolean hasChildEntries()
true
if the entry has children.true
if the entry has childrenvoid removePropertySheetEntryListener(IPropertySheetEntryListener listener)
listener
- the listener to removevoid resetPropertyValue()
Does nothing if the notion of a default value is not meaningful for the property.
void setValues(Object[] values)
values
- the values for this entry
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.