org.eclipse.nebula.widgets.nattable.formula

Class FormulaEditDisplayConverter

java.lang.Object

org.eclipse.nebula.widgets.nattable.data.convert.ContextualDisplayConverter

org.eclipse.nebula.widgets.nattable.formula.FormulaEditDisplayConverter

All Implemented Interfaces:

IDisplayConverter

public class FormulaEditDisplayConverter
extends ContextualDisplayConverter

IDisplayConverter that needs to be registered for DisplayMode.EDIT in order to support editing of formulas without formula execution.

Technically it does not perform a conversion, but returns the value of the IDataProvider that is wrapped by a FormulaDataProvider via FormulaDataProvider.getNativeDataValue(int, int).

 configRegistry.registerConfigAttribute(
         CellConfigAttributes.DISPLAY_CONVERTER,
         new FormulaEditDisplayConverter(formulaDataProvider),
         DisplayMode.EDIT);
 

Since:

1.4

Field Summary

Fields

Modifier and Type	Field and Description
protected FormulaDataProvider	dataProvider

Constructor Summary

Constructors

Constructor and Description
FormulaEditDisplayConverter(FormulaDataProvider dataProvider)

Method Summary

Modifier and Type	Method and Description
Object	canonicalToDisplayValue(ILayerCell cell, IConfigRegistry configRegistry, Object canonicalValue) Convert backing data value to value to be displayed.
Object	displayToCanonicalValue(ILayerCell cell, IConfigRegistry configRegistry, Object displayValue) Convert from display value to value in the backing data structure.

Methods inherited from class org.eclipse.nebula.widgets.nattable.data.convert.ContextualDisplayConverter

canonicalToDisplayValue, displayToCanonicalValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dataProvider

protected FormulaDataProvider dataProvider

Constructor Detail

FormulaEditDisplayConverter

public FormulaEditDisplayConverter(FormulaDataProvider dataProvider)

Parameters:

dataProvider - The FormulaDataProvider for retrieving the native formula value.

Method Detail

canonicalToDisplayValue

public Object canonicalToDisplayValue(ILayerCell cell,
                                      IConfigRegistry configRegistry,
                                      Object canonicalValue)

Description copied from interface: IDisplayConverter

Convert backing data value to value to be displayed. Typically converts to a String for display. Use this method for contextual conversion.

Note that on returning a different type than String, toString() will be called on the returned object to render the value for displaying.

Specified by:

canonicalToDisplayValue in interface IDisplayConverter

Specified by:

canonicalToDisplayValue in class ContextualDisplayConverter

Parameters:

cell - The ILayerCell whose canonical value should be converted.

configRegistry - The IConfigRegistry of the NatTable to which the ILayerCell belongs.

canonicalValue - The data value from the backing data.

Returns:

The converted value to display.

displayToCanonicalValue

public Object displayToCanonicalValue(ILayerCell cell,
                                      IConfigRegistry configRegistry,
                                      Object displayValue)

Description copied from interface: IDisplayConverter

Convert from display value to value in the backing data structure.

NOTE:
The type the display value is converted to must match the type in the setter of the backing bean/row object Use this method for contextual conversion.

Specified by:

displayToCanonicalValue in interface IDisplayConverter

Specified by:

displayToCanonicalValue in class ContextualDisplayConverter

Parameters:

cell - The ILayerCell whose canonical value should be converted.

configRegistry - The IConfigRegistry of the NatTable to which the ILayerCell belongs.

displayValue - The display value that should be converted to the data value that matches the backing data.

Returns:

The converted value to put to the backing data.