org.eclipse.emf.ecp.edit.spi.swt.table

Interface ECPCellEditor

All Known Implementing Classes:

BooleanCellEditor, DateCellEditor, ECPEnumCellEditor, EnumCellEditor, LinkCellEditor, MultiStringCellEditor, NumberCellEditor, StringBasedCellEditor, StringCellEditor, XmlDateCellEditor

public interface ECPCellEditor

A common super interface for all CellEditors contributed to ECP.

See the ECPCellEditorComparator interface for an optional extension to the ECPCellEditor.

Since:

1.5

Author:

Eugen Neufeld

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPY_STRING_ALTERNATIVE Indicator for an alternative copy string.
static String	CUSTOM_VARIANT RAP theming variable.

Method Summary

Modifier and Type	Method and Description
int	getColumnWidthWeight() The returned value is used for layouting the table columns.
String	getFormatedString(Object value) This returns the String which will be shown in the table when no cell editor is open.
org.eclipse.swt.graphics.Image	getImage(Object value) This returns the Image which will be shown in the table when no cell editor is open.
int	getMinWidth() Returns the minimum width of the cell editor.
org.eclipse.core.databinding.UpdateValueStrategy	getModelToTargetStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext) This UpdateValueStrategy will be used as the model to target strategy during data binding.
int	getStyle() The SWT style bits.
org.eclipse.core.databinding.UpdateValueStrategy	getTargetToModelStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext) This UpdateValueStrategy will be used as the target to model strategy during data binding.
org.eclipse.core.databinding.property.value.IValueProperty	getValueProperty() Returns the IValueProperty for this cell editor which is used by the table to create an IObservableValue.
void	instantiate(org.eclipse.emf.ecore.EStructuralFeature feature, ViewModelContext viewModelContext) Instantiates this cell editor.
void	setEditable(boolean editable) Sets editable state of the cell editor.

Field Detail

CUSTOM_VARIANT

static final String CUSTOM_VARIANT

RAP theming variable.

See Also:

Constant Field Values

COPY_STRING_ALTERNATIVE

static final String COPY_STRING_ALTERNATIVE

Indicator for an alternative copy string.

Since:

1.11

See Also:

Constant Field Values

Method Detail

getValueProperty

org.eclipse.core.databinding.property.value.IValueProperty getValueProperty()

Returns the IValueProperty for this cell editor which is used by the table to create an IObservableValue.

Returns:

the IValueProperty for this cell editor

instantiate

void instantiate(org.eclipse.emf.ecore.EStructuralFeature feature,
                 ViewModelContext viewModelContext)

Instantiates this cell editor. This allows the cell editor to use ViewModelServices.

Parameters:

feature - the EStructuralFeature displayed in this cell editor

viewModelContext - the ViewModelContext used for the current view

getStyle

int getStyle()

The SWT style bits.

Returns:

the style

getFormatedString

String getFormatedString(Object value)

This returns the String which will be shown in the table when no cell editor is open.

Parameters:

value - the Object to get the formated String for

Returns:

the formated String

getImage

org.eclipse.swt.graphics.Image getImage(Object value)

This returns the Image which will be shown in the table when no cell editor is open.

Parameters:

value - the Object to get the Image for

Returns:

the image

getColumnWidthWeight

int getColumnWidthWeight()

The returned value is used for layouting the table columns. The value is a relative column weight. A column containing text has a weight of 100. Please consider this when defining you weight. E.g if you return 200 your column will be twice the width of a text column.

Returns:

the relative column width

getTargetToModelStrategy

org.eclipse.core.databinding.UpdateValueStrategy getTargetToModelStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext)

This UpdateValueStrategy will be used as the target to model strategy during data binding.

Parameters:

databindingContext - The DataBindingContext used by this strategy

Returns:

the strategy

Since:

1.6

getModelToTargetStrategy

org.eclipse.core.databinding.UpdateValueStrategy getModelToTargetStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext)

This UpdateValueStrategy will be used as the model to target strategy during data binding.

Parameters:

databindingContext - The DataBindingContext used by this strategy

Returns:

the strategy

Since:

1.6

setEditable

void setEditable(boolean editable)

Sets editable state of the cell editor.

Parameters:

editable - true if editable, false otherwise

getMinWidth

int getMinWidth()

Returns the minimum width of the cell editor.

Returns:

the minimum width

Since:

1.6