com.vaadin.flow.component.formlayout.FormLayout.FormItem API 24.7.0 | Vaadin

com.vaadin.flow.component.formlayout.

java.lang.Object

com.vaadin.flow.component.Component

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

All Implemented Interfaces:

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

Enclosing class:

@Tag("vaadin-form-item") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.7.1") @NpmPackage(value="@vaadin/form-layout",version="24.7.1") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @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, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, 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.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, add, add, addComponentAsFirst, addComponentAtIndex, remove

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.HasStyle
addClassName, addClassNames, 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 HasComponents.add(Component...).
  See Also:
  
  HasComponents.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 HasComponents.add(Component...).
  Parameters:
  
  components - the initial components to wrap as a form item.
  
  See Also:
  
  HasComponents.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 HasComponents
- remove
  
  public void remove(Component... components)
  
  Removes the given child components from this component.
  
  Specified by:
  
  remove in interface HasComponents
  
  Parameters:
  
  components - The components to remove.
  
  Throws:
  
  IllegalArgumentException - if any of the components is not a child of this component.