Package org.linkki.core.ui.creation.section

Enum SectionLayoutDefinition

java.lang.Object

java.lang.Enum<SectionLayoutDefinition>

org.linkki.core.ui.creation.section.SectionLayoutDefinition

All Implemented Interfaces:

Serializable, Comparable<SectionLayoutDefinition>, LinkkiLayoutDefinition

public enum SectionLayoutDefinition
extends Enum<SectionLayoutDefinition>
implements LinkkiLayoutDefinition

Defines how UI components are added to an LinkkiSection.

See Also:

SectionComponentDefiniton for the creation of the section

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Uses FormItemComponentWrappers for section content.
LABEL_ON_TOP	Uses LabelComponentWrapper for section content.

Method Summary

Modifier and Type	Method	Description
void	createChildren(Object parentComponent, Object pmo, BindingContext bindingContext)
protected abstract VaadinComponentWrapper	createComponentWrapperAndAddComponentToSection(BaseSection section, com.vaadin.flow.component.html.Label label, com.vaadin.flow.component.Component component)	Creates the component wrapper for the given Label and Component and adds it to the given BaseSection.
static SectionLayoutDefinition	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SectionLayoutDefinition[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final SectionLayoutDefinition DEFAULT

Uses FormItemComponentWrappers for section content. Labels are shown aside of the components.

LABEL_ON_TOP

public static final SectionLayoutDefinition LABEL_ON_TOP

Uses LabelComponentWrapper for section content. Labels are shown on top of the components.

Method Detail

values

public static SectionLayoutDefinition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SectionLayoutDefinition c : SectionLayoutDefinition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SectionLayoutDefinition valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

createChildren

public void createChildren(Object parentComponent,
                           Object pmo,
                           BindingContext bindingContext)

The parent component must be an LinkkiSection.

Specified by:

createChildren in interface LinkkiLayoutDefinition

Throws:

ClassCastException - if the parent component is not an LinkkiSection.

createComponentWrapperAndAddComponentToSection

protected abstract VaadinComponentWrapper createComponentWrapperAndAddComponentToSection(BaseSection section,
                                                                                         com.vaadin.flow.component.html.Label label,
                                                                                         com.vaadin.flow.component.Component component)

Creates the component wrapper for the given Label and Component and adds it to the given BaseSection.

Note that it is necessary to add the component directly to the section in this method. In case of a FormItemComponentWrapper, the LabelComponentFormItem has to be added to the section, and not the given Component itself. However, it is not possible to retrieve the created LabelComponentFormItem from the FormItemComponentWrapper after creation. Thus, the LabelComponentFormItem has to be added to the section before it is returned.