Package com.storedobject.vaadin

Class AbstractDataForm<D>

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.AbstractDataForm<D>

Type Parameters:

D - Type of data in the embedded form

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:

AbstractDataEditor, DataForm, TemplateDataForm

public abstract class AbstractDataForm<D>
extends View
implements HasContainer

A view that is used for creating "data entry forms". An AbstractForm is embedded in the view.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractDataForm.FieldError	For internal use only.

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 AbstractForm<D>	form	Form embedded in this view.

Constructor Summary

Constructors

Constructor	Description
AbstractDataForm()

Method Summary

Modifier and Type	Method	Description
void	add(com.vaadin.flow.component.Component... components)	Add components to the form's field container.
com.vaadin.flow.shared.Registration	addConstructedListener(ConstructedListener constructedListener)	Add a ConstructedListener so that we will be informed about when the UI part is constructed.
void	addField(com.vaadin.flow.component.HasValue<?,?>... fields)	Add fields to the form.
void	addField(String fieldName, com.vaadin.flow.component.HasValue<?,?> field)	Add a field to the form.
com.vaadin.flow.shared.Registration	addIncludeFieldChecker(IncludeField includeField)	Add an "include field checker" to the existing chain.
<T> void	addValidator(com.vaadin.flow.component.HasValue<?,T> field, Function<T,Boolean> validator)	Add a validator for the field.
<T> void	addValidator(com.vaadin.flow.component.HasValue<?,T> field, Function<T,Boolean> validator, String errorMessage)	Add a validator for the field.
protected void	attachField(String fieldName, com.vaadin.flow.component.HasValue<?,?> field)	Attach a field to the form.
void	clean()	Close resources if any that are left opened.
void	clearAlerts()	Clear all alters owned by this view.
static void	clearError(com.vaadin.flow.component.HasValue<?,?> field)	Clear the error status associated with a field.
void	clearErrors()	Clear error status of all the fields.
void	clearFields()	Clear values of all the fields.
boolean	commit()	Save data from the fields to the internal data structure.
boolean	connect(com.vaadin.flow.component.HasValue<?,?>... fields)	Connect fields so that a change in any of it is propagated to others within that connected group.
boolean	connect(String... fieldNames)	Connect fields so that a change in any of it is propagated to others within that connected group.
boolean	connect(Collection<com.vaadin.flow.component.HasValue<?,?>> fields)	Connect fields so that a change in any of it is propagated to others within that connected group.
protected com.vaadin.flow.component.HasComponents	createButtonLayout()	This method is invoked to create a "button panel" to be displayed typically at the top of the view's layout.
protected com.vaadin.flow.component.HasValue<?,?>	createField(String fieldName)	Create the field for a particular "field name".
protected com.vaadin.flow.component.HasValue<?,?>	createField(String fieldName, String label)	Create the field for a particular "field name".
protected com.vaadin.flow.component.HasComponents	createFieldContainer()	Create the field container of this form.
protected com.vaadin.flow.component.HasComponents	createLayout()	This method is invoked to create the layout of the view.
protected void	detachField(String fieldName, com.vaadin.flow.component.HasValue<?,?> field)	Detach a field from the form.
protected void	fieldAttached(String fieldName, com.vaadin.flow.component.HasValue<?,?> field)	This method is invoked whenever a field is attached to the form.
protected void	fieldDetached(String fieldName, com.vaadin.flow.component.HasValue<?,?> field)	This method is invoked whenever a field is detached from the form.
protected final void	fireFormConstructed()	This method is invoked to inform all ConstructedListeners when the form is constructed.
protected void	formConstructed()	This method is invoked when the form is constructed.
final int	getColumns()	Get number of responsive columns for the form.
int	getColumnSpan(com.vaadin.flow.component.Component component)	Get the column span of a component.
com.vaadin.flow.component.HasComponents	getContainer()	Get the field container of the form.
com.vaadin.flow.component.Component	getContent()	Get the field container of the form as a component.
protected final Data<D>	getData()	Get the "data" associated with the form.
com.vaadin.flow.component.HasText	getErrorDisplay()	Get the current error display of the form.
com.vaadin.flow.component.HasValue<?,?>	getField(String fieldName)	Get a field associated with a field name.
final String	getFieldLabel(com.vaadin.flow.component.HasValue<?,?> field)	Get label for the given field.
final String	getFieldLabel(String fieldName)	Get label for the given field.
String	getFieldName(com.vaadin.flow.component.HasValue<?,?> field)	Get a field name associated with a field.
Stream<String>	getFieldNames()	Get the field names.
AbstractForm<D>	getForm()	Get the form embedded in this view.
protected String	getLabel(String fieldName)	This method is invoked to determine the label used for displaying the field.
boolean	isFieldEditable(com.vaadin.flow.component.HasValue<?,?> field)	This method is invoked to determine if a field needs to be made editable or not.
boolean	isFieldEditable(String fieldName)	This method is invoked to determine if a field needs to be made editable or not.
boolean	isFieldVisible(com.vaadin.flow.component.HasValue<?,?> field)	This method is invoked to determine if a field needs to be made visible or not.
boolean	isFieldVisible(String fieldName)	This method is invoked to determine if a field needs to be made visible or not.
boolean	isReadOnly()	Check whether the view is "read only" or not.
void	load()	Load data to the fields from the internal data structure.
static void	markError(com.vaadin.flow.component.HasValue<?,?> field)	Mark a field as not valid.
void	newLine()	Add a new line to the form.
void	remove(com.vaadin.flow.component.Component... components)	Remove components from the form's field container.
void	removeAll()	Remove all components from the form's field container.
void	removeField(com.vaadin.flow.component.HasValue<?,?> field)	Remove a field from the form.
void	removeField(String fieldName)	Remove a field from the form.
void	removeField(String... fieldNames)	Remove fields from the form.
void	setColumns(int columns)	Set number of responsive columns for the form.
void	setColumnSpan(com.vaadin.flow.component.Component component, int columnSpan)	Set number of columns to span for a particular component.
void	setErrorDisplay(com.vaadin.flow.component.HasText display)	Error messages of the form are typically displayed using Notification.
void	setFieldContainerProvider(HasContainer fieldContainerProvider)	Set the field container provider for this form so that createFieldContainer()} can provide the component container from this.
void	setFieldCustomizer(FieldCustomizer fieldCustomizer)	Set an external field customizer.
void	setFieldEditable(com.vaadin.flow.component.HasValue<?,?>... fields)	Set fields editable.
void	setFieldEditable(String... fieldNames)	Set fields editable.
void	setFieldHidden(com.vaadin.flow.component.HasValue<?,?>... fields)	Set fields hidden.
void	setFieldHidden(String... fieldNames)	Set fields hidden.
final void	setFieldLabel(com.vaadin.flow.component.HasValue<?,?> field, String label)	Set label for a specific field.
final void	setFieldLabel(String fieldName, String label)	Set label for a specific field.
void	setFieldReadOnly(boolean readOnly, com.vaadin.flow.component.HasValue<?,?>... fields)	Set fields read only.
void	setFieldReadOnly(boolean readOnly, String... fieldNames)	Set fields read only.
void	setFieldReadOnly(com.vaadin.flow.component.HasValue<?,?>... fields)	Set fields read only.
void	setFieldReadOnly(String... fieldNames)	Set fields read only.
void	setFieldVisible(boolean visible, com.vaadin.flow.component.HasValue<?,?>... fields)	Set fields visible.
void	setFieldVisible(boolean visible, String... fieldNames)	Set fields visible.
void	setFieldVisible(com.vaadin.flow.component.HasValue<?,?>... fields)	Set fields visible.
void	setFieldVisible(String... fieldNames)	Set fields visible.
void	setIncludeFieldChecker(IncludeField includeField)	Set "include field checker".
void	setReadOnly(boolean readOnly)	Set the view read only.
void	setRequired(com.vaadin.flow.component.HasValue<?,?> field)	Set the "required" attribute of a field.
void	setRequired(com.vaadin.flow.component.HasValue<?,?> field, boolean required)	Set the "required" attribute of a field.
void	setRequired(com.vaadin.flow.component.HasValue<?,?> field, boolean required, String errorMessage)	Set the "required" attribute of a field.
void	setRequired(com.vaadin.flow.component.HasValue<?,?> field, String errorMessage)	Set the "required" attribute of a field.
void	setRequired(String fieldName)	Set the "required" attribute of a field.
void	setRequired(String fieldName, boolean required)	Set the "required" attribute of a field.
void	setRequired(String fieldName, boolean required, String errorMessage)	Set the "required" attribute of a field.
void	setRequired(String fieldName, String errorMessage)	Set the "required" attribute of a field.
final Stream<String>	streamFieldNamesCreated()	Get all fields names.
final Stream<com.vaadin.flow.component.HasValue<?,?>>	streamFieldsCreated()	Get all fields.

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

Field Details

form

protected AbstractForm<D> form

Form embedded in this view.

Constructor Details

AbstractDataForm

public AbstractDataForm()

Method Details

getForm

public AbstractForm<D> getForm()

Get the form embedded in this view.

Returns:

Form

formConstructed

protected void formConstructed()

This method is invoked when the form is constructed.

fireFormConstructed

protected final void fireFormConstructed()

This method is invoked to inform all ConstructedListeners when the form is constructed.

addConstructedListener

public com.vaadin.flow.shared.Registration addConstructedListener(ConstructedListener constructedListener)

Add a ConstructedListener so that we will be informed about when the UI part is constructed.

Parameters:

constructedListener - Listener.

Returns:

Registration.

getData

protected final Data<D> getData()

Get the "data" associated with the form.

Returns:

Data structure that holds the data.

getContent

public com.vaadin.flow.component.Component getContent()

Get the field container of the form as a component.

Overrides:

getContent in class View

Returns:

Field container as a component. null is returned if the field container is not a component.

setFieldContainerProvider

public void setFieldContainerProvider(HasContainer fieldContainerProvider)

Set the field container provider for this form so that createFieldContainer()} can provide the component container from this.

Parameters:

fieldContainerProvider - Field container to set

createFieldContainer

protected com.vaadin.flow.component.HasComponents createFieldContainer()

Create the field container of this form. Default implementation creates a container from the field container provider that was set, otherwise, it creates FormLayout.

Returns:

Field container created.

createLayout

protected com.vaadin.flow.component.HasComponents createLayout()

This method is invoked to create the layout of the view.

Returns:

Layout

createButtonLayout

protected com.vaadin.flow.component.HasComponents createButtonLayout()

This method is invoked to create a "button panel" to be displayed typically at the top of the view's layout.

Returns:

A component to display other components, typically, buttons.

getContainer

public com.vaadin.flow.component.HasComponents getContainer()

Get the field container of the form.

Specified by:

getContainer in interface HasContainer

Returns:

Field container.

getFieldNames

public Stream<String> getFieldNames()

Get the field names. This is invoked to determine the fields to be created for constructing the form.

Returns:

Stream of fields.

setIncludeFieldChecker

public void setIncludeFieldChecker(IncludeField includeField)

Set "include field checker". It will determine if a field can be added or not.

Parameters:

includeField - The "include field checker"

addIncludeFieldChecker

public com.vaadin.flow.shared.Registration addIncludeFieldChecker(IncludeField includeField)

Add an "include field checker" to the existing chain. If any one of the IncludeField in the chain returns false for a specific field, the field will not be included in the form.

Parameters:

includeField - The "include field checker" to add.

Returns:

Registration.

setFieldCustomizer

public void setFieldCustomizer(FieldCustomizer fieldCustomizer)

Set an external field customizer. If set, the method FieldCustomizer.customizeField(String, HasValue) will be invoked when each field gets created.

Parameters:

fieldCustomizer - Field customizer.

createField

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

Create the field for a particular "field name".

Parameters:

fieldName - Field name

Returns:

Field created.

createField

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

Create the field for a particular "field name".

Parameters:

fieldName - Field name

label - Label for the field

Returns:

Field created.

addField

public void addField(com.vaadin.flow.component.HasValue<?,?>... fields)

Add fields to the form. These fields will not be having "field names".

Parameters:

fields - Fields to be added

addField

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

Add a field to the form.

Parameters:

fieldName - Name associated with the field

field - Field

removeField

public void removeField(String fieldName)

Remove a field from the form.

Parameters:

fieldName - Name of the field to be removed.

removeField

public void removeField(String... fieldNames)

Remove fields from the form.

Parameters:

fieldNames - Names of the field to be removed

removeField

public void removeField(com.vaadin.flow.component.HasValue<?,?> field)

Remove a field from the form.

Parameters:

field - Field to be removed.

add

public void add(com.vaadin.flow.component.Component... components)

Add components to the form's field container.

Parameters:

components - Components to add

remove

public void remove(com.vaadin.flow.component.Component... components)

Remove components from the form's field container.

Parameters:

components - Components to remove

removeAll

public void removeAll()

Remove all components from the form's field container.

load

public void load()

Load data to the fields from the internal data structure.

commit

public boolean commit()

Save data from the fields to the internal data structure.

Returns:

True if data is saved successfully.

getField

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

Get a field associated with a field name.

Parameters:

fieldName - Name of the field

Returns:

Field.

getFieldName

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

Get a field name associated with a field.

Parameters:

field - Field

Returns:

Name of the field.

setRequired

public void setRequired(com.vaadin.flow.component.HasValue<?,?> field)

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

field - Field

setRequired

public void setRequired(String fieldName)

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

fieldName - Field name

setRequired

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

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

field - Field

errorMessage - Error message to show when the field is empty

setRequired

public void setRequired(String fieldName,
 String errorMessage)

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

fieldName - Field name

errorMessage - Error message to show when the field is empty

setRequired

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

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

field - Field

required - True or false

setRequired

public void setRequired(String fieldName,
 boolean required)

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

fieldName - Field name

required - True or false

setRequired

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

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

field - Field

required - True or false

errorMessage - Error message to show when the field is empty

setRequired

public void setRequired(String fieldName,
 boolean required,
 String errorMessage)

Set the "required" attribute of a field. If set to true, with empty data (checked by invoking HasValue.isEmpty()), commit() will fail.

Parameters:

fieldName - Field name

required - True or false

errorMessage - Error message to show when the field is empty

addValidator

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

Add a validator for the field. Validator should return true if the field is valid.

Type Parameters:

T - Type of the field.

Parameters:

field - Field

validator - Validator

addValidator

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

Add a validator for the field. Validator should return true if the field is valid.

Type Parameters:

T - Type of the field value.

Parameters:

field - Field

validator - Validator

errorMessage - Error message to be displayed if the field is not valid

markError

public static void markError(com.vaadin.flow.component.HasValue<?,?> field)

Mark a field as not valid.

Parameters:

field - Field

clearError

public static void clearError(com.vaadin.flow.component.HasValue<?,?> field)

Clear the error status associated with a field.

Parameters:

field - Field

clearFields

public void clearFields()

Clear values of all the fields.

clearErrors

public void clearErrors()

Clear error status of all the fields.

setReadOnly

public void setReadOnly(boolean readOnly)

Set the view read only.

Parameters:

readOnly - True or false

isReadOnly

public boolean isReadOnly()

Check whether the view is "read only" or not.

Returns:

True or false.

isFieldVisible

public boolean isFieldVisible(String fieldName)

This method is invoked to determine if a field needs to be made visible or not.

Parameters:

fieldName - Name of the field

Returns:

True or false.

isFieldVisible

public boolean isFieldVisible(com.vaadin.flow.component.HasValue<?,?> field)

This method is invoked to determine if a field needs to be made visible or not.

Parameters:

field - Field

Returns:

True or false.

setFieldVisible

public void setFieldVisible(String... fieldNames)

Set fields visible. (By default fields are visible).

Parameters:

fieldNames - Field names

setFieldVisible

public void setFieldVisible(com.vaadin.flow.component.HasValue<?,?>... fields)

Set fields visible. (By default fields are visible).

Parameters:

fields - Fields

setFieldVisible

public void setFieldVisible(boolean visible,
 String... fieldNames)

Set fields visible. (By default fields are visible).

Parameters:

visible - To make it visible or not

fieldNames - Field names

setFieldVisible

public void setFieldVisible(boolean visible,
 com.vaadin.flow.component.HasValue<?,?>... fields)

Set fields visible. (By default fields are visible).

Parameters:

visible - To make it visible or not

fields - Fields

setFieldHidden

public void setFieldHidden(String... fieldNames)

Set fields hidden. (By default fields are visible).

Parameters:

fieldNames - Field names

setFieldHidden

public void setFieldHidden(com.vaadin.flow.component.HasValue<?,?>... fields)

Set fields hidden. (By default fields are visible).

Parameters:

fields - Fields

isFieldEditable

public boolean isFieldEditable(String fieldName)

This method is invoked to determine if a field needs to be made editable or not.

Parameters:

fieldName - Name of the field

Returns:

True or false.

isFieldEditable

public boolean isFieldEditable(com.vaadin.flow.component.HasValue<?,?> field)

This method is invoked to determine if a field needs to be made editable or not.

Parameters:

field - Field

Returns:

True or false.

setFieldEditable

public void setFieldEditable(String... fieldNames)

Set fields editable. (By default fields are editable).

Parameters:

fieldNames - Field names

setFieldEditable

public void setFieldEditable(com.vaadin.flow.component.HasValue<?,?>... fields)

Set fields editable. (By default fields are editable).

Parameters:

fields - Fields

setFieldReadOnly

public void setFieldReadOnly(String... fieldNames)

Set fields read only. (By default fields are editable).

Parameters:

fieldNames - Field names

setFieldReadOnly

public void setFieldReadOnly(com.vaadin.flow.component.HasValue<?,?>... fields)

Set fields read only. (By default fields are editable).

Parameters:

fields - Fields

setFieldReadOnly

public void setFieldReadOnly(boolean readOnly,
 String... fieldNames)

Set fields read only. (By default fields are editable).

Parameters:

readOnly - Read-only or not.

fieldNames - Field names

setFieldReadOnly

public void setFieldReadOnly(boolean readOnly,
 com.vaadin.flow.component.HasValue<?,?>... fields)

Set fields read only. (By default fields are editable).

Parameters:

readOnly - Read-only or not.

fields - Fields

getLabel

protected String getLabel(String fieldName)

This method is invoked to determine the label used for displaying the field. The default implementation determine it by invoking ApplicationEnvironment.createLabel(String).

Parameters:

fieldName - Name of the field

Returns:

Label

setFieldLabel

public final void setFieldLabel(String fieldName,
 String label)

Set label for a specific field. Label will be set only if the field has a setLabel(String) method.

Parameters:

fieldName - Name of the field for which label needs to be set

label - Label to set

setFieldLabel

public final void setFieldLabel(com.vaadin.flow.component.HasValue<?,?> field,
 String label)

Set label for a specific field. Label will be set only if the field has a setLabel(String) method.

Parameters:

field - Field for which label needs to be set

label - Label to set

getFieldLabel

public final String getFieldLabel(String fieldName)

Get label for the given field.

Parameters:

fieldName - Name of the field

Returns:

Label string if "getLabel" method exists in the field, otherwise null.

getFieldLabel

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

Get label for the given field.

Parameters:

field - Field

Returns:

Label string if "getLabel" method exists in the field, otherwise null.

attachField

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

Attach a field to the form. This is invoked whenever a field is added to the form. The default implementation adds the component of the field (if it is a component) to the field container.

Parameters:

fieldName - Name of the field

field - Field

fieldAttached

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

This method is invoked whenever a field is attached to the form.

Parameters:

fieldName - Name of the field

field - Field

detachField

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

Detach a field from the form. This is invoked whenever a field is removed to the form. The default implementation removes the component of the field (if it is a component) from the field container.

Parameters:

fieldName - Name of the field

field - Field

fieldDetached

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

This method is invoked whenever a field is detached from the form.

Parameters:

fieldName - Name of the field

field - Field

setErrorDisplay

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

Error messages of the form are typically displayed using Notification. However, one can set any HasText for that.

Parameters:

display - Error messages will be displayed on this

getErrorDisplay

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

Get the current error display of the form. (See setErrorDisplay(HasText)).

Returns:

Current error display.

setColumns

public void setColumns(int columns)

Set number of responsive columns for the form.

Parameters:

columns - Number of responsive columns required

getColumns

public final int getColumns()

Get number of responsive columns for the form.

Returns:

Number of responsive columns of the form.

newLine

public void newLine()

Add a new line to the form.

setColumnSpan

public void setColumnSpan(com.vaadin.flow.component.Component component,
 int columnSpan)

Set number of columns to span for a particular component.

Parameters:

component - Component for which column span to be set

columnSpan - Number of columns to span

getColumnSpan

public int getColumnSpan(com.vaadin.flow.component.Component component)

Get the column span of a component.

Parameters:

component - Component for which column span to be retrieved

Returns:

Column span for the component.

connect

public boolean connect(String... fieldNames)

Connect fields so that a change in any of it is propagated to others within that connected group.

Parameters:

fieldNames - Fields to connect.

Returns:

True if connection is established successfully.

connect

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

Connect fields so that a change in any of it is propagated to others within that connected group.

Parameters:

fields - Fields to connect.

Returns:

True if connection is established successfully.

connect

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

Connect fields so that a change in any of it is propagated to others within that connected group.

Parameters:

fields - Fields to connect.

Returns:

True if connection is established successfully.

clean

public void clean()

Description copied from class: View

Close resources if any that are left opened. This method is invoked when the view is removed from the Application. The default implementation does nothing.

Specified by:

clean in interface ExecutableView

Overrides:

clean in class View

streamFieldsCreated

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

Get all fields.

Returns:

Stream of fields.

streamFieldNamesCreated

public final Stream<String> streamFieldNamesCreated()

Get all fields names.

Returns:

Stream of field names.

clearAlerts

public void clearAlerts()

Description copied from interface: ExecutableView

Clear all alters owned by this view.

Specified by:

clearAlerts in interface ExecutableView