Module org.tentackle.fx

Package org.tentackle.fx

Class FxTextComponentDelegate

java.lang.Object

org.tentackle.fx.FxControlDelegate

org.tentackle.fx.FxComponentDelegate

org.tentackle.fx.FxTextComponentDelegate

All Implemented Interfaces:

java.util.function.Function<javafx.scene.control.TextFormatter.Change,javafx.scene.control.TextFormatter.Change>, java.util.function.UnaryOperator<javafx.scene.control.TextFormatter.Change>, ErrorPopupSupported, FxComponent, FxControl, FxTextComponent, InfoPopupSupported

Direct Known Subclasses:

AbstractTextFieldDelegate, FxComboBoxDelegate, FxDatePickerDelegate, FxHTMLEditorDelegate

public abstract class FxTextComponentDelegate
extends FxComponentDelegate
implements FxTextComponent, java.util.function.UnaryOperator<javafx.scene.control.TextFormatter.Change>

Delegate implementing FxComponent.

Author:

harald

Field Summary

Fields inherited from class org.tentackle.fx.FxComponentDelegate

ERROR_STYLE, INFO_STYLE, MANDATORY_STYLE

Constructor Summary

Constructors

Constructor	Description
FxTextComponentDelegate()

Method Summary

Modifier and Type	Method	Description
javafx.scene.control.TextFormatter.Change	apply(javafx.scene.control.TextFormatter.Change t)
void	autoSelect()	Selects or deselects all text in the text input.
protected javafx.beans.property.ReadOnlyBooleanWrapper	createChangeableProperty(boolean changeable)	Creates the changeable property.
protected ValueTranslator<?,?>	createValueTranslator(java.lang.Class<?> type)
java.lang.String	filter(java.lang.String text)	Filters input characters.
CaseConversion	getCaseConversion()	Gets the case conversion.
java.lang.Integer	getErrorOffset()	Gets the error offset.
char	getFiller()	Gets the filler character.
java.lang.String	getInvalidChars()	Gets invalid characters.
int	getMaxColumns()	Gets the maximum number of columns.
java.lang.String	getPattern()	Gets the format pattern.
int	getScale()	Gets the current scale.
javafx.geometry.Pos	getTextAlignment()	Gets the text alignment.
protected FxTextComponent	getTextComponent()	Gets the text component.
java.util.function.Function<java.lang.String,java.lang.String>	getTextConverter()	Gets the text converter.
java.lang.String	getValidChars()	Gets allowed characters.
boolean	isAutoSelect()	Returns whether the auto-select feature is enabled.
boolean	isLenient()	Returns whether parsing to model should be lenient.
boolean	isUnsigned()	Returns whether a numeric field is unsigned or signed.
boolean	isUTC()	Returns whether this is a UTC timestamp.
void	saveView()	Creates a copy of the value shown to the user.
void	setAutoSelect(boolean autoSelect)	Sets the auto-select feature. A component with autoselect enabled will automatically select all characters if the component gets the keyboard focus.
void	setCaseConversion(CaseConversion caseConversion)	Sets the case conversion.
void	setContainerChangeable(boolean containerChangeable)	Invoked when setChangeable() is invoked on the container of this component.
void	setError(java.lang.String errorMessage)	Sets the error message. Notice that an empty string will set the style but dows not show any popup.
void	setErrorOffset(java.lang.Integer errorOffset)	Sets the error offset.
void	setFiller(char filler)	Sets the filler character. The default is space.
void	setInvalidChars(java.lang.String invalidChars)	Sets invalid characters.
void	setLenient(boolean lenient)	Sets whether parsing to model should be lenient.
void	setMaxColumns(int maxColumns)	Sets the maximum number of columns. The number of columns will be enforced by the model.
void	setPattern(java.lang.String pattern)	Sets the format pattern. The format pattern is used to format the view of the data.
void	setScale(int scale)	Changes the format according to the given scale.
void	setTextAlignment(javafx.geometry.Pos textAlignment)	Sets the text alignment.
void	setTextConverter(java.util.function.Function<java.lang.String,java.lang.String> textConverter)	Sets a text converter. Converts input text to the view's text.
void	setType(java.lang.Class<?> type)	Sets the type for this component.
void	setUnsigned(boolean unsigned)	Sets whether a numeric field is unsigned or signed.
void	setUTC(boolean utc)	Sets whether this is a UTC timestamp.
void	setValidChars(java.lang.String validChars)	Sets allowed characters.
void	showErrorPopup()	Shows the error popup. Requires the error message set.
void	triggerViewModified()	Walks up the component hierarchy and updates the viewModified property. This is done by comparing the saved view value with the current view.
protected void	updateChangeable(boolean changeable)	Updates other properties if changeable is bound to something else.
protected void	updateMandatoryStyle(boolean mandatory)	Does the physical update of the style.
void	updateModel()	Updates the model according to the view.
void	updateView()	Updates the view according to the model.

Methods inherited from class org.tentackle.fx.FxComponentDelegate

getBinding, getBindingPath, getComponent, getComponentPath, getDelegate, getError, getGenericType, getInfo, getNode, getParentContainer, getSavedViewObject, getTableCell, getType, getValueTranslator, handleInputFailure, hideErrorPopup, hideInfoPopup, invalidateSavedView, isErrorTemporary, isMandatory, isModelUpdated, isSavedViewObjectValid, isUpdatingModel, isUpdatingView, mandatoryProperty, setBinding, setBindingPath, setComponentPath, setErrorTemporary, setGenericType, setInfo, setMandatory, setTableCell, setValueTranslator, showInfoPopup, toGenericString, toString, updateErrorStyle, updateInfoStyle

Methods inherited from class org.tentackle.fx.FxControlDelegate

addModelToViewListener, addViewToModelListener, changeableProperty, fireModelToViewListeners, fireViewToModelListeners, getHelpUrl, getModelToViewListeners, getViewToModelListeners, isBindable, isChangeable, isContainerChangeableIgnored, isControlChangeable, isViewModified, removeModelToViewListener, removeViewToModelListener, setBindable, setChangeable, setContainerChangableIgnored, setHelpUrl, setViewModified, showHelp, viewModifiedProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.fx.ErrorPopupSupported

getError, hideErrorPopup, isErrorTemporary, setErrorTemporary

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.tentackle.fx.FxComponent

getBinding, getBindingPath, getComponentPath, getDelegate, getGenericType, getSavedViewObject, getTableCell, getType, getValueTranslator, getViewObject, getViewValue, isMandatory, isModelUpdated, isSavedViewObjectValid, mandatoryProperty, setBinding, setBindingPath, setComponentPath, setGenericType, setMandatory, setTableCell, setValueTranslator, setViewObject, setViewValue

Methods inherited from interface org.tentackle.fx.FxControl

addModelToViewListener, addViewToModelListener, changeableProperty, getHelpUrl, getParentContainer, invalidateSavedView, isBindable, isChangeable, isContainerChangeableIgnored, isViewModified, removeModelToViewListener, removeViewToModelListener, setBindable, setChangeable, setContainerChangableIgnored, setHelpUrl, setViewModified, showHelp, toGenericString, viewModifiedProperty

Methods inherited from interface org.tentackle.fx.FxTextComponent

getColumns, mapErrorOffsetToCaretPosition, setColumns

Methods inherited from interface org.tentackle.fx.InfoPopupSupported

getInfo, hideInfoPopup, setInfo, showInfoPopup

Constructor Detail

FxTextComponentDelegate

public FxTextComponentDelegate()

Method Detail

getTextComponent

protected FxTextComponent getTextComponent()

Gets the text component.

Returns:

the text component

updateChangeable

protected void updateChangeable(boolean changeable)

Description copied from class: FxControlDelegate

Updates other properties if changeable is bound to something else.

Overrides:

updateChangeable in class FxComponentDelegate

Parameters:

changeable - the flag

updateMandatoryStyle

protected void updateMandatoryStyle(boolean mandatory)

Description copied from class: FxComponentDelegate

Does the physical update of the style. See resources/org/tentackle/fx/tentackle.css

Overrides:

updateMandatoryStyle in class FxComponentDelegate

Parameters:

mandatory - true if mandatory

createChangeableProperty

protected javafx.beans.property.ReadOnlyBooleanWrapper createChangeableProperty(boolean changeable)

Description copied from class: FxControlDelegate

Creates the changeable property.

Overrides:

createChangeableProperty in class FxComponentDelegate

Parameters:

changeable - the initial value

Returns:

the property

setContainerChangeable

public void setContainerChangeable(boolean containerChangeable)

Description copied from interface: FxControl

Invoked when setChangeable() is invoked on the container of this component.

Specified by:

setContainerChangeable in interface FxControl

Overrides:

setContainerChangeable in class FxComponentDelegate

Parameters:

containerChangeable - true if container is changeable, false if all components readonly

getErrorOffset

public java.lang.Integer getErrorOffset()

Description copied from interface: FxTextComponent

Gets the error offset.

Specified by:

getErrorOffset in interface FxTextComponent

Returns:

the offset, null if no offset

setErrorOffset

public void setErrorOffset(java.lang.Integer errorOffset)

Description copied from interface: FxTextComponent

Sets the error offset.

Specified by:

setErrorOffset in interface FxTextComponent

Parameters:

errorOffset - null to clear

setError

public void setError(java.lang.String errorMessage)

Description copied from interface: ErrorPopupSupported

Sets the error message.
Notice that an empty string will set the style but dows not show any popup.

Specified by:

setError in interface ErrorPopupSupported

Overrides:

setError in class FxComponentDelegate

Parameters:

errorMessage - the error message, null to clear

showErrorPopup

public void showErrorPopup()

Description copied from interface: ErrorPopupSupported

Shows the error popup.
Requires the error message set.

Specified by:

showErrorPopup in interface ErrorPopupSupported

Overrides:

showErrorPopup in class FxComponentDelegate

triggerViewModified

public void triggerViewModified()

Description copied from interface: FxControl

Walks up the component hierarchy and updates the viewModified property.
This is done by comparing the saved view value with the current view.

Specified by:

triggerViewModified in interface FxControl

Overrides:

triggerViewModified in class FxComponentDelegate

updateView

public void updateView()

Description copied from interface: FxControl

Updates the view according to the model.

Specified by:

updateView in interface FxControl

Overrides:

updateView in class FxComponentDelegate

updateModel

public void updateModel()

Description copied from interface: FxControl

Updates the model according to the view.

Specified by:

updateModel in interface FxControl

Overrides:

updateModel in class FxComponentDelegate

saveView

public void saveView()

Description copied from interface: FxControl

Creates a copy of the value shown to the user.

Specified by:

saveView in interface FxControl

Overrides:

saveView in class FxComponentDelegate

setValidChars

public void setValidChars(java.lang.String validChars)

Description copied from interface: FxTextComponent

Sets allowed characters.

Specified by:

setValidChars in interface FxTextComponent

Parameters:

validChars - the valid characters, null = all (default)

getValidChars

public java.lang.String getValidChars()

Description copied from interface: FxTextComponent

Gets allowed characters.

Specified by:

getValidChars in interface FxTextComponent

Returns:

the valid characters, null = all (default)

setInvalidChars

public void setInvalidChars(java.lang.String invalidChars)

Description copied from interface: FxTextComponent

Sets invalid characters.

Specified by:

setInvalidChars in interface FxTextComponent

Parameters:

invalidChars - the invalid characters, null = none (default)

getInvalidChars

public java.lang.String getInvalidChars()

Description copied from interface: FxTextComponent

Gets invalid characters.

Specified by:

getInvalidChars in interface FxTextComponent

Returns:

the invalid characters, null = none (default)

setTextConverter

public void setTextConverter(java.util.function.Function<java.lang.String,java.lang.String> textConverter)

Description copied from interface: FxTextComponent

Sets a text converter.
Converts input text to the view's text.

Specified by:

setTextConverter in interface FxTextComponent

Parameters:

textConverter - the converter

getTextConverter

public java.util.function.Function<java.lang.String,java.lang.String> getTextConverter()

Description copied from interface: FxTextComponent

Gets the text converter.

Specified by:

getTextConverter in interface FxTextComponent

Returns:

the converter

apply

public javafx.scene.control.TextFormatter.Change apply(javafx.scene.control.TextFormatter.Change t)

Specified by:

apply in interface java.util.function.Function<javafx.scene.control.TextFormatter.Change,javafx.scene.control.TextFormatter.Change>

filter

public java.lang.String filter(java.lang.String text)

Filters input characters.

Parameters:

text - the input text, never null

Returns:

the filtered text, never null

setTextAlignment

public void setTextAlignment(javafx.geometry.Pos textAlignment)

Description copied from interface: FxTextComponent

Sets the text alignment.

Specified by:

setTextAlignment in interface FxTextComponent

Parameters:

textAlignment - the alignment, null if component's default

getTextAlignment

public javafx.geometry.Pos getTextAlignment()

Description copied from interface: FxTextComponent

Gets the text alignment.

Specified by:

getTextAlignment in interface FxTextComponent

Returns:

the alignment, null if component's default

setType

public void setType(java.lang.Class<?> type)

Description copied from interface: FxComponent

Sets the type for this component.

Notice that the type can be applied only once. This is because previously installed listeners could cause memleaks.

Specified by:

setType in interface FxComponent

Overrides:

setType in class FxComponentDelegate

Parameters:

type - the type

createValueTranslator

protected ValueTranslator<?,?> createValueTranslator(java.lang.Class<?> type)

setMaxColumns

public void setMaxColumns(int maxColumns)

Description copied from interface: FxTextComponent

Sets the maximum number of columns.
The number of columns will be enforced by the model.

Specified by:

setMaxColumns in interface FxTextComponent

Parameters:

maxColumns - the maximum number of columns, 0 if unlimited (default)

getMaxColumns

public int getMaxColumns()

Description copied from interface: FxTextComponent

Gets the maximum number of columns.

Specified by:

getMaxColumns in interface FxTextComponent

Returns:

the maximum number of columns, 0 if unlimited (default)

setAutoSelect

public void setAutoSelect(boolean autoSelect)

Description copied from interface: FxTextComponent

Sets the auto-select feature.
A component with autoselect enabled will automatically select all characters if the component gets the keyboard focus. Useful for numerical fields, for example.

Specified by:

setAutoSelect in interface FxTextComponent

Parameters:

autoSelect - true if autoselect enabled, false if disabled (default)

isAutoSelect

public boolean isAutoSelect()

Description copied from interface: FxTextComponent

Returns whether the auto-select feature is enabled.

Specified by:

isAutoSelect in interface FxTextComponent

Returns:

true if autoselect enabled, false if disabled (default)

setPattern

public void setPattern(java.lang.String pattern)

Description copied from interface: FxTextComponent

Sets the format pattern.
The format pattern is used to format the view of the data.

Specified by:

setPattern in interface FxTextComponent

Parameters:

pattern - the format pattern

getPattern

public java.lang.String getPattern()

Description copied from interface: FxTextComponent

Gets the format pattern.

Specified by:

getPattern in interface FxTextComponent

Returns:

the format pattern

isLenient

public boolean isLenient()

Description copied from interface: FxTextComponent

Returns whether parsing to model should be lenient.

Specified by:

isLenient in interface FxTextComponent

Returns:

true if lenient, false is default

setLenient

public void setLenient(boolean lenient)

Description copied from interface: FxTextComponent

Sets whether parsing to model should be lenient.

Specified by:

setLenient in interface FxTextComponent

Parameters:

lenient - true if lenient

setScale

public void setScale(int scale)

Description copied from interface: FxTextComponent

Changes the format according to the given scale.

Specified by:

setScale in interface FxTextComponent

Parameters:

scale - the number of digits after the comma

getScale

public int getScale()

Description copied from interface: FxTextComponent

Gets the current scale.

Specified by:

getScale in interface FxTextComponent

Returns:

the scale

isUnsigned

public boolean isUnsigned()

Description copied from interface: FxTextComponent

Returns whether a numeric field is unsigned or signed.

Specified by:

isUnsigned in interface FxTextComponent

Returns:

true if unsigned

setUnsigned

public void setUnsigned(boolean unsigned)

Description copied from interface: FxTextComponent

Sets whether a numeric field is unsigned or signed.

Specified by:

setUnsigned in interface FxTextComponent

Parameters:

unsigned - true if unsigned

isUTC

public boolean isUTC()

Description copied from interface: FxTextComponent

Returns whether this is a UTC timestamp.

Specified by:

isUTC in interface FxTextComponent

Returns:

true if UTC

setUTC

public void setUTC(boolean utc)

Description copied from interface: FxTextComponent

Sets whether this is a UTC timestamp.

Specified by:

setUTC in interface FxTextComponent

Parameters:

utc - true if UTC

setCaseConversion

public void setCaseConversion(CaseConversion caseConversion)

Description copied from interface: FxTextComponent

Sets the case conversion.

Specified by:

setCaseConversion in interface FxTextComponent

Parameters:

caseConversion - the conversion, null if no conversion (default)

getCaseConversion

public CaseConversion getCaseConversion()

Description copied from interface: FxTextComponent

Gets the case conversion.

Specified by:

getCaseConversion in interface FxTextComponent

Returns:

the conversion, null if no conversion (default)

setFiller

public void setFiller(char filler)

Description copied from interface: FxTextComponent

Sets the filler character.
The default is space.

Specified by:

setFiller in interface FxTextComponent

Parameters:

filler - the filler

getFiller

public char getFiller()

Description copied from interface: FxTextComponent

Gets the filler character.

Specified by:

getFiller in interface FxTextComponent

Returns:

the filler

autoSelect

public void autoSelect()

Description copied from interface: FxTextComponent

Selects or deselects all text in the text input.

Specified by:

autoSelect in interface FxTextComponent

See Also:

FxTextComponent.isAutoSelect()