We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.
Interface HasComponents
-
All Superinterfaces:
All Known Subinterfaces:
FlexComponent, HasItemComponents<T>, HasItemsAndComponents<T>, HasOrderedComponents
All Known Implementing Classes:
Anchor, Article, Aside, Board, CheckboxGroup, ConfirmDialog, ContextMenu, ContextMenuBase, DescriptionList, DescriptionList.Description, DescriptionList.Term, Dialog, Div, Emphasis, FlexLayout, Footer, FormLayout, FormLayout.FormItem, GridContextMenu, GridMenuItem, H1, H2, H3, H4, H5, H6, Header, HorizontalLayout, HtmlContainer, HtmlObject, Image, JavaScriptBootstrapUI, Label, ListBox, ListBoxBase, ListItem, Main, MenuItem, MenuItemBase, MultiSelectListBox, NativeButton, NativeDetails.Summary, Nav, Notification, OrderedList, Paragraph, Pre, RadioButtonGroup, RouterLink, Row, Section, Select, Span, Tab, Tabs, UI, UnorderedList, VerticalLayout, WebComponentUI
public interface HasComponents extends HasElement, HasEnabledA component to which the user can add and remove child components.
Componentin 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 voidadd(Component... components)Adds the given components as children of this component.
default voidadd(String text)Add the given text as a child of this component.
default voidaddComponentAsFirst(Component component)Adds the given component as the first child of this component.
default voidaddComponentAtIndex(int index, Component component)Adds the given component as child of this component at the specific index.
default voidremove(Component... components)Removes the given child components from this component.
default voidremoveAll()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
ElementAPI.-
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.
In case the any of the specified components has already been added to another parent, it will be removed from there and added to this one.
Parameters:
components- the components to add
-
add
default void add(String text)Add the given text as a child of this component.
Parameters:
text- the text to add, notnull
-
remove
default void remove(Component... components)Removes the given child components from this component.
Parameters:
components- the components to removeThrows:
IllegalArgumentException- if there is a component whose nonnullparent is not 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
ElementAPI. it also removes the children that were added only at the client-side.
-
addComponentAtIndex
default void addComponentAtIndex(int index, Component component)Adds the given component as child of this component at the specific index.
In case the specified component has already been added to another parent, it will be removed from there and added to this one.
Parameters:
index- the index, where the component will be added. The index must be non-negative and may not exceed the children countcomponent- the component to add, value should not be null
-
addComponentAsFirst
default void addComponentAsFirst(Component component)Adds the given component as the first child of this component.
In case the specified component has already been added to another parent, it will be removed from there and added to this one.
Parameters:
component- the component to add, value should not be null
-
-