Package org.eclipse.nebula.widgets.nattable.summaryrow

Class SummaryDisplayConverter

java.lang.Object

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

org.eclipse.nebula.widgets.nattable.summaryrow.SummaryDisplayConverter

All Implemented Interfaces:

IDisplayConverter

public class SummaryDisplayConverter
extends DisplayConverter

Special display converter that will render a default value in case there is no summary value calculated yet. If there is a value calculated, it will be converted using the wrapped display converter.

By default "..." will be used as default value.

Constructor Summary

Constructors

Constructor	Description
SummaryDisplayConverter(IDisplayConverter wrappedConverter)
SummaryDisplayConverter(IDisplayConverter wrappedConverter, Object defaultSummaryValue)

Method Summary

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

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

canonicalToDisplayValue, displayToCanonicalValue

Methods inherited from class java.lang.Object

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

Constructor Detail

SummaryDisplayConverter

public SummaryDisplayConverter(IDisplayConverter wrappedConverter)

Parameters:

wrappedConverter - The IDisplayConverter that is wrapped by this GroupBySummaryDisplayConverter. Will be used to convert calculated values.

SummaryDisplayConverter

public SummaryDisplayConverter(IDisplayConverter wrappedConverter,
                               Object defaultSummaryValue)

Parameters:

wrappedConverter - The IDisplayConverter that is wrapped by this GroupBySummaryDisplayConverter. Will be used to convert calculated values.

defaultSummaryValue - The value that will be shown in case the summary value is not calculated yet.

Method Detail

canonicalToDisplayValue

public Object canonicalToDisplayValue(Object canonicalValue)

Description copied from interface: IDisplayConverter

Convert backing data value to value to be displayed. Typically converts to a String for display.

Specified by:

canonicalToDisplayValue in interface IDisplayConverter

Specified by:

canonicalToDisplayValue in class DisplayConverter

Parameters:

canonicalValue - The data value from the backing data.

Returns:

The converted value to display.

displayToCanonicalValue

public Object displayToCanonicalValue(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

Specified by:

displayToCanonicalValue in interface IDisplayConverter

Specified by:

displayToCanonicalValue in class DisplayConverter

Parameters:

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.