com.dlsc.formsfx.model.structure

Class DataField<P extends Property,V,F extends Field>

java.lang.Object

com.dlsc.formsfx.model.structure.Field<F>

com.dlsc.formsfx.model.structure.DataField<P,V,F>

Direct Known Subclasses:

BooleanField, DoubleField, IntegerField, StringField

public class DataField<P extends Property,V,F extends Field>
extends Field<F>

DataField holds a single value. This value can be represented and manipulated as a String. It is stored as a concrete type.

Author:

Sacha Schmid, Rinesch Murugathas

Property Summary

Type	Property and Description
StringProperty	userInput
P	value Every field tracks its value in multiple ways.

Properties inherited from class com.dlsc.formsfx.model.structure.Field

changedProperty, editableProperty, errorMessagesProperty, idProperty, labelProperty, placeholderProperty, requiredProperty, spanProperty, styleClassProperty, tooltipProperty, validProperty

Method Summary

Modifier and Type	Method and Description
F	bind(P binding) Binds the given property with the field.
F	format(String errorMessage) Adds an error message to handle formatting errors with the default value transformers.
F	format(ValueTransformer<V> newValue) Sets the value transformer for the current field.
F	format(ValueTransformer<V> newValue, String errorMessage) Applies a new value transformer that converts the entered string input to a concrete value.
String	getUserInput() Gets the value of the property userInput.
V	getValue() Gets the value of the property value.
void	setBindingMode(BindingMode newValue) Activates or deactivates the bindingModeListener based on the given BindingMode.
F	unbind(P binding) Unbinds the given property with the field.
StringProperty	userInputProperty()
F	validate(Validator<V>... newValue) Sets the list of validators for the current field.
protected boolean	validateRequired(String newValue) Validates that the new field input matches the required condition.
P	valueProperty() Every field tracks its value in multiple ways.

Methods inherited from class com.dlsc.formsfx.model.structure.Field

changedProperty, editable, editableProperty, errorMessagesProperty, getErrorMessages, getID, getLabel, getPlaceholder, getRenderer, getSpan, getStyleClass, getTooltip, hasChanged, id, idProperty, isEditable, isI18N, isRequired, isValid, label, labelProperty, ofBooleanType, ofBooleanType, ofDoubleType, ofDoubleType, ofIntegerType, ofIntegerType, ofMultiSelectionType, ofMultiSelectionType, ofMultiSelectionType, ofSingleSelectionType, ofSingleSelectionType, ofSingleSelectionType, ofStringType, ofStringType, placeholder, placeholderProperty, render, required, required, requiredProperty, span, span, spanProperty, styleClass, styleClassProperty, tooltip, tooltipProperty, validProperty

Methods inherited from class java.lang.Object

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

Property Detail

userInput

public StringProperty userInputProperty

See Also:

getUserInput()

value

public P extends Property valueProperty

Every field tracks its value in multiple ways. - The user input is bound to a specific control's input value and is a 1-to-1 representation of what the user enters. - The value is the last valid value entered by the user. This means that the value passes the type transformation of the concrete field and all user-defined validations. - The persistent value is the value that was last saved on the field. It is the responsibility of the form creator to persist the field values at the correct time.

See Also:

getValue()

Method Detail

format

public F format(ValueTransformer<V> newValue)

Sets the value transformer for the current field.

Parameters:

newValue - The value transformer that parses the user input string to the field's underlying value.

Returns:

Returns the current field to allow for chaining.

format

public F format(ValueTransformer<V> newValue,
                String errorMessage)

Applies a new value transformer that converts the entered string input to a concrete value.

Parameters:

newValue - The new value transformer. Takes a string as an input and returns the concrete type.

errorMessage - The error message to display if the transformation was unsuccessful.

Returns:

Returns the current field to allow for chaining.

format

public F format(String errorMessage)

Adds an error message to handle formatting errors with the default value transformers.

Parameters:

errorMessage - The error message to display if the transformation was unsuccessful.

Returns:

Returns the current field to allow for chaining.

validate

@SafeVarargs
public final F validate(Validator<V>... newValue)

Sets the list of validators for the current field. This overrides all validators that have previously been added.

Parameters:

newValue - The validators that are to be used for validating this field. Limited to validators that are able to handle the field's underlying type.

Returns:

Returns the current field to allow for chaining.

bind

public F bind(P binding)

Binds the given property with the field.

Parameters:

binding - The property to be bound with.

Returns:

Returns the current field to allow for chaining.

unbind

public F unbind(P binding)

Unbinds the given property with the field.

Parameters:

binding - The property to be unbound with.

Returns:

Returns the current field to allow for chaining.

setBindingMode

public void setBindingMode(BindingMode newValue)

Activates or deactivates the bindingModeListener based on the given BindingMode.

Parameters:

newValue - The new binding mode for the current field.

validateRequired

protected boolean validateRequired(String newValue)

Validates that the new field input matches the required condition.

Parameters:

newValue - The new value to check for the required state.

Returns:

Returns whether the input matches the required condition.

getUserInput

public String getUserInput()

Gets the value of the property userInput.

userInputProperty

public StringProperty userInputProperty()

See Also:

getUserInput()

getValue

public V getValue()

Gets the value of the property value.

valueProperty

public P valueProperty()

Every field tracks its value in multiple ways. - The user input is bound to a specific control's input value and is a 1-to-1 representation of what the user enters. - The value is the last valid value entered by the user. This means that the value passes the type transformation of the concrete field and all user-defined validations. - The persistent value is the value that was last saved on the field. It is the responsibility of the form creator to persist the field values at the correct time.

See Also:

getValue()