Package com.storedobject.vaadin

Class AbstractDataEditor<T>

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.AbstractDataForm<T>

com.storedobject.vaadin.AbstractDataEditor<T>

Type Parameters:

T - Type of object to be edited

All Implemented Interfaces:

ClickHandler, ExecutableView, HasContainer, ValueChangeHandler, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, com.vaadin.flow.component.HasValue.ValueChangeListener, Serializable, Runnable, EventListener

Direct Known Subclasses:

DataEditor, ObjectEditor

public abstract class AbstractDataEditor<T>
extends AbstractDataForm<T>

A view that is used for creating "data entry forms" for a particular type of object. The "form" embedded in this is an ObjectForm. Please refer to ObjectForm for a detailed explanation of how the "form" is generated. Many of the methods in this are delegated to the embedded "form".

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractDataEditor.DForm	Form to be used internally.

Nested classes/interfaces inherited from class com.storedobject.vaadin.AbstractDataForm

AbstractDataForm.FieldError

Nested classes/interfaces inherited from interface com.storedobject.vaadin.ClickHandler

ClickHandler.ModifiedClickEvent<C extends com.vaadin.flow.component.Component>

Field Summary

Fields inherited from class com.storedobject.vaadin.AbstractDataForm

form

Constructor Summary

Constructors

Constructor	Description
AbstractDataEditor(Class<T> objectClass)	Constructor
AbstractDataEditor(Class<T> objectClass, String caption)	Constructor

Method Summary

Modifier and Type	Method	Description
protected <V> String	addField(com.vaadin.flow.component.HasValue<?,V> field, Function<T,V> valueGetter)	Add an extra field
protected <V> String	addField(com.vaadin.flow.component.HasValue<?,V> field, Function<T,V> valueGetter, BiConsumer<T,V> valueSetter)	Add an extra field
protected void	addField(Iterable<String> fieldNames)	Add extra fields.
protected void	addField(String... fieldNames)	Add extra fields.
protected void	addField(String fieldName, Method getMethod)	Add an extra field
protected void	addField(String fieldName, Method getMethod, Method setMethod)	Add an extra field
protected void	addField(String fieldName, Function<T,?> valueGetter)	Add an extra field
protected void	addField(String fieldName, Function<T,?> valueGetter, BiConsumer<T,?> valueSetter)	Add an extra field
protected final com.vaadin.flow.component.HasValue<?,?>	constructField(String fieldName)	Construct a field for the given field name.
protected com.vaadin.flow.component.HasValue<?,?>	createField(String fieldName, Class<?> fieldType, String label)	Create the field for the particular name..
protected T	createObjectInstance()	Create an instance of the object.
protected void	customizeField(String fieldName, com.vaadin.flow.component.HasValue<?,?> field)	Customize a field.
Class<T>	getDataClass()	Get the class of the object being edited.
protected ObjectFieldCreator<T>	getFieldCreator()	Get the "field creator" for this form.
protected Method	getFieldGetMethod(String fieldName)	Get the field's "get" method.
Stream<String>	getFieldNames()	Get the names of the fields to be generated in the form.
protected int	getFieldOrder(String fieldName)	Get the order in which a field to appear in the form.
protected Method	getFieldSetMethod(String fieldName, Method getMethod)	Get the field's "set" method.
ObjectForm<T>	getForm()	Get the form embedded in this view.
T	getObject()	Get the instance of the currently editing object.
Class<T>	getObjectClass()	Get the class of the object being edited.
protected boolean	handleValueSetError(String fieldName, com.vaadin.flow.component.HasValue<?,?> field, Object fieldValue, Object objectValue, Throwable error)	Handle errors while setting (committing) values.
protected boolean	includeField(String fieldName)	Check whether field should be included in the form or not.
final boolean	isFieldIncluded(String fieldName)	Check whether this field was included while creating this editor or not.
final T	newObject()	Create an instance of the object (public method).
void	setFixedValue(com.vaadin.flow.component.HasValue<?,?> field, Object value)	Set a fixed value for a field.
void	setFixedValue(String fieldName, Object value)	Set a fixed value for a field.
void	setFixedValues(T object)	Set the attributes of the object with "fixed values" from the respective fields if fixed values are defined using setFixedValue(String, Object) or setFixedValue(HasValue, Object) method for those attributes.
void	setObject(T object)	Set the current object.
void	setObject(T object, boolean load)	Set the current object.

Methods inherited from class com.storedobject.vaadin.AbstractDataForm

add, addConstructedListener, addField, addField, addIncludeFieldChecker, addValidator, addValidator, attachField, clean, clearAlerts, clearError, clearErrors, clearFields, commit, connect, connect, connect, createButtonLayout, createField, createField, createFieldContainer, createLayout, detachField, fieldAttached, fieldDetached, fireFormConstructed, formConstructed, getColumns, getColumnSpan, getContainer, getContent, getData, getErrorDisplay, getField, getFieldLabel, getFieldLabel, getFieldName, getLabel, isFieldEditable, isFieldEditable, isFieldVisible, isFieldVisible, isReadOnly, load, markError, newLine, remove, removeAll, removeField, removeField, removeField, setColumns, setColumnSpan, setErrorDisplay, setFieldContainerProvider, setFieldCustomizer, setFieldEditable, setFieldEditable, setFieldHidden, setFieldHidden, setFieldLabel, setFieldLabel, setFieldReadOnly, setFieldReadOnly, setFieldReadOnly, setFieldReadOnly, setFieldVisible, setFieldVisible, setFieldVisible, setFieldVisible, setIncludeFieldChecker, setReadOnly, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, streamFieldNamesCreated, streamFieldsCreated

Methods inherited from class com.storedobject.vaadin.View

abort, aborted, addClosedListener, addOpenedListener, close, createCloseableView, createWindow, decorateComponent, execute, execute, execute, executing, focus, focus, focusAny, getApplication, getCaption, getComponent, getCreatedBy, getEmbeddedView, getMenuItem, getMenuItem, getView, initUI, invoke, isFullScreen, isScrollable, isWindowMode, select, setCaption, setComponent, setCreatedBy, setDefaultPadding, setEmbeddedView, setFirstFocus, setFullScreen, setScrollable, setWindowMode, skipFirstFocus

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface com.storedobject.vaadin.ExecutableView

clicked, createMenuItem, error, getMenuIconName, getView, isCloseable, isHomeView, log, log, message, returnedFrom, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

AbstractDataEditor

public AbstractDataEditor(Class<T> objectClass)

Constructor

Parameters:

objectClass - Type of class to be edited

AbstractDataEditor

public AbstractDataEditor(Class<T> objectClass,
 String caption)

Constructor

Parameters:

objectClass - Type of class to be edited

caption - Caption of the view

Method Details

getForm

public ObjectForm<T> getForm()

Description copied from class: AbstractDataForm

Get the form embedded in this view.

Overrides:

getForm in class AbstractDataForm<T>

Returns:

Form

getObjectClass

public Class<T> getObjectClass()

Get the class of the object being edited. (Same as getDataClass().

Returns:

Object's class.

getDataClass

public Class<T> getDataClass()

Get the class of the object being edited. (Same as getObjectClass().

Returns:

Object's class.

getFieldNames

public Stream<String> getFieldNames()

Get the names of the fields to be generated in the form. This can be overridden to generate a custom list.

Overrides:

getFieldNames in class AbstractDataForm<T>

Returns:

Stream of field names.

getFieldGetMethod

protected Method getFieldGetMethod(String fieldName)

Get the field's "get" method. The default implementation checks for both getXXX and isXXX methods.

Parameters:

fieldName - Name of the field

Returns:

Field' "get" method (if method is found, it will returns null).

getFieldSetMethod

protected Method getFieldSetMethod(String fieldName,
 Method getMethod)

Get the field's "set" method. The default implementation checks both availability of setXXX method.

Parameters:

fieldName - Name of the field

getMethod - "get" method of this field (determined through getFieldGetMethod(String))

Returns:

Field' "set" method (if method is found, it will returns null).

addField

protected void addField(Iterable<String> fieldNames)

Add extra fields.

Parameters:

fieldNames - Names of the fields to be added

addField

protected void addField(String... fieldNames)

Add extra fields.

Parameters:

fieldNames - Names of the fields to be added

addField

protected <V> String addField(com.vaadin.flow.component.HasValue<?,V> field,
 Function<T,V> valueGetter)

Add an extra field

Type Parameters:

V - Value type of the field.

Parameters:

field - Field.

valueGetter - Function that determines how to get the value to load the field

Returns:

A field name will be generated (starting with an underscore character followed by a random number) and returned.

addField

protected <V> String addField(com.vaadin.flow.component.HasValue<?,V> field,
 Function<T,V> valueGetter,
 BiConsumer<T,V> valueSetter)

Add an extra field

Type Parameters:

V - Value type of the field.

Parameters:

field - Field.

valueGetter - Function that determines how to get the value to load the field

valueSetter - Function that determines how to commit value from the field to the object's instance

Returns:

A field name will be generated (starting with an underscore character followed by a random number) and returned.

addField

protected void addField(String fieldName,
 Function<T,?> valueGetter)

Add an extra field

Parameters:

fieldName - Name of the field.

valueGetter - Function that determines how to get the value to load the field.

addField

protected void addField(String fieldName,
 Function<T,?> valueGetter,
 BiConsumer<T,?> valueSetter)

Add an extra field

Parameters:

fieldName - Name of the field.

valueGetter - Function that determines how to get the value to load the field

valueSetter - Function that determines how to commit value from the field to the object's instance

addField

protected void addField(String fieldName,
 Method getMethod)

Add an extra field

Parameters:

fieldName - Name of the field.

getMethod - Method that determines how to get the value to load the field

addField

protected void addField(String fieldName,
 Method getMethod,
 Method setMethod)

Add an extra field

Parameters:

fieldName - Name of the field.

getMethod - Method that determines how to get the value to load the field

setMethod - Method that determines how to commit the value from the field to the object's instance

includeField

protected boolean includeField(String fieldName)

Check whether field should be included in the form or not.

Parameters:

fieldName - Name of the field.

Returns:

True or false. (Default return value is true).

isFieldIncluded

public final boolean isFieldIncluded(String fieldName)

Check whether this field was included while creating this editor or not.

Parameters:

fieldName - Name of the field.

Returns:

True or false.

customizeField

protected void customizeField(String fieldName,
 com.vaadin.flow.component.HasValue<?,?> field)

Customize a field. This method is invoked when a field is created. One may do some customization here.

Parameters:

fieldName - Name of the field

field - Field

createField

protected com.vaadin.flow.component.HasValue<?,?> createField(String fieldName,
 Class<?> fieldType,
 String label)

Create the field for the particular name.. Default implementation try to obtain the value from the "field creator" (ObjectFieldCreator.createField(String, Class, String)).

Parameters:

fieldName - Name of the field

fieldType - Type of the field's value

label - Label

Returns:

Field

constructField

protected final com.vaadin.flow.component.HasValue<?,?> constructField(String fieldName)

Construct a field for the given field name. (For internal purpose only).

Parameters:

fieldName - Field name

Returns:

Field

getFieldCreator

protected ObjectFieldCreator<T> getFieldCreator()

Get the "field creator" for this form. By default, it tries to obtain it from ApplicationEnvironment.getObjectFieldCreator().

Returns:

Field creator.

getFieldOrder

protected int getFieldOrder(String fieldName)

Get the order in which a field to appear in the form. Any integer value can be returned and the field is placed in the form in ascending order of the values returned by this method. Default implementation try to obtain the value from the "field creator" (ObjectFieldCreator.getFieldOrder(String)).

Parameters:

fieldName - Name of the field

Returns:

Field order.

createObjectInstance

protected T createObjectInstance()

Create an instance of the object. Default implementation tries to invoke the default constructor to create an instance and fixed values will be set if defined.

Returns:

Newly created object.

newObject

public final T newObject()

Create an instance of the object (public method).

Returns:

Newly created object.

getObject

public T getObject()

Get the instance of the currently editing object. (A new object will be created by invoking createObjectInstance() if there is no current object instance set).

Returns:

Instance of the currently loaded object.

setObject

public void setObject(T object)

Set the current object. Fields will be loaded.

Parameters:

object - Object to set

setObject

public void setObject(T object,
 boolean load)

Set the current object. Fields will be loaded.

Parameters:

object - Object to set

load - Whether to load the fields or not

setFixedValue

public void setFixedValue(String fieldName,
 Object value)

Set a fixed value for a field. If a fixed value is set, that value will be set to the corresponding attribute of the object when a new instance is created. (The field value may be still overwritten).

Parameters:

fieldName - Name of the field

value - Value to be set as fixed value

setFixedValue

public void setFixedValue(com.vaadin.flow.component.HasValue<?,?> field,
 Object value)

Set a fixed value for a field. If a fixed value is set, that value will be set to the corresponding attribute of the object when a new instance is created. (The field value may be still overwritten).

Parameters:

field - Field

value - Value to be set as fixed value

setFixedValues

public void setFixedValues(T object)

Set the attributes of the object with "fixed values" from the respective fields if fixed values are defined using setFixedValue(String, Object) or setFixedValue(HasValue, Object) method for those attributes.

Parameters:

object - Object to which fixed values to be set.

handleValueSetError

protected boolean handleValueSetError(String fieldName,
 com.vaadin.flow.component.HasValue<?,?> field,
 Object fieldValue,
 Object objectValue,
 Throwable error)

Handle errors while setting (committing) values. Default implementation returns true without doing anything.

Parameters:

fieldName - Name of the field

field - Field

fieldValue - Field's value that's being committed

objectValue - Value currently being in the object

error - Error occurred while setting the value

Returns:

Whether the error situation is handled or not.