Package org.vaadin.miki.superfields.object

Class ObjectField<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<T>,T>

com.vaadin.flow.component.customfield.CustomField<T>

org.vaadin.miki.superfields.object.ObjectField<T>

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, Serializable, HasHelperPositionable, HasId, HasLabelPositionable, WithHelperMixin<ObjectField<T>>, WithHelperPositionableMixin<ObjectField<T>>, WithIdMixin<ObjectField<T>>, WithLabelMixin<ObjectField<T>>, WithLabelPositionableMixin<ObjectField<T>>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T,ObjectField<T>>

@CssImport(value="./styles/label-positions.css",
           themeFor="vaadin-custom-field")
public class ObjectField<T>
extends com.vaadin.flow.component.customfield.CustomField<T>
implements com.vaadin.flow.component.HasStyle, WithHelperMixin<ObjectField<T>>, WithHelperPositionableMixin<ObjectField<T>>, WithIdMixin<ObjectField<T>>, WithLabelMixin<ObjectField<T>>, WithLabelPositionableMixin<ObjectField<T>>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T,ObjectField<T>>

A field capable of displaying any object, provided it is known how to construct various elements of it. Construction of the field happens in stages:

1. obtain properties of the object
2. group properties
3. map each property to a component capable of showing that property
4. configure components (individually and in defined groups)
5. set value of each component

Note that the above defines just the overall process. While there are reasonable defaults, they do very little. Please adjust the configuration to suit individual use cases.

Since:

2022-05-16

Author:

miki

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V extends Object>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Field Summary

Fields

Modifier and Type	Field	Description
static final com.vaadin.flow.function.SerializableSupplier<PropertyComponentBuilder>	DEFAULT_COMPONENT_BUILDER
static final com.vaadin.flow.function.SerializableSupplier<PropertyGroupLayoutProvider>	DEFAULT_GROUP_LAYOUT_PROVIDER
static final com.vaadin.flow.function.SerializableSupplier<PropertyGroupingProvider>	DEFAULT_GROUPING_PROVIDER
static final com.vaadin.flow.function.SerializableSupplier<com.vaadin.flow.component.orderedlayout.FlexLayout>	DEFAULT_LAYOUT_PROVIDER
static final com.vaadin.flow.function.SerializableSupplier<PropertyProvider>	DEFAULT_PROPERTY_PROVIDER

Fields inherited from interface org.vaadin.miki.markers.HasHelperPositionable

HELPER_ABOVE_THEME_VARIANT

Fields inherited from interface org.vaadin.miki.markers.HasLabelPositionable

LABEL_POSITION_ATTRIBUTE, LABEL_POSITION_DETAILS_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
ObjectField(Class<T> dataType, com.vaadin.flow.function.SerializableSupplier<T> emptyObjectSupplier)	Builds an ObjectField using DEFAULT_LAYOUT_PROVIDER for the main layout.
ObjectField(Class<T> dataType, com.vaadin.flow.function.SerializableSupplier<T> emptyObjectSupplier, com.vaadin.flow.function.SerializableSupplier<L> layoutSupplier)	Builds an ObjectField using a given supplier for the main layout.

Method Summary

Modifier and Type	Method	Description
void	addComponentConfigurators(Collection<ComponentConfigurator<T>> configurators)	Adds given ComponentConfigurators.
final void	addComponentConfigurators(ComponentConfigurator<T>... configurators)	Adds given ComponentConfigurators.
void	addComponentGroupConfigurators(Collection<ComponentGroupConfigurator> configurators)	Adds given ComponentGroupConfigurators.
void	addComponentGroupConfigurators(ComponentGroupConfigurator... configurators)	Adds given ComponentGroupConfigurators.
void	clearComponentConfigurators()	Removes all previously added ComponentConfigurator.
void	clearComponentGroupConfigurators()	Removes all previously added ComponentGroupConfigurators.
void	focus()
protected T	generateModelValue()
Class<T>	getDataType()	Returns the type of the value returned by this field.
PropertyGroupLayoutProvider	getGroupLayoutProvider()	Returns current PropertyGroupLayoutProvider.
PropertyComponentBuilder	getPropertyComponentBuilder()	Returns the current PropertyComponentBuilder.
PropertyGroupingProvider	getPropertyGroupingProvider()	Returns the current PropertyGroupingProvider.
PropertyProvider	getPropertyProvider()	Returns the current PropertyProvider.
protected boolean	isReloadNeeded()	Checks if reloading is currently needed.
protected void	markReloadNeeded()	Indicates that reload of data and components is needed.
void	removeComponentConfigurator(ComponentConfigurator<T> configurator)	Removes given configurator.
void	removeComponentGroupConfigurator(ComponentGroupConfigurator configurator)	Removes given ComponentGroupConfigurator.
void	repaint()	Repaints the component with its current value.
void	setGroupLayoutProvider(PropertyGroupLayoutProvider groupLayoutProvider)	Sets the new PropertyGroupLayoutProvider.
protected void	setPresentationValue(T t)
void	setPropertyComponentBuilder(PropertyComponentBuilder builder)	Sets the new PropertyComponentBuilder.
void	setPropertyGroupingProvider(PropertyGroupingProvider propertyGroupingProvider)	Sets the new PropertyGroupingProvider.
void	setPropertyProvider(PropertyProvider propertyProvider)	Sets the new PropertyProvider.
void	setReadOnly(boolean readOnly)
final ObjectField<T>	withComponentConfigurators(Collection<ComponentConfigurator<T>> configurators)	Chains addComponentConfigurators(Collection) and returns itself.
final ObjectField<T>	withComponentConfigurators(ComponentConfigurator<T>... configurators)	Chains addComponentConfigurators(ComponentConfigurator[]) and returns itself.
final ObjectField<T>	withComponentGroupConfigurators(Collection<ComponentGroupConfigurator> configurators)	Chains addComponentGroupConfigurators(Collection) and returns itself.
final ObjectField<T>	withComponentGroupConfigurators(ComponentGroupConfigurator... configurators)	Chains addComponentGroupConfigurators(ComponentGroupConfigurator...) and returns itself.
final ObjectField<T>	withGroupLayoutProvider(PropertyGroupLayoutProvider provider)	Chains setGroupLayoutProvider(PropertyGroupLayoutProvider) and returns itself.
final ObjectField<T>	withPropertyComponentBuilder(PropertyComponentBuilder builder)	Chains setPropertyComponentBuilder(PropertyComponentBuilder) and returns itself.
final ObjectField<T>	withPropertyGroupingProvider(PropertyGroupingProvider provider)	Chains setPropertyGroupingProvider(PropertyGroupingProvider) and returns itself.
final ObjectField<T>	withPropertyProvider(PropertyProvider provider)	Chains setPropertyProvider(PropertyProvider) and returns itself.

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, getLabel, onAttach, remove, removeThemeVariants, setLabel, updateValue

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface org.vaadin.miki.markers.HasHelperPositionable

isHelperAbove, setHelperAbove, setHelperAbove, setHelperBelow

Methods inherited from interface org.vaadin.miki.markers.HasId

getId, setId

Methods inherited from interface com.vaadin.flow.component.HasLabel

getLabel, setLabel

Methods inherited from interface org.vaadin.miki.markers.HasLabelPositionable

getLabelPosition, setLabelPosition

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, isInvalid, setErrorMessage, setInvalid

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Methods inherited from interface org.vaadin.miki.markers.WithHelperMixin

withHelperComponent, withHelperText

Methods inherited from interface org.vaadin.miki.markers.WithHelperPositionableMixin

withHelperAbove, withHelperAbove, withHelperBelow

Methods inherited from interface org.vaadin.miki.markers.WithIdMixin

withId

Methods inherited from interface org.vaadin.miki.markers.WithLabelMixin

withLabel

Methods inherited from interface org.vaadin.miki.markers.WithLabelPositionableMixin

withLabelPosition

Methods inherited from interface org.vaadin.miki.markers.WithValueMixin

withValue

Field Details

DEFAULT_LAYOUT_PROVIDER

public static final com.vaadin.flow.function.SerializableSupplier<com.vaadin.flow.component.orderedlayout.FlexLayout> DEFAULT_LAYOUT_PROVIDER

DEFAULT_PROPERTY_PROVIDER

public static final com.vaadin.flow.function.SerializableSupplier<PropertyProvider> DEFAULT_PROPERTY_PROVIDER

DEFAULT_COMPONENT_BUILDER

public static final com.vaadin.flow.function.SerializableSupplier<PropertyComponentBuilder> DEFAULT_COMPONENT_BUILDER

DEFAULT_GROUPING_PROVIDER

public static final com.vaadin.flow.function.SerializableSupplier<PropertyGroupingProvider> DEFAULT_GROUPING_PROVIDER

DEFAULT_GROUP_LAYOUT_PROVIDER

public static final com.vaadin.flow.function.SerializableSupplier<PropertyGroupLayoutProvider> DEFAULT_GROUP_LAYOUT_PROVIDER

Constructor Details

ObjectField

public ObjectField(Class<T> dataType,
 com.vaadin.flow.function.SerializableSupplier<T> emptyObjectSupplier)

Builds an ObjectField using DEFAULT_LAYOUT_PROVIDER for the main layout.

Parameters:

dataType - Type of objects to display.

emptyObjectSupplier - A method to provide new, empty objects of the given type.

ObjectField

public ObjectField(Class<T> dataType,
 com.vaadin.flow.function.SerializableSupplier<T> emptyObjectSupplier,
 com.vaadin.flow.function.SerializableSupplier<L> layoutSupplier)

Builds an ObjectField using a given supplier for the main layout.

Type Parameters:

L - Layout type.

Parameters:

dataType - Type of objects to display.

emptyObjectSupplier - A method to provide new, empty objects of the given type.

layoutSupplier - A method to provide the main layout of this component.

Method Details

generateModelValue

protected T generateModelValue()

Specified by:

generateModelValue in class com.vaadin.flow.component.customfield.CustomField<T>

repaint

public void repaint()

Repaints the component with its current value. In some rare cases it makes sense to completely reload the components without changing the value of this field.

setPresentationValue

protected void setPresentationValue(T t)

Specified by:

setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<T>

getDataType

public Class<T> getDataType()

Returns the type of the value returned by this field.

Returns:

Type.

markReloadNeeded

protected void markReloadNeeded()

Indicates that reload of data and components is needed.

isReloadNeeded

protected boolean isReloadNeeded()

Checks if reloading is currently needed.

Returns:

When true, the inner state of the component will be reloaded the next time a value is displayed.

getPropertyProvider

public PropertyProvider getPropertyProvider()

Returns the current PropertyProvider.

Returns:

Current PropertyProvider.

setPropertyProvider

public void setPropertyProvider(PropertyProvider propertyProvider)

Sets the new PropertyProvider. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

propertyProvider - A PropertyProvider to use. If null is passed, one provided by DEFAULT_PROPERTY_PROVIDER will be used.

withPropertyProvider

public final ObjectField<T> withPropertyProvider(PropertyProvider provider)

Chains setPropertyProvider(PropertyProvider) and returns itself.

Parameters:

provider - A PropertyProvider to use.

Returns:

This.

See Also:

• setPropertyProvider(PropertyProvider)

setPropertyComponentBuilder

public void setPropertyComponentBuilder(PropertyComponentBuilder builder)

Sets the new PropertyComponentBuilder. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

builder - A PropertyComponentBuilder to use. If null is passed, one provided by DEFAULT_COMPONENT_BUILDER will be used.

getPropertyComponentBuilder

public PropertyComponentBuilder getPropertyComponentBuilder()

Returns the current PropertyComponentBuilder.

Returns:

A PropertyComponentBuilder.

withPropertyComponentBuilder

public final ObjectField<T> withPropertyComponentBuilder(PropertyComponentBuilder builder)

Chains setPropertyComponentBuilder(PropertyComponentBuilder) and returns itself.

Parameters:

builder - Builder.

Returns:

This.

See Also:

• setPropertyComponentBuilder(PropertyComponentBuilder)

setPropertyGroupingProvider

public void setPropertyGroupingProvider(PropertyGroupingProvider propertyGroupingProvider)

Sets the new PropertyGroupingProvider. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

propertyGroupingProvider - A PropertyGroupingProvider to use. If null is passed, one provided by DEFAULT_GROUPING_PROVIDER will be used.

getPropertyGroupingProvider

public PropertyGroupingProvider getPropertyGroupingProvider()

Returns the current PropertyGroupingProvider.

Returns:

A PropertyGroupingProvider.

withPropertyGroupingProvider

public final ObjectField<T> withPropertyGroupingProvider(PropertyGroupingProvider provider)

Chains setPropertyGroupingProvider(PropertyGroupingProvider) and returns itself.

Parameters:

provider - Provider.

Returns:

This.

See Also:

• setPropertyGroupingProvider(PropertyGroupingProvider)

getGroupLayoutProvider

public PropertyGroupLayoutProvider getGroupLayoutProvider()

Returns current PropertyGroupLayoutProvider.

Returns:

A PropertyGroupLayoutProvider.

setGroupLayoutProvider

public void setGroupLayoutProvider(PropertyGroupLayoutProvider groupLayoutProvider)

Sets the new PropertyGroupLayoutProvider. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

groupLayoutProvider - A PropertyGroupLayoutProvider to use. If null is passed, one provided by DEFAULT_GROUP_LAYOUT_PROVIDER will be used.

withGroupLayoutProvider

public final ObjectField<T> withGroupLayoutProvider(PropertyGroupLayoutProvider provider)

Chains setGroupLayoutProvider(PropertyGroupLayoutProvider) and returns itself.

Parameters:

provider - Provider.

Returns:

This.

See Also:

• setGroupLayoutProvider(PropertyGroupLayoutProvider)

addComponentConfigurators

@SafeVarargs
public final void addComponentConfigurators(ComponentConfigurator<T>... configurators)

Adds given ComponentConfigurators. Each configurator receives every component for each property. Configurators are run in the order of adding. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

configurators - Configurators to add.

addComponentConfigurators

public void addComponentConfigurators(Collection<ComponentConfigurator<T>> configurators)

Adds given ComponentConfigurators. Each configurator receives every component for each property. Configurators are run in the order of adding. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

configurators - Configurators to add.

removeComponentConfigurator

public void removeComponentConfigurator(ComponentConfigurator<T> configurator)

Removes given configurator.

Parameters:

configurator - Configurator to remove.

withComponentConfigurators

@SafeVarargs
public final ObjectField<T> withComponentConfigurators(ComponentConfigurator<T>... configurators)

Chains addComponentConfigurators(ComponentConfigurator[]) and returns itself.

Parameters:

configurators - Configurators to add.

Returns:

This.

See Also:

• addComponentConfigurators(ComponentConfigurator[])

withComponentConfigurators

public final ObjectField<T> withComponentConfigurators(Collection<ComponentConfigurator<T>> configurators)

Chains addComponentConfigurators(Collection) and returns itself.

Parameters:

configurators - Configurators to add.

Returns:

This.

See Also:

• addComponentConfigurators(Collection)

clearComponentConfigurators

public void clearComponentConfigurators()

Removes all previously added ComponentConfigurator. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

addComponentGroupConfigurators

public void addComponentGroupConfigurators(ComponentGroupConfigurator... configurators)

Adds given ComponentGroupConfigurators. Each configurator receives every group of components after basic ComponentConfigurators are executed. Configurators are run in the order of adding. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

configurators - Configurators to add.

addComponentGroupConfigurators

public void addComponentGroupConfigurators(Collection<ComponentGroupConfigurator> configurators)

Adds given ComponentGroupConfigurators. Each configurator receives every group of components after basic ComponentConfigurators are executed. Configurators are run in the order of adding. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

configurators - Configurators to add.

removeComponentGroupConfigurator

public void removeComponentGroupConfigurator(ComponentGroupConfigurator configurator)

Removes given ComponentGroupConfigurator. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

Parameters:

configurator - Configurator to remove.

withComponentGroupConfigurators

public final ObjectField<T> withComponentGroupConfigurators(ComponentGroupConfigurator... configurators)

Chains addComponentGroupConfigurators(ComponentGroupConfigurator...) and returns itself.

Parameters:

configurators - Configurators to add.

Returns:

This.

See Also:

• addComponentGroupConfigurators(ComponentGroupConfigurator...)

withComponentGroupConfigurators

public final ObjectField<T> withComponentGroupConfigurators(Collection<ComponentGroupConfigurator> configurators)

Chains addComponentGroupConfigurators(Collection) and returns itself.

Parameters:

configurators - Configurators to add.

Returns:

This.

See Also:

• addComponentGroupConfigurators(Collection)

clearComponentGroupConfigurators

public void clearComponentGroupConfigurators()

Removes all previously added ComponentGroupConfigurators. Note that changes will not be reflected until the component is repaint()ed or a new value is set.

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>

focus

public void focus()

Specified by:

focus in interface com.vaadin.flow.component.Focusable<T>