public interface IColumnPropertyEditor
An interface for a custom property editor that want to contribute to the construction of complex properties. Namely, any property editor that wants to be 'renderable' as a column of the complex property table, must implement this interface.
Implementors of this interface are managed by the Complex Property framework.
In particular, once a property editor signals state change
(e.g. via notifyObservers
call), the framework will handle
notification of other property editors that constitute this complex property.
Creation date: (01/20/2007 6:04:30 PM)
Method | Description |
---|---|
boolean canModify() | Return whether column can be modified |
int getCellEditorType() | Return CellEditor type that should be rendered when property editor deployed in a table |
Object getDisplayValue() | Gets the desired Property value as it should be presented to the user in the table. |
String[] getEnumChoices() | Getter for the user choices for this property. |
IStatus isValid(Object) | Returns and IStatus object that indicates whether value
is valid for the current state of the editor. |
void resetValue() | Sets the value for the property to its defaults |
public static final int ADAPTABLE_COMBOBOX_CELL_EDITOR
public static final int CHECKBOX_CELL_EDITOR
public static final int COMBOBOX_CELL_EDITOR
public static final java.lang.String copyright
public static final int DEFAULT_CELL_EDITOR
public static final int DIALOG_CELL_EDITOR
public static final int DYNAMIC_COMBOBOX_CELL_EDITOR
public static final int EDITABLE_COMBOBOX_CELL_EDITOR
public static final int INTEGER_CELL_EDITOR
public static final int TEXT_CELL_EDITOR
public static final int XPATH_DIALOG_CELL_EDITOR
public static final int XPATH_OPQ_PARSE_DIALOG_CELL_EDITOR
public static final int XPATH_READONLY_DIALOG_CELL_EDITOR
public static final int XPATH_READWRITE_DIALOG_CELL_EDITOR
public boolean canModify()Return whether column can be modified
- Returns
public int getCellEditorType()Return CellEditor type that should be rendered when property editor deployed in a table
- Returns
public Object getDisplayValue()Gets the desired Property value as it should be presented to the user in the table. Typically, this method should simply call
IPropertyEditor#getValue
- Returns
- the desired value from the UI
public String[] getEnumChoices()Getter for the user choices for this property. Typically, used by the property editor that provide
COMBOBOX_CELL_EDITOR
orEDITABLE_COMBOBOX_CELL_EDITOR
as their CellEditor type
public IStatus isValid(Object value)Returns and IStatus object that indicates whether
value
is valid for the current state of the editor.This method is called by the Complex Property Framework when a value change occurs in a table cell, that corresponds to this editor.
- Returns
- IStatus corresponding to the validation state of the editor.
public void resetValue()Sets the value for the property to its defaults