Package com.storedobject.vaadin.util

Class Data<T>

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

com.storedobject.vaadin.util.Data<T>

Type Parameters:

T - Type of the bean.

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class Data<T>
extends HashMap<String,Object>

Class that is internally handling Vaadin's Binder.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
Data(AbstractForm<T> form)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	addField(com.vaadin.flow.component.HasValue<?,?> field)	Add a field with auto-generated filed name.
String	addField(String fieldName, com.vaadin.flow.component.HasValue<?,?> field)	Add a field.
<F> void	addValidator(com.vaadin.flow.component.HasValue<?,F> field, Function<F,Boolean> validator, String errorMessage)	Add a validator for the given field.
void	clearErrors()	Clear all errors.
void	clearFields()	Clear all field values.
boolean	connect(Collection<com.vaadin.flow.component.HasValue<?,?>> fields)	Connect a collection of fields so that their values will be updated whenever any of the field value is changed.
com.vaadin.flow.data.binder.Binder<T>	getBinder()	Get the embedded binder.
com.vaadin.flow.component.HasText	getErrorDisplay()	Get the current error display.
com.vaadin.flow.component.HasValue<?,?>	getField(String fieldName)	Get the field for the given field name.
int	getFieldCount()	Get the number of fields.
Stream<String>	getFieldNames()	Get the names of all the fields.
Stream<com.vaadin.flow.component.HasValue<?,?>>	getFields()	Get all the fields.
FieldValueHandler	getFieldValueHandler()	Get the current field value handler.
static String	getLabel(com.vaadin.flow.component.HasValue<?,?> field)	Get the label for the given field.
String	getName(com.vaadin.flow.component.HasValue<?,?> field)	Get the name of the given field.
boolean	isReadOnly()	Is this read-only?
void	loadValues()	Load all the fields from the bean.
com.vaadin.flow.component.HasValue<?,?>	removeField(String fieldName)	Remove a field.
boolean	saveValues()	Save all the field values to the bean.
void	setErrorDisplay(com.vaadin.flow.component.HasText display)	Set the error display (If not set, a default mechanism is used to display errors and warnings).
void	setExtraErrors()	Set extra errors flag.
void	setFieldValueHandler(FieldValueHandler valueHandler)	Set the field value handler.
void	setReadOnly(boolean readOnly)	Set this as read-only.
<F> void	setRequired(com.vaadin.flow.component.HasValue<?,F> field, boolean required, String errorMessage)	Set the "required" attribute of the field.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

Data

public Data(AbstractForm<T> form)

Constructor.

Parameters:

form - Form that contains the fields.

Method Details

getBinder

public com.vaadin.flow.data.binder.Binder<T> getBinder()

Get the embedded binder.

Returns:

The binder.

setErrorDisplay

public void setErrorDisplay(com.vaadin.flow.component.HasText display)

Set the error display (If not set, a default mechanism is used to display errors and warnings).

Parameters:

display - Display to set.

getErrorDisplay

public com.vaadin.flow.component.HasText getErrorDisplay()

Get the current error display.

Returns:

Get the current error display.

setExtraErrors

public void setExtraErrors()

Set extra errors flag.

setFieldValueHandler

public void setFieldValueHandler(FieldValueHandler valueHandler)

Set the field value handler.

Parameters:

valueHandler - Field value handler.

getFieldValueHandler

public FieldValueHandler getFieldValueHandler()

Get the current field value handler.

Returns:

The field value handler.

addField

public String addField(com.vaadin.flow.component.HasValue<?,?> field)

Add a field with auto-generated filed name.

Parameters:

field - The field to add.

Returns:

Name of the field.

addField

public String addField(String fieldName,
 com.vaadin.flow.component.HasValue<?,?> field)

Add a field.

Parameters:

fieldName - Field name.

field - The field to add.

Returns:

Name of the field.

connect

public boolean connect(Collection<com.vaadin.flow.component.HasValue<?,?>> fields)

Connect a collection of fields so that their values will be updated whenever any of the field value is changed.

Parameters:

fields - Collection of fields to connect together.

Returns:

Returns true if the field list contains at least 2 fields.

isReadOnly

public boolean isReadOnly()

Is this read-only?

Returns:

True or false.

setReadOnly

public void setReadOnly(boolean readOnly)

Set this as read-only.

Parameters:

readOnly - True or false.

removeField

public com.vaadin.flow.component.HasValue<?,?> removeField(String fieldName)

Remove a field.

Parameters:

fieldName - Name of the field to remove.

Returns:

The field that is removed.

getName

public String getName(com.vaadin.flow.component.HasValue<?,?> field)

Get the name of the given field.

Parameters:

field - Filed.

Returns:

Name of the field.

getField

public com.vaadin.flow.component.HasValue<?,?> getField(String fieldName)

Get the field for the given field name.

Parameters:

fieldName - Field name.

Returns:

Field if found.

getFieldCount

public int getFieldCount()

Get the number of fields.

Returns:

Number of fields.

getFieldNames

public Stream<String> getFieldNames()

Get the names of all the fields.

Returns:

Names of all the fields.

getFields

public Stream<com.vaadin.flow.component.HasValue<?,?>> getFields()

Get all the fields.

Returns:

All the fields.

loadValues

public void loadValues()

Load all the fields from the bean.

saveValues

public boolean saveValues()

Save all the field values to the bean.

Returns:

True if the save is successful.

clearErrors

public void clearErrors()

Clear all errors.

clearFields

public void clearFields()

Clear all field values.

addValidator

public <F> void addValidator(com.vaadin.flow.component.HasValue<?,F> field,
 Function<F,Boolean> validator,
 String errorMessage)

Add a validator for the given field.

Type Parameters:

F - Field value type.

Parameters:

field - Field.

validator - Validator.

errorMessage - Error message to show when validation fails.

setRequired

public <F> void setRequired(com.vaadin.flow.component.HasValue<?,F> field,
 boolean required,
 String errorMessage)

Set the "required" attribute of the field.

Type Parameters:

F - Field value type.

Parameters:

field - Field.

required - True/false.

errorMessage - Error message to show when empty.

getLabel

public static String getLabel(com.vaadin.flow.component.HasValue<?,?> field)

Get the label for the given field.

Parameters:

field - Field.

Returns:

Label string if exists, otherwise null.