Package com.vaadin.flow.component.formlayout

Class FormLayout.FormItem

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.formlayout.FormLayout.FormItem

All Implemented Interfaces:

AttachNotifier, ClickNotifier<FormLayout.FormItem>, DetachNotifier, HasComponents, HasComponentsOfType<Component>, HasElement, HasEnabled, HasStyle, Serializable

Enclosing class:

FormLayout

@Tag("vaadin-form-item")
@NpmPackage(value="@vaadin/form-layout",
            version="25.2.0-alpha13")
@JsModule("@vaadin/form-layout/src/vaadin-form-item.js")
public static class FormLayout.FormItem
extends Component
implements HasComponents, HasStyle, ClickNotifier<FormLayout.FormItem>

Server-side component for the <vaadin-form-item> element. Used to wrap components for display in a FormLayout.

Author:

Vaadin Ltd

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FormItem()	Constructs an empty FormItem.
FormItem(Component... components)	Constructs a FormItem with the given initial components to wrap.

Method Summary

Modifier and Type	Method	Description
protected void	addToLabel(Component... components)	Adds the given components as children of this component at the slot 'label'.
void	remove(Component... components)	Removes the given child components from this component.
void	removeAll()	Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the Element API.

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

addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, 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.ClickNotifier

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

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

addDetachListener

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

add

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

add, add, addComponentAsFirst, addComponentAtIndex, bindChildren, getChildren, getComponentAt, getComponentCount, indexOf, remove, replace

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

getElement

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

bindEnabled, isEnabled, setEnabled

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

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

Constructor Details

FormItem

public FormItem()

Constructs an empty FormItem. Components to wrap can be added after construction with HasComponentsOfType.add(Component...).

See Also:

• HasComponentsOfType.add(Component...)

FormItem

public FormItem(Component... components)

Constructs a FormItem with the given initial components to wrap. Additional components can be added after construction with HasComponentsOfType.add(Component...).

Parameters:

components - the initial components to wrap as a form item.

See Also:

• HasComponentsOfType.add(Component...)

Method Details

addToLabel

protected void addToLabel(Component... components)

Adds the given components as children of this component at the slot 'label'.

Parameters:

components - The components to add.

See Also:

• MDN page about slots
• Spec website about slots

removeAll

public void removeAll()

Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the Element API.

Specified by:

removeAll in interface HasComponentsOfType<Component>

remove

public void remove(Component... components)

Removes the given child components from this component.

Specified by:

remove in interface HasComponentsOfType<Component>

Parameters:

components - The components to remove.

Throws:

IllegalArgumentException - if any of the components is not a child of this component.