Module org.tentackle.fx

Package org.tentackle.fx.translate

Class I18NTextStringTranslator

java.lang.Object

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

org.tentackle.fx.translate.ValueStringTranslator<org.tentackle.common.I18NText>

org.tentackle.fx.translate.I18NTextStringTranslator

All Implemented Interfaces:

ValueTranslator<org.tentackle.common.I18NText,String>

@ValueTranslatorService(modelClass=org.tentackle.common.I18NText.class,
                        viewClass=java.lang.String.class)
public class I18NTextStringTranslator
extends ValueStringTranslator<org.tentackle.common.I18NText>

I18NText translator.

Author:

harald

Constructor Summary

Constructors

Constructor	Description
I18NTextStringTranslator(FxTextComponent component)

Method Summary

Modifier and Type	Method	Description
protected void	edit()
boolean	isMappingIncomplete()	Returns whether the model value is only mapped partially to the view. Such data types may hold more data that could have changed by the translator, but the view object still looks unchanged. An example for such a type is I18NText.
boolean	isModelModified()	Returns whether the model is modified compared to value saved via ValueTranslator.saveModelValue(Object). Only invoked if ValueTranslator.isMappingIncomplete() is true.
void	saveModelValue(org.tentackle.common.I18NText modelValue)	Remembers the model value for later check if changed. Only invoked if ValueTranslator.isMappingIncomplete() is true.
Function<String,org.tentackle.common.I18NText>	toModelFunction()	Function to translate a view value to a model value.
Function<org.tentackle.common.I18NText,String>	toViewFunction()	Function to translate a model value to a view value.
void	updateI18NText(org.tentackle.common.I18NText i18NText)	Updates the model with a new I18NText object. Invoked from I18NEditor.

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

getComponent, getValidChars, toModel

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

isLenient, 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

Constructor Details

I18NTextStringTranslator

public I18NTextStringTranslator(FxTextComponent component)

Method Details

isMappingIncomplete

public boolean isMappingIncomplete()

Description copied from interface: ValueTranslator

Returns whether the model value is only mapped partially to the view.
Such data types may hold more data that could have changed by the translator, but the view object still looks unchanged.
An example for such a type is I18NText.

Specified by:

isMappingIncomplete in interface ValueTranslator<org.tentackle.common.I18NText,String>

Overrides:

isMappingIncomplete in class AbstractValueTranslator<org.tentackle.common.I18NText,String>

Returns:

true if view may look unchanged but the model could be modified

saveModelValue

public void saveModelValue(org.tentackle.common.I18NText modelValue)

Description copied from interface: ValueTranslator

Remembers the model value for later check if changed.
Only invoked if ValueTranslator.isMappingIncomplete() is true.

Specified by:

saveModelValue in interface ValueTranslator<org.tentackle.common.I18NText,String>

Overrides:

saveModelValue in class AbstractValueTranslator<org.tentackle.common.I18NText,String>

Parameters:

modelValue - the model value

isModelModified

public boolean isModelModified()

Description copied from interface: ValueTranslator

Returns whether the model is modified compared to value saved via ValueTranslator.saveModelValue(Object).
Only invoked if ValueTranslator.isMappingIncomplete() is true.

Specified by:

isModelModified in interface ValueTranslator<org.tentackle.common.I18NText,String>

Overrides:

isModelModified in class AbstractValueTranslator<org.tentackle.common.I18NText,String>

Returns:

true if model is modified

toViewFunction

public Function<org.tentackle.common.I18NText,String> toViewFunction()

Description copied from interface: ValueTranslator

Function to translate a model value to a view value.

Returns:

the function

toModelFunction

public Function<String,org.tentackle.common.I18NText> toModelFunction()

Description copied from interface: ValueTranslator

Function to translate a view value to a model value.

Returns:

the function

updateI18NText

public void updateI18NText(org.tentackle.common.I18NText i18NText)

Updates the model with a new I18NText object.
Invoked from I18NEditor.

Parameters:

i18NText - the I18N text object

edit

protected void edit()