Module org.tentackle.fx

Package org.tentackle.fx.translate

Class TemporalStringTranslator<T extends Temporal>

java.lang.Object

org.tentackle.fx.translate.AbstractValueTranslator<M,String>

org.tentackle.fx.translate.ValueStringTranslator<T>

org.tentackle.fx.translate.TemporalStringTranslator<T>

Type Parameters:

T - the Temporal type

All Implemented Interfaces:

ValueTranslator<T,String>, NumberShortcut.WindowProvider, SmartDateTimeParser.Shortcut

Direct Known Subclasses:

InstantStringTranslator, LocalDateStringTranslator, LocalDateTimeStringTranslator, LocalTimeStringTranslator, OffsetDateTimeStringTranslator, OffsetTimeStringTranslator, ZonedDateTimeStringTranslator

public abstract class TemporalStringTranslator<T extends Temporal>
extends ValueStringTranslator<T>
implements NumberShortcut.WindowProvider, SmartDateTimeParser.Shortcut

String translator for date- and/or time types based on Temporal.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DAY_WINDOW	Property to define the sliding day input window.
static final String	MONTH_WINDOW	Property to define the sliding month input window.
static final String	REFERENCE_DATE_SUPPLIER	Component property for a reference date supplier of type Supplier<T>. '@' as input will be replaced by the supplier's date. Example:
static final String	YEAR_WINDOW	Property to define the sliding year input window.

Constructor Summary

Constructors

Constructor	Description
TemporalStringTranslator(FxTextComponent component)	Creates a translator.

Method Summary

Modifier and Type	Method	Description
static void	connectAsReferenceDateSuppliers(FxTextComponent a, FxTextComponent b)	Connects two fields as reference date suppliers. Each field provides the reference date for the other one. Replaces code like:
protected abstract SmartDateTimeParser<T>	createParser()	Creates the parser instance according to the concrete data type.
protected String	format(T value)	Formats the given value.
int	getDayWindow()
protected int	getDefaultDayWindow()	Gets the default day window for getDayWindow().
protected int	getDefaultMonthWindow()	Gets the default month window for getMonthWindow().
protected int	getDefaultYearWindow()	Gets the default value for getYearWindow().
List<SmartDateTimeParser.TextFilter>	getFilters()	Gets the list of filters.
List<SmartDateTimeParser.ErrorHandler>	getHandlers()	Gets the list of error handlers.
protected T	getLastValue()	Gets the last formatted value.
int	getMonthWindow()
protected SmartDateTimeParser<T>	getParser()	Gets the parser instance.
protected Supplier<?>	getReferenceDateSupplier()	Gets the reference date supplier.
List<SmartDateTimeParser.Shortcut>	getShortcuts()	Gets the list of default shortcuts.
int	getYearWindow()
protected T	parse(String s)	Parses the input.
<V extends Temporal> V	parse(SmartDateTimeParser<V> parser, V currentValue, String part)
SmartDateTimeParser.TextRange	test(SmartDateTimeParser<? extends Temporal> parser, String text)
Function<String,T>	toModelFunction()	Function to translate a view value to a model value.
Function<T,String>	toViewFunction()	Function to translate a model value to a view value.

Methods inherited from class org.tentackle.fx.translate.ValueStringTranslator

getComponent, getValidChars, toModel

Methods inherited from class org.tentackle.fx.translate.AbstractValueTranslator

isLenient, isMappingIncomplete, isModelModified, saveModelValue, setLenient

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.fx.ValueTranslator

bindingPropertiesUpdated, needsToModelTwice, toView

Field Details

REFERENCE_DATE_SUPPLIER

public static final String REFERENCE_DATE_SUPPLIER

Component property for a reference date supplier of type Supplier<T>.
'@' as input will be replaced by the supplier's date.
Example:

   blahField.getProperties.put(REFERENCE_DATE_SUPPLIER, (Supplier<LocalDate>) () -> otherDate);
 

See Also:

• connectAsReferenceDateSuppliers(FxTextComponent, FxTextComponent)
• Constant Field Values

YEAR_WINDOW

public static final String YEAR_WINDOW

Property to define the sliding year input window.

Example:

   blahField.getProperties().put(TemporalStringTranslator.YEAR_WINDOW, 30);
 

See Also:

• NumberShortcut.WindowProvider.getYearWindow()
• Constant Field Values

MONTH_WINDOW

public static final String MONTH_WINDOW

Property to define the sliding month input window.

Example:

   blahField.getProperties().put(TemporalStringTranslator.MONTH_WINDOW, 2);
 

See Also:

• NumberShortcut.WindowProvider.getMonthWindow()
• Constant Field Values

DAY_WINDOW

public static final String DAY_WINDOW

Property to define the sliding day input window.

Example:

   blahField.getProperties().put(TemporalStringTranslator.DAY_WINDOW, 1);
 

See Also:

• NumberShortcut.WindowProvider.getDayWindow()
• Constant Field Values

Constructor Details

TemporalStringTranslator

public TemporalStringTranslator(FxTextComponent component)

Creates a translator.

Parameters:

component - the text component

Method Details

connectAsReferenceDateSuppliers

public static void connectAsReferenceDateSuppliers(FxTextComponent a,
 FxTextComponent b)

Connects two fields as reference date suppliers.
Each field provides the reference date for the other one.
Replaces code like:

   fromField.getProperties().put(TemporalStringTranslator.REFERENCE_DATE_SUPPLIER, (Supplier) () -> until);
   untilField.getProperties().put(TemporalStringTranslator.REFERENCE_DATE_SUPPLIER, (Supplier) () -> from);
 

by

   TemporalStringTranslator.connectAsReferenceDateSuppliers(fromField, untilField);
 

Throws BindingException if one of the fields is not bound.

Parameters:

a - the first component

b - the second component

toViewFunction

public Function<T,String> toViewFunction()

Description copied from interface: ValueTranslator

Function to translate a model value to a view value.

Specified by:

toViewFunction in interface ValueTranslator<T extends Temporal,String>

Returns:

the function

toModelFunction

public Function<String,T> toModelFunction()

Description copied from interface: ValueTranslator

Function to translate a view value to a model value.

Specified by:

toModelFunction in interface ValueTranslator<T extends Temporal,String>

Returns:

the function

getReferenceDateSupplier

protected Supplier<?> getReferenceDateSupplier()

Gets the reference date supplier.

Returns:

the date supplier, null if none

getYearWindow

public int getYearWindow()

Specified by:

getYearWindow in interface NumberShortcut.WindowProvider

getDefaultYearWindow

protected int getDefaultYearWindow()

Gets the default value for getYearWindow().

Returns:

the default (50 years)

getMonthWindow

public int getMonthWindow()

Specified by:

getMonthWindow in interface NumberShortcut.WindowProvider

getDefaultMonthWindow

protected int getDefaultMonthWindow()

Gets the default month window for getMonthWindow().

Returns:

the default (-1 == disabled)

getDayWindow

public int getDayWindow()

Specified by:

getDayWindow in interface NumberShortcut.WindowProvider

getDefaultDayWindow

protected int getDefaultDayWindow()

Gets the default day window for getDayWindow().

Returns:

the default (-1 == disabled)

test

public SmartDateTimeParser.TextRange test(SmartDateTimeParser<? extends Temporal> parser,
 String text)

Specified by:

test in interface SmartDateTimeParser.Shortcut

parse

public <V extends Temporal> V parse(SmartDateTimeParser<V> parser,
 V currentValue,
 String part)

Specified by:

parse in interface SmartDateTimeParser.Shortcut

getShortcuts

public List<SmartDateTimeParser.Shortcut> getShortcuts()

Gets the list of default shortcuts.

Returns:

the list of shortcuts

getHandlers

public List<SmartDateTimeParser.ErrorHandler> getHandlers()

Gets the list of error handlers.

Returns:

the handlers

getFilters

public List<SmartDateTimeParser.TextFilter> getFilters()

Gets the list of filters.

Returns:

the list of filters

createParser

protected abstract SmartDateTimeParser<T> createParser()

Creates the parser instance according to the concrete data type.

Returns:

the parser

getParser

protected SmartDateTimeParser<T> getParser()

Gets the parser instance.

Returns:

the parser

format

protected String format(T value)

Formats the given value.

Parameters:

value - the temporal value

Returns:

the formatted string

getLastValue

protected T getLastValue()

Gets the last formatted value.

Returns:

the last date- or time formatted

parse

protected T parse(String s)

Parses the input.

Parameters:

s - the input string

Returns:

the model value