Package com.storedobject.vaadin

Class DataEditor<T>

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.AbstractDataForm<T>

com.storedobject.vaadin.AbstractDataEditor<T>

com.storedobject.vaadin.DataEditor<T>

Type Parameters:

T - Type of the object to edit

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

public class DataEditor<T>
extends AbstractDataEditor<T>

A View that is used for creating a "data entry form" with "Save"/"Cancel" buttons.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

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

AbstractDataEditor.DForm

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

Modifier and Type	Field	Description
protected com.vaadin.flow.component.HasComponents	buttonPanel	The button panel where the buttons are painted.
protected Button	cancel	The "cancel" button.
protected Button	save	The "save" button.

Fields inherited from class com.storedobject.vaadin.AbstractDataForm

form

Constructor Summary

Constructors

Constructor	Description
DataEditor(Class<T> objectClass)	Constructor.
DataEditor(Class<T> objectClass, String caption)	Constructor.
DataEditor(Class<T> objectClass, String labelSave, String labelCancel)	Constructor.
DataEditor(Class<T> objectClass, String caption, String labelSave, String labelCancel)	Constructor.
DataEditor(Class<T> objectClass, String caption, String labelSave, String labelCancel, Consumer<T> saveAction)	Constructor.
DataEditor(Class<T> objectClass, String caption, String labelSave, String labelCancel, Consumer<T> saveAction, Consumer<T> cancelAction)	Constructor.
DataEditor(Class<T> objectClass, String labelSave, String labelCancel, Consumer<T> saveAction)	Constructor.
DataEditor(Class<T> objectClass, String labelSave, String labelCancel, Consumer<T> saveAction, Consumer<T> cancelAction)	Constructor.
DataEditor(Class<T> objectClass, String caption, Consumer<T> saveAction)	Constructor.
DataEditor(Class<T> objectClass, String caption, Consumer<T> saveAction, Consumer<T> cancelAction)	Constructor.
DataEditor(Class<T> objectClass, Consumer<T> saveAction)	Constructor.
DataEditor(Class<T> objectClass, Consumer<T> saveAction, Consumer<T> cancelAction)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	buildButtons()	Build the buttons.
protected void	cancel()	This method is invoked to carry out the "cancel".
void	clicked(com.vaadin.flow.component.Component c)	Default implementation, does nothing.
protected void	execute(View parent, boolean doNotLock)	Override this if you want to do something before the View comes up on the screen.
protected void	initUI()	This method is invoked when the view wants to determine its "content" to be displayed and nothing exists at that moment.
protected void	save()	This method is invoked to carry out the "save".
void	setCancelAction(Consumer<T> cancelAction)	Set the "cancel action" that will be used when "cancel" button is pressed.
void	setSaveAction(Consumer<T> saveAction)	Set the "save action" that will be used to save the instance.
boolean	skipFirstFocus(com.vaadin.flow.component.Focusable<?> skipFocus)	Check if this component to be skipped while traversing the component tree to find the first focusable component or not.
protected void	validateData()	Validate data.

Methods inherited from class com.storedobject.vaadin.AbstractDataEditor

addField, addField, addField, addField, addField, addField, addField, addField, constructField, createField, createObjectInstance, customizeField, getDataClass, getFieldCreator, getFieldGetMethod, getFieldNames, getFieldOrder, getFieldSetMethod, getForm, getObject, getObjectClass, handleValueSetError, includeField, isFieldIncluded, newObject, setFixedValue, setFixedValue, setFixedValues, setObject, setObject

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, executing, focus, focus, focusAny, getApplication, getCaption, getComponent, getCreatedBy, getEmbeddedView, getMenuItem, getMenuItem, getView, invoke, isFullScreen, isScrollable, isWindowMode, select, setCaption, setComponent, setCreatedBy, setDefaultPadding, setEmbeddedView, setFirstFocus, setFullScreen, setScrollable, setWindowMode

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

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

Field Details

save

protected Button save

The "save" button.

cancel

protected Button cancel

The "cancel" button.

buttonPanel

protected com.vaadin.flow.component.HasComponents buttonPanel

The button panel where the buttons are painted.

Constructor Details

DataEditor

public DataEditor(Class<T> objectClass)

Constructor.

Parameters:

objectClass - Object class

DataEditor

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

Constructor.

Parameters:

objectClass - Object class

caption - Caption

DataEditor

public DataEditor(Class<T> objectClass,
 String labelSave,
 String labelCancel)

Constructor.

Parameters:

objectClass - Object class

labelSave - Label for "save" button

labelCancel - Label for "cancel" button

DataEditor

public DataEditor(Class<T> objectClass,
 String caption,
 String labelSave,
 String labelCancel)

Constructor.

Parameters:

objectClass - Object class

caption - Caption

labelSave - Label for "save" button

labelCancel - Label for "cancel" button

DataEditor

public DataEditor(Class<T> objectClass,
 Consumer<T> saveAction)

Constructor.

Parameters:

objectClass - Object class

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

DataEditor

public DataEditor(Class<T> objectClass,
 String caption,
 Consumer<T> saveAction)

Constructor.

Parameters:

objectClass - Object class

caption - Caption

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

DataEditor

public DataEditor(Class<T> objectClass,
 String labelSave,
 String labelCancel,
 Consumer<T> saveAction)

Constructor.

Parameters:

objectClass - Object class

labelSave - Label for "save" button

labelCancel - Label for "cancel" button

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

DataEditor

public DataEditor(Class<T> objectClass,
 String caption,
 String labelSave,
 String labelCancel,
 Consumer<T> saveAction)

Constructor.

Parameters:

objectClass - Object class

caption - Caption

labelSave - Label for "save" button

labelCancel - Label for "cancel" button

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

DataEditor

public DataEditor(Class<T> objectClass,
 Consumer<T> saveAction,
 Consumer<T> cancelAction)

Constructor.

Parameters:

objectClass - Object class

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

cancelAction - Cancel action (Will be called when the "cancel" button is pressed)

DataEditor

public DataEditor(Class<T> objectClass,
 String caption,
 Consumer<T> saveAction,
 Consumer<T> cancelAction)

Constructor.

Parameters:

objectClass - Object class

caption - Caption

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

cancelAction - Cancel action (Will be called when the "cancel" button is pressed)

DataEditor

public DataEditor(Class<T> objectClass,
 String labelSave,
 String labelCancel,
 Consumer<T> saveAction,
 Consumer<T> cancelAction)

Constructor.

Parameters:

objectClass - Object class

labelSave - Label for "save" button

labelCancel - Label for "cancel" button

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

cancelAction - Cancel action (Will be called when the "cancel" button is pressed)

DataEditor

public DataEditor(Class<T> objectClass,
 String caption,
 String labelSave,
 String labelCancel,
 Consumer<T> saveAction,
 Consumer<T> cancelAction)

Constructor.

Parameters:

objectClass - Object class

caption - Caption

labelSave - Label for "save" button

labelCancel - Label for "cancel" button

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

cancelAction - Cancel action (Will be called when the "cancel" button is pressed)

Method Details

initUI

protected void initUI()

Description copied from class: View

This method is invoked when the view wants to determine its "content" to be displayed and nothing exists at that moment. View.setComponent(Component) may be called from within this method.

Overrides:

initUI in class View

skipFirstFocus

public boolean skipFirstFocus(com.vaadin.flow.component.Focusable<?> skipFocus)

Description copied from class: View

Check if this component to be skipped while traversing the component tree to find the first focusable component or not.

Overrides:

skipFirstFocus in class View

Parameters:

skipFocus - The focusable component

Returns:

False if it should not be skipped (Default implementation returns false).

buildButtons

protected void buildButtons()

Build the buttons. Button "save" and "cancel" are already created. This method add those to the buttonPanel. You can add additional custom buttons and components to the buttonPanel.

execute

protected void execute(View parent,
 boolean doNotLock)

Description copied from class: View

Override this if you want to do something before the View comes up on the screen. Call super.execute(parent, doNotLock) to make the View appear on the screen. Parent view is automatically selected when this view closes.

Overrides:

execute in class View

Parameters:

parent - Parent-view to lock

doNotLock - True if parent should not be locked

cancel

protected void cancel()

This method is invoked to carry out the "cancel". By default it processes the "cancel action" if defined.

save

protected void save()

This method is invoked to carry out the "save". By default it processes the "save action" if defined.

setSaveAction

public void setSaveAction(Consumer<T> saveAction)

Set the "save action" that will be used to save the instance.

Parameters:

saveAction - Save action (Will be called when the "save" button is pressed and data is validated)

setCancelAction

public void setCancelAction(Consumer<T> cancelAction)

Set the "cancel action" that will be used when "cancel" button is pressed.

Parameters:

cancelAction - Cancel action (Will be called when the "cancel" button is pressed)

validateData

protected void validateData()
                     throws Exception

Validate data. This method is invoked when the "save" button is pressed. save() will be invoked only if this method did not raise any exception.

Throws:

Exception - Exception raised will be displayed as a warning message and "data entry form" will not be closed.

clicked

public void clicked(com.vaadin.flow.component.Component c)

Description copied from interface: ExecutableView

Default implementation, does nothing.

Parameters:

c - Component