org.vaadin.miki.superfields.object

Class DefaultPropertyGroupLayoutProvider

java.lang.Object

org.vaadin.miki.superfields.object.DefaultPropertyGroupLayoutProvider

All Implemented Interfaces:

Serializable, PropertyGroupLayoutProvider

public class DefaultPropertyGroupLayoutProvider
extends Object
implements PropertyGroupLayoutProvider

Default implementation of PropertyGroupLayoutProvider. When a group consists of 2 or more elements, it returns a layout for it. Otherwise, it returns no layout.

Since:

2022-09-01

Author:

miki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultPropertyGroupLayoutProvider()
DefaultPropertyGroupLayoutProvider(com.vaadin.flow.function.SerializableSupplier<C> newLayoutProvider)

Method Summary

Modifier and Type	Method and Description
<T,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> Optional<C>	buildGroupLayout(String groupName, List<Property<T,?>> definitions) Builds a layout for a given group.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPropertyGroupLayoutProvider

public DefaultPropertyGroupLayoutProvider()

DefaultPropertyGroupLayoutProvider

public DefaultPropertyGroupLayoutProvider(com.vaadin.flow.function.SerializableSupplier<C> newLayoutProvider)

Method Detail

buildGroupLayout

public <T,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents> Optional<C> buildGroupLayout(String groupName,
                                                                                                                                List<Property<T,?>> definitions)

Description copied from interface: PropertyGroupLayoutProvider

Builds a layout for a given group.

Specified by:

buildGroupLayout in interface PropertyGroupLayoutProvider

Type Parameters:

T - Type of the object in Propertys.

C - Type to ensure the returned object is both a Component that HasComponents.

Parameters:

groupName - Name of the group.

definitions - A list of Propertys within the group.

Returns:

A layout for the group, if any needed. An empty Optional means the corresponding components will be added to the main layout of the parent component instead.