Package org.vaadin.miki.superfields.util.factory

Class ObjectFieldFactory

java.lang.Object

org.vaadin.miki.superfields.util.factory.ObjectFieldFactory

public class ObjectFieldFactory
extends Object

Configures ObjectField to work "out of the box" for most common use cases. Allows overriding most settings either directly or by subclassing.

Since:

2022-09-08

Author:

miki

Constructor Summary

Constructors

Constructor	Description
ObjectFieldFactory()	Constructs the factory.

Method Summary

Modifier and Type	Method	Description
protected PropertyComponentBuilder	buildAndConfigureComponentBuilder()	Builds a SimplePropertyComponentBuilder and configures it for building most default components: properties marked with MetadataProperties.SHOW_AS_COMPONENT_METADATA_PROPERTY as requested boolean properties as SuperCheckbox integer properties as SuperIntegerField long properties as SuperLongField double properties as SuperDoubleField BigDecimal properties as SuperBigDecimalField LocalDate properties as SuperDatePicker LocalDateTime properties as SuperDateTimePicker String properties as either SuperTextField or SuperTextArea (depending on MetadataProperties.MULTILINE_METADATA_PROPERTY) registered collection (lists and sets) properties as CollectionField map properties as MapField ObjectField using this factory as default (that falls back to LabelField)
protected PropertyGroupingProvider	buildAndConfigureGroupingProvider()	Builds a PropertyGroupingProvider based on presence of MetadataProperties.GROUP_METADATA_PROPERTY and MetadataProperties.ORDER_METADATA_PROPERTY.
protected PropertyGroupLayoutProvider	buildAndConfigureGroupLayoutProvider()	Builds a PropertyGroupLayoutProvider that provides a separate layout for a group with two or more properties in it.
<T> ObjectField<T>	buildAndConfigureObjectField(Class<T> type)	Builds, configures, and repaints an ObjectField for a given type, using instance provider from getInstanceProvider(Class).
<T> ObjectField<T>	buildAndConfigureObjectField(Class<T> type, boolean repaint)	Builds, configures, and optionally repaints an ObjectField for a given type, using instance provider from getInstanceProvider(Class).
<T> ObjectField<T>	buildAndConfigureObjectField(Class<T> type, com.vaadin.flow.function.SerializableSupplier<T> newInstanceProvider)	Builds, configures, and repaints an ObjectField for a given type using given instance provider.
<T> ObjectField<T>	buildAndConfigureObjectField(Class<T> type, com.vaadin.flow.function.SerializableSupplier<T> newInstanceProvider, boolean repaint)	Builds, configures and optionally repaints an ObjectField for a given type using given instance provider.
protected PropertyProvider	buildAndConfigurePropertyProvider()	Builds a ReflectivePropertyProvider and configures it to a typical use case based on annotations: FieldGroup is mapped to MetadataProperties.GROUP_METADATA_PROPERTY FieldOrder is mapped to MetadataProperties.ORDER_METADATA_PROPERTY BigField is mapped to MetadataProperties.MULTILINE_METADATA_PROPERTY FieldCaption is mapped to MetadataProperties.CAPTION_METADATA_PROPERTY ShowFieldAs is mapped to MetadataProperties.SHOW_AS_COMPONENT_METADATA_PROPERTY BuildFieldWith is mapped to MetadataProperties.COMPONENT_BUILDER_METADATA_PROPERTY In addition fields without a setter are marked with MetadataProperties.READ_ONLY_METADATA_PROPERTY, and collections and maps using MetadataProperties.COLLECTION_ELEMENT_TYPE_METADATA_PROPERTY, MetadataProperties.MAP_KEY_TYPE_METADATA_PROPERTY and MetadataProperties.MAP_VALUE_TYPE_METADATA_PROPERTY.
protected <T,C extends Collection<T>> CollectionField<T,C>	buildCollectionField(Property<?,T> elementProperty, Class<? extends Collection<?>> collectionType, PropertyComponentBuilder callbackFactory)	Builds a collection field.
protected <T> Collection<ComponentConfigurator<T>>	buildComponentConfigurators(Class<T> dataType)	Builds ComponentConfigurators for a given data type: components have their label set up according to MetadataProperties.CAPTION_METADATA_PROPERTY or the field name components are set to read only based on MetadataProperties.READ_ONLY_METADATA_PROPERTY components have their style names set up according to MetadataProperties.COMPONENT_STYLE_METADATA_PROPERTY components have their id set according to MetadataProperties.COMPONENT_ID_METADATA_PROPERTY
protected Collection<ComponentGroupConfigurator>	buildComponentGroupConfigurators()	Builds ComponentGroupConfigurators: each component in a named group has style names added to it (obtained from getGroupComponentStyleNames()
protected <K,V> MapField<K,V>	buildMapField(Property<?,K> keyProperty, Property<?,V> valueProperty, PropertyComponentBuilder callbackFactory)	Builds a map field.
<T> ObjectField<T>	configureObjectField(ObjectField<T> objectField)	Configures a given object field.
CollectionLayoutProvider<?>	getCollectionFieldLayoutProvider()	Returns a CollectionLayoutProvider to be used in new CollectionFields.
<E,C extends Collection<E>> com.vaadin.flow.function.SerializableSupplier<C>	getEmptyCollectionProvider(Class<C> type)	Returns an empty collection provider for a given collection type.
<K,V> com.vaadin.flow.function.SerializableSupplier<Map<K,V>>	getEmptyMapSupplier()	Returns a supplier for an empty map.
Collection<String>	getGroupComponentStyleNames()	Returns styles to be added to each component in a group in ObjectField.
Collection<String>	getGroupLayoutStyleNames()	Returns styles to be added to each group layout in an ObjectField.
<T> com.vaadin.flow.function.SerializableSupplier<T>	getInstanceProvider(Class<T> type)	Returns the instance provider associated with the given type, if any, or a default one.
<L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> com.vaadin.flow.function.SerializableSupplier<L>	getMapEntryFieldLayoutProvider()	Returns a way to obtain a layout for a MapEntryField used in MapFields.
CollectionLayoutProvider<?>	getMapFieldLayoutProvider()	Returns a CollectionLayoutProvider for new MapFields.
<L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> com.vaadin.flow.function.SerializableSupplier<L>	getObjectFieldGroupLayoutProvider()	Returns a way to obtain layouts for each group in an ObjectField.
<L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> com.vaadin.flow.function.SerializableSupplier<L>	getObjectFieldLayoutProvider()	Returns a way to obtain layouts for new ObjectFields.
<E,C extends Collection<E>> void	registerEmptyCollectionProvider(Class<C> collectionType, com.vaadin.flow.function.SerializableSupplier<C> supplier)	Registers an empty collection provider for a given collection type.
<T> void	registerInstanceProvider(Class<T> type, com.vaadin.flow.function.SerializableSupplier<T> supplier)	Registers an instance provider for a given type.
void	setCollectionFieldLayoutProvider(CollectionLayoutProvider<?> collectionFieldLayoutProvider)	Sets a new CollectionLayoutProvider to be used in new CollectionFields.
void	setEmptyMapSupplier(com.vaadin.flow.function.SerializableSupplier<Map<?,?>> emptyMapSupplier)	Sets a supplier for empty maps.
void	setGroupComponentStyleNames(Collection<String> groupComponentStyleNames)	Sets new styles to be added to each component in a group in ObjectField.
void	setGroupLayoutStyleNames(Collection<String> groupLayoutStyleNames)	Sets new styles to be added to each group layout in an ObjectField.
<L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> void	setMapEntryFieldLayoutProvider(com.vaadin.flow.function.SerializableSupplier<L> mapEntryFieldLayoutProvider)	Sets a new way to obtain layouts for MapEntryField in MapField.
void	setMapFieldLayoutProvider(CollectionLayoutProvider<?> mapFieldLayoutProvider)	Sets a new CollectionLayoutProvider to be used in new MapFields.
<L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> void	setObjectFieldGroupLayoutProvider(com.vaadin.flow.function.SerializableSupplier<L> objectFieldGroupLayoutProvider)	Sets a new way to obtain layouts for each group in an ObjectField.
<L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> void	setObjectFieldLayoutProvider(com.vaadin.flow.function.SerializableSupplier<L> objectFieldLayoutProvider)	Sets a new way to obtain layouts for new ObjectFields.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectFieldFactory

public ObjectFieldFactory()

Constructs the factory.

Method Detail

buildCollectionField

protected <T,C extends Collection<T>> CollectionField<T,C> buildCollectionField(Property<?,T> elementProperty,
                                                                                            Class<? extends Collection<?>> collectionType,
                                                                                            PropertyComponentBuilder callbackFactory)

Builds a collection field.

Type Parameters:

T - Type of element in the collection.

C - Type of collection.

Parameters:

elementProperty - Property for the element of the collection.

collectionType - Type of the collection.

callbackFactory - Callback factory to build components.

Returns:

An instance of a CollectionField.

buildMapField

protected <K,V> MapField<K,V> buildMapField(Property<?,K> keyProperty,
                                                        Property<?,V> valueProperty,
                                                        PropertyComponentBuilder callbackFactory)

Builds a map field.

Type Parameters:

K - Type of key.

V - Type of value.

Parameters:

keyProperty - Property for the key of the map.

valueProperty - Property for the value of the map.

callbackFactory - Factory to produce components.

Returns:

A MapField.

buildAndConfigureComponentBuilder

protected PropertyComponentBuilder buildAndConfigureComponentBuilder()

Builds a SimplePropertyComponentBuilder and configures it for building most default components:

• properties marked with MetadataProperties.SHOW_AS_COMPONENT_METADATA_PROPERTY as requested
• boolean properties as SuperCheckbox
• integer properties as SuperIntegerField
• long properties as SuperLongField
• double properties as SuperDoubleField
• BigDecimal properties as SuperBigDecimalField
• LocalDate properties as SuperDatePicker
• LocalDateTime properties as SuperDateTimePicker
• String properties as either SuperTextField or SuperTextArea (depending on MetadataProperties.MULTILINE_METADATA_PROPERTY)
• registered collection (lists and sets) properties as CollectionField
• map properties as MapField
• ObjectField using this factory as default (that falls back to LabelField)

Returns:

A SimplePropertyComponentBuilder.

buildAndConfigurePropertyProvider

protected PropertyProvider buildAndConfigurePropertyProvider()

Builds a ReflectivePropertyProvider and configures it to a typical use case based on annotations:

• FieldGroup is mapped to MetadataProperties.GROUP_METADATA_PROPERTY
• FieldOrder is mapped to MetadataProperties.ORDER_METADATA_PROPERTY
• BigField is mapped to MetadataProperties.MULTILINE_METADATA_PROPERTY
• FieldCaption is mapped to MetadataProperties.CAPTION_METADATA_PROPERTY
• ShowFieldAs is mapped to MetadataProperties.SHOW_AS_COMPONENT_METADATA_PROPERTY
• BuildFieldWith is mapped to MetadataProperties.COMPONENT_BUILDER_METADATA_PROPERTY

In addition fields without a setter are marked with MetadataProperties.READ_ONLY_METADATA_PROPERTY, and collections and maps using MetadataProperties.COLLECTION_ELEMENT_TYPE_METADATA_PROPERTY, MetadataProperties.MAP_KEY_TYPE_METADATA_PROPERTY and MetadataProperties.MAP_VALUE_TYPE_METADATA_PROPERTY.

Returns:

A ReflectivePropertyProvider.

buildAndConfigureGroupingProvider

protected PropertyGroupingProvider buildAndConfigureGroupingProvider()

Builds a PropertyGroupingProvider based on presence of MetadataProperties.GROUP_METADATA_PROPERTY and MetadataProperties.ORDER_METADATA_PROPERTY.

Returns:

A MetadataBasedGroupingProvider.

buildComponentConfigurators

protected <T> Collection<ComponentConfigurator<T>> buildComponentConfigurators(Class<T> dataType)

Builds ComponentConfigurators for a given data type:

• components have their label set up according to MetadataProperties.CAPTION_METADATA_PROPERTY or the field name
• components are set to read only based on MetadataProperties.READ_ONLY_METADATA_PROPERTY
• components have their style names set up according to MetadataProperties.COMPONENT_STYLE_METADATA_PROPERTY
• components have their id set according to MetadataProperties.COMPONENT_ID_METADATA_PROPERTY

Type Parameters:

T - Type of object.

Parameters:

dataType - Type of object (the type of the ObjectField the returned configurators will be added to).

Returns:

A non-null, but possibly empty collection.

buildAndConfigureGroupLayoutProvider

protected PropertyGroupLayoutProvider buildAndConfigureGroupLayoutProvider()

Builds a PropertyGroupLayoutProvider that provides a separate layout for a group with two or more properties in it. Each produced layout has style names added (from getGroupLayoutStyleNames()), if possible.

Returns:

A PropertyGroupLayoutProvider.

buildComponentGroupConfigurators

protected Collection<ComponentGroupConfigurator> buildComponentGroupConfigurators()

Builds ComponentGroupConfigurators:

• each component in a named group has style names added to it (obtained from getGroupComponentStyleNames()

Returns:

A non-null collection of ComponentGroupConfigurators.

buildAndConfigureObjectField

public <T> ObjectField<T> buildAndConfigureObjectField(Class<T> type)

Builds, configures, and repaints an ObjectField for a given type, using instance provider from getInstanceProvider(Class).

Type Parameters:

T - Type of object to display.

Parameters:

type - Type to build an ObjectField for.

Returns:

An ObjectField.

buildAndConfigureObjectField

public <T> ObjectField<T> buildAndConfigureObjectField(Class<T> type,
                                                       boolean repaint)

Builds, configures, and optionally repaints an ObjectField for a given type, using instance provider from getInstanceProvider(Class).

Type Parameters:

T - Type of object to display.

Parameters:

type - Type to build an ObjectField for.

repaint - Whether to repaint the created object field. Note that a not-repainted field will basically be empty until it is repainted or a new value is set.

Returns:

An ObjectField.

buildAndConfigureObjectField

public <T> ObjectField<T> buildAndConfigureObjectField(Class<T> type,
                                                       com.vaadin.flow.function.SerializableSupplier<T> newInstanceProvider)

Builds, configures, and repaints an ObjectField for a given type using given instance provider.

Type Parameters:

T - Type of object to display.

Parameters:

type - Type to build an ObjectField for.

newInstanceProvider - A way to produce new instances of the object.

Returns:

An ObjectField.

buildAndConfigureObjectField

public <T> ObjectField<T> buildAndConfigureObjectField(Class<T> type,
                                                       com.vaadin.flow.function.SerializableSupplier<T> newInstanceProvider,
                                                       boolean repaint)

Builds, configures and optionally repaints an ObjectField for a given type using given instance provider.

Type Parameters:

T - Type of object to display.

Parameters:

type - Type to build an ObjectField for.

newInstanceProvider - A way to produce new instances of the object.

repaint - Whether to repaint the created object field. Note that a not-repainted field will basically be empty until it is repainted or a new value is set.

Returns:

An ObjectField.

configureObjectField

public final <T> ObjectField<T> configureObjectField(ObjectField<T> objectField)

Configures a given object field. This will call the following methods, in the given order:

1. ObjectField.withPropertyProvider(PropertyProvider) using buildAndConfigurePropertyProvider()
2. ObjectField.withPropertyGroupingProvider(PropertyGroupingProvider) using buildAndConfigureGroupingProvider()
3. ObjectField.withPropertyComponentBuilder(PropertyComponentBuilder) using buildAndConfigureComponentBuilder()
4. ObjectField.withGroupLayoutProvider(PropertyGroupLayoutProvider) using buildAndConfigureGroupLayoutProvider()
5. ObjectField.withComponentConfigurators(Collection) using buildComponentConfigurators(Class)
6. ObjectField.withComponentGroupConfigurators(Collection) using buildComponentGroupConfigurators()

Type Parameters:

T - Type of object to display.

Parameters:

objectField - The passed parameter, but with the above-mentioned configuration applied.

registerInstanceProvider

public <T> void registerInstanceProvider(Class<T> type,
                                         com.vaadin.flow.function.SerializableSupplier<T> supplier)

Registers an instance provider for a given type. This speeds up creating new instances of the type in ObjectFields.

Type Parameters:

T - Type.

Parameters:

type - Type to register instance provider for.

supplier - A method called to create a new instance.

getInstanceProvider

public <T> com.vaadin.flow.function.SerializableSupplier<T> getInstanceProvider(Class<T> type)

Returns the instance provider associated with the given type, if any, or a default one.

Type Parameters:

T - Type.

Parameters:

type - Type to return the instance provider for.

Returns:

A method that produces new instances of the given type.

registerEmptyCollectionProvider

public <E,C extends Collection<E>> void registerEmptyCollectionProvider(Class<C> collectionType,
                                                                              com.vaadin.flow.function.SerializableSupplier<C> supplier)

Registers an empty collection provider for a given collection type.

Type Parameters:

E - Element type. Ignored.

C - Collection type. Ignored.

Parameters:

collectionType - Base collection type.

supplier - Supplier for an empty collection.

getEmptyCollectionProvider

public <E,C extends Collection<E>> com.vaadin.flow.function.SerializableSupplier<C> getEmptyCollectionProvider(Class<C> type)

Returns an empty collection provider for a given collection type.

Type Parameters:

E - Element type. Ignored.

C - Collection type. Ignored.

Parameters:

type - Type of collection.

Returns:

A method to produce an empty collection. Used in buildCollectionField(Property, Class, PropertyComponentBuilder).

getEmptyMapSupplier

public <K,V> com.vaadin.flow.function.SerializableSupplier<Map<K,V>> getEmptyMapSupplier()

Returns a supplier for an empty map. Used in buildMapField(Property, Property, PropertyComponentBuilder).

Returns:

A way to get an empty map.

setEmptyMapSupplier

public void setEmptyMapSupplier(com.vaadin.flow.function.SerializableSupplier<Map<?,?>> emptyMapSupplier)

Sets a supplier for empty maps.

Parameters:

emptyMapSupplier - A way to produce an empty map.

getCollectionFieldLayoutProvider

public CollectionLayoutProvider<?> getCollectionFieldLayoutProvider()

Returns a CollectionLayoutProvider to be used in new CollectionFields.

Returns:

A CollectionLayoutProvider. Used in buildCollectionField(Property, Class, PropertyComponentBuilder).

setCollectionFieldLayoutProvider

public void setCollectionFieldLayoutProvider(CollectionLayoutProvider<?> collectionFieldLayoutProvider)

Sets a new CollectionLayoutProvider to be used in new CollectionFields.

Parameters:

collectionFieldLayoutProvider - A CollectionLayoutProvider.

getMapFieldLayoutProvider

public CollectionLayoutProvider<?> getMapFieldLayoutProvider()

Returns a CollectionLayoutProvider for new MapFields.

Returns:

A CollectionLayoutProvider. Used in buildMapField(Property, Property, PropertyComponentBuilder).

setMapFieldLayoutProvider

public void setMapFieldLayoutProvider(CollectionLayoutProvider<?> mapFieldLayoutProvider)

Sets a new CollectionLayoutProvider to be used in new MapFields.

Parameters:

mapFieldLayoutProvider - A CollectionLayoutProvider.

getMapEntryFieldLayoutProvider

public <L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> com.vaadin.flow.function.SerializableSupplier<L> getMapEntryFieldLayoutProvider()

Returns a way to obtain a layout for a MapEntryField used in MapFields.

Type Parameters:

L - Type of layout.

Returns:

A way to obtain a layout. Used in buildMapField(Property, Property, PropertyComponentBuilder).

setMapEntryFieldLayoutProvider

public <L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> void setMapEntryFieldLayoutProvider(com.vaadin.flow.function.SerializableSupplier<L> mapEntryFieldLayoutProvider)

Sets a new way to obtain layouts for MapEntryField in MapField.

Type Parameters:

L - Layout type.

Parameters:

mapEntryFieldLayoutProvider - A new way to obtain layouts.

getObjectFieldLayoutProvider

public <L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> com.vaadin.flow.function.SerializableSupplier<L> getObjectFieldLayoutProvider()

Returns a way to obtain layouts for new ObjectFields.

Type Parameters:

L - Type of layout.

Returns:

A way to obtain a layout.

setObjectFieldLayoutProvider

public <L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> void setObjectFieldLayoutProvider(com.vaadin.flow.function.SerializableSupplier<L> objectFieldLayoutProvider)

Sets a new way to obtain layouts for new ObjectFields.

Type Parameters:

L - Layout type.

Parameters:

objectFieldLayoutProvider - Layout provider.

getObjectFieldGroupLayoutProvider

public <L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> com.vaadin.flow.function.SerializableSupplier<L> getObjectFieldGroupLayoutProvider()

Returns a way to obtain layouts for each group in an ObjectField. This is used in buildAndConfigureGroupLayoutProvider().

Type Parameters:

L - Layout type.

Returns:

A layout provider.

setObjectFieldGroupLayoutProvider

public <L extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> void setObjectFieldGroupLayoutProvider(com.vaadin.flow.function.SerializableSupplier<L> objectFieldGroupLayoutProvider)

Sets a new way to obtain layouts for each group in an ObjectField.

Type Parameters:

L - Type of layout.

Parameters:

objectFieldGroupLayoutProvider - A layout provider.

getGroupLayoutStyleNames

public Collection<String> getGroupLayoutStyleNames()

Returns styles to be added to each group layout in an ObjectField. This is used in buildAndConfigureGroupLayoutProvider().

Returns:

A non-null collection of styles.

setGroupLayoutStyleNames

public void setGroupLayoutStyleNames(Collection<String> groupLayoutStyleNames)

Sets new styles to be added to each group layout in an ObjectField. Each style name will have .format(groupName) applied to it.

Parameters:

groupLayoutStyleNames - Style names.

getGroupComponentStyleNames

public Collection<String> getGroupComponentStyleNames()

Returns styles to be added to each component in a group in ObjectField. This is used in buildComponentGroupConfigurators().

Returns:

A non-null collection of styles.

setGroupComponentStyleNames

public void setGroupComponentStyleNames(Collection<String> groupComponentStyleNames)

Sets new styles to be added to each component in a group in ObjectField. Each style name will have .format(groupName) applied to it.

Parameters:

groupComponentStyleNames - Style names.