Uses of Class
com.vaadin.flow.component.Component
-
-
Uses of Component in com.vaadin.collaborationengine
Subclasses of Component in com.vaadin.collaborationengine Modifier and Type Class Description classCollaborationAvatarGroupExtension of theAvatarGroupcomponent which integrates with theCollaborationEngine.classCollaborationMessageInputExtension of theMessageInputcomponent which integrates with theCollaborationMessageList.classCollaborationMessageListExtension of theMessageListcomponent which integrates with theCollaborationEngine.Methods in com.vaadin.collaborationengine with parameters of type Component Modifier and Type Method Description voidComponentConnectionContext. addComponent(Component component)Adds a component instance to track for this context.TopicConnectionRegistrationCollaborationEngine. openTopicConnection(Component component, String topicId, UserInfo localUser, SerializableFunction<TopicConnection,Registration> connectionActivationCallback)Opens a connection to the collaboration topic with the provided id based on a component instance.voidComponentConnectionContext. removeComponent(Component component)Stops tracking a component for this context.Constructors in com.vaadin.collaborationengine with parameters of type Component Constructor Description ComponentConnectionContext(Component component)Creates a new component connection context which is initially using a single component.FormManager(Component component, UserInfo localUser, String topicId)Creates a new manager for the provided component.MessageManager(Component component, UserInfo localUser, String topicId)Creates a new manager for the given component.MessageManager(Component component, UserInfo localUser, String topicId, CollaborationMessagePersister persister)Creates a new persisting manager for the given component.PresenceManager(Component component, UserInfo localUser, String topicId)Creates a new manager for the provided component. -
Uses of Component in com.vaadin.flow.component
Classes in com.vaadin.flow.component with type parameters of type Component Modifier and Type Class Description classAbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T>An abstract field class that is backed by a composite component.static classAbstractField.ComponentValueChangeEvent<C extends Component,V>Value change event fired by components.interfaceBlurNotifier<T extends Component>Mixin interface to handle blur events on components.static classBlurNotifier.BlurEvent<C extends Component>Represents the DOM event "blur".classClickEvent<C extends Component>Event fired when a component is clicked.interfaceClickNotifier<T extends Component>Mixin interface for components that support adding click listeners to the their root elements.classComponentEvent<T extends Component>An event whose source is aComponent.classComposite<T extends Component>A composite encapsulates aComponenttree to allow creation of new components by composing existing components.interfaceFocusable<T extends Component>Represents a component that can gain and lose focus.interfaceFocusNotifier<T extends Component>Mixin interface to handle focus events on components.static classFocusNotifier.FocusEvent<C extends Component>Represents the DOM event "focus".classWebComponentExporter<C extends Component>Exports aComponentas a web component.interfaceWebComponentExporterFactory<C extends Component>Exports aComponentas a web component.static classWebComponentExporterFactory.DefaultWebComponentExporterFactory<C extends Component>Default factory implementation which uses an exporter class to instantiate it using its default constructor.Subclasses of Component in com.vaadin.flow.component Modifier and Type Class Description classAbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T>An abstract field class that is backed by a composite component.classAbstractField<C extends AbstractField<C,T>,T>An abstract implementation of a field, or aComponentallowing user input.classAbstractSinglePropertyField<C extends AbstractField<C,T>,T>Abstract field that is based on a single element property.classComposite<T extends Component>A composite encapsulates aComponenttree to allow creation of new components by composing existing components.classHtmlA component which encapsulates a given HTML fragment with a single root element.classHtmlComponentBase class for aComponentthat represents a single built-in HTML element.classHtmlContainerBase class for aComponentthat represents a single built-in HTML element that can contain child components or text.classTextA component which encapsulates the given text in a text node.classUIThe topmost component in any component hierarchy.Methods in com.vaadin.flow.component with type parameters of type Component Modifier and Type Method Description static <T extends Component>
TComponentUtil. componentFromElement(Element element, Class<T> componentType, boolean mapComponent)Creates a new component instance using the given element, maps the component to the element and optionally maps the element to the component (ifmapComponentistrue).<T extends Component>
WebComponentConfiguration<T>WebComponentExporter.WebComponentConfigurationFactory. create(WebComponentExporter<T> exporter)Creates aWebComponentConfigurationfor the providedWebComponentExporterinstances.static <T extends Component>
voidComponentUtil. fireEvent(T component, ComponentEvent<? extends T> componentEvent)Dispatches the event to all listeners registered for the event type.static <T extends Component>
TComponent. from(Element element, Class<T> componentType)Creates a new component instance using the given element.<T,C extends Component & HasUrlParameter<T>>
Optional<C>UI. navigate(Class<? extends C> navigationTarget, T parameter)Updates this UI to show the view corresponding to the given navigation target with the specified parameter.<T,C extends Component & HasUrlParameter<T>>
Optional<C>UI. navigate(Class<? extends C> navigationTarget, T parameter, QueryParameters queryParameters)Updates this UI to show the view corresponding to the given navigation target with the specified parameter.<T extends Component>
Optional<T>UI. navigate(Class<? extends T> navigationTarget, QueryParameters queryParameters)Updates this UI to show the view corresponding to the given navigation target and query parameters.<T extends Component>
Optional<T>UI. navigate(Class<T> navigationTarget)Updates this UI to show the view corresponding to the given navigation target.<T extends Component>
Optional<T>UI. navigate(Class<T> navigationTarget, RouteParameters parameters)Updates this UI to show the view corresponding to the given navigation target with the specified parameters.Methods in com.vaadin.flow.component that return Component Modifier and Type Method Description ComponentUI. getActiveDragSourceComponent()Gets the drag source of an active HTML5 drag event.default ComponentHasOrderedComponents. getComponentAt(int index)Returns the component at the given position.default ComponentHasHelper. getHelperComponent()Gets the component in the helper slot of this field.static ComponentComponentUtil. getInnermostComponent(Composite<?> composite)Returns the innermost component from aCompositechain, i.e.static ComponentComponentUtil. getInnermostComponent(Element element)Gets the innermost mapped component for the element.ComponentShortcutEvent. getLifecycleOwner()Component which owns the shortcut.ComponentShortcutRegistration. getLifecycleOwner()Componentwhich controls when the shortcut is active and when it is not.ComponentShortcutRegistration. getOwner()Deprecated.This component has now multiple owners so this method has been replaced by #getOwners().Component[]ShortcutRegistration. getOwners()TheComponents which own the shortcuts key event listeners.static ComponentComponentUtil. getParentUsingComposite(Composite<?> composite, Component component)Gets the parent of the given component, which is inside the given composite.ComponentShortcutEvent. getSource()Component which listened for the shortcut.Methods in com.vaadin.flow.component that return types with arguments of type Component Modifier and Type Method Description static Optional<Component>ComponentUtil. findParentComponent(Element element)Finds the first component by traversing upwards in the element hierarchy, starting from the given element.Stream<Component>Component. getChildren()Gets the child components of this component.Stream<Component>Composite. getChildren()Gets the child components of this composite.Stream<Component>HasOrderedComponents. getChildren()Gets the children components of this component.Optional<Component>Component. getParent()Gets the parent component of this component.Methods in com.vaadin.flow.component with parameters of type Component Modifier and Type Method Description default voidHasComponents. add(Component... components)Adds the given components as children of this component.voidUI. add(Component... components)Adds the given components to the UI.default voidHasComponents. addComponentAsFirst(Component component)Adds the given component as the first child of this component.default voidHasComponents. addComponentAtIndex(int index, Component component)Adds the given component as child of this component at the specific index.static <T extends ComponentEvent<?>>
RegistrationComponentUtil. addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener)Adds a listener for an event of the given type to thecomponent.static <T extends ComponentEvent<?>>
RegistrationComponentUtil. addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener, Consumer<DomListenerRegistration> domListenerConsumer)Adds a listener for an event of the given type to thecomponent, and customizes the corresponding DOM event listener with the given consumer.voidUI. addModal(Component component)Adds the given component as a modal child to the UI, making the UI and all other (existing) components added to the UI impossible for the user to interact with.static ShortcutRegistrationShortcuts. addShortcutListener(Component lifecycleOwner, ShortcutEventListener listener, Key key, KeyModifier... keyModifiers)Invoke aShortcutEventListenerwhen the shortcut is invoked.static ShortcutRegistrationShortcuts. addShortcutListener(Component lifecycleOwner, Command command, Key key, KeyModifier... keyModifiers)Invoke aCommandwhen the shortcut is invoked.voidUI. addToModalComponent(Component component)Add component as child to modal component if one is active.StateTree.ExecutionRegistrationUI. beforeClientResponse(Component component, SerializableConsumer<ExecutionContext> execution)Registers a task to be executed before the response is sent to the client.ShortcutRegistrationShortcutRegistration. bindLifecycleTo(Component component)Binds the shortcut's life cycle to that of the givenComponent.static <T> TComponentUtil. getData(Component component, Class<T> type)Gets a data instance with the given type, ornullif there is no such instance.static ObjectComponentUtil. getData(Component component, String key)Gets a data instance with the given key, ornullif no data has been set for that key.static Collection<?>ComponentUtil. getListeners(Component component, Class<? extends ComponentEvent> eventType)Returns all listeners that match or extend the given event type.static ComponentComponentUtil. getParentUsingComposite(Composite<?> composite, Component component)Gets the parent of the given component, which is inside the given composite.static <T extends ComponentEvent<?>>
booleanComponentUtil. hasEventListener(Component component, Class<? extends T> eventType)Check if the component has at least one registered listener of the given event type.default intHasOrderedComponents. indexOf(Component component)Returns the index of the given component.static booleanComponentUtil. isCompositeContent(Composite<?> composite, Component component)Checks if the given component is inside aCompositechain, i.e.ShortcutRegistrationShortcutRegistration. listenOn(Component... listenOnComponents)Fluently define theComponentonto which the shortcut's listener is bound.static voidComponentUtil. onComponentAttach(Component component, boolean initialAttach)Handles triggering theonAttachmethod and firing theAttachEventfor the given component when it has been attached to a UI.static voidComponentUtil. onComponentDetach(Component component)Handles triggering theonDetachmethod and firing theDetachEventfor the given component right before it is detached from a UI.default voidHasComponents. remove(Component... components)Removes the given child components from this component.default voidHasOrderedComponents. replace(Component oldComponent, Component newComponent)Replaces the component in the container with another one without changing position.voidUI. setChildComponentModal(Component childComponent, boolean modal)Makes the child component modal or modeless.static <T> voidComponentUtil. setData(Component component, Class<T> type, T value)Stores an instance of a specific type for the given component.static voidComponentUtil. setData(Component component, String key, Object value)Stores a arbitrary value for the given component.protected static voidComponent. setElement(Component component, Element element)Initializes the root element of a component.default voidHasHelper. setHelperComponent(Component component)Adds the given component into helper slot of component, replacing any existing helper component.static RegistrationShortcuts. setShortcutListenOnElement(String elementLocatorJs, Component listenOnComponent)Setup an element, that is only accessible on the browser (not server side), to listen for shortcut events on and delegate to the given component.Method parameters in com.vaadin.flow.component with type arguments of type Component Modifier and Type Method Description default voidHasComponents. add(Collection<Component> components)Adds the given components as children of this component.static voidComponentUtil. findComponents(Element element, Consumer<Component> componentConsumer)static ComponentMetaData.DependencyInfoComponentUtil. getDependencies(VaadinService service, Class<? extends Component> componentClass)Gets the dependencies for the given class, defined using annotations (JavaScript,StyleSheetandUses).static Collection<ComponentMetaData.SynchronizedPropertyInfo>ComponentUtil. getSynchronizedProperties(Class<? extends Component> componentClass)Gets the synchronized property infos of the properties that are defined declaratively for the given class with their RPC update mode.static Stream<String>ComponentUtil. getSynchronizedPropertyEvents(Class<? extends Component> componentClass)Gets the name of the synchronized property event defined declaratively for the given class.default voidHasComponents. remove(Collection<Component> components)Removes the given child components from this component.Constructors in com.vaadin.flow.component with parameters of type Component Constructor Description AttachEvent(Component source, boolean initialAttach)Creates a new attach event with the given component as source.ClickEvent(Component source)Creates a new server-side click event with no additional information.ClickEvent(Component source, boolean fromClient, int screenX, int screenY, int clientX, int clientY, int clickCount, int button, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey)Creates a new click event.ComponentEventBus(Component component)Creates an event bus for the given component.CompositionEndEvent(Component source)Creates a new server-side composition event with no additional information.CompositionEndEvent(Component source, boolean fromClient, String data, String locale)Creates a new composition event.CompositionStartEvent(Component source)Creates a new server-side composition event with no additional information.CompositionStartEvent(Component source, boolean fromClient, String data, String locale)Creates a new composition event.CompositionUpdateEvent(Component source)Creates a new server-side composition event with no additional information.CompositionUpdateEvent(Component source, boolean fromClient, String data, String locale)Creates a new composition event.DetachEvent(Component source)Creates a new detach event with the given component as source.HtmlContainer(Component... components)Creates a component with the given child components.HtmlContainer(String tagName, Component... components)Creates a new component with the given contents and a new element with the given tag name.InputEvent(Component source, boolean fromClient)Creates a new input event.KeyDownEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)Creates a new keyboard event.KeyDownEvent(Component source, String key)Creates a new server-side keyboard event with no additional information.KeyDownEvent(Component source, String key, String code)Creates a new server-side keyboard event with no additional information.KeyPressEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)Creates a new keyboard event.KeyPressEvent(Component source, String key)Creates a new server-side keyboard event with no additional information.KeyPressEvent(Component source, String key, String code)Creates a new server-side keyboard event with no additional information.KeyUpEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)Creates a new keyboard event.KeyUpEvent(Component source, String key)Creates a new server-side keyboard event with no additional information.KeyUpEvent(Component source, String key, String code)Creates a new server-side keyboard event with no additional information.ShortcutEvent(Component source, Component lifecycleOwner, Key key, Set<KeyModifier> keyModifiers)Creates a newShortcutEvent. -
Uses of Component in com.vaadin.flow.component.accordion
Subclasses of Component in com.vaadin.flow.component.accordion Modifier and Type Class Description classAccordionAccordion is a vertically stacked set of expandable panels.classAccordionPanelAn accordion panel which could be opened or closed.Methods in com.vaadin.flow.component.accordion with parameters of type Component Modifier and Type Method Description AccordionPanelAccordion. add(String summary, Component content)Adds a panel created from the given title and content.voidAccordion. remove(Component content)Removes a panel based on the contentConstructors in com.vaadin.flow.component.accordion with parameters of type Component Constructor Description AccordionPanel(Component summary)Initializes a new panel using the provided summary.AccordionPanel(Component summary, Component content)Creates a panel with the provided summary component and content.AccordionPanel(Component summary, Component... components)Initializes a new panel using the provided summary and content components.AccordionPanel(String summary, Component content)Creates a panel with the provided summary text and content.AccordionPanel(String summary, Component... components)Initializes a new panel using the provided summary and content components. -
Uses of Component in com.vaadin.flow.component.applayout
Subclasses of Component in com.vaadin.flow.component.applayout Modifier and Type Class Description classAppLayoutApp Layout is a component for building common application layouts.classDrawerToggleServer-side component for the<vaadin-drawer-toggle>element.Methods in com.vaadin.flow.component.applayout that return Component Modifier and Type Method Description ComponentAppLayout. getContent()Methods in com.vaadin.flow.component.applayout with parameters of type Component Modifier and Type Method Description voidAppLayout. addToDrawer(Component... components)Adds the components to the drawer slot of this AppLayout.voidAppLayout. addToNavbar(boolean touchOptimized, Component... components)Adds the components to the navbar slot of this AppLayout.voidAppLayout. addToNavbar(Component... components)Adds the components to the navbar slot of this AppLayout.voidAppLayout. remove(Component... components)Removes the child components from the parent.voidAppLayout. setContent(Component content)Sets the displayed content.voidDrawerToggle. setIcon(Component icon) -
Uses of Component in com.vaadin.flow.component.avatar
Subclasses of Component in com.vaadin.flow.component.avatar Modifier and Type Class Description classAvatarAvatar is a graphical representation of an object or entity, for example a person or an organisation.classAvatarGroupAvatar Group is used to group multiple Avatars together. -
Uses of Component in com.vaadin.flow.component.board
Subclasses of Component in com.vaadin.flow.component.board Modifier and Type Class Description classBoardVaadin Board allows creating responsive layouts in an easy way.classRowRow class to define rows used in aBoardinstance.Methods in com.vaadin.flow.component.board with parameters of type Component Modifier and Type Method Description voidRow. add(Component... components)Adds the given component(s) to the row.voidRow. add(Component component, int cols)Adds the given component to the row using the given number of columns.RowBoard. addRow(Component... components)Creates a new row and adds the given components to the row.intRow. getComponentSpan(Component component)Gets the number of columns the given component spans.voidRow. setComponentSpan(Component component, int columns)Sets the number of columns the given component spans.Constructors in com.vaadin.flow.component.board with parameters of type Component Constructor Description Row(Component... components)Creates an new row with the given components. -
Uses of Component in com.vaadin.flow.component.board.internal
Methods in com.vaadin.flow.component.board.internal with parameters of type Component Modifier and Type Method Description static voidFunctionCaller. callOnceOnClientReponse(Component component, String function)An internal helper for executing a JS function only once after other updates have been done. -
Uses of Component in com.vaadin.flow.component.button
Subclasses of Component in com.vaadin.flow.component.button Modifier and Type Class Description classButtonThe Button component allows users to perform actions.classGeneratedVaadinButton<R extends GeneratedVaadinButton<R>>Deprecated.since v23.3, generated classes will be removed in v24.Methods in com.vaadin.flow.component.button that return Component Modifier and Type Method Description ComponentButton. getIcon()Gets the component that is defined as the icon of this button.Methods in com.vaadin.flow.component.button with parameters of type Component Modifier and Type Method Description protected voidGeneratedVaadinButton. addToPrefix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinButton. addToSuffix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinButton. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.voidButton. setIcon(Component icon)Sets the given component as the icon of this button.Constructors in com.vaadin.flow.component.button with parameters of type Component Constructor Description Button(Component icon)Creates a button with an icon inside.Button(Component icon, ComponentEventListener<ClickEvent<Button>> clickListener)Creates a button with an icon and a listener for click events.Button(String text, Component icon)Creates a button with a text and an icon inside.Button(String text, Component icon, ComponentEventListener<ClickEvent<Button>> clickListener)Create a button with a text, an icon and a listener for click events. -
Uses of Component in com.vaadin.flow.component.charts
Subclasses of Component in com.vaadin.flow.component.charts Modifier and Type Class Description classChartVaadin Charts is a feature-rich interactive charting library for Vaadin. -
Uses of Component in com.vaadin.flow.component.checkbox
Subclasses of Component in com.vaadin.flow.component.checkbox Modifier and Type Class Description classCheckboxCheckbox is an input field representing a binary choice.classCheckboxGroup<T>CheckBoxGroup is a multi-selection component where items are displayed as check boxes.classGeneratedVaadinCheckbox<R extends GeneratedVaadinCheckbox<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinCheckboxGroup<R extends GeneratedVaadinCheckboxGroup<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.Methods in com.vaadin.flow.component.checkbox that return types with arguments of type Component Modifier and Type Method Description ComponentRenderer<? extends Component,T>CheckboxGroup. getItemRenderer()Returns the item component renderer.Methods in com.vaadin.flow.component.checkbox with parameters of type Component Modifier and Type Method Description voidCheckbox. setLabelComponent(Component component)Replaces the label content with the given label component.Method parameters in com.vaadin.flow.component.checkbox with type arguments of type Component Modifier and Type Method Description voidCheckboxGroup. setRenderer(ComponentRenderer<? extends Component,T> renderer)Sets the item renderer for this checkbox group. -
Uses of Component in com.vaadin.flow.component.combobox
Subclasses of Component in com.vaadin.flow.component.combobox Modifier and Type Class Description classComboBox<T>Combo Box allows the user to choose a value from a filterable list of options presented in an overlay.classComboBoxBase<TComponent extends ComboBoxBase<TComponent,TItem,TValue>,TItem,TValue>Provides base functionality for combo box related components, such asComboBoxclassMultiSelectComboBox<TItem>MultiSelectComboBox allows the user to select one or more values from a filterable list of options presented in an overlay.Methods in com.vaadin.flow.component.combobox with parameters of type Component Modifier and Type Method Description protected voidComboBox. addToPrefix(Component... components)Deprecated.since v23.3protected voidComboBox. remove(Component... components)Deprecated.since v23.3 -
Uses of Component in com.vaadin.flow.component.combobox.dataview
Constructors in com.vaadin.flow.component.combobox.dataview with parameters of type Component Constructor Description ComboBoxLazyDataView(DataCommunicator<T> dataCommunicator, Component component)Creates a new lazy data view for ComboBox and verifies the passed data provider is compatible with this data view implementation. -
Uses of Component in com.vaadin.flow.component.confirmdialog
Subclasses of Component in com.vaadin.flow.component.confirmdialog Modifier and Type Class Description classConfirmDialogConfirm Dialog is a modal Dialog used to confirm user actions.Methods in com.vaadin.flow.component.confirmdialog with parameters of type Component Modifier and Type Method Description voidConfirmDialog. setCancelButton(Component component)Sets custom cancel buttonvoidConfirmDialog. setConfirmButton(Component component)Sets custom confirm buttonvoidConfirmDialog. setHeader(Component component)Sets confirmation dialog custom header elementvoidConfirmDialog. setRejectButton(Component component)Sets custom Reject buttonvoidConfirmDialog. setText(Component component)Sets custom confirmation message element -
Uses of Component in com.vaadin.flow.component.contextmenu
Classes in com.vaadin.flow.component.contextmenu with type parameters of type Component Modifier and Type Class Description classMenuManager<C extends Component,I extends MenuItemBase<?,I,S>,S extends SubMenuBase<?,I,S>>Common management logic for context menus and sub menus.Subclasses of Component in com.vaadin.flow.component.contextmenu Modifier and Type Class Description classContextMenuContext Menu is a component that you can attach to any component to display a context menu.classContextMenuBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>>Base functionality for server-side components based on<vaadin-context-menu>.classGeneratedVaadinContextMenu<R extends ContextMenuBase<R,?,?>>Deprecated.since v23.3, generated classes will be removed in v24.classMenuItemItem component used insideContextMenuandSubMenu.classMenuItemBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>>Base class for item component used insideContextMenus.Methods in com.vaadin.flow.component.contextmenu that return Component Modifier and Type Method Description ComponentContextMenuBase. getTarget()Gets the target component of this context menu, ornullif it doesn't have a target.Methods in com.vaadin.flow.component.contextmenu that return types with arguments of type Component Modifier and Type Method Description Stream<Component>ContextMenuBase. getChildren()Gets the child components of this component.Stream<Component>MenuManager. getChildren()Gets all (sub)menu children.Stream<Component>SubMenuBase. getChildren()Gets the child components of this sub menu.Methods in com.vaadin.flow.component.contextmenu with parameters of type Component Modifier and Type Method Description voidContextMenuBase. add(Component... components)Adds the given components into the context menu overlay.voidMenuManager. add(Component... components)Adds components to the (sub)menu.voidSubMenuBase. add(Component... components)Adds the given components into the sub menu overlay.voidContextMenuBase. addComponentAtIndex(int index, Component component)Adds the given component into this context menu at the given index.voidMenuManager. addComponentAtIndex(int index, Component component)Inserts component to the (sub)menu using theindex.voidSubMenuBase. addComponentAtIndex(int index, Component component)Adds the given component into the sub menu overlay at the given index.MenuItemContextMenu. addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)IContextMenuBase. addItem(Component component)Adds a new item component with the given component to the context menu overlay.MenuItemHasMenuItems. addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)Adds a new item component with the given component and click listener to the context menu overlay.IMenuManager. addItem(Component component)Adds a component as a menu item.IMenuManager. addItem(Component component, ComponentEventListener<ClickEvent<I>> clickListener)Adds a component as a menu item with a click listener.MenuItemSubMenu. addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)ISubMenuBase. addItem(Component component)Adds a new item component with the given component to the sub menu overlay.voidContextMenuBase. remove(Component... components)voidMenuManager. remove(Component... components)Removes components to the (sub)menu.voidSubMenuBase. remove(Component... components)Removes the given components from the sub menu overlay.voidContextMenuBase. setTarget(Component target)Sets the target component for this context menu.Constructors in com.vaadin.flow.component.contextmenu with parameters of type Component Constructor Description ContextMenu(Component target)Creates an empty context menu with the given target component.MenuItemsArrayGenerator(Component menu) -
Uses of Component in com.vaadin.flow.component.cookieconsent
Subclasses of Component in com.vaadin.flow.component.cookieconsent Modifier and Type Class Description classCookieConsentCookie Consent is a component for showing a cookie consent banner the first time a user visits the application, until the banner is dismissed. -
Uses of Component in com.vaadin.flow.component.crud
Subclasses of Component in com.vaadin.flow.component.crud Modifier and Type Class Description classCrud<E>A component for performing CRUD operations on a data backend (e.g entities from a database).classCrudGrid<E>A simple grid implementation for Crud that allows searching and sorting backed by a data provider.Methods in com.vaadin.flow.component.crud that return Component Modifier and Type Method Description ComponentBinderCrudEditor. getView()Deprecated.This method should not be used outside.ComponentCrudEditor. getView()Returns the user interface of an editor.Methods in com.vaadin.flow.component.crud with parameters of type Component Modifier and Type Method Description voidCrud. setToolbar(Component... components)Sets the content of the toolbar.Constructors in com.vaadin.flow.component.crud with parameters of type Component Constructor Description BinderCrudEditor(Binder<E> binder, Component view)Initializes a BinderCrudEditor with the given binder and form view -
Uses of Component in com.vaadin.flow.component.customfield
Subclasses of Component in com.vaadin.flow.component.customfield Modifier and Type Class Description classCustomField<T>AHasValuewhose UI content can be constructed by the user, enabling the creation of e.g.Methods in com.vaadin.flow.component.customfield with parameters of type Component Modifier and Type Method Description protected voidCustomField. add(Component... components)Adds the given components as children of this component.protected voidCustomField. remove(Component... components)Removes the given child components from this component. -
Uses of Component in com.vaadin.flow.component.datepicker
Subclasses of Component in com.vaadin.flow.component.datepicker Modifier and Type Class Description classDatePickerDate Picker is an input field that allows the user to enter a date by typing or by selecting from a calendar overlay.classGeneratedVaadinDatePicker<R extends GeneratedVaadinDatePicker<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.Methods in com.vaadin.flow.component.datepicker with parameters of type Component Modifier and Type Method Description protected voidGeneratedVaadinDatePicker. addToPrefix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinDatePicker. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24. -
Uses of Component in com.vaadin.flow.component.datetimepicker
Subclasses of Component in com.vaadin.flow.component.datetimepicker Modifier and Type Class Description classDateTimePickerDate Time Picker is an input field for selecting both a date and a time. -
Uses of Component in com.vaadin.flow.component.dependency
Methods in com.vaadin.flow.component.dependency that return types with arguments of type Component Modifier and Type Method Description Class<? extends Component>value()Marks the component class to depend on. -
Uses of Component in com.vaadin.flow.component.details
Subclasses of Component in com.vaadin.flow.component.details Modifier and Type Class Description classDetailsDetails is an expandable panel for showing and hiding content from the user to make the UI less crowded.Methods in com.vaadin.flow.component.details that return Component Modifier and Type Method Description ComponentDetails. getSummary()Returns summary component which was set viaDetails.setSummary(Component)orDetails.setSummaryText(String)Methods in com.vaadin.flow.component.details that return types with arguments of type Component Modifier and Type Method Description Stream<Component>Details. getContent()Returns the content components which were added viaDetails.setContent(Component)or viaDetails.addContent(Component...)Methods in com.vaadin.flow.component.details with parameters of type Component Modifier and Type Method Description voidDetails. addContent(Component... components)Adds components to the content sectionvoidDetails. setContent(Component content)Sets the component contentvoidDetails. setSummary(Component summary)Sets the component summaryConstructors in com.vaadin.flow.component.details with parameters of type Component Constructor Description Details(Component summary)Initializes a new Details using the provided summary.Details(Component summary, Component content)Initializes a new Details using the provided summary and content.Details(Component summary, Component... components)Initializes a new Details using the provided summary and content components.Details(String summary, Component content)Initializes a new Details using the provided summary and content.Details(String summary, Component... components)Initializes a new Details using the provided summary and content components. -
Uses of Component in com.vaadin.flow.component.dialog
Subclasses of Component in com.vaadin.flow.component.dialog Modifier and Type Class Description classDialogA Dialog is a small window that can be used to present information and user interface elements in an overlay.classGeneratedVaadinDialog<R extends GeneratedVaadinDialog<R>>Deprecated.since v23.3, generated classes will be removed in v24.Methods in com.vaadin.flow.component.dialog that return types with arguments of type Component Modifier and Type Method Description Stream<Component>Dialog. getChildren()Methods in com.vaadin.flow.component.dialog with parameters of type Component Modifier and Type Method Description voidDialog. add(Component... components)Adds the given components into this dialog.voidDialog. addComponentAtIndex(int index, Component component)Adds the given component into this dialog at the given index.voidDialog. remove(Component... components)Constructors in com.vaadin.flow.component.dialog with parameters of type Component Constructor Description Dialog(Component... components)Creates a dialog with given components inside. -
Uses of Component in com.vaadin.flow.component.dnd
Classes in com.vaadin.flow.component.dnd with type parameters of type Component Modifier and Type Class Description classDragEndEvent<T extends Component>HTML5 drag end event, fired when the user stops dragging a drag source either by dropping on top of a valid drop target or by canceling to drop.interfaceDragSource<T extends Component>Mixin interface that provides basic drag source API for any component.classDragStartEvent<T extends Component>HTML5 drag start event, fired when the user starts dragging a drag source.classDropEvent<T extends Component>Server side drop event.interfaceDropTarget<T extends Component>Mixin interface that provides basic drop target API for any component.Methods in com.vaadin.flow.component.dnd with type parameters of type Component Modifier and Type Method Description static <T extends Component>
DragSource<T>DragSource. configure(T component)Gives access to the generic drag source API for the given component.static <T extends Component>
DragSource<T>DragSource. configure(T component, boolean draggable)Gives access to the generic drag source API for the given component and applies the given draggable status to it.static <T extends Component>
DropTarget<T>DropTarget. configure(T component)Gives access to the generic drop target API for the given component.static <T extends Component>
DropTarget<T>DropTarget. configure(T component, boolean active)Gives access to the generic drop target API for the given component and either activates or deactivates the drop target.static <T extends Component>
DragSource<T>DragSource. create(T component)Makes the given component draggable and gives access to the generic drag source API for the component.static <T extends Component>
DropTarget<T>DropTarget. create(T component)Makes the given component a drop target and gives access to the generic drop target API for the component.Methods in com.vaadin.flow.component.dnd that return types with arguments of type Component Modifier and Type Method Description Optional<Component>DropEvent. getDragSourceComponent()Returns the drag source component if the drag originated from a component in the same UI as the drop target component, or an empty optional. -
Uses of Component in com.vaadin.flow.component.dnd.internal
Methods in com.vaadin.flow.component.dnd.internal with type parameters of type Component Modifier and Type Method Description static <T extends Component>
voidDndUtil. updateDragSourceActivation(DragSource<T> dragSource)Triggers drag source activation method in JS connector once when the component has been attached.static <T extends Component>
voidDndUtil. updateDropTargetActivation(DropTarget<T> dropTarget)Triggers drop target activation method in JS connector once when the component has been attached.Methods in com.vaadin.flow.component.dnd.internal with parameters of type Component Modifier and Type Method Description static voidDndUtil. addMobileDndPolyfillIfNeeded(Component component)Adds the mobile dnd polyfills when a iOS device is used. -
Uses of Component in com.vaadin.flow.component.formlayout
Subclasses of Component in com.vaadin.flow.component.formlayout Modifier and Type Class Description classFormLayoutForm Layout allows you to build responsive forms with multiple columns and to position input labels on top or to the side of the input.static classFormLayout.FormItemServer-side component for the<vaadin-form-item>element.classGeneratedVaadinFormItem<R extends GeneratedVaadinFormItem<R>>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinFormLayout<R extends GeneratedVaadinFormLayout<R>>Deprecated.since v23.3, generated classes will be removed in v24.Methods in com.vaadin.flow.component.formlayout with parameters of type Component Modifier and Type Method Description voidFormLayout. add(Component component, int colspan)Adds a component with the desired colspan.FormLayout.FormItemFormLayout. addFormItem(Component field, Component label)Convenience method for creating and adding a new FormItem to this layout that wraps the given field with a component as its label.FormLayout.FormItemFormLayout. addFormItem(Component field, String label)Convenience method for creating and adding a new FormItem to this layout that wraps the given field with a label.protected voidGeneratedVaadinFormItem. addToLabel(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.intFormLayout. getColspan(Component component)Gets the colspan of the given component.voidFormLayout.FormItem. remove(Component... components)protected voidGeneratedVaadinFormItem. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.voidFormLayout. setColspan(Component component, int colspan)Sets the colspan of the given component's element.Constructors in com.vaadin.flow.component.formlayout with parameters of type Component Constructor Description FormItem(Component... components)Constructs a FormItem with the given initial components to wrap.FormLayout(Component... components)Constructs a FormLayout with the given initial components. -
Uses of Component in com.vaadin.flow.component.grid
Subclasses of Component in com.vaadin.flow.component.grid Modifier and Type Class Description classGrid<T>Grid is a component for showing tabular data.static classGrid.Column<T>Server-side component for the<vaadin-grid-column>element.classGridSelectionColumnServer side implementation for the flow specific grid selection column.Methods in com.vaadin.flow.component.grid with type parameters of type Component Modifier and Type Method Description <V extends Component>
Grid.Column<T>Grid. addComponentColumn(ValueProvider<T,V> componentProvider)Adds a new column that shows components.Methods in com.vaadin.flow.component.grid that return Component Modifier and Type Method Description ComponentFooterRow.FooterCell. getComponent()ComponentHeaderRow.HeaderCell. getComponent()ComponentGrid.Column. getEditorComponent()Gets the editor component that is used for this column.Methods in com.vaadin.flow.component.grid with parameters of type Component Modifier and Type Method Description voidFooterRow.FooterCell. setComponent(Component component)voidHeaderRow.HeaderCell. setComponent(Component component)Grid.Column<T>Grid.Column. setEditorComponent(Component editorComponent)Sets a component to use for editing values of this column in the editor row.Grid.Column<T>Grid.Column. setFooter(Component footerComponent)Sets a footer component to the column.Grid.Column<T>Grid.Column. setHeader(Component headerComponent)Sets a header component to the column.Method parameters in com.vaadin.flow.component.grid with type arguments of type Component Modifier and Type Method Description Grid.Column<T>Grid.Column. setEditorComponent(SerializableFunction<T,? extends Component> componentCallback)Sets a function that returns the editor component to be used for an specific item in the editor row. -
Uses of Component in com.vaadin.flow.component.grid.contextmenu
Subclasses of Component in com.vaadin.flow.component.grid.contextmenu Modifier and Type Class Description classGridContextMenu<T>Server-side component for<vaadin-context-menu>to be used withGrid.classGridMenuItem<T>Item component used insideGridContextMenuandGridSubMenu.Methods in com.vaadin.flow.component.grid.contextmenu with parameters of type Component Modifier and Type Method Description GridMenuItem<T>GridContextMenu. addItem(Component component, ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>> clickListener)GridMenuItem<T>GridSubMenu. addItem(Component component, ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>> clickListener)voidGridContextMenu. setTarget(Component target)Sets the target component for this context menu. -
Uses of Component in com.vaadin.flow.component.grid.editor
Method parameters in com.vaadin.flow.component.grid.editor with type arguments of type Component Modifier and Type Method Description voidEditorRenderer. setComponentFunction(SerializableFunction<T,? extends Component> componentFunction)Sets the function that creates components to be used as editors for the column. -
Uses of Component in com.vaadin.flow.component.gridpro
Subclasses of Component in com.vaadin.flow.component.gridpro Modifier and Type Class Description classGridPro<E>static classGridPro.EditColumn<T>Server-side component for the<vaadin-grid-edit-column>element. -
Uses of Component in com.vaadin.flow.component.html
Subclasses of Component in com.vaadin.flow.component.html Modifier and Type Class Description classAnchorComponent representing an<a>element.classArticleComponent representing a<article>element.classAsideComponent representing a<aside>element.classDescriptionListComponent representing a<dl>element.static classDescriptionList.DescriptionComponent representing a<dd>element.static classDescriptionList.TermComponent representing a<dt>element.classDivComponent representing a<div>element.classEmphasisComponent representing a<em>element.classFooterComponent representing a<footer>element.classH1Component representing a<h1>element.classH2Component representing a<h2>element.classH3Component representing a<h3>element.classH4Component representing a<h4>element.classH5Component representing a<h5>element.classH6Component representing a<h6>element.classHeaderComponent representing a<header>element.classHrComponent representing a<hr>element.classHtmlObjectComponent representing a<object>element.classIFrameComponent representing a<iframe>element.classImageComponent representing a<img>element.classInputComponent representing an<input>element.classLabelComponent for a<label>element, which represents a caption for an item in a user interface.classListItemComponent representing a<li>element.classMainComponent representing a<main>element.classNativeButtonComponent representing a<button>element.classNativeDetailsComponent representing a<details>element.static classNativeDetails.SummaryComponent representing a<summary>element.classNavComponent representing a<nav>element.classOrderedListComponent representing a<ol>element.classParagraphComponent representing a<p>element.classParamComponent representing a<param>element for<param>element.classPreComponent representing a<pre>element.classSectionComponent representing a<section>element.classSpanComponent representing a<span>element.classUnorderedListComponent representing a<ul>element.Methods in com.vaadin.flow.component.html that return Component Modifier and Type Method Description ComponentNativeDetails. getContent()Returns the details content which was set viaNativeDetails.setContent(Component).Methods in com.vaadin.flow.component.html with parameters of type Component Modifier and Type Method Description voidNativeDetails. setContent(Component content)Sets the details content and removes the previously set content.voidLabel. setFor(Component forComponent)Sets the component that this label describes.voidNativeDetails. setSummary(Component... summaryContent)Sets the components of the summary.Constructors in com.vaadin.flow.component.html with parameters of type Component Constructor Description Anchor(String href, Component... components)Creates an anchor component with the given href and components as children of this component.Article(Component... components)Creates a new article with the given child components.Aside(Component... components)Creates a new aside with the given child components.Description(Component... components)Creates a new description with the given child components.Div(Component... components)Creates a new div with the given child components.Emphasis(Component... components)Creates a new emphasis with the given child components.Footer(Component... components)Creates a new footer with the given child components.H1(Component... components)Creates a new heading with the given child components.H2(Component... components)Creates a new heading with the given child components.H3(Component... components)Creates a new heading with the given child components.H4(Component... components)Creates a new heading with the given child components.H5(Component... components)Creates a new heading with the given child components.H6(Component... components)Creates a new heading with the given child components.Header(Component... components)Creates a new header with the given child components.ListItem(Component... components)Creates a new list item with the given child components.Main(Component... components)Creates a new main with the given child components.NativeDetails(Component summaryContent)Creates a new details with the given content of the summary.NativeDetails(Component summaryContent, Component content)Creates a new details using the provided summary content and content.NativeDetails(String summary, Component content)Creates a new details using the provided summary and content.Nav(Component... components)Creates a new nav with the given child components.Paragraph(Component... components)Creates a new paragraph with the given child components.Pre(Component... components)Creates a new preformatted text block with the given child components.Section(Component... components)Creates a new section with the given child components.Span(Component... components)Creates a new span with the given child components.Term(Component... components)Creates a new term with the given child components. -
Uses of Component in com.vaadin.flow.component.icon
Subclasses of Component in com.vaadin.flow.component.icon Modifier and Type Class Description classIconComponent for displaying an icon from the Vaadin Icons collection.classIronIconDeprecated.since Vaadin 21,IronIconis deprecated in favor ofIcon -
Uses of Component in com.vaadin.flow.component.internal
Classes in com.vaadin.flow.component.internal with type parameters of type Component Modifier and Type Class Description classAbstractFieldSupport<C extends Component & HasValue<AbstractField.ComponentValueChangeEvent<C,T>,T>,T>Encapsulates all the logic required for a typical field implementation.Subclasses of Component in com.vaadin.flow.component.internal Modifier and Type Class Description classJavaScriptBootstrapUICustom UI forJavaScriptBootstrapHandler.static classJavaScriptBootstrapUI.ClientViewPlaceholderPlaceholder view when navigating from server-side views to client-side views.Methods in com.vaadin.flow.component.internal that return Component Modifier and Type Method Description ComponentUIInternals. getActiveDragSourceComponent()Gets the drag source of an active HTML5 drag event.ComponentUIInternals. getActiveModalComponent()Get the active modal component if modal components set.Methods in com.vaadin.flow.component.internal that return types with arguments of type Component Modifier and Type Method Description Stream<Component>JavaScriptBootstrapUI. getChildren()Methods in com.vaadin.flow.component.internal with parameters of type Component Modifier and Type Method Description voidUIInternals. setActiveDragSourceComponent(Component activeDragSourceComponent)Sets the drag source of an active HTML5 drag event.voidUIInternals. setChildModal(Component child)Makes an existing child component modal.voidUIInternals. setChildModeless(Component child)Sets the given child modeless.voidUIInternals. showRouteTarget(Location viewLocation, Component target, List<RouterLayout> layouts)Shows a route target in the related UI.Method parameters in com.vaadin.flow.component.internal with type arguments of type Component Modifier and Type Method Description voidUIInternals. addComponentDependencies(Class<? extends Component> componentClass)Adds the dependencies defined usingStyleSheetorJavaScripton the given Component class.Constructors in com.vaadin.flow.component.internal with parameters of type Component Constructor Description AbstractAttachDetachEvent(Component source)Creates a new event with the given component as source.CompositionEvent(Component source)Creates a new server-side composition event with no additional information.CompositionEvent(Component source, boolean fromClient, String data, String locale)Creates a new composition event.KeyboardEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)Creates a new keyboard event.KeyboardEvent(Component source, String key)Creates a new server-side keyboard event with no additional information.KeyboardEvent(Component source, String key, String code)Creates a new server-side keyboard event with no additional information.Constructor parameters in com.vaadin.flow.component.internal with type arguments of type Component Constructor Description ComponentMetaData(Class<? extends Component> componentClass)Scans the given component class and creates a new instance based on found annotations. -
Uses of Component in com.vaadin.flow.component.ironlist
Subclasses of Component in com.vaadin.flow.component.ironlist Modifier and Type Class Description classIronList<T>Deprecated.since Vaadin 21,IronListis deprecated in favor ofVirtualList -
Uses of Component in com.vaadin.flow.component.listbox
Subclasses of Component in com.vaadin.flow.component.listbox Modifier and Type Class Description classListBox<T>List Box allows the user to select one or more values from a scrollable list of items.classListBoxBase<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE>Base class for theListBoxandMultiSelectListBox.classMultiSelectListBox<T>Server-side component for thevaadin-list-boxelement with multi-selection.Methods in com.vaadin.flow.component.listbox that return types with arguments of type Component Modifier and Type Method Description ComponentRenderer<? extends Component,ITEM>ListBoxBase. getItemRenderer()Returns the item component renderer.Method parameters in com.vaadin.flow.component.listbox with type arguments of type Component Modifier and Type Method Description voidListBoxBase. setRenderer(ComponentRenderer<? extends Component,ITEM> itemRenderer)Sets the item renderer for this ListBox. -
Uses of Component in com.vaadin.flow.component.littemplate
Subclasses of Component in com.vaadin.flow.component.littemplate Modifier and Type Class Description classLitTemplateComponent which renders a LitElement template.Methods in com.vaadin.flow.component.littemplate that return types with arguments of type Component Modifier and Type Method Description Stream<Component>LitTemplate. getChildren()Gets the child components of this component.Constructor parameters in com.vaadin.flow.component.littemplate with type arguments of type Component Constructor Description InjectableLitElementInitializer(Element element, Class<? extends Component> templateClass)Creates an initializer for theelement. -
Uses of Component in com.vaadin.flow.component.login
Subclasses of Component in com.vaadin.flow.component.login Modifier and Type Class Description classAbstractLoginAbstract component for the<vaadin-login-overlay>and<vaadin-login-form>components.classLoginFormLogin is a component that contains a login form.classLoginOverlayServer-side component for the<vaadin-login-overlay>component.Methods in com.vaadin.flow.component.login that return Component Modifier and Type Method Description ComponentLoginOverlay. getTitle()Returns custom title component which was set viaLoginOverlay.setTitle(Component)Methods in com.vaadin.flow.component.login with parameters of type Component Modifier and Type Method Description voidLoginOverlay. setTitle(Component title)Sets the application title,nullto remove any previous title and to display title set viaLoginOverlay.setTitle(String). -
Uses of Component in com.vaadin.flow.component.map
Subclasses of Component in com.vaadin.flow.component.map Modifier and Type Class Description classMapMap is a component for displaying geographic maps from various sources.classMapBaseBase class for the map component. -
Uses of Component in com.vaadin.flow.component.menubar
Subclasses of Component in com.vaadin.flow.component.menubar Modifier and Type Class Description classMenuBarMenu Bar is a horizontal button bar with hierarchical drop-down menus.Methods in com.vaadin.flow.component.menubar that return types with arguments of type Component Modifier and Type Method Description Stream<Component>MenuBar. getChildren()Gets the child components of this menu bar.Methods in com.vaadin.flow.component.menubar with parameters of type Component Modifier and Type Method Description MenuItemMenuBar. addItem(Component component)Creates a newMenuItemcomponent and adds it to the root level of this menu bar.MenuItemMenuBar. addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)Creates a newMenuItemcomponent with the provided click listener and adds it to the root level of this menu bar.MenuItemMenuBar. addItem(Component component, String tooltipText)Creates a newMenuItemcomponent with the provided tooltip text and adds it to the root level of this menu bar.MenuItemMenuBar. addItem(Component component, String tooltipText, ComponentEventListener<ClickEvent<MenuItem>> clickListener)Creates a newMenuItemcomponent with the provided click listener and the tooltip text and adds it to the root level of this menu bar. -
Uses of Component in com.vaadin.flow.component.messages
Subclasses of Component in com.vaadin.flow.component.messages Modifier and Type Class Description classMessageInputMessage Input allows users to author and send messages.classMessageListMessage List allows you to show a list of messages, for example, a chat log. -
Uses of Component in com.vaadin.flow.component.notification
Subclasses of Component in com.vaadin.flow.component.notification Modifier and Type Class Description classGeneratedVaadinNotification<R extends GeneratedVaadinNotification<R>>Deprecated.since v23.3, generated classes will be removed in v24.classNotificationNotifications are used to provide feedback to the user.Methods in com.vaadin.flow.component.notification that return types with arguments of type Component Modifier and Type Method Description Stream<Component>Notification. getChildren()Methods in com.vaadin.flow.component.notification with parameters of type Component Modifier and Type Method Description voidNotification. add(Component... components)Adds the given components into this notification.voidNotification. addComponentAtIndex(int index, Component component)Adds the given component into this notification at the given index.voidNotification. remove(Component... components)Remove the given components from this notification.Constructors in com.vaadin.flow.component.notification with parameters of type Component Constructor Description Notification(Component... components)Creates a notification with given components inside. -
Uses of Component in com.vaadin.flow.component.orderedlayout
Subclasses of Component in com.vaadin.flow.component.orderedlayout Modifier and Type Class Description classFlexLayoutA layout component that implements Flexbox.classHorizontalLayoutHorizontal Layout places components side-by-side in a row.classScrollerScroller is a component container which enables scrolling overflowing content.classVerticalLayoutVertical Layout places components top-to-bottom in a column.Methods in com.vaadin.flow.component.orderedlayout that return Component Modifier and Type Method Description ComponentScroller. getContent()Gets the content of this scroller.Methods in com.vaadin.flow.component.orderedlayout with parameters of type Component Modifier and Type Method Description voidHorizontalLayout. addAndExpand(Component... components)Adds the given components to this layout and sets them as expanded.voidVerticalLayout. addAndExpand(Component... components)Adds the given components to this layout and sets them as expanded.default voidFlexComponent. expand(Component... componentsToExpand)Expands the given components.FlexComponent.AlignmentVerticalLayout. getHorizontalComponentAlignment(Component component)Gets the individual horizontal alignment of a given component.FlexComponent.AlignmentHorizontalLayout. getVerticalComponentAlignment(Component component)Gets the individual vertical alignment of a given component.default voidFlexComponent. replace(Component oldComponent, Component newComponent)voidScroller. setContent(Component content)Sets the content of this scroller.voidVerticalLayout. setHorizontalComponentAlignment(FlexComponent.Alignment alignment, Component... componentsToAlign)Sets a horizontal alignment for individual components inside the layout.voidHorizontalLayout. setVerticalComponentAlignment(FlexComponent.Alignment alignment, Component... componentsToAlign)Sets a vertical alignment for individual components inside the layout.Constructors in com.vaadin.flow.component.orderedlayout with parameters of type Component Constructor Description FlexLayout(Component... children)Convenience constructor to create a layout with the children already inside it.HorizontalLayout(Component... children)Convenience constructor to create a layout with the children already inside it.Scroller(Component content)Convenience constructor to create a scroller with the given content.Scroller(Component content, Scroller.ScrollDirection scrollDirection)Convenience constructor to create a scroller with the given content and scroll direction.VerticalLayout(Component... children)Convenience constructor to create a layout with the children already inside it. -
Uses of Component in com.vaadin.flow.component.polymertemplate
Subclasses of Component in com.vaadin.flow.component.polymertemplate Modifier and Type Class Description classAbstractTemplate<M extends TemplateModel>Deprecated.Polymer template support is deprecated - we recommend you to useLitTemplateinstead.classPolymerTemplate<M extends TemplateModel>Deprecated.Polymer template support is deprecated - we recommend you to useLitTemplateinstead.Methods in com.vaadin.flow.component.polymertemplate that return types with arguments of type Component Modifier and Type Method Description Stream<Component>PolymerTemplate. getChildren()Deprecated.Gets the child components of this component.static Optional<Class<? extends Component>>TemplateInitializer. getUsesClass(Class<? extends PolymerTemplate<?>> templateType, String tagName)Deprecated.Looks for a component class with the given tag name among the classes used by the given polymer template class.Constructors in com.vaadin.flow.component.polymertemplate with parameters of type Component Constructor Description IdMapper(Component template)Deprecated.Creates a mapper for the given template.Constructor parameters in com.vaadin.flow.component.polymertemplate with type arguments of type Component Constructor Description InjectablePolymerElementInitializer(Element element, Class<? extends Component> templateClass)Deprecated.Creates an initializer for theelement. -
Uses of Component in com.vaadin.flow.component.polymertemplate.rpc
Methods in com.vaadin.flow.component.polymertemplate.rpc with parameters of type Component Modifier and Type Method Description ObjectPolymerPublishedEventRpcHandler. getTemplateItem(Component template, elemental.json.JsonObject argValue, Type convertedType)Get the template model object and type.booleanPolymerPublishedEventRpcHandler. isTemplateModelValue(Component instance, elemental.json.JsonValue argValue, Class<?> convertedType)Validate that the given Component instance is a PolymerTemplate and that the value can be converted. -
Uses of Component in com.vaadin.flow.component.progressbar
Subclasses of Component in com.vaadin.flow.component.progressbar Modifier and Type Class Description classGeneratedVaadinProgressBar<R extends GeneratedVaadinProgressBar<R>>Deprecated.since v23.3, generated classes will be removed in v24.classProgressBarProgress Bar shows the completion status of a task or process. -
Uses of Component in com.vaadin.flow.component.radiobutton
Subclasses of Component in com.vaadin.flow.component.radiobutton Modifier and Type Class Description classGeneratedVaadinRadioButton<R extends GeneratedVaadinRadioButton<R>>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinRadioGroup<R extends GeneratedVaadinRadioGroup<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classRadioButtonGroup<T>Radio Button Group allows the user to select exactly one value from a list of related but mutually exclusive options.Methods in com.vaadin.flow.component.radiobutton that return types with arguments of type Component Modifier and Type Method Description ComponentRenderer<? extends Component,T>RadioButtonGroup. getItemRenderer()Returns the item component renderer.Methods in com.vaadin.flow.component.radiobutton with parameters of type Component Modifier and Type Method Description voidRadioButtonGroup. add(Component... components)Deprecated.since v23.3.voidRadioButtonGroup. addComponentAsFirst(Component component)Deprecated.since v23.3.voidRadioButtonGroup. addComponentAtIndex(int index, Component component)Deprecated.since v23.3.voidRadioButtonGroup. addComponents(T afterItem, Component... components)Deprecated.since v23.3.voidRadioButtonGroup. prependComponents(T beforeItem, Component... components)Deprecated.since v23.3.voidRadioButtonGroup. remove(Component... components)Deprecated.since v23.3.Method parameters in com.vaadin.flow.component.radiobutton with type arguments of type Component Modifier and Type Method Description voidRadioButtonGroup. add(Collection<Component> components)Deprecated.since v23.3.voidRadioButtonGroup. remove(Collection<Component> components)Deprecated.since v23.3.voidRadioButtonGroup. setRenderer(ComponentRenderer<? extends Component,T> renderer)Sets the item renderer for this radio button group. -
Uses of Component in com.vaadin.flow.component.richtexteditor
Subclasses of Component in com.vaadin.flow.component.richtexteditor Modifier and Type Class Description classGeneratedVaadinRichTextEditor<R extends GeneratedVaadinRichTextEditor<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classRichTextEditorRich Text Editor is an input field for entering rich text. -
Uses of Component in com.vaadin.flow.component.select
Subclasses of Component in com.vaadin.flow.component.select Modifier and Type Class Description classSelect<T>Select allows users to choose a single value from a list of options presented in an overlay.Methods in com.vaadin.flow.component.select that return types with arguments of type Component Modifier and Type Method Description Stream<Component>Select. getChildren()ComponentRenderer<? extends Component,T>Select. getItemRenderer()Returns the item component renderer.Methods in com.vaadin.flow.component.select with parameters of type Component Modifier and Type Method Description voidSelect. add(Component... components)Adds the given components as children of this component.voidSelect. addComponentAsFirst(Component component)Adds the given component as the first child of this component.voidSelect. addComponentAtIndex(int index, Component component)Adds the given component as child of this component at the specific index.voidSelect. addComponents(T afterItem, Component... components)voidSelect. addToPrefix(Component... components)voidSelect. prependComponents(T beforeItem, Component... components)voidSelect. remove(Component... components)Removes the given child components from this component.Method parameters in com.vaadin.flow.component.select with type arguments of type Component Modifier and Type Method Description voidSelect. setRenderer(ComponentRenderer<? extends Component,T> renderer)Sets the item renderer for this select group. -
Uses of Component in com.vaadin.flow.component.select.generated
Subclasses of Component in com.vaadin.flow.component.select.generated Modifier and Type Class Description classGeneratedVaadinSelect<R extends GeneratedVaadinSelect<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.Methods in com.vaadin.flow.component.select.generated with parameters of type Component Modifier and Type Method Description protected voidGeneratedVaadinSelect. addToPrefix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinSelect. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24. -
Uses of Component in com.vaadin.flow.component.shared
Methods in com.vaadin.flow.component.shared with type parameters of type Component Modifier and Type Method Description static <C extends Component & HasValidation>
voidClientValidationUtil. preventWebComponentFromSettingItselfToValid(C component)Methods in com.vaadin.flow.component.shared that return Component Modifier and Type Method Description static ComponentSlotUtils. getChildInSlot(HasElement parent, String slot)Gets the first child component of the parent that is in the specified slot.Methods in com.vaadin.flow.component.shared with parameters of type Component Modifier and Type Method Description static TooltipTooltip. forComponent(Component component)Creates a tooltip to the givenComponentif one hasn't already been created.Constructors in com.vaadin.flow.component.shared with parameters of type Component Constructor Description ClientValidatedEvent(Component source, boolean fromClient, boolean valid)Creates a new event using the given source. -
Uses of Component in com.vaadin.flow.component.splitlayout
Subclasses of Component in com.vaadin.flow.component.splitlayout Modifier and Type Class Description classGeneratedVaadinSplitLayout<R extends GeneratedVaadinSplitLayout<R>>Deprecated.since v23.3, generated classes will be removed in v24.classSplitLayoutSplit Layout is a component with two content areas and a draggable split handle between them.Methods in com.vaadin.flow.component.splitlayout that return Component Modifier and Type Method Description ComponentSplitLayout. getPrimaryComponent()Get the component currently set to the primary split.ComponentSplitLayout. getSecondaryComponent()Get the component currently set to the secondary split.Methods in com.vaadin.flow.component.splitlayout with parameters of type Component Modifier and Type Method Description protected voidGeneratedVaadinSplitLayout. addToPrimary(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.voidSplitLayout. addToPrimary(Component... components)Sets the given components to the primary split of this layout, i.e.protected voidGeneratedVaadinSplitLayout. addToSecondary(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.voidSplitLayout. addToSecondary(Component... components)Sets the given components to the secondary split of this layout, i.e.protected voidGeneratedVaadinSplitLayout. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.voidSplitLayout. remove(Component... components)Constructors in com.vaadin.flow.component.splitlayout with parameters of type Component Constructor Description SplitLayout(Component primaryComponent, Component secondaryComponent)Constructs a SplitLayout with the given initial components to set to the primary and secondary splits.SplitLayout(Component primaryComponent, Component secondaryComponent, SplitLayout.Orientation orientation)Constructs a SplitLayout with the given initial components to set to the primary and secondary splits and with the orientation. -
Uses of Component in com.vaadin.flow.component.tabs
Subclasses of Component in com.vaadin.flow.component.tabs Modifier and Type Class Description classGeneratedVaadinTab<R extends GeneratedVaadinTab<R>>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinTabs<R extends GeneratedVaadinTabs<R>>Deprecated.since v23.3, generated classes will be removed in v24.classTabThis component provides an accessible and customizable tab to be used insideTabscomponent.classTabsTabs are used to organize and group content into sections that the user can navigate between.classTabSheetTabSheet consists of a set of tabs and the content area.Methods in com.vaadin.flow.component.tabs that return Component Modifier and Type Method Description ComponentTabSheet. getPrefixComponent()Gets the component in the prefix slot of this component.ComponentTabSheet. getSuffixComponent()Gets the component in the suffix slot of this component.Methods in com.vaadin.flow.component.tabs with parameters of type Component Modifier and Type Method Description voidTabs. add(Component... components)TabTabSheet. add(Component tabContent, Component content)Adds a tab created from the given tab content and content.TabTabSheet. add(Tab tab, Component content)Adds a tab with the given content.TabTabSheet. add(Tab tab, Component content, int position)Adds a tab with the given content to the given position.TabTabSheet. add(String tabText, Component content)Adds a tab created from the given text and content.voidTabs. addComponentAtIndex(int index, Component component)Adds the given component as child of this component at the specific index.voidTabs. remove(Component... components)Removes the given child components from this component.voidTabSheet. remove(Component content)Removes a tab based on the contentvoidTabs. replace(Component oldComponent, Component newComponent)Replaces the component in the container with another one without changing position.voidTabSheet. setPrefixComponent(Component component)Adds the given component as the prefix of this component, replacing any existing prefix component.voidTabSheet. setSuffixComponent(Component component)Adds the given component as the suffix of this component, replacing any existing suffix component.Constructors in com.vaadin.flow.component.tabs with parameters of type Component Constructor Description Tab(Component... components)Constructs a new object with child components. -
Uses of Component in com.vaadin.flow.component.template.internal
Methods in com.vaadin.flow.component.template.internal with parameters of type Component Modifier and Type Method Description ObjectDeprecatedPolymerPublishedEventHandler. getTemplateItem(Component template, elemental.json.JsonObject argValue, Type convertedType)Deprecated.Get the template model object and type.booleanDeprecatedPolymerPublishedEventHandler. isTemplateModelValue(Component instance, elemental.json.JsonValue argValue, Class<?> convertedType)Deprecated.Validate that the given Component instance is a PolymerTemplate and that the value can be converted.Constructors in com.vaadin.flow.component.template.internal with parameters of type Component Constructor Description IdMapper(Component template)Creates a mapper for the given template. -
Uses of Component in com.vaadin.flow.component.textfield
Subclasses of Component in com.vaadin.flow.component.textfield Modifier and Type Class Description classAbstractNumberField<C extends AbstractNumberField<C,T>,T extends Number>Abstract base class for components based onvaadin-number-fieldelement and its subclasses.classBigDecimalFieldBigDecimalField is an input field for handling decimal numbers with high precision.classEmailFieldEmail Field is an extension of Text Field that only accepts email addresses as input.classGeneratedVaadinEmailField<R extends GeneratedVaadinEmailField<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinNumberField<R extends GeneratedVaadinNumberField<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinPasswordField<R extends GeneratedVaadinPasswordField<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinTextArea<R extends GeneratedVaadinTextArea<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinTextField<R extends GeneratedVaadinTextField<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classIntegerFieldIntegerField is an extension of Text Field that only accepts integer numbers.classNumberFieldNumber Field sports many of the same features as Text Field but only accepts numeric input.classPasswordFieldPassword Field is an input field for entering passwords.classTextAreaText Area is an input field component for multi-line text input.classTextFieldText Field allows the user to input and edit text.Methods in com.vaadin.flow.component.textfield that return Component Modifier and Type Method Description default ComponentHasPrefixAndSuffix. getPrefixComponent()Gets the component in the prefix slot of this field.default ComponentHasPrefixAndSuffix. getSuffixComponent()Gets the component in the suffix slot of this field.Methods in com.vaadin.flow.component.textfield with parameters of type Component Modifier and Type Method Description protected voidGeneratedVaadinTextField. addToInput(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinTextArea. addToPrefix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinTextField. addToPrefix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinTextArea. addToSuffix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinTextField. addToSuffix(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinTextArea. addToTextarea(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinTextArea. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinTextField. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.default voidHasPrefixAndSuffix. setPrefixComponent(Component component)Adds the given component into this field before the content, replacing any existing prefix component.default voidHasPrefixAndSuffix. setSuffixComponent(Component component)Adds the given component into this field after the content, replacing any existing suffix component. -
Uses of Component in com.vaadin.flow.component.timepicker
Subclasses of Component in com.vaadin.flow.component.timepicker Modifier and Type Class Description classGeneratedVaadinTimePicker<R extends GeneratedVaadinTimePicker<R,T>,T>Deprecated.since v23.3, generated classes will be removed in v24.classTimePickerTime Picker is an input field for entering or selecting a specific time. -
Uses of Component in com.vaadin.flow.component.treegrid
Classes in com.vaadin.flow.component.treegrid with type parameters of type Component Modifier and Type Class Description classCollapseEvent<T,C extends Component>classExpandEvent<T,C extends Component>classHierarchyColumnComponentRenderer<COMPONENT extends Component,SOURCE>Renders components as hierarchy column for tree grid.Subclasses of Component in com.vaadin.flow.component.treegrid Modifier and Type Class Description classTreeGrid<T>Tree Grid is a component for displaying hierarchical tabular data grouped into expandable and collapsible nodes.Methods in com.vaadin.flow.component.treegrid with type parameters of type Component Modifier and Type Method Description <V extends Component>
Grid.Column<T>TreeGrid. addComponentHierarchyColumn(ValueProvider<T,V> componentProvider)Adds a new Hierarchy column that shows components. -
Uses of Component in com.vaadin.flow.component.upload
Subclasses of Component in com.vaadin.flow.component.upload Modifier and Type Class Description classGeneratedVaadinUpload<R extends GeneratedVaadinUpload<R>>Deprecated.since v23.3, generated classes will be removed in v24.classGeneratedVaadinUploadFile<R extends GeneratedVaadinUploadFile<R>>Deprecated.since v23.3, generated classes will be removed in v24.classUploadUpload is a component for uploading one or more files.Methods in com.vaadin.flow.component.upload that return Component Modifier and Type Method Description ComponentUpload. getDropLabel()Get the component set as the drop label, if any.ComponentUpload. getDropLabelIcon()Get the component set as the drop label icon, if any.ComponentUpload. getUploadButton()Get the component set as the upload button for the upload, if any.Methods in com.vaadin.flow.component.upload with parameters of type Component Modifier and Type Method Description protected voidGeneratedVaadinUpload. addToAddButton(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinUpload. addToDropLabel(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinUpload. addToDropLabelIcon(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinUpload. addToFileList(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.protected voidGeneratedVaadinUpload. remove(Component... components)Deprecated.since v23.3, generated classes will be removed in v24.voidUpload. setDropLabel(Component dropLabel)Set the component to show as a message to the user to drop files in the upload component.voidUpload. setDropLabelIcon(Component dropLabelIcon)Set the component to show as the drop label icon.voidUpload. setUploadButton(Component uploadButton)Set the component as the actionable button inside the upload component, that opens the dialog for choosing the files to be upload. -
Uses of Component in com.vaadin.flow.component.virtuallist
Subclasses of Component in com.vaadin.flow.component.virtuallist Modifier and Type Class Description classVirtualList<T>Virtual List allows you to render a long list of items inside a scrollable container without sacrificing performance. -
Uses of Component in com.vaadin.flow.component.webcomponent
Classes in com.vaadin.flow.component.webcomponent with type parameters of type Component Modifier and Type Interface Description interfacePropertyConfiguration<C extends Component,P extends Serializable>Offers a fluent API for configuring the properties of embedded web components produced byWebComponentExporter.classWebComponent<C extends Component>Acts as a proxy to the web component root onto which the exporterComponentis added.interfaceWebComponentConfiguration<C extends Component>Result of defining an embeddable web component usingWebComponentExporter.Subclasses of Component in com.vaadin.flow.component.webcomponent Modifier and Type Class Description classWebComponentUICustom UI for use with WebComponents served from the server.classWebComponentWrapperWrapper component for a web component that exposesClientCallablemethods that the client-side components expect to be available.Methods in com.vaadin.flow.component.webcomponent with type parameters of type Component Modifier and Type Method Description <T,C extends Component & HasUrlParameter<T>>
Optional<C>WebComponentUI. navigate(Class<? extends C> navigationTarget, T parameter)<T extends Component>
Optional<T>WebComponentUI. navigate(Class<T> navigationTarget) -
Uses of Component in com.vaadin.flow.data.binder
Methods in com.vaadin.flow.data.binder that return types with arguments of type Component Modifier and Type Method Description Optional<Component>ValueContext. getComponent()Returns anOptionalfor theComponentrelated to value conversion.Methods in com.vaadin.flow.data.binder with parameters of type Component Modifier and Type Method Description default voidHasItemComponents. addComponents(T afterItem, Component... components)Adds the components after the given item.default voidHasItemComponents. prependComponents(T beforeItem, Component... components)Adds the components before the given item.Constructors in com.vaadin.flow.data.binder with parameters of type Component Constructor Description ValueContext(Component component)Constructor forValueContext.ValueContext(Component component, HasValue<?,?> hasValue)Constructor forValueContext.ValueContext(Component component, HasValue<?,?> hasValue, Locale locale)Constructor forValueContext. -
Uses of Component in com.vaadin.flow.data.event
Classes in com.vaadin.flow.data.event with type parameters of type Component Modifier and Type Class Description classSortEvent<T extends Component,S extends SortOrder<?>>Event describing a change in sorting of aDataProvider.static interfaceSortEvent.SortNotifier<T extends Component,S extends SortOrder<?>>The interface for adding and removing listeners forSortEvents. -
Uses of Component in com.vaadin.flow.data.provider
Classes in com.vaadin.flow.data.provider with type parameters of type Component Modifier and Type Class Description classIdentifierProviderChangeEvent<T,C extends Component>Event notifying the component that its identifier provider has been changed through a data view.classItemCountChangeEvent<T extends Component>Event describing the item count change for a component.Fields in com.vaadin.flow.data.provider declared as Component Modifier and Type Field Description protected ComponentAbstractDataView. componentMethods in com.vaadin.flow.data.provider that return Component Modifier and Type Method Description protected abstract ComponentAbstractComponentDataGenerator. createComponent(T item)Creates a new component based on the provided item.protected ComponentAbstractComponentDataGenerator. getRenderedComponent(String itemKey)protected ComponentAbstractComponentDataGenerator. updateComponent(Component currentComponent, T item)Updates an existing component after the item has been updated.Methods in com.vaadin.flow.data.provider with parameters of type Component Modifier and Type Method Description static <T> Optional<SerializablePredicate<T>>DataViewUtils. getComponentFilter(Component component)Gets the in-memory filter of a given component instance.static <T> Optional<SerializableComparator<T>>DataViewUtils. getComponentSortComparator(Component component)Gets the in-memory sort comparator of a given component instance.static QueryDataViewUtils. getQuery(Component component)Generates a data query with component's in-memory filter and sort comparator.static QueryDataViewUtils. getQuery(Component component, boolean withSorting)Generates a data query with component's in-memory filter and sort comparator, which is optionally included ifwithSortingis set totrue.protected voidAbstractComponentDataGenerator. registerRenderedComponent(String itemKey, Component component)Appends the component to the container and registers it for future use during the lifecycle of the generator.static voidDataViewUtils. removeComponentFilterAndSortComparator(Component component)Removes the in-memory filter and sort comparator from a given component instance.static <T> voidDataViewUtils. setComponentFilter(Component component, SerializablePredicate<T> filter)Sets the in-memory filter to a given component instance.static <T> voidDataViewUtils. setComponentSortComparator(Component component, SerializableComparator<T> sortComparator)Sets the in-memory sort comparator to a given component instance.protected ComponentAbstractComponentDataGenerator. updateComponent(Component currentComponent, T item)Updates an existing component after the item has been updated.Constructors in com.vaadin.flow.data.provider with parameters of type Component Constructor Description AbstractDataView(SerializableSupplier<? extends DataProvider<T,?>> dataProviderSupplier, Component component)Creates a new instance ofAbstractDataViewsubclass and verifies the passed data provider is compatible with this data view implementation.AbstractLazyDataView(DataCommunicator<T> dataCommunicator, Component component)Creates a new instance and verifies the passed data provider is compatible with this data view implementation.AbstractListDataView(SerializableSupplier<? extends DataProvider<T,?>> dataProviderSupplier, Component component, SerializableBiConsumer<SerializablePredicate<T>,SerializableComparator<T>> filterOrSortingChangedCallback)Creates a new instance ofAbstractListDataViewsubclass and verifies the passed data provider is compatible with this data view implementation. -
Uses of Component in com.vaadin.flow.data.renderer
Classes in com.vaadin.flow.data.renderer with type parameters of type Component Modifier and Type Class Description classComponentRenderer<COMPONENT extends Component,SOURCE>Base class for all renderers that support arbitraryComponents.Methods in com.vaadin.flow.data.renderer that return Component Modifier and Type Method Description ComponentBasicRenderer. createComponent(SOURCE item)protected ComponentComponentDataGenerator. createComponent(T item)ComponentIconRenderer. createComponent(ITEM item)ComponentNativeButtonRenderer. createComponent(SOURCE item)ComponentTextRenderer. createComponent(ITEM item)protected ComponentComponentDataGenerator. updateComponent(Component currentComponent, T item)ComponentComponentRenderer. updateComponent(Component currentComponent, SOURCE item)Called when the item is updated.Methods in com.vaadin.flow.data.renderer that return types with arguments of type Component Modifier and Type Method Description ComponentRenderer<? extends Component,T>ComponentDataGenerator. getComponentRenderer()Methods in com.vaadin.flow.data.renderer with parameters of type Component Modifier and Type Method Description protected ComponentComponentDataGenerator. updateComponent(Component currentComponent, T item)ComponentComponentRenderer. updateComponent(Component currentComponent, SOURCE item)Called when the item is updated.Constructor parameters in com.vaadin.flow.data.renderer with type arguments of type Component Constructor Description ComponentDataGenerator(ComponentRenderer<? extends Component,T> componentRenderer, ValueProvider<T,String> keyMapper)Creates a new generator.ComponentRenderer(SerializableFunction<SOURCE,COMPONENT> componentFunction, SerializableBiFunction<Component,SOURCE,Component> componentUpdateFunction)ComponentRenderer(SerializableFunction<SOURCE,COMPONENT> componentFunction, SerializableBiFunction<Component,SOURCE,Component> componentUpdateFunction)IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator)Creates a new renderer instance using the defaultItemLabelGenerator:String::valueOfand the providediconGenerator.IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator, ItemLabelGenerator<ITEM> itemLabelGenerator)Creates a new renderer instance using the providediconGeneratoranditemLabelGenerator. -
Uses of Component in com.vaadin.flow.data.selection
Classes in com.vaadin.flow.data.selection with type parameters of type Component Modifier and Type Interface Description interfaceMultiSelect<C extends Component,T>Multi selection component which allows to select and deselect multiple items.classMultiSelectionEvent<C extends Component,T>Fired when the selection changes in a listing component that supports multiple item selection.interfaceMultiSelectionListener<C extends Component,T>A listener for listening for selection changes from a multiselection component.interfaceSelectionEvent<C extends Component,T>A selection event that unifies the way to access to selection event for multi selection and single selection components (in case when only one selected item is required).interfaceSelectionListener<C extends Component,T>A listener forSelectionEvent.interfaceSelectionModel<C extends Component,T>Models the selection logic of aListingcomponent.static interfaceSelectionModel.Multi<C extends Component,T>A selection model in which multiple items can be selected at the same time.static interfaceSelectionModel.Single<C extends Component,T>A selection model in which at most one item can be selected at a time.interfaceSingleSelect<C extends Component,T>Single selection component whose selection is treated as a value.classSingleSelectionEvent<C extends Component,T>Fired when the selection changes in a listing component.interfaceSingleSelectionListener<C extends Component,T>A listener for listening to selection changes on a single selection component. -
Uses of Component in com.vaadin.flow.di
Methods in com.vaadin.flow.di with type parameters of type Component Modifier and Type Method Description <T extends Component>
TDefaultInstantiator. createComponent(Class<T> componentClass)<T extends Component>
TInstantiator. createComponent(Class<T> componentClass)Creates an instance of a component by itscomponentClass. -
Uses of Component in com.vaadin.flow.dom
Methods in com.vaadin.flow.dom with type parameters of type Component Modifier and Type Method Description <T extends Component>
TElement. as(Class<T> componentType)Creates a new component instance using this element.Methods in com.vaadin.flow.dom that return types with arguments of type Component Modifier and Type Method Description Optional<Component>Element. getComponent()Gets the component this element has been mapped to, if any.default Optional<Component>ElementStateProvider. getComponent(StateNode node)Gets the component this element is mapped to.Methods in com.vaadin.flow.dom with parameters of type Component Modifier and Type Method Description default voidElementStateProvider. setComponent(StateNode node, Component component)Defines a mapping between the element and the given component.static voidElementUtil. setComponent(Element element, Component component)Defines a mapping between this element and the givenComponent. -
Uses of Component in com.vaadin.flow.internal
Method parameters in com.vaadin.flow.internal with type arguments of type Component Modifier and Type Method Description static List<CssImport>AnnotationReader. getCssImportAnnotations(Class<? extends Component> componentClass)static List<JavaScript>AnnotationReader. getJavaScriptAnnotations(Class<? extends Component> componentClass)Finds allJavaScriptannotations on the givenComponentclass, its super classes and implemented interfaces.static List<JsModule>AnnotationReader. getJsModuleAnnotations(Class<? extends Component> componentClass)static List<StyleSheet>AnnotationReader. getStyleSheetAnnotations(Class<? extends Component> componentClass)Finds allStyleSheetannotations on the givenComponentclass, its super classes and implemented interfaces. -
Uses of Component in com.vaadin.flow.internal.nodefeature
Methods in com.vaadin.flow.internal.nodefeature that return types with arguments of type Component Modifier and Type Method Description Optional<Component>ComponentMapping. getComponent()Gets the component this node has been mapped to, if any.static Optional<Component>ComponentMapping. getComponent(StateNode node)Gets the component mapped to the given state node.Methods in com.vaadin.flow.internal.nodefeature with parameters of type Component Modifier and Type Method Description voidComponentMapping. setComponent(Component component)Assigns the given component to this node. -
Uses of Component in com.vaadin.flow.router
Subclasses of Component in com.vaadin.flow.router Modifier and Type Class Description classInternalServerErrorThis is a basic default error view shown on exceptions during navigation.classRouteNotFoundErrorThis is a basic default error view shown on routing exceptions.classRouterLinkA link that handles navigation internally usingRouterinstead of loading a new page in the browser.Methods in com.vaadin.flow.router with type parameters of type Component Modifier and Type Method Description <C extends Component>
voidBeforeEvent. forwardTo(Class<? extends C> forwardTargetComponent, QueryParameters queryParameters)Forward the navigation to show the given component with given query parameters instead of the component that is currently about to be displayed.<C extends Component>
voidBeforeEvent. forwardTo(Class<? extends C> forwardTargetComponent, RouteParameters routeParameters, QueryParameters queryParameters)Forward the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
voidBeforeEvent. forwardTo(Class<? extends C> forwardTargetComponent, List<T> routeParameters)Forward the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
voidBeforeEvent. forwardTo(Class<? extends C> forwardTargetComponent, T routeParameter)Forward the navigation to show the given component with given route parameter instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
voidBeforeEvent. forwardTo(Class<? extends C> forwardTargetComponent, T routeParameter, QueryParameters queryParameters)Forward the navigation to show the given component with given route parameter and query parameters instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
StringRouteConfiguration. getUrl(Class<? extends C> navigationTarget, List<T> parameters)Get the url string for given navigation target with the parameters in the url.<T,C extends Component & HasUrlParameter<T>>
StringRouteConfiguration. getUrl(Class<? extends C> navigationTarget, T parameter)Get the url string for given navigation target with the parameter in the url.<C extends Component>
voidBeforeEvent. rerouteTo(Class<? extends C> routeTargetType, QueryParameters queryParameters)Reroutes the navigation to show the given component with given query parameters instead of the component that is currently about to be displayed.<C extends Component>
voidBeforeEvent. rerouteTo(Class<? extends C> routeTargetType, RouteParameters routeParameters, QueryParameters queryParameters)Reroutes the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
voidBeforeEvent. rerouteTo(Class<? extends C> routeTargetType, List<T> routeParameters)Reroutes the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
voidBeforeEvent. rerouteTo(Class<? extends C> routeTargetType, T routeParameter)Reroutes the navigation to show the given component with given route parameter instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
voidBeforeEvent. rerouteTo(Class<? extends C> routeTargetType, T routeParameter, QueryParameters queryParameters)Reroutes the navigation to show the given component with given route parameter and query parameters instead of the component that is currently about to be displayed.<T,C extends Component & HasUrlParameter<T>>
voidRouterLink. setRoute(Router router, Class<? extends C> navigationTarget, T parameter)Set the navigation target for this link.<T,C extends Component & HasUrlParameter<T>>
voidRouterLink. setRoute(Class<? extends C> navigationTarget, T parameter)Set the navigation target for this link.Methods in com.vaadin.flow.router that return types with arguments of type Component Modifier and Type Method Description List<Class<? extends Component>>RoutesChangedEvent. getAddedNavigationTargets()Get every single navigation targets of all added routes in this change.Class<? extends Component>BeforeEvent. getForwardTargetType()Get the forward target type for forwarding.Class<? extends Component>NavigationState. getNavigationTarget()Gets the navigation target of this state.Class<? extends Component>RouteBaseData. getNavigationTarget()GetRoutenavigation target.List<Class<? extends Component>>RoutesChangedEvent. getRemovedNavigationTargets()Get every single navigation targets of all removed routes in this change.Class<? extends Component>BeforeEvent. getRerouteTargetType()Get the route target type for rerouting.Optional<Class<? extends Component>>RouteConfiguration. getRoute(String path)Gets the registered route class for a given path.Optional<Class<? extends Component>>RouteConfiguration. getRoute(String path, List<String> segments)Gets the optional navigation target class for a given Location matching with path segments.Class<? extends Component>BeforeEvent. getRouteTargetType()Deprecated.useBeforeEvent.getRerouteTargetType()instead.Method parameters in com.vaadin.flow.router with type arguments of type Component Modifier and Type Method Description voidBeforeEvent. forwardTo(Class<? extends Component> forwardTargetComponent)Forward the navigation to show the given component instead of the component that is currently about to be displayed.voidBeforeEvent. forwardTo(Class<? extends Component> forwardTargetComponent, RouteParameters parameters)Forward the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.Optional<String>RouteConfiguration. getTemplate(Class<? extends Component> navigationTarget)Gets the route template for the given target.StringRouteConfiguration. getUrl(Class<? extends Component> navigationTarget)Get the registered url string for given navigation target.StringRouteConfiguration. getUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)Gets the url which navigates to given navigationTarget using given parameters.Optional<String>RouteConfiguration. getUrlBase(Class<? extends Component> navigationTarget)Return the url base without any route parameters.booleanRoutesChangedEvent. isRouteAdded(Class<? extends Component> clazz)Determines if a given route navigation target was added for this change.booleanRouteConfiguration. isRouteRegistered(Class<? extends Component> route)Check if the route is available as a registered target.booleanRoutesChangedEvent. isRouteRemoved(Class<? extends Component> clazz)Determines if a given route navigation target was removed for this change.voidRouteConfiguration. removeRoute(Class<? extends Component> navigationTarget)Remove the given navigation target route registration.voidRouteConfiguration. removeRoute(String path, Class<? extends Component> navigationTarget)Remove only the specified navigationTarget from the path and not other targets if they exist for the same path.voidBeforeEvent. rerouteTo(Class<? extends Component> routeTargetType)Reroutes the navigation to show the given component instead of the component that is currently about to be displayed.voidBeforeEvent. rerouteTo(Class<? extends Component> routeTargetType, RouteParameters parameters)Reroutes the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.voidRouteConfiguration. setAnnotatedRoute(Class<? extends Component> navigationTarget)Giving a navigation target here will handle theRouteannotation to get the path and also register anyRouteAliasthat may be on the class.voidNavigationState. setNavigationTarget(Class<? extends Component> navigationTarget)Sets the navigation target of this state.voidRouteConfiguration. setParentAnnotatedRoute(String path, Class<? extends Component> navigationTarget)Register a navigation target on the specified path.voidRouteConfiguration. setRoute(String path, Class<? extends Component> navigationTarget)Register a navigation target with specified path and with no parent layouts.voidRouteConfiguration. setRoute(String path, Class<? extends Component> navigationTarget, Class<? extends RouterLayout>... parentChain)Register a navigation target with specified path and given parent layout chain.voidRouteConfiguration. setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)Register a navigation target with specified path and given parent layout chain.voidRouterLink. setRoute(Router router, Class<? extends Component> navigationTarget)Set the navigation target for this link.voidRouterLink. setRoute(Router router, Class<? extends Component> navigationTarget, RouteParameters parameters)Set the navigation target for this link.voidRouterLink. setRoute(Class<? extends Component> navigationTarget)Set the navigation target for this link.voidRouterLink. setRoute(Class<? extends Component> navigationTarget, RouteParameters parameters)Set the navigation target for this link.NavigationStateBuilderNavigationStateBuilder. withTarget(Class<? extends Component> navigationTarget)Assigns the given navigation target to the navigation state being built.NavigationStateBuilderNavigationStateBuilder. withTarget(Class<? extends Component> navigationTarget, RouteParameters parameters)Assigns the given navigation target with the given url parameter to the navigation state being built.NavigationStateBuilderNavigationStateBuilder. withTarget(Class<? extends Component> navigationTarget, List<String> parameters)Deprecated.Constructor parameters in com.vaadin.flow.router with type arguments of type Component Constructor Description RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget)AliasData constructor.RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget)AliasData constructor.RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget)RouteBaseData constructor.RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget)RouteBaseData constructor.RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases)RouteData constructor.RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases)RouteData constructor.RouterLink(Router router, Class<? extends Component> navigationTarget)Creates a new router link for the given navigation target.RouterLink(Router router, Class<? extends Component> navigationTarget, RouteParameters parameters)Creates a new router link for the given navigation target using the given parameters.RouterLink(Router router, String text, Class<? extends Component> navigationTarget)Creates a new router link for the given navigation target using the given text.RouterLink(Router router, String text, Class<? extends Component> navigationTarget, RouteParameters parameters)Creates a new router link for the given navigation target using the given text and parameters.RouterLink(Class<? extends Component> navigationTarget)Creates a new router link for the given navigation target.RouterLink(Class<? extends Component> navigationTarget, RouteParameters parameters)Creates a new router link for the given navigation target using the given parameters.RouterLink(String text, Class<? extends Component> navigationTarget)Creates a new router link for the given navigation target using the given text.RouterLink(String text, Class<? extends Component> navigationTarget, RouteParameters parameters)Creates a new router link for the given navigation target using the given text and parameters. -
Uses of Component in com.vaadin.flow.router.internal
Methods in com.vaadin.flow.router.internal that return types with arguments of type Component Modifier and Type Method Description protected Map<Class<? extends Component>,com.vaadin.flow.router.internal.RouteModel>ConfiguredRoutes. copyTargetRouteModels(boolean mutable)Make a copy of the target and route models mapping.Class<? extends Component>ConfiguredRoutes. getExceptionHandlerByClass(Class<?> exceptionClass)Get a exception handler by exception class.Map<Class<? extends Exception>,Class<? extends Component>>ConfiguredRoutes. getExceptionHandlers()Get all registered exception handlers as a exception-to-handler map.Map<Class<? extends Exception>,Class<? extends Component>>ConfigureRoutes. getExceptionHandlers()Override so that the getters use the correct exception targets map for data.Optional<Class<? extends Component>>AbstractRouteRegistry. getNavigationTarget(String url)Optional<Class<? extends Component>>AbstractRouteRegistry. getNavigationTarget(String url, List<String> segments)Class<? extends Component>ErrorTargetEntry. getNavigationTarget()Gets the navigation target type.Optional<Class<? extends Component>>ConfiguredRoutes. getRoute(String url, List<String> segments)Get the route class matching the given path and path segments.Optional<Class<? extends Component>>ConfiguredRoutes. getTarget(String url)Get the target class matching the given url.Class<? extends Component>RouteTarget. getTarget()Get the component route target.Map<Class<? extends Component>,String>ConfiguredRoutes. getTargetRoutes()Get all registered target routes for this configuration mapping the main template.Map<Class<? extends Component>,String>ConfigureRoutes. getTargetRoutes()Override so that the getters use the correct target routes map for data.Methods in com.vaadin.flow.router.internal with parameters of type Component Modifier and Type Method Description protected abstract voidAbstractNavigationStateRenderer. notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)Notify the navigation target about the status of the navigation.protected voidErrorStateRenderer. notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)protected voidNavigationStateRenderer. notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)Method parameters in com.vaadin.flow.router.internal with type arguments of type Component Modifier and Type Method Description protected voidAbstractRouteRegistry. addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>,Class<? extends Component>> exceptionTargetsMap)Add the given error target to the exceptionTargetMap.protected voidAbstractRouteRegistry. addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>,Class<? extends Component>> exceptionTargetsMap)Add the given error target to the exceptionTargetMap.static voidHasUrlParameterFormat. checkMandatoryParameter(Class<? extends Component> navigationTarget, RouteParameters parameters)Verify whether the navigationTarget has mandatory parameter and complies with the given parameter values.booleanRouteTarget. containsTarget(Class<? extends Component> target)Check if navigation target is present in current target.List<Class<? extends RouterLayout>>ConfiguredRoutes. getParentLayouts(String path, Class<? extends Component> navigationTarget)Deprecated.useConfiguredRoutes.getNavigationRouteTarget(String)instead.List<Class<? extends RouterLayout>>AbstractRouteRegistry. getRouteLayouts(String path, Class<? extends Component> navigationTarget)Deprecated.instead useAbstractRouteRegistry.getNavigationRouteTarget(String)and retrieve the list of route layouts from theRouteTargetcontained in theNavigationRouteTarget.protected List<String>ConfiguredRoutes. getRoutePaths(Class<? extends Component> routeTarget)Collect all routes for which given routeTarget is registered.protected abstract List<Class<? extends RouterLayout>>AbstractNavigationStateRenderer. getRouterLayoutTypes(Class<? extends Component> routeTargetType, Router router)Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.List<Class<? extends RouterLayout>>ErrorStateRenderer. getRouterLayoutTypes(Class<? extends Component> targetType, Router router)Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.protected List<Class<? extends RouterLayout>>NavigationStateRenderer. getRouterLayoutTypes(Class<? extends Component> targetType, Router router)RouteTargetAbstractRouteRegistry. getRouteTarget(Class<? extends Component> target, RouteParameters parameters)RouteTargetConfiguredRoutes. getRouteTarget(Class<? extends Component> target, RouteParameters parameters)Gets theRouteTargetinstance matching the given target component and route parameters.StringConfiguredRoutes. getTargetRoute(Class<? extends Component> navigationTarget)Get the route template String for the given navigation target class.Optional<String>AbstractRouteRegistry. getTargetUrl(Class<? extends Component> navigationTarget)Optional<String>AbstractRouteRegistry. getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)StringConfiguredRoutes. getTargetUrl(Class<? extends Component> navigationTarget)Get the url path String for the given navigation target class.StringConfiguredRoutes. getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)Get the url path String for the given navigation target class and parameters.Optional<String>AbstractRouteRegistry. getTemplate(Class<? extends Component> navigationTarget)StringConfiguredRoutes. getTemplate(Class<? extends Component> navigationTarget)Get the route template String for the given navigation target class.StringConfiguredRoutes. getTemplate(Class<? extends Component> navigationTarget, Set<RouteParameterFormatOption> format)Get the route template String for the given navigation target class and using the specified parameters format.static StringHasUrlParameterFormat. getTemplate(String urlBase, Class<? extends Component> navigationTarget)Gets the template for the given url base by appending the parameter according to the given navigationTarget if it's implementingHasUrlParameterbooleanAbstractRouteRegistry. hasMandatoryParameter(Class<? extends Component> navigationTarget)booleanConfiguredRoutes. hasRouteTarget(Class<? extends Component> target)Check it the given route target has been registered to the configuration.voidAbstractRouteRegistry. removeRoute(Class<? extends Component> navigationTarget)voidAbstractRouteRegistry. removeRoute(String path, Class<? extends Component> navigationTarget)voidConfigureRoutes. removeRoute(Class<? extends Component> target)Remove the target completely from the configuration.voidConfigureRoutes. removeRoute(String template, Class<? extends Component> targetRoute)Remove navigation target for given template.voidAbstractRouteRegistry. setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)voidConfigureRoutes. setRoute(String template, Class<? extends Component> navigationTarget)Set a newRouteTargetfor the given template.voidConfigureRoutes. setRoute(String template, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)Set a newRouteTargetfor the given template.voidConfigureRoutes. setTargetRoute(Class<? extends Component> navigationTarget, String path)Put a new target route for Class-to-path mapping.Constructor parameters in com.vaadin.flow.router.internal with type arguments of type Component Constructor Description ErrorTargetEntry(Class<? extends Component> navigationTarget, Class<? extends Exception> handledExceptionType)Creates a new new entry with the given navigation target type and exception type.RouteTarget(Class<? extends Component> target)Create a new Route target holder with the given target registered and empty parent layouts.RouteTarget(Class<? extends Component> target, List<Class<? extends RouterLayout>> parents)Create a new Route target holder with the given target registered. -
Uses of Component in com.vaadin.flow.server
Methods in com.vaadin.flow.server that return types with arguments of type Component Modifier and Type Method Description Class<? extends Component>AmbiguousRouteConfigurationException. getConfiguredNavigationTarget()Returns the already configured navigation target component class which caused the exception.Optional<Class<? extends Component>>RouteRegistry. getNavigationTarget(String url)Gets the optional navigation target class for a given path.Optional<Class<? extends Component>>RouteRegistry. getNavigationTarget(String url, List<String> segments)Gets the optional navigation target class for a given Location matching with path segments.Optional<Class<? extends Component>>SessionRouteRegistry. getNavigationTarget(String url)Optional<Class<? extends Component>>SessionRouteRegistry. getNavigationTarget(String url, List<String> segments)Method parameters in com.vaadin.flow.server with type arguments of type Component Modifier and Type Method Description List<Class<? extends RouterLayout>>RouteRegistry. getRouteLayouts(String path, Class<? extends Component> navigationTarget)Deprecated.instead useRouteRegistry.getNavigationRouteTarget(String)and retrieve the list of route layouts from theRouteTargetcontained in theNavigationRouteTarget.List<Class<? extends RouterLayout>>SessionRouteRegistry. getRouteLayouts(String path, Class<? extends Component> navigationTarget)Deprecated.instead useSessionRouteRegistry.getNavigationRouteTarget(String)and retrieve the list of route layouts from theRouteTargetcontained in theNavigationRouteTarget.RouteTargetRouteRegistry. getRouteTarget(Class<? extends Component> target, RouteParameters parameters)Gets theRouteTargetinstance matching the given target component and route parameters.RouteTargetSessionRouteRegistry. getRouteTarget(Class<? extends Component> target, RouteParameters parameters)Optional<String>RouteRegistry. getTargetUrl(Class<? extends Component> navigationTarget)Get the url string for given navigation target.Optional<String>RouteRegistry. getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)Get the url string for given navigation target.Optional<String>SessionRouteRegistry. getTargetUrl(Class<? extends Component> navigationTarget)Optional<String>SessionRouteRegistry. getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)Optional<String>RouteRegistry. getTemplate(Class<? extends Component> navigationTarget)Get the main template for given navigation target.Optional<String>SessionRouteRegistry. getTemplate(Class<? extends Component> navigationTarget)booleanRouteRegistry. hasMandatoryParameter(Class<? extends Component> navigationTarget)Check if the given navigationTarget requires parameters.voidRouteRegistry. removeRoute(Class<? extends Component> navigationTarget)Remove the given navigation target route registration.voidRouteRegistry. removeRoute(String path, Class<? extends Component> navigationTarget)Remove navigationTarget for the path.voidRouteRegistry. setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)Register a navigation target with specified path and given parent layout chain.Constructor parameters in com.vaadin.flow.server with type arguments of type Component Constructor Description AmbiguousRouteConfigurationException(String message, Class<? extends Component> navigationTarget)Constructs a new invalid route configuration exception with the specified detail message and the existing navigation target component which already presents in the configuration with the route path. -
Uses of Component in com.vaadin.flow.server.auth
Method parameters in com.vaadin.flow.server.auth with type arguments of type Component Modifier and Type Method Description voidViewAccessChecker. setLoginView(Class<? extends Component> loginView)Sets the Flow login view to use. -
Uses of Component in com.vaadin.flow.server.startup
Methods in com.vaadin.flow.server.startup that return types with arguments of type Component Modifier and Type Method Description protected Set<Class<? extends Component>>AbstractRouteRegistryInitializer. validateRouteClasses(VaadinContext context, Stream<Class<?>> routeClasses)Validate the potential route classes stream and return them as a set.Method parameters in com.vaadin.flow.server.startup with type arguments of type Component Modifier and Type Method Description voidApplicationRouteRegistry. setErrorNavigationTargets(Set<Class<? extends Component>> errorNavigationTargets)Set error handler navigation targets.voidApplicationRouteRegistry. setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)booleanNavigationTargetFilter. testNavigationTarget(Class<? extends Component> navigationTarget)Tests whether the given navigation target class should be included. -
Uses of Component in com.vaadin.flow.server.webcomponent
Classes in com.vaadin.flow.server.webcomponent with type parameters of type Component Modifier and Type Class Description classPropertyConfigurationImpl<C extends Component,P extends Serializable>For internal use only.classWebComponentBinding<C extends Component>Represents a single instance of a exported web component instance embedded onto a host page.Methods in com.vaadin.flow.server.webcomponent with type parameters of type Component Modifier and Type Method Description <T extends Component>
Set<WebComponentConfiguration<T>>WebComponentConfigurationRegistry. getConfigurationsByComponentType(Class<T> componentClass)Get an unmodifiable set containing all registered web component configurations for a specificComponenttype.Methods in com.vaadin.flow.server.webcomponent that return types with arguments of type Component Modifier and Type Method Description Optional<WebComponentConfiguration<? extends Component>>WebComponentConfigurationRegistry. getConfiguration(String tag)Get a web component configuration for given custom element tag if one is registered.Set<WebComponentConfiguration<? extends Component>>WebComponentConfigurationRegistry. getConfigurations()Get an unmodifiable set containing all registered web component configurations.Method parameters in com.vaadin.flow.server.webcomponent with type arguments of type Component Modifier and Type Method Description StringWebComponentExporterTagExtractor. apply(WebComponentExporterFactory<? extends Component> factory)static StringWebComponentGenerator. generateModule(WebComponentConfiguration<? extends Component> webComponentConfiguration, String frontendURI, boolean compatibilityMode, String themeName)Generate web component html/JS for given tag and class.static StringWebComponentGenerator. generateModule(WebComponentExporterFactory<? extends Component> factory, String frontendURI, boolean compatibilityMode, String themeName)Generate web component html/JS for given exporter factory.booleanWebComponentConfigurationRegistry. setConfigurations(Set<WebComponentConfiguration<? extends Component>> configurations)Registers all available web component configurations to the registry.protected voidWebComponentConfigurationRegistry. updateRegistry(Set<WebComponentConfiguration<? extends Component>> configurations)Internal method for updating registry.
-