com.vaadin.flow.component.HasComponents API 11.0.4 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.

All Superinterfaces:

HasElement, HasEnabled, Serializable

All Known Subinterfaces:

FlexComponent<C>, HasItemsAndComponents<T>, HasOrderedComponents<T>

All Known Implementing Classes:

Anchor, Article, Aside, DescriptionList, DescriptionList.Description, DescriptionList.Term, Dialog, Div, Emphasis, FlexLayout, Footer, FormLayout, FormLayout.FormItem, H1, H2, H3, H4, H5, H6, Header, HorizontalLayout, HtmlContainer, Image, Label, ListBox, ListItem, Main, NativeButton, Nav, Notification, OrderedList, Paragraph, RadioButtonGroup, RouterLink, Section, Span, Tab, Tabs, UI, UnorderedList, VerticalLayout
```
public interface HasComponents
extends HasElement, HasEnabled
```
A component to which the user can add and remove child components. Component in itself provides basic support for child components that are manually added as children of an element belonging to the component. This interface provides an explicit API for components that explicitly supports adding and removing arbitrary child components.
The default implementations assume that children are attached to HasElement.getElement(). Override all methods in this interface if the components should be added to some other element.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

All Methods
Modifier and Type	Method and Description
`default void`	`add(Component... components)` Adds the given components as children of this component.
`default void`	`remove(Component... components)` Removes the given child components from this component.
`default 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 interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled

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

- Method Detail
  - add
```
default void add(Component... components)
```
    Adds the given components as children of this component.
    
    Parameters:
    
    components - the components to add
  - remove
```
default void remove(Component... components)
```
    Removes the given child components from this component.
    
    Parameters:
    
    components - the components to remove
    
    Throws:
    
    IllegalArgumentException - if any of the components is not a child of this component
  - removeAll
```
default 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. it also removes the children that were added only at the client-side.