Package org.vaadin.miki.superfields.util

Class CollectionComponentProviders

java.lang.Object

org.vaadin.miki.superfields.util.CollectionComponentProviders

public class CollectionComponentProviders
extends Object

Utility class with common (hopefully) use-cases of CollectionComponentProvider and subclasses.

Since:

2021-09-04

Author:

miki

Method Summary

Modifier and Type	Method	Description
static CollectionComponentProvider<com.vaadin.flow.component.button.Button>	addFirstButton(String text)	A CollectionComponentProvider that produces a Button that adds an element to the collection by calling CollectionController.add(int) with 0 as parameter.
static CollectionComponentProvider<com.vaadin.flow.component.button.Button>	addLastButton(String text)	A CollectionComponentProvider that produces a Button that adds an element to the collection by calling CollectionController.add().
static CollectionLayoutProvider<HeaderFooterLayoutWrapper<com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>>	columnWithHeaderAndFooterRows(Collection<CollectionComponentProvider<?>> headerComponents, Collection<CollectionComponentProvider<?>> footerComponents)	A CollectionLayoutProvider for a HeaderFooterLayoutWrapper based on FlexLayouts.
static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>>	columnWithHeaderAndFooterRows(CollectionValueComponentProvider<T,F> inner, Collection<CollectionComponentProvider<?>> headerComponents, Collection<CollectionComponentProvider<?>> footerComponents)	A CollectionValueComponentProvider for a column-based HeaderFooterFieldWrapper where header and footer are row-based FlexLayouts.
static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T> & com.vaadin.flow.component.HasLabel> CollectionValueComponentProvider<T,F>	labelledField(Supplier<F> fieldSupplier, String label)	Returns a CollectionValueComponentProvider that generates a given field and sets its label.
static <K,V,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,K>,W extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,V>> CollectionValueComponentProvider<Map.Entry<K,V>,MapEntryField<K,V>>	mapEntryField(com.vaadin.flow.function.SerializableSupplier<C> keyComponentSupplier, com.vaadin.flow.function.SerializableSupplier<W> valueComponentSupplier)	A CollectionValueComponentProvider that produces a MapEntryField with given key and value suppliers.
static <K,V,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasLabel & com.vaadin.flow.component.HasValue<?,K>,W extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasLabel & com.vaadin.flow.component.HasValue<?,V>> CollectionValueComponentProvider<Map.Entry<K,V>,MapEntryField<K,V>>	mapEntryField(String keyLabel, com.vaadin.flow.function.SerializableSupplier<C> keyComponentSupplier, String valueLabel, com.vaadin.flow.function.SerializableSupplier<W> valueComponentSupplier)	A CollectionValueComponentProvider that produces a MapEntryField with given key and value suppliers, but also sets labels to both produced components..
static CollectionComponentProvider<com.vaadin.flow.component.button.Button>	removeAllButton(String text)	A CollectionComponentProvider that produces a Button that clears the collection by calling CollectionController.removeAll().
static CollectionComponentProvider<IndexedButton>	removeButton(String text)	A CollectionComponentProvider that produces an IndexedButton that removes a given element from the collection by calling CollectionController.remove(int).
static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>>	row(CollectionValueComponentProvider<T,F> inner, Collection<CollectionComponentProvider<?>> headerComponents, Collection<CollectionComponentProvider<?>> footerComponents)	A CollectionValueComponentProvider that wraps given field with a layout containing header and footer.
static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>>	rowWithRemoveButtonFirst(CollectionValueComponentProvider<T,F> inner, String removeButtonText)	A CollectionValueComponentProvider that wraps given field with a layout containing a header and footer.
static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>>	rowWithRemoveButtonLast(CollectionValueComponentProvider<T,F> inner, String removeButtonText)	A CollectionValueComponentProvider that wraps given field with a layout containing a header and footer.
static SuperTextArea	textArea(int index, CollectionController controller)	Produces plain text area.
static SuperTextField	textField(int index, CollectionController controller)	Produces plain text field.

Methods inherited from class java.lang.Object

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

Method Detail

textField

public static SuperTextField textField(int index,
                                       CollectionController controller)

Produces plain text field. Method signature follows CollectionValueComponentProvider.

Parameters:

index - Index.

controller - Controller.

Returns:

A SuperTextField.

textArea

public static SuperTextArea textArea(int index,
                                     CollectionController controller)

Produces plain text area. Method signature follows CollectionValueComponentProvider.

Parameters:

index - Index.

controller - Controller.

Returns:

A SuperTextArea.

labelledField

public static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T> & com.vaadin.flow.component.HasLabel> CollectionValueComponentProvider<T,F> labelledField(Supplier<F> fieldSupplier,
                                                                                                                                                                                                                     String label)

Returns a CollectionValueComponentProvider that generates a given field and sets its label.

Type Parameters:

T - Type of data.

F - Type of component to display the data.

Parameters:

fieldSupplier - Field supplier.

label - Label to use. String.format(label, index) will be applied, so any %d will be replaced with an index.

Returns:

A CollectionValueComponentProvider that generates given field and sets its label.

row

public static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>> row(CollectionValueComponentProvider<T,F> inner,
                                                                                                                                                                                                                                                                                                                  Collection<CollectionComponentProvider<?>> headerComponents,
                                                                                                                                                                                                                                                                                                                  Collection<CollectionComponentProvider<?>> footerComponents)

A CollectionValueComponentProvider that wraps given field with a layout containing header and footer. The wrapper is row-aligned, with header and footer being column-based. None of the parameters may ever be null.

Type Parameters:

T - Type of the value.

F - Type of the field used to show the value.

Parameters:

inner - Inner field generator.

headerComponents - A collection of generators for components to appear in the header.

footerComponents - A collection of generators for components to appear in the footer.

Returns:

A CollectionValueComponentProvider that generates a HeaderFooterFieldWrapper with a given field, header and footer.

rowWithRemoveButtonLast

public static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>> rowWithRemoveButtonLast(CollectionValueComponentProvider<T,F> inner,
                                                                                                                                                                                                                                                                                                                                      String removeButtonText)

A CollectionValueComponentProvider that wraps given field with a layout containing a header and footer. The footer contains a button that removes the entry from the collection.

Type Parameters:

T - Type of the value.

F - Type of the field used to show the value.

Parameters:

inner - Inner field generator.

removeButtonText - Text to appear on the button.

Returns:

A CollectionValueComponentProvider that generates a HeaderFooterFieldWrapper with a given field, header and footer (with a button).

rowWithRemoveButtonFirst

public static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>> rowWithRemoveButtonFirst(CollectionValueComponentProvider<T,F> inner,
                                                                                                                                                                                                                                                                                                                                       String removeButtonText)

A CollectionValueComponentProvider that wraps given field with a layout containing a header and footer. The header contains a button that removes the entry from the collection.

Type Parameters:

T - Type of the value.

F - Type of the field used to show the value.

Parameters:

inner - Inner field generator.

removeButtonText - Text to appear on the button.

Returns:

A CollectionValueComponentProvider that generates a HeaderFooterFieldWrapper with a given field, header (with a button) and a footer.

columnWithHeaderAndFooterRows

public static <T,F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,T>> CollectionValueComponentProvider<T,HeaderFooterFieldWrapper<T,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>> columnWithHeaderAndFooterRows(CollectionValueComponentProvider<T,F> inner,
                                                                                                                                                                                                                                                                                                                                            Collection<CollectionComponentProvider<?>> headerComponents,
                                                                                                                                                                                                                                                                                                                                            Collection<CollectionComponentProvider<?>> footerComponents)

A CollectionValueComponentProvider for a column-based HeaderFooterFieldWrapper where header and footer are row-based FlexLayouts.

Type Parameters:

T - Type of data to display.

F - Type of field to use.

Parameters:

inner - Inner field.

headerComponents - Components to put in the header. Must never be null.

footerComponents - Components to put in the footer. Must never be null.

Returns:

A CollectionValueComponentProvider that produces a HeaderFooterFieldWrapper with a given field.

columnWithHeaderAndFooterRows

public static CollectionLayoutProvider<HeaderFooterLayoutWrapper<com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout,com.vaadin.flow.component.orderedlayout.FlexLayout>> columnWithHeaderAndFooterRows(Collection<CollectionComponentProvider<?>> headerComponents,
                                                                                                                                                                                                                                                                                                                               Collection<CollectionComponentProvider<?>> footerComponents)

A CollectionLayoutProvider for a HeaderFooterLayoutWrapper based on FlexLayouts. The content is column-based. The footer and header are row-based. No parameter may ever be null.

Parameters:

headerComponents - Components to place in the header.

footerComponents - Components to place in the footer.

Returns:

A CollectionLayoutProvider.

removeAllButton

public static CollectionComponentProvider<com.vaadin.flow.component.button.Button> removeAllButton(String text)

A CollectionComponentProvider that produces a Button that clears the collection by calling CollectionController.removeAll().

Parameters:

text - Text to appear on the button.

Returns:

A CollectionComponentProvider that produces a Button.

addFirstButton

public static CollectionComponentProvider<com.vaadin.flow.component.button.Button> addFirstButton(String text)

A CollectionComponentProvider that produces a Button that adds an element to the collection by calling CollectionController.add(int) with 0 as parameter.

Parameters:

text - Text to appear on the button.

Returns:

A CollectionComponentProvider that produces a Button.

addLastButton

public static CollectionComponentProvider<com.vaadin.flow.component.button.Button> addLastButton(String text)

A CollectionComponentProvider that produces a Button that adds an element to the collection by calling CollectionController.add().

Parameters:

text - Text to appear on the button.

Returns:

A CollectionComponentProvider that produces a Button.

removeButton

public static CollectionComponentProvider<IndexedButton> removeButton(String text)

A CollectionComponentProvider that produces an IndexedButton that removes a given element from the collection by calling CollectionController.remove(int).

Parameters:

text - Text to appear on the button.

Returns:

A CollectionComponentProvider that produces a Button.

mapEntryField

public static <K,V,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,K>,W extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,V>> CollectionValueComponentProvider<Map.Entry<K,V>,MapEntryField<K,V>> mapEntryField(com.vaadin.flow.function.SerializableSupplier<C> keyComponentSupplier,
                                                                                                                                                                                                                                                                                                                                      com.vaadin.flow.function.SerializableSupplier<W> valueComponentSupplier)

A CollectionValueComponentProvider that produces a MapEntryField with given key and value suppliers.

Type Parameters:

K - Key type.

V - Value type.

C - Ensures key component supplier is a Component that HasValue of type K.

W - Ensures value component supplier is a Component that HasValue of type V.

Parameters:

keyComponentSupplier - Supplier of components capable of displaying keys.

valueComponentSupplier - Supplier of components capable of displaying values.

Returns:

A CollectionValueComponentProvider of MapEntryFields.

mapEntryField

public static <K,V,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasLabel & com.vaadin.flow.component.HasValue<?,K>,W extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasLabel & com.vaadin.flow.component.HasValue<?,V>> CollectionValueComponentProvider<Map.Entry<K,V>,MapEntryField<K,V>> mapEntryField(String keyLabel,
                                                                                                                                                                                                                                                                                                                                                                                                                com.vaadin.flow.function.SerializableSupplier<C> keyComponentSupplier,
                                                                                                                                                                                                                                                                                                                                                                                                                String valueLabel,
                                                                                                                                                                                                                                                                                                                                                                                                                com.vaadin.flow.function.SerializableSupplier<W> valueComponentSupplier)

A CollectionValueComponentProvider that produces a MapEntryField with given key and value suppliers, but also sets labels to both produced components..

Type Parameters:

K - Key type.

V - Value type.

C - Ensures key component supplier is a Component that HasLabel and HasValue of type K.

W - Ensures value component supplier is a Component that HasLabel and HasValue of type V.

Parameters:

keyLabel - Label for the key component. It is applied as is.

keyComponentSupplier - Supplier of components capable of displaying keys.

valueLabel - Label for the value component. It is applied as is.

valueComponentSupplier - Supplier of components capable of displaying values.

Returns:

A CollectionValueComponentProvider of MapEntryFields.