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

Class DefaultDateDisplayConverter

java.lang.Object

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

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

All Implemented Interfaces:

IDisplayConverter

public class DefaultDateDisplayConverter
extends DisplayConverter

Converts a java.util.Date object to a given format and vice versa

Constructor Summary

Constructors

Constructor	Description
DefaultDateDisplayConverter()	Convert Date to String using the default format from SimpleDateFormat
DefaultDateDisplayConverter(String dateFormat)
DefaultDateDisplayConverter(String dateFormat, TimeZone timeZone)
DefaultDateDisplayConverter(TimeZone timeZone)

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

DefaultDateDisplayConverter

public DefaultDateDisplayConverter()

Convert Date to String using the default format from SimpleDateFormat

DefaultDateDisplayConverter

public DefaultDateDisplayConverter(TimeZone timeZone)

DefaultDateDisplayConverter

public DefaultDateDisplayConverter(String dateFormat)

Parameters:

dateFormat - as specified in SimpleDateFormat

DefaultDateDisplayConverter

public DefaultDateDisplayConverter(String dateFormat,
                                   TimeZone timeZone)

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.