Uses of Class
com.vaadin.flow.component.Component

Packages that use Component

Package	Description
com.vaadin.base.devserver
com.vaadin.base.devserver.themeeditor
com.vaadin.collaborationengine
com.vaadin.flow.component
com.vaadin.flow.component.accordion
com.vaadin.flow.component.applayout
com.vaadin.flow.component.avatar
com.vaadin.flow.component.board
com.vaadin.flow.component.board.internal
com.vaadin.flow.component.button
com.vaadin.flow.component.charts
com.vaadin.flow.component.checkbox
com.vaadin.flow.component.combobox
com.vaadin.flow.component.combobox.dataview
com.vaadin.flow.component.confirmdialog
com.vaadin.flow.component.contextmenu
com.vaadin.flow.component.cookieconsent
com.vaadin.flow.component.crud
com.vaadin.flow.component.customfield
com.vaadin.flow.component.datepicker
com.vaadin.flow.component.datetimepicker
com.vaadin.flow.component.details
com.vaadin.flow.component.dialog
com.vaadin.flow.component.dnd
com.vaadin.flow.component.dnd.internal
com.vaadin.flow.component.formlayout
com.vaadin.flow.component.grid
com.vaadin.flow.component.grid.contextmenu
com.vaadin.flow.component.grid.editor
com.vaadin.flow.component.gridpro
com.vaadin.flow.component.html
com.vaadin.flow.component.html.testbench
com.vaadin.flow.component.icon
com.vaadin.flow.component.internal
com.vaadin.flow.component.listbox
com.vaadin.flow.component.littemplate
com.vaadin.flow.component.login
com.vaadin.flow.component.map
com.vaadin.flow.component.menubar
com.vaadin.flow.component.messages
com.vaadin.flow.component.notification
com.vaadin.flow.component.orderedlayout
com.vaadin.flow.component.progressbar
com.vaadin.flow.component.radiobutton
com.vaadin.flow.component.richtexteditor
com.vaadin.flow.component.select
com.vaadin.flow.component.shared
com.vaadin.flow.component.sidenav
com.vaadin.flow.component.splitlayout
com.vaadin.flow.component.tabs
com.vaadin.flow.component.template.internal
com.vaadin.flow.component.textfield
com.vaadin.flow.component.timepicker
com.vaadin.flow.component.treegrid
com.vaadin.flow.component.upload
com.vaadin.flow.component.virtuallist
com.vaadin.flow.component.webcomponent
com.vaadin.flow.data.binder
com.vaadin.flow.data.event
com.vaadin.flow.data.provider
com.vaadin.flow.data.renderer
com.vaadin.flow.data.selection
com.vaadin.flow.di
com.vaadin.flow.dom
com.vaadin.flow.internal
com.vaadin.flow.internal.nodefeature
com.vaadin.flow.router
com.vaadin.flow.router.internal
com.vaadin.flow.server
com.vaadin.flow.server.auth
com.vaadin.flow.server.frontend
com.vaadin.flow.server.startup
com.vaadin.flow.server.webcomponent
com.vaadin.flow.spring
com.vaadin.flow.spring.security
com.vaadin.testbench.unit

Uses of Component in com.vaadin.base.devserver

Methods in com.vaadin.base.devserver with parameters of type Component

Modifier and Type	Method	Description
void	IdeIntegration.showComponentAttachInIde(Component component)	Opens, in the current IDE, the location (file + line number) where the given component was attached.
void	IdeIntegration.showComponentCreateInIde(Component component)	Opens, in the current IDE, the location (file + line number) where the given component was created.

Uses of Component in com.vaadin.base.devserver.themeeditor

Methods in com.vaadin.base.devserver.themeeditor that return Component

Modifier and Type	Method	Description
protected Component	JavaSourceModifier.getComponent(VaadinSession session, int uiId, int nodeId)

Methods in com.vaadin.base.devserver.themeeditor with parameters of type Component

Modifier and Type	Method	Description
protected com.github.javaparser.ast.stmt.ExpressionStmt	JavaSourceModifier.findLocalClassNameStmt(com.github.javaparser.ast.CompilationUnit cu, Component component, boolean overlay)
protected Where	JavaSourceModifier.findModificationWhere(com.github.javaparser.ast.CompilationUnit cu, Component component)
protected com.github.javaparser.ast.Node	JavaSourceModifier.findNode(com.github.javaparser.ast.CompilationUnit cu, Component component)
protected com.github.javaparser.ast.Node	JavaSourceModifier.findParentBlockNode(com.github.javaparser.ast.CompilationUnit cu, Component component)
protected com.github.javaparser.ast.CompilationUnit	JavaSourceModifier.getCompilationUnit(Component component)
protected ComponentTracker.Location	JavaSourceModifier.getCreateLocation(Component c)
protected boolean	JavaSourceModifier.hasOverlay(Component component)
void	JavaSourceModifier.removeLocalClassName(Component component, boolean overlay)
protected void	JavaSourceModifier.setLocalClassName(Component component, String className, boolean overlay)

Uses of Component in com.vaadin.collaborationengine

Subclasses of Component in com.vaadin.collaborationengine

Modifier and Type	Class	Description
class	CollaborationAvatarGroup	Extension of the AvatarGroup component which integrates with the CollaborationEngine.
class	CollaborationMessageInput	Extension of the MessageInput component which integrates with the CollaborationMessageList.
class	CollaborationMessageList	Extension of the MessageList component which integrates with the CollaborationEngine.

Methods in com.vaadin.collaborationengine with parameters of type Component

Modifier and Type	Method	Description
void	ComponentConnectionContext.addComponent(Component component)	Adds a component instance to track for this context.
TopicConnectionRegistration	CollaborationEngine.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.
void	ComponentConnectionContext.removeComponent(Component component)	Stops tracking a component for this context.

Constructors in com.vaadin.collaborationengine with parameters of type Component

Modifier	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
class	AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T>	An abstract field class that is backed by a composite component.
static class	AbstractField.ComponentValueChangeEvent<C extends Component,V>	Value change event fired by components.
interface	BlurNotifier<T extends Component>	Mixin interface to handle blur events on components.
static class	BlurNotifier.BlurEvent<C extends Component>	Represents the DOM event "blur".
class	ClickEvent<C extends Component>	Event fired when a component is clicked.
interface	ClickNotifier<T extends Component>	Mixin interface for components that support adding click listeners to the their root elements.
class	ComponentEvent<T extends Component>	An event whose source is a Component.
class	Composite<T extends Component>	A composite encapsulates a Component tree to allow creation of new components by composing existing components.
interface	Focusable<T extends Component>	Represents a component that can gain and lose focus.
interface	FocusNotifier<T extends Component>	Mixin interface to handle focus events on components.
static class	FocusNotifier.FocusEvent<C extends Component>	Represents the DOM event "focus".
class	WebComponentExporter<C extends Component>	Exports a Component as a web component.
interface	WebComponentExporterFactory<C extends Component>	Exports a Component as a web component.
static class	WebComponentExporterFactory.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
class	AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T>	An abstract field class that is backed by a composite component.
class	AbstractField<C extends AbstractField<C,T>,T>	An abstract implementation of a field, or a Component allowing user input.
class	AbstractSinglePropertyField<C extends AbstractField<C,T>,T>	Abstract field that is based on a single element property.
class	Composite<T extends Component>	A composite encapsulates a Component tree to allow creation of new components by composing existing components.
class	Html	A component which encapsulates a given HTML fragment with a single root element.
class	HtmlComponent	Base class for a Component that represents a single built-in HTML element.
class	HtmlContainer	Base class for a Component that represents a single built-in HTML element that can contain child components or text.
class	Svg	A component that displays a given SVG image.
class	Text	A component which encapsulates the given text in a text node.
class	UI	The topmost component in any component hierarchy.
static class	UI.ClientViewPlaceholder	Placeholder view when navigating from server-side views to client-side views.

Methods in com.vaadin.flow.component with type parameters of type Component

Modifier and Type	Method	Description
static <T extends Component> T	ComponentUtil.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 (if mapComponent is true).
<T extends Component> WebComponentConfiguration<T>	WebComponentExporter.WebComponentConfigurationFactory.create(WebComponentExporter<T> exporter)	Creates a WebComponentConfiguration for the provided WebComponentExporter instances.
static <T extends Component> void	ComponentUtil.fireEvent(T component, ComponentEvent<? extends T> componentEvent)	Dispatches the event to all listeners registered for the event type.
static <T extends Component> T	Component.from(Element element, Class<T> componentType)	Creates a new component instance using the given element.
<C extends Component> Optional<C>	UI.navigate(Class<? extends C> navigationTarget, RouteParameters routeParameter, QueryParameters queryParameters)	Updates this UI to show the view corresponding to the given navigation target with the specified parameters.
<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, RouteParam... parameters)	Updates this UI to show the view corresponding to the given navigation target with the specified parameters.
<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
Component	UI.getActiveDragSourceComponent()	Gets the drag source of an active HTML5 drag event.
default Component	HasOrderedComponents.getComponentAt(int index)	Returns the component at the given position.
Component	UI.getCurrentView()	Returns the currently active route aka navigation target shown in this UI.
default Component	HasHelper.getHelperComponent()	Gets the component in the helper slot of this field.
static Component	ComponentUtil.getInnermostComponent(Composite<?> composite)	Returns the innermost component from a Composite chain, i.e.
static Component	ComponentUtil.getInnermostComponent(Element element)	Gets the innermost mapped component for the element.
Component	ShortcutEvent.getLifecycleOwner()	Component which owns the shortcut.
Component	ShortcutRegistration.getLifecycleOwner()	Component which controls when the shortcut is active and when it is not.
Component	ShortcutRegistration.getOwner()	Deprecated. This component has now multiple owners so this method has been replaced by #getOwners().
Component[]	ShortcutRegistration.getOwners()	The Components which own the shortcuts key event listeners.
static Component	ComponentUtil.getParentUsingComposite(Composite<?> composite, Component component)	Gets the parent of the given component, which is inside the given composite.
Component	ShortcutEvent.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.
Stream<Component>	UI.getChildren()
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 void	HasComponents.add(Component... components)	Adds the given components as children of this component.
void	UI.add(Component... components)	Adds the given components to the UI.
default void	HasComponents.addComponentAsFirst(Component component)	Adds the given component as the first child of this component.
default void	HasComponents.addComponentAtIndex(int index, Component component)	Adds the given component as child of this component at the specific index.
static <T extends ComponentEvent<?>> Registration	ComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener)	Adds a listener for an event of the given type to the component.
static <T extends ComponentEvent<?>> Registration	ComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener, Consumer<DomListenerRegistration> domListenerConsumer)	Adds a listener for an event of the given type to the component, and customizes the corresponding DOM event listener with the given consumer.
void	UI.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 ShortcutRegistration	Shortcuts.addShortcutListener(Component lifecycleOwner, ShortcutEventListener listener, Key key, KeyModifier... keyModifiers)	Invoke a ShortcutEventListener when the shortcut is invoked.
static ShortcutRegistration	Shortcuts.addShortcutListener(Component lifecycleOwner, Command command, Key key, KeyModifier... keyModifiers)	Invoke a Command when the shortcut is invoked.
void	UI.addToModalComponent(Component component)	Add component as child to modal component if one is active.
StateTree.ExecutionRegistration	UI.beforeClientResponse(Component component, SerializableConsumer<ExecutionContext> execution)	Registers a task to be executed before the response is sent to the client.
ShortcutRegistration	ShortcutRegistration.bindLifecycleTo(Component component)	Binds the shortcut's life cycle to that of the given Component.
static <T> T	ComponentUtil.getData(Component component, Class<T> type)	Gets a data instance with the given type, or null if there is no such instance.
static Object	ComponentUtil.getData(Component component, String key)	Gets a data instance with the given key, or null if 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 Component	ComponentUtil.getParentUsingComposite(Composite<?> composite, Component component)	Gets the parent of the given component, which is inside the given composite.
static <T extends ComponentEvent<?>> boolean	ComponentUtil.hasEventListener(Component component, Class<? extends T> eventType)	Check if the component has at least one registered listener of the given event type.
default int	HasOrderedComponents.indexOf(Component component)	Returns the index of the given component.
static boolean	ComponentUtil.isCompositeContent(Composite<?> composite, Component component)	Checks if the given component is inside a Composite chain, i.e.
ShortcutRegistration	ShortcutRegistration.listenOn(Component... listenOnComponents)	Fluently define the Component onto which the shortcut's listener is bound.
static void	ComponentUtil.onComponentAttach(Component component, boolean initialAttach)	Handles triggering the onAttach method and firing the AttachEvent for the given component when it has been attached to a UI.
static void	ComponentUtil.onComponentDetach(Component component)	Handles triggering the onDetach method and firing the DetachEvent for the given component right before it is detached from a UI.
default void	HasComponents.remove(Component... components)	Removes the given child components from this component.
default void	HasOrderedComponents.replace(Component oldComponent, Component newComponent)	Replaces the component in the container with another one without changing position.
void	UI.setChildComponentModal(Component childComponent, boolean modal)	Makes the child component modal or modeless.
static <T> void	ComponentUtil.setData(Component component, Class<T> type, T value)	Stores an instance of a specific type for the given component.
static void	ComponentUtil.setData(Component component, String key, Object value)	Stores a arbitrary value for the given component.
protected static void	Component.setElement(Component component, Element element)	Initializes the root element of a component.
default void	HasHelper.setHelperComponent(Component component)	Adds the given component into helper slot of component, replacing any existing helper component.
static Registration	Shortcuts.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 void	HasComponents.add(Collection<Component> components)	Adds the given components as children of this component.
static void	ComponentUtil.findComponents(Element element, Consumer<Component> componentConsumer)	Finds the first component instance in each Element subtree by traversing the Element tree starting from the given element.
static ComponentMetaData.DependencyInfo	ComponentUtil.getDependencies(VaadinService service, Class<? extends Component> componentClass)	Gets the dependencies for the given class, defined using annotations ( JavaScript, StyleSheet and Uses).
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 void	HasComponents.remove(Collection<Component> components)	Removes the given child components from this component.

Constructors in com.vaadin.flow.component with parameters of type Component

Modifier	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.
protected	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 new ShortcutEvent.

Uses of Component in com.vaadin.flow.component.accordion

Subclasses of Component in com.vaadin.flow.component.accordion

Modifier and Type	Class	Description
class	Accordion	Accordion is a vertically stacked set of expandable panels.
class	AccordionPanel	An accordion panel which could be opened or closed.

Methods in com.vaadin.flow.component.accordion that return Component

Modifier and Type	Method	Description
protected Component	AccordionPanel.createSummaryContainer()	Creates the summary container component.

Methods in com.vaadin.flow.component.accordion with parameters of type Component

Modifier and Type	Method	Description
AccordionPanel	Accordion.add(String summary, Component content)	Adds a panel created from the given title and content.
void	Accordion.remove(Component content)	Removes a panel based on the content

Constructors in com.vaadin.flow.component.accordion with parameters of type Component

Modifier	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
class	AppLayout	App Layout is a component for building common application layouts.
class	DrawerToggle	Server-side component for the <vaadin-drawer-toggle> element.

Methods in com.vaadin.flow.component.applayout that return Component

Modifier and Type	Method	Description
Component	AppLayout.getContent()

Methods in com.vaadin.flow.component.applayout with parameters of type Component

Modifier and Type	Method	Description
void	AppLayout.addToDrawer(Component... components)	Adds the components to the drawer slot of this AppLayout.
void	AppLayout.addToNavbar(boolean touchOptimized, Component... components)	Adds the components to the navbar slot of this AppLayout.
void	AppLayout.addToNavbar(Component... components)	Adds the components to the navbar slot of this AppLayout.
void	AppLayout.remove(Component... components)	Removes the child components from the parent.
void	AppLayout.setContent(Component content)	Sets the displayed content.
void	DrawerToggle.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
class	Avatar	Avatar is a graphical representation of an object or entity, for example a person or an organisation.
class	AvatarGroup	Avatar 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
class	Board	Vaadin Board allows creating responsive layouts in an easy way.
class	Row	Row class to define rows used in a Board instance.

Methods in com.vaadin.flow.component.board with parameters of type Component

Modifier and Type	Method	Description
void	Row.add(Component... components)	Adds the given component(s) to the row.
void	Row.add(Component component, int cols)	Adds the given component to the row using the given number of columns.
Row	Board.addRow(Component... components)	Creates a new row and adds the given components to the row.
int	Row.getComponentSpan(Component component)	Gets the number of columns the given component spans.
void	Row.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

Modifier	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 void	FunctionCaller.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
class	Button	The Button component allows users to perform actions.

Methods in com.vaadin.flow.component.button that return Component

Modifier and Type	Method	Description
Component	Button.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 void	Button.remove(Component... components)	Removes the given child components from this component.
void	Button.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

Modifier	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
class	Chart	Vaadin 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
class	Checkbox	Checkbox is an input field representing a binary choice.
class	CheckboxGroup<T>	CheckBoxGroup is a multi-selection component where items are displayed as check boxes.

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
void	Checkbox.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
void	CheckboxGroup.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
class	ComboBox<T>	Combo Box allows the user to choose a value from a filterable list of options presented in an overlay.
class	ComboBoxBase<TComponent extends ComboBoxBase<TComponent,TItem,TValue>,TItem,TValue>	Provides base functionality for combo box related components, such as ComboBox
class	MultiSelectComboBox<TItem>	MultiSelectComboBox allows the user to select one or more values from a filterable list of options presented in an overlay.

Uses of Component in com.vaadin.flow.component.combobox.dataview

Constructors in com.vaadin.flow.component.combobox.dataview with parameters of type Component

Modifier	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
class	ConfirmDialog	Confirm 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
void	ConfirmDialog.setCancelButton(Component component)	Sets custom cancel button
void	ConfirmDialog.setConfirmButton(Component component)	Sets custom confirm button
void	ConfirmDialog.setHeader(Component component)	Sets confirmation dialog custom header
void	ConfirmDialog.setRejectButton(Component component)	Sets custom Reject button
void	ConfirmDialog.setText(Component component)	Sets custom confirmation message

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
class	MenuManager<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
class	ContextMenu	Context Menu is a component that you can attach to any component to display a context menu.
class	ContextMenuBase<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>.
class	MenuItem	Item component used inside ContextMenu and SubMenu.
class	MenuItemBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>>	Base class for item component used inside ContextMenus.

Methods in com.vaadin.flow.component.contextmenu that return Component

Modifier and Type	Method	Description
Component	ContextMenuBase.getTarget()	Gets the target component of this context menu, or null if 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
void	ContextMenuBase.add(Component... components)	Adds the given components into the context menu overlay.
void	MenuManager.add(Component... components)	Adds components to the (sub)menu.
void	SubMenuBase.add(Component... components)	Adds the given components into the sub menu overlay.
void	ContextMenuBase.addComponentAtIndex(int index, Component component)	Adds the given component into this context menu at the given index.
void	MenuManager.addComponentAtIndex(int index, Component component)	Inserts component to the (sub)menu using the index.
void	SubMenuBase.addComponentAtIndex(int index, Component component)	Adds the given component into the sub menu overlay at the given index.
MenuItem	ContextMenu.addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)
I	ContextMenuBase.addItem(Component component)	Adds a new item component with the given component to the context menu overlay.
MenuItem	HasMenuItems.addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)	Adds a new item component with the given component and click listener to the context menu overlay.
I	MenuManager.addItem(Component component)	Adds a component as a menu item.
I	MenuManager.addItem(Component component, ComponentEventListener<ClickEvent<I>> clickListener)	Adds a component as a menu item with a click listener.
MenuItem	SubMenu.addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)
I	SubMenuBase.addItem(Component component)	Adds a new item component with the given component to the sub menu overlay.
void	ContextMenuBase.remove(Component... components)
void	MenuManager.remove(Component... components)	Removes components to the (sub)menu.
void	SubMenuBase.remove(Component... components)	Removes the given components from the sub menu overlay.
void	ContextMenuBase.setTarget(Component target)	Sets the target component for this context menu.

Constructors in com.vaadin.flow.component.contextmenu with parameters of type Component

Modifier	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
class	CookieConsent	Cookie 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
class	Crud<E>	A component for performing CRUD operations on a data backend (e.g entities from a database).
class	CrudGrid<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
Component	Crud.getNewButton()	Gets the Crud new item button
Component	BinderCrudEditor.getView()	Deprecated. This method should not be used outside.
Component	CrudEditor.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
void	Crud.setNewButton(Component button)	Sets the Crud new item button
void	Crud.setToolbar(Component... components)	Sets the content of the toolbar.

Constructors in com.vaadin.flow.component.crud with parameters of type Component

Modifier	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
class	CustomField<T>	A HasValue whose 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 void	CustomField.add(Component... components)	Adds the given components as children of this component.
protected void	CustomField.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
class	DatePicker	Date Picker is an input field that allows the user to enter a date by typing or by selecting from a calendar overlay.

Uses of Component in com.vaadin.flow.component.datetimepicker

Subclasses of Component in com.vaadin.flow.component.datetimepicker

Modifier and Type	Class	Description
class	DateTimePicker	Date Time Picker is an input field for selecting both a date and a time.

Uses of Component in com.vaadin.flow.component.details

Subclasses of Component in com.vaadin.flow.component.details

Modifier and Type	Class	Description
class	Details	Details 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
protected Component	Details.createSummaryContainer()	Creates the summary container component.
Component	Details.getSummary()	Returns summary component which was set via Details.setSummary(Component) or Details.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 via HasComponents.add(Component...)

Methods in com.vaadin.flow.component.details with parameters of type Component

Modifier and Type	Method	Description
void	Details.addComponentAtIndex(int index, Component component)	Adds the given component to the content section at the specific index.
void	Details.addContent(Component... components)	Deprecated. since v24.2, use HasComponents.add(Component...) instead.
void	Details.setContent(Component content)	Deprecated. since v24.2, use Details.removeAll() and HasComponents.add(Component...) instead.
void	Details.setSummary(Component summary)	Sets the component summary

Method parameters in com.vaadin.flow.component.details with type arguments of type Component

Modifier and Type	Method	Description
void	Details.add(Collection<Component> components)	Adds components to the content section
void	Details.remove(Collection<Component> components)	Removes specified components from the content section

Constructors in com.vaadin.flow.component.details with parameters of type Component

Modifier	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
class	Dialog	A Dialog is a small window that can be used to present information and user interface elements in an overlay.

Methods in com.vaadin.flow.component.dialog with parameters of type Component

Modifier and Type	Method	Description
void	Dialog.addComponentAtIndex(int index, Component component)	Adds the given component into this dialog at the given index.

Method parameters in com.vaadin.flow.component.dialog with type arguments of type Component

Modifier and Type	Method	Description
void	Dialog.add(Collection<Component> components)	Adds the given components into this dialog.

Constructors in com.vaadin.flow.component.dialog with parameters of type Component

Modifier	Constructor	Description
	Dialog(Component... components)	Creates a dialog with given components inside.
	Dialog(String title, Component... components)	Creates a dialog with given title and 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
class	DragEndEvent<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.
interface	DragSource<T extends Component>	Mixin interface that provides basic drag source API for any component.
class	DragStartEvent<T extends Component>	HTML5 drag start event, fired when the user starts dragging a drag source.
class	DropEvent<T extends Component>	Server side drop event.
interface	DropTarget<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> void	DndUtil.updateDragSourceActivation(DragSource<T> dragSource)	Triggers drag source activation method in JS connector once when the component has been attached.
static <T extends Component> void	DndUtil.updateDropTargetActivation(DropTarget<T> dropTarget)	Triggers drop target activation method in JS connector once when the component has been attached.

Uses of Component in com.vaadin.flow.component.formlayout

Subclasses of Component in com.vaadin.flow.component.formlayout

Modifier and Type	Class	Description
class	FormLayout	Form 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 class	FormLayout.FormItem	Server-side component for the <vaadin-form-item> element.

Methods in com.vaadin.flow.component.formlayout with parameters of type Component

Modifier and Type	Method	Description
void	FormLayout.add(Component component, int colspan)	Adds a component with the desired colspan.
FormLayout.FormItem	FormLayout.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.FormItem	FormLayout.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 void	FormLayout.FormItem.addToLabel(Component... components)	Adds the given components as children of this component at the slot 'label'.
int	FormLayout.getColspan(Component component)	Gets the colspan of the given component.
void	FormLayout.FormItem.remove(Component... components)	Removes the given child components from this component.
void	FormLayout.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

Modifier	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
class	Grid<T>	Grid is a component for showing tabular data.
static class	Grid.Column<T>	Server-side component for the <vaadin-grid-column> element.
class	GridSelectionColumn	Server 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
Component	GridTester.getCellComponent(int row, int column)	Get component for item in cell.
Component	GridTester.getCellComponent(int row, String columnName)	Get component for item in column.
Component	FooterRow.FooterCell.getComponent()
Component	HeaderRow.HeaderCell.getComponent()
Component	Grid.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
void	FooterRow.FooterCell.setComponent(Component component)
void	HeaderRow.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
class	GridContextMenu<T>	Server-side component for <vaadin-context-menu> to be used with Grid.
class	GridMenuItem<T>	Item component used inside GridContextMenu and GridSubMenu.

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)
void	GridContextMenu.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
void	EditorRenderer.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
class	GridPro<E>
static class	GridPro.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
class	Anchor	Component representing an <a> element.
class	Article	Component representing a <article> element.
class	Aside	Component representing a <aside> element.
class	DescriptionList	Component representing a <dl> element.
static class	DescriptionList.Description	Component representing a <dd> element.
static class	DescriptionList.Term	Component representing a <dt> element.
class	Div	Component representing a <div> element.
class	Emphasis	Component representing a <em> element.
class	Footer	Component representing a <footer> element.
class	H1	Component representing a <h1> element.
class	H2	Component representing a <h2> element.
class	H3	Component representing a <h3> element.
class	H4	Component representing a <h4> element.
class	H5	Component representing a <h5> element.
class	H6	Component representing a <h6> element.
class	Header	Component representing a <header> element.
class	Hr	Component representing a <hr> element.
class	HtmlObject	Component representing a <object> element.
class	IFrame	Component representing a <iframe> element.
class	Image	Component representing a <img> element.
class	Input	Component representing an <input> element.
class	Label	Deprecated, for removal: This API element is subject to removal in a future version. Use NativeLabel instead, if you need the HTML <label> element, which is normally not needed within a Vaadin Flow application's high-level components.
class	ListItem	Component representing a <li> element.
class	Main	Component representing a <main> element.
class	NativeButton	Component representing a <button> element.
class	NativeDetails	Component representing a <details> element.
static class	NativeDetails.Summary	Component representing a <summary> element.
class	NativeLabel	Component for a <label> element, which represents a caption for an input field in a user interface.
class	Nav	Component representing a <nav> element.
class	OrderedList	Component representing a <ol> element.
class	Paragraph	Component representing a <p> element.
class	Param	Component representing a <param> element for <param> element.
class	Pre	Component representing a <pre> element.
class	RangeInput	Creates a new input element with type "range".
class	Section	Component representing a <section> element.
class	Span	Component representing a <span> element.
class	UnorderedList	Component representing a <ul> element.

Methods in com.vaadin.flow.component.html that return Component

Modifier and Type	Method	Description
Component	NativeDetails.getContent()	Returns the details content which was set via NativeDetails.setContent(Component).

Methods in com.vaadin.flow.component.html with parameters of type Component

Modifier and Type	Method	Description
void	NativeDetails.setContent(Component content)	Sets the details content and removes the previously set content.
void	Label.setFor(Component forComponent)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the component that this label describes.
void	NativeLabel.setFor(Component forComponent)	Sets the component that this label describes.
void	NativeDetails.setSummary(Component... summaryContent)	Sets the components of the summary.

Constructors in com.vaadin.flow.component.html with parameters of type Component

Modifier	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.html.testbench

Methods in com.vaadin.flow.component.html.testbench that return Component

Modifier and Type	Method	Description
Component	NativeDetailsTester.getContent()	Get details content if the details is opened.

Uses of Component in com.vaadin.flow.component.icon

Subclasses of Component in com.vaadin.flow.component.icon

Modifier and Type	Class	Description
class	AbstractIcon<T extends AbstractIcon<T>>	Abstract base class for icon components
class	FontIcon	Component for displaying an icon from a font icon collection.
class	Icon	Component for displaying an icon from the Vaadin Icons collection.
class	SvgIcon	Component for displaying an icon from a SVG file.

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
class	AbstractFieldSupport<C extends Component & HasValue<AbstractField.ComponentValueChangeEvent<C,T>,T>,T>	Encapsulates all the logic required for a typical field implementation.

Methods in com.vaadin.flow.component.internal that return Component

Modifier and Type	Method	Description
Component	UIInternals.getActiveDragSourceComponent()	Gets the drag source of an active HTML5 drag event.
Component	UIInternals.getActiveModalComponent()	Get the active modal component if modal components set.

Methods in com.vaadin.flow.component.internal with parameters of type Component

Modifier and Type	Method	Description
static ComponentTracker.Location	ComponentTracker.findAttach(Component component)	Finds the location where the given component instance was attached to a parent.
static ComponentTracker.Location	ComponentTracker.findCreate(Component component)	Finds the location where the given component instance was created.
void	UIInternals.setActiveDragSourceComponent(Component activeDragSourceComponent)	Sets the drag source of an active HTML5 drag event.
void	UIInternals.setChildModal(Component child)	Makes an existing child component modal.
void	UIInternals.setChildModeless(Component child)	Sets the given child modeless.
void	UIInternals.showRouteTarget(Location viewLocation, Component target, List<RouterLayout> layouts)	Shows a route target in the related UI.
static void	ComponentTracker.trackAttach(Component component)	Tracks the location where the component was attached.
static void	ComponentTracker.trackCreate(Component component)	Tracks the location where the component was created.

Method parameters in com.vaadin.flow.component.internal with type arguments of type Component

Modifier and Type	Method	Description
void	UIInternals.addComponentDependencies(Class<? extends Component> componentClass)	Adds the dependencies defined using StyleSheet or JavaScript on the given Component class.

Constructors in com.vaadin.flow.component.internal with parameters of type Component

Modifier	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

Modifier	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.listbox

Subclasses of Component in com.vaadin.flow.component.listbox

Modifier and Type	Class	Description
class	ListBox<T>	List Box allows the user to select one or more values from a scrollable list of items.
class	ListBoxBase<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE>	Base class for the ListBox and MultiSelectListBox.
class	MultiSelectListBox<T>	Server-side component for the vaadin-list-box element 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
void	ListBoxBase.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
class	LitTemplate	Component 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

Modifier	Constructor	Description
	InjectableLitElementInitializer(Element element, Class<? extends Component> templateClass)	Creates an initializer for the element.

Uses of Component in com.vaadin.flow.component.login

Subclasses of Component in com.vaadin.flow.component.login

Modifier and Type	Class	Description
class	AbstractLogin	Abstract component for the <vaadin-login-overlay> and <vaadin-login-form> components.
class	LoginForm	Login is a component that contains a login form.
class	LoginOverlay	Server-side component for the <vaadin-login-overlay> component.

Methods in com.vaadin.flow.component.login that return Component

Modifier and Type	Method	Description
Component	LoginOverlay.getTitle()	Returns custom title component which was set via LoginOverlay.setTitle(Component)

Methods in com.vaadin.flow.component.login with parameters of type Component

Modifier and Type	Method	Description
void	LoginOverlay.setTitle(Component title)	Sets the application title, null to remove any previous title and to display title set via LoginOverlay.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
class	Map	Map is a component for displaying geographic maps from various sources.
class	MapBase	Base 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
class	MenuBar	Menu 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
MenuItem	MenuBar.addItem(Component component)	Creates a new MenuItem component and adds it to the root level of this menu bar.
MenuItem	MenuBar.addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)	Creates a new MenuItem component with the provided click listener and adds it to the root level of this menu bar.
MenuItem	MenuBar.addItem(Component component, String tooltipText)	Creates a new MenuItem component with the provided tooltip text and adds it to the root level of this menu bar.
MenuItem	MenuBar.addItem(Component component, String tooltipText, ComponentEventListener<ClickEvent<MenuItem>> clickListener)	Creates a new MenuItem component 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
class	MessageInput	Message Input allows users to author and send messages.
class	MessageList	Message 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
class	Notification	Notifications are used to provide feedback to the user.

Methods in com.vaadin.flow.component.notification with parameters of type Component

Modifier and Type	Method	Description
void	Notification.addComponentAtIndex(int index, Component component)	Adds the given component into this notification at the given index.

Method parameters in com.vaadin.flow.component.notification with type arguments of type Component

Modifier and Type	Method	Description
void	Notification.add(Collection<Component> components)	Adds the given components into this notification.

Constructors in com.vaadin.flow.component.notification with parameters of type Component

Modifier	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
class	FlexLayout	A layout component that implements Flexbox.
class	HorizontalLayout	Horizontal Layout places components side-by-side in a row.
class	Scroller	Scroller is a component container which enables scrolling overflowing content.
class	VerticalLayout	Vertical Layout places components top-to-bottom in a column.

Methods in com.vaadin.flow.component.orderedlayout that return Component

Modifier and Type	Method	Description
Component	Scroller.getContent()	Gets the content of this scroller.

Methods in com.vaadin.flow.component.orderedlayout with parameters of type Component

Modifier and Type	Method	Description
void	HorizontalLayout.addAndExpand(Component... components)	Adds the given components to this layout and sets them as expanded.
void	VerticalLayout.addAndExpand(Component... components)	Adds the given components to this layout and sets them as expanded.
default void	FlexComponent.expand(Component... componentsToExpand)	Expands the given components.
FlexComponent.Alignment	VerticalLayout.getHorizontalComponentAlignment(Component component)	Gets the individual horizontal alignment of a given component.
FlexComponent.Alignment	HorizontalLayout.getVerticalComponentAlignment(Component component)	Gets the individual vertical alignment of a given component.
default void	FlexComponent.replace(Component oldComponent, Component newComponent)
void	Scroller.setContent(Component content)	Sets the content of this scroller.
void	VerticalLayout.setHorizontalComponentAlignment(FlexComponent.Alignment alignment, Component... componentsToAlign)	Sets a horizontal alignment for individual components inside the layout.
void	HorizontalLayout.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

Modifier	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.
	HorizontalLayout(FlexComponent.Alignment alignment, Component... children)	Convenience constructor to create a layout with the children and specified vertical alignment.
	HorizontalLayout(FlexComponent.JustifyContentMode justifyContentMode, Component... children)	Convenience constructor to create a layout with the children and specified justifyContentMode.
	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.
	VerticalLayout(FlexComponent.Alignment alignment, Component... children)	Convenience constructor to create a layout with the children and specified horizontal alignment.
	VerticalLayout(FlexComponent.JustifyContentMode justifyContentMode, Component... children)	Convenience constructor to create a layout with the children and specified justifyContentMode.

Uses of Component in com.vaadin.flow.component.progressbar

Subclasses of Component in com.vaadin.flow.component.progressbar

Modifier and Type	Class	Description
class	ProgressBar	Progress 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
class	RadioButtonGroup<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.

Method parameters in com.vaadin.flow.component.radiobutton with type arguments of type Component

Modifier and Type	Method	Description
void	RadioButtonGroup.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
class	RichTextEditor	Rich 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
class	Select<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
void	Select.add(Component... components)	Adds the given components as children of this component.
void	Select.addComponentAsFirst(Component component)	Adds the given component as the first child of this component.
void	Select.addComponentAtIndex(int index, Component component)	Adds the given component as child of this component at the specific index.
void	Select.addComponents(T afterItem, Component... components)
void	Select.prependComponents(T beforeItem, Component... components)
void	Select.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
void	Select.setRenderer(ComponentRenderer<? extends Component,T> renderer)	Sets the item renderer for this select group.

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> void	ClientValidationUtil.preventWebComponentFromModifyingInvalidState(C component)

Methods in com.vaadin.flow.component.shared that return Component

Modifier and Type	Method	Description
static Component	SlotUtils.getChildInSlot(HasElement parent, String slot)	Gets the first child component of the parent that is in the specified slot.
default Component	HasPrefix.getPrefixComponent()	Gets the component in the prefix slot of this field.
default Component	HasSuffix.getSuffixComponent()	Gets the component in the suffix slot of this field.

Methods in com.vaadin.flow.component.shared with parameters of type Component

Modifier and Type	Method	Description
static void	SlotUtils.addToSlot(HasElement parent, String slot, Component... components)	Adds components to the specified slot in the parent component.
static Tooltip	Tooltip.forComponent(Component component)	Creates a tooltip to the given Component if one hasn't already been created.
default void	HasPrefix.setPrefixComponent(Component component)	Adds the given component into this field before the content, replacing any existing prefix component.
static void	SlotUtils.setSlot(HasElement parent, String slot, Component... components)	Clears the specific slot in the parent component and adds components to it.
default void	HasSuffix.setSuffixComponent(Component component)	Adds the given component into this field after the content, replacing any existing suffix component.

Constructors in com.vaadin.flow.component.shared with parameters of type Component

Modifier	Constructor	Description
	ClientValidatedEvent(Component source, boolean fromClient)	Creates a new event using the given source.
	ClientValidatedEvent(Component source, boolean fromClient, boolean valid)	Creates a new event using the given source.

Uses of Component in com.vaadin.flow.component.sidenav

Subclasses of Component in com.vaadin.flow.component.sidenav

Modifier and Type	Class	Description
class	SideNav	A side navigation menu with support for hierarchical and flat menus.
class	SideNavItem	A menu item for the SideNav component.

Method parameters in com.vaadin.flow.component.sidenav with type arguments of type Component

Modifier and Type	Method	Description
void	SideNavItem.setPath(Class<? extends Component> view)	Retrieves Route and RouteAlias annotations from the specified view, and then sets the corresponding path and path aliases for this item.
void	SideNavItem.setPath(Class<? extends Component> view, RouteParameters routeParameters)	Retrieves Route and RouteAlias annotations from the specified view, and then sets the corresponding path and path aliases for this item.

Constructors in com.vaadin.flow.component.sidenav with parameters of type Component

Modifier	Constructor	Description
	SideNavItem(String label, Class<? extends Component> view, Component prefixComponent)	Creates a new menu item using the given label and prefix component (like an icon) that links to the given view.
	SideNavItem(String label, Class<? extends Component> view, RouteParameters routeParameters, Component prefixComponent)	Creates a new menu item using the given label and prefix component (like an icon) that links to the given view.
	SideNavItem(String label, String path, Component prefixComponent)	Creates a new menu item using the given label and prefix component (like an icon) that links to the given path.

Constructor parameters in com.vaadin.flow.component.sidenav with type arguments of type Component

Modifier	Constructor	Description
	SideNavItem(String label, Class<? extends Component> view)	Creates a new menu item using the given label that links to the given view.
	SideNavItem(String label, Class<? extends Component> view, Component prefixComponent)	Creates a new menu item using the given label and prefix component (like an icon) that links to the given view.
	SideNavItem(String label, Class<? extends Component> view, RouteParameters routeParameters)	Creates a new menu item using the given label that links to the given view.
	SideNavItem(String label, Class<? extends Component> view, RouteParameters routeParameters, Component prefixComponent)	Creates a new menu item using the given label and prefix component (like an icon) that links to the given view.

Uses of Component in com.vaadin.flow.component.splitlayout

Subclasses of Component in com.vaadin.flow.component.splitlayout

Modifier and Type	Class	Description
class	SplitLayout	Split 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
Component	SplitLayout.getPrimaryComponent()	Get the component currently set to the primary split.
Component	SplitLayout.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
void	SplitLayout.addToPrimary(Component... components)	Sets the given components to the primary split of this layout, i.e.
void	SplitLayout.addToSecondary(Component... components)	Sets the given components to the secondary split of this layout, i.e.
void	SplitLayout.remove(Component... components)	Removes the given child components from this component.

Constructors in com.vaadin.flow.component.splitlayout with parameters of type Component

Modifier	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
class	Tab	This component provides an accessible and customizable tab to be used inside Tabs component.
class	Tabs	Tabs are used to organize and group content into sections that the user can navigate between.
class	TabSheet	TabSheet consists of a set of tabs and the content area.

Methods in com.vaadin.flow.component.tabs with type parameters of type Component

Modifier and Type	Method	Description
<E extends Component> E	TabSheetTester.getTabContent(int index)	Gets the content of the visible tab at given index.
<E extends Component> E	TabSheetTester.getTabContent(String label)	Gets the content of the visible tab with the given label.

Methods in com.vaadin.flow.component.tabs that return Component

Modifier and Type	Method	Description
Component	TabSheet.getComponent(Tab tab)	Returns the Component instance associated with the given tab.
Component	Tabs.getComponentAt(int index)	Deprecated. since 24.0, use Tabs.getTabAt(int) instead.

Methods in com.vaadin.flow.component.tabs with parameters of type Component

Modifier and Type	Method	Description
void	Tabs.add(Component... components)	Deprecated. since 24.0, use Tabs.add(Tab...) instead.
Tab	TabSheet.add(Component tabContent, Component content)	Adds a tab created from the given tab content and content.
Tab	TabSheet.add(Tab tab, Component content)	Adds a tab with the given content.
Tab	TabSheet.add(Tab tab, Component content, int position)	Adds a tab with the given content to the given position.
Tab	TabSheet.add(String tabText, Component content)	Adds a tab created from the given text and content.
void	Tabs.addComponentAsFirst(Component component)	Deprecated. since 24.0, use Tabs.addTabAsFirst(Tab) instead.
void	Tabs.addComponentAtIndex(int index, Component component)	Deprecated. since 24.0, use Tabs.addTabAtIndex(int, Tab) instead.
Tab	TabSheet.getTab(Component content)	Returns the Tab associated with the given component.
int	Tabs.indexOf(Component component)	Deprecated. since 24.0, use Tabs.indexOf(Tab) instead.
void	Tabs.remove(Component... components)	Deprecated. since 24.0, use Tabs.remove(Tab...) instead.
void	TabSheet.remove(Component content)	Removes a tab based on the content
void	Tabs.replace(Component oldComponent, Component newComponent)	Deprecated. since 24.0, use Tabs.replace(Tab, Tab) instead.

Constructors in com.vaadin.flow.component.tabs with parameters of type Component

Modifier	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
Object	DeprecatedPolymerPublishedEventHandler.getTemplateItem(Component template, elemental.json.JsonObject argValue, Type convertedType)	Deprecated. Get the template model object and type.
boolean	DeprecatedPolymerPublishedEventHandler.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

Modifier	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
class	AbstractNumberField<C extends AbstractNumberField<C,T>,T extends Number>	Abstract base class for components based on vaadin-number-field element and its subclasses.
class	BigDecimalField	BigDecimalField is an input field for handling decimal numbers with high precision.
class	EmailField	Email Field is an extension of Text Field that only accepts email addresses as input.
class	IntegerField	IntegerField is an extension of Text Field that only accepts integer numbers.
class	NumberField	Number Field sports many of the same features as Text Field but only accepts numeric input.
class	PasswordField	Password Field is an input field for entering passwords.
class	TextArea	Text Area is an input field component for multi-line text input.
class	TextField	Text Field allows the user to input and edit text.
class	TextFieldBase<TComponent extends TextFieldBase<TComponent,TValue>,TValue>	Internal class that provides base functionality for input field components, such as TextField.

Methods in com.vaadin.flow.component.textfield with parameters of type Component

Modifier and Type	Method	Description
protected void	TextFieldBase.addToInput(Component... components)	Adds the given components as children of this component at the slot 'input'.
protected void	TextFieldBase.addToPrefix(Component... components)	Adds the given components as children of this component at the slot 'prefix'.
protected void	TextFieldBase.addToSuffix(Component... components)	Adds the given components as children of this component at the slot 'suffix'.

Uses of Component in com.vaadin.flow.component.timepicker

Subclasses of Component in com.vaadin.flow.component.timepicker

Modifier and Type	Class	Description
class	TimePicker	Time 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
class	CollapseEvent<T,C extends Component>
class	ExpandEvent<T,C extends Component>
class	HierarchyColumnComponentRenderer<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
class	TreeGrid<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
class	Upload	Upload is a component for uploading one or more files.

Methods in com.vaadin.flow.component.upload that return Component

Modifier and Type	Method	Description
Component	Upload.getDropLabel()	Get the component set as the drop label.
Component	Upload.getDropLabelIcon()	Get the component set as the drop label icon.
Component	Upload.getUploadButton()	Get the component set as the upload button for the upload.

Methods in com.vaadin.flow.component.upload with parameters of type Component

Modifier and Type	Method	Description
void	Upload.setDropLabel(Component label)	Set the component to show as a message to the user to drop files in the upload component.
void	Upload.setDropLabelIcon(Component icon)	Set the component to show as the drop label icon.
void	Upload.setUploadButton(Component button)	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
class	VirtualList<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
interface	PropertyConfiguration<C extends Component,P extends Serializable>	Offers a fluent API for configuring the properties of embedded web components produced by WebComponentExporter.
final class	WebComponent<C extends Component>	Acts as a proxy to the web component root onto which the exporter Component is added.
interface	WebComponentConfiguration<C extends Component>	Result of defining an embeddable web component using WebComponentExporter.

Subclasses of Component in com.vaadin.flow.component.webcomponent

Modifier and Type	Class	Description
class	WebComponentUI	Custom UI for use with WebComponents served from the server.
class	WebComponentWrapper	Wrapper component for a web component that exposes ClientCallable methods 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 an Optional for the Component related to value conversion.

Methods in com.vaadin.flow.data.binder with parameters of type Component

Modifier and Type	Method	Description
default void	HasItemComponents.addComponents(T afterItem, Component... components)	Adds the components after the given item.
default void	HasItemComponents.prependComponents(T beforeItem, Component... components)	Adds the components before the given item.

Constructors in com.vaadin.flow.data.binder with parameters of type Component

Modifier	Constructor	Description
	ValueContext(Component component)	Constructor for ValueContext.
	ValueContext(Component component, HasValue<?,?> hasValue)	Constructor for ValueContext.
	ValueContext(Component component, HasValue<?,?> hasValue, Locale locale)	Constructor for ValueContext.

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
class	SortEvent<T extends Component,S extends SortOrder<?>>	Event describing a change in sorting of a DataProvider.
static interface	SortEvent.SortNotifier<T extends Component,S extends SortOrder<?>>	The interface for adding and removing listeners for SortEvents.

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
class	IdentifierProviderChangeEvent<T,C extends Component>	Event notifying the component that its identifier provider has been changed through a data view.
class	ItemCountChangeEvent<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 Component	AbstractDataView.component

Methods in com.vaadin.flow.data.provider that return Component

Modifier and Type	Method	Description
protected abstract Component	AbstractComponentDataGenerator.createComponent(T item)	Creates a new component based on the provided item.
protected Component	AbstractComponentDataGenerator.getRenderedComponent(String itemKey)
protected Component	AbstractComponentDataGenerator.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 Query	DataViewUtils.getQuery(Component component)	Generates a data query with component's in-memory filter and sort comparator.
static Query	DataViewUtils.getQuery(Component component, boolean withSorting)	Generates a data query with component's in-memory filter and sort comparator, which is optionally included if withSorting is set to true.
protected void	AbstractComponentDataGenerator.registerRenderedComponent(String itemKey, Component component)	Appends the component to the container and registers it for future use during the lifecycle of the generator.
static void	DataViewUtils.removeComponentFilterAndSortComparator(Component component)	Removes the in-memory filter and sort comparator from a given component instance.
static <T> void	DataViewUtils.setComponentFilter(Component component, SerializablePredicate<T> filter)	Sets the in-memory filter to a given component instance.
static <T> void	DataViewUtils.setComponentSortComparator(Component component, SerializableComparator<T> sortComparator)	Sets the in-memory sort comparator to a given component instance.
protected Component	AbstractComponentDataGenerator.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

Modifier	Constructor	Description
	AbstractDataView(SerializableSupplier<? extends DataProvider<T,?>> dataProviderSupplier, Component component)	Creates a new instance of AbstractDataView subclass 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 of AbstractListDataView subclass 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
class	ComponentRenderer<COMPONENT extends Component,SOURCE>	Base class for all renderers that support arbitrary Components.

Methods in com.vaadin.flow.data.renderer that return Component

Modifier and Type	Method	Description
Component	BasicRenderer.createComponent(SOURCE item)
protected Component	ComponentDataGenerator.createComponent(T item)
Component	IconRenderer.createComponent(ITEM item)
Component	NativeButtonRenderer.createComponent(SOURCE item)
Component	TextRenderer.createComponent(ITEM item)
protected Component	ComponentDataGenerator.updateComponent(Component currentComponent, T item)
Component	ComponentRenderer.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 Component	ComponentDataGenerator.updateComponent(Component currentComponent, T item)
Component	ComponentRenderer.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

Modifier	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)	Creates a new ComponentRenderer that uses the componentFunction to generate new Component instances, and a componentUpdateFunction to update existing Component instances.
	ComponentRenderer(SerializableFunction<SOURCE,COMPONENT> componentFunction, SerializableBiFunction<Component,SOURCE,Component> componentUpdateFunction)	Creates a new ComponentRenderer that uses the componentFunction to generate new Component instances, and a componentUpdateFunction to update existing Component instances.
	IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator)	Creates a new renderer instance using the default ItemLabelGenerator: String::valueOf and the provided iconGenerator.
	IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator, ItemLabelGenerator<ITEM> itemLabelGenerator)	Creates a new renderer instance using the provided iconGenerator and itemLabelGenerator.

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
interface	MultiSelect<C extends Component,T>	Multi selection component which allows to select and deselect multiple items.
class	MultiSelectionEvent<C extends Component,T>	Fired when the selection changes in a listing component that supports multiple item selection.
interface	MultiSelectionListener<C extends Component,T>	A listener for listening for selection changes from a multiselection component.
interface	SelectionEvent<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).
interface	SelectionListener<C extends Component,T>	A listener for SelectionEvent.
interface	SelectionModel<C extends Component,T>	Models the selection logic of a Listing component.
static interface	SelectionModel.Multi<C extends Component,T>	A selection model in which multiple items can be selected at the same time.
static interface	SelectionModel.Single<C extends Component,T>	A selection model in which at most one item can be selected at a time.
interface	SingleSelect<C extends Component,T>	Single selection component whose selection is treated as a value.
class	SingleSelectionEvent<C extends Component,T>	Fired when the selection changes in a listing component.
interface	SingleSelectionListener<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> T	DefaultInstantiator.createComponent(Class<T> componentClass)
<T extends Component> T	Instantiator.createComponent(Class<T> componentClass)	Creates an instance of a component by its componentClass.

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> T	Element.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 void	ElementStateProvider.setComponent(StateNode node, Component component)	Defines a mapping between the element and the given component.
static void	ElementUtil.setComponent(Element element, Component component)	Defines a mapping between this element and the given Component.

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)	Finds all CssImport annotations on the given Component class, its super classes and implemented interfaces.
static List<JavaScript>	AnnotationReader.getJavaScriptAnnotations(Class<? extends Component> componentClass)	Finds all JavaScript annotations on the given Component class, its super classes and implemented interfaces.
static List<JsModule>	AnnotationReader.getJsModuleAnnotations(Class<? extends Component> componentClass)	Finds all JsModule annotation on the given Component class, its super classes and implenented interfaces.
static List<StyleSheet>	AnnotationReader.getStyleSheetAnnotations(Class<? extends Component> componentClass)	Finds all StyleSheet annotations on the given Component class, 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
void	ComponentMapping.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
class	AbstractRouteNotFoundError	This is abstract error view for routing exceptions.
class	InternalServerError	This is a basic default error view shown on exceptions during navigation.
class	RouteAccessDeniedError	This is a default error view shown on access denied routing exceptions.
class	RouteNotFoundError	This is a basic default error view shown on routing exceptions.
class	RouterLink	A link that handles navigation internally using Router instead 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> void	BeforeEvent.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> void	BeforeEvent.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>> void	BeforeEvent.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>> void	BeforeEvent.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>> void	BeforeEvent.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>> String	RouteConfiguration.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>> String	RouteConfiguration.getUrl(Class<? extends C> navigationTarget, T parameter)	Get the url string for given navigation target with the parameter in the url.
<C extends Component> void	BeforeEvent.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> void	BeforeEvent.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>> void	BeforeEvent.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>> void	BeforeEvent.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>> void	BeforeEvent.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>> void	RouterLink.setRoute(Router router, Class<? extends C> navigationTarget, T parameter)	Set the navigation target for this link.
<T, C extends Component & HasUrlParameter<T>> void	RouterLink.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()	Get Route navigation 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.

Method parameters in com.vaadin.flow.router with type arguments of type Component

Modifier and Type	Method	Description
void	BeforeEvent.forwardTo(Class<? extends Component> forwardTargetComponent)	Forward the navigation to show the given component instead of the component that is currently about to be displayed.
void	BeforeEvent.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.
String	RouteConfiguration.getUrl(Class<? extends Component> navigationTarget)	Get the registered url string for given navigation target.
String	RouteConfiguration.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.
boolean	RoutesChangedEvent.isRouteAdded(Class<? extends Component> clazz)	Determines if a given route navigation target was added for this change.
boolean	RouteConfiguration.isRouteRegistered(Class<? extends Component> route)	Check if the route is available as a registered target.
boolean	RoutesChangedEvent.isRouteRemoved(Class<? extends Component> clazz)	Determines if a given route navigation target was removed for this change.
void	RouteConfiguration.removeRoute(Class<? extends Component> navigationTarget)	Remove the given navigation target route registration.
void	RouteConfiguration.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.
void	BeforeEvent.rerouteTo(Class<? extends Component> routeTargetType)	Reroutes the navigation to show the given component instead of the component that is currently about to be displayed.
void	BeforeEvent.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.
void	RouteConfiguration.setAnnotatedRoute(Class<? extends Component> navigationTarget)	Giving a navigation target here will handle the Route annotation to get the path and also register any RouteAlias that may be on the class.
void	NavigationState.setNavigationTarget(Class<? extends Component> navigationTarget)	Sets the navigation target of this state.
void	RouteConfiguration.setParentAnnotatedRoute(String path, Class<? extends Component> navigationTarget)	Register a navigation target on the specified path.
void	RouteConfiguration.setRoute(String path, Class<? extends Component> navigationTarget)	Register a navigation target with specified path and with no parent layouts.
void	RouteConfiguration.setRoute(String path, Class<? extends Component> navigationTarget, Class<? extends RouterLayout>... parentChain)	Register a navigation target with specified path and given parent layout chain.
void	RouteConfiguration.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)	Register a navigation target with specified path and given parent layout chain.
void	RouterLink.setRoute(Router router, Class<? extends Component> navigationTarget)	Set the navigation target for this link.
void	RouterLink.setRoute(Router router, Class<? extends Component> navigationTarget, RouteParameters parameters)	Set the navigation target for this link.
void	RouterLink.setRoute(Class<? extends Component> navigationTarget)	Set the navigation target for this link.
void	RouterLink.setRoute(Class<? extends Component> navigationTarget, RouteParameters parameters)	Set the navigation target for this link.
NavigationStateBuilder	NavigationStateBuilder.withTarget(Class<? extends Component> navigationTarget)	Assigns the given navigation target to the navigation state being built.
NavigationStateBuilder	NavigationStateBuilder.withTarget(Class<? extends Component> navigationTarget, RouteParameters parameters)	Assigns the given navigation target with the given url parameter to the navigation state being built.

Constructor parameters in com.vaadin.flow.router with type arguments of type Component

Modifier	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 final 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 void	AbstractNavigationStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)	Notify the navigation target about the status of the navigation.
protected void	ErrorStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)
protected void	NavigationStateRenderer.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 void	AbstractRouteRegistry.addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>,Class<? extends Component>> exceptionTargetsMap)	Add the given error target to the exceptionTargetMap.
protected void	AbstractRouteRegistry.addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>,Class<? extends Component>> exceptionTargetsMap)	Add the given error target to the exceptionTargetMap.
static void	HasUrlParameterFormat.checkMandatoryParameter(Class<? extends Component> navigationTarget, RouteParameters parameters)	Verify whether the navigationTarget has mandatory parameter and complies with the given parameter values.
boolean	RouteTarget.containsTarget(Class<? extends Component> target)	Check if navigation target is present in current target.
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)
RouteTarget	AbstractRouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)
RouteTarget	ConfiguredRoutes.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)	Gets the RouteTarget instance matching the given target component and route parameters.
String	ConfiguredRoutes.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)
String	ConfiguredRoutes.getTargetUrl(Class<? extends Component> navigationTarget)	Get the url path String for the given navigation target class.
String	ConfiguredRoutes.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)
String	ConfiguredRoutes.getTemplate(Class<? extends Component> navigationTarget)	Get the route template String for the given navigation target class.
String	ConfiguredRoutes.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 String	HasUrlParameterFormat.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 implementing HasUrlParameter
boolean	AbstractRouteRegistry.hasMandatoryParameter(Class<? extends Component> navigationTarget)
boolean	ConfiguredRoutes.hasRouteTarget(Class<? extends Component> target)	Check it the given route target has been registered to the configuration.
void	AbstractRouteRegistry.removeRoute(Class<? extends Component> navigationTarget)
void	AbstractRouteRegistry.removeRoute(String path, Class<? extends Component> navigationTarget)
void	ConfigureRoutes.removeRoute(Class<? extends Component> target)	Remove the target completely from the configuration.
void	ConfigureRoutes.removeRoute(String template, Class<? extends Component> targetRoute)	Remove navigation target for given template.
void	AbstractRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)
void	ConfigureRoutes.setRoute(String template, Class<? extends Component> navigationTarget)	Set a new RouteTarget for the given template.
void	ConfigureRoutes.setRoute(String template, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)	Set a new RouteTarget for the given template.
void	ConfigureRoutes.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

Modifier	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
Optional<Component>	ErrorEvent.getComponent()	Get the Component that the error was thrown for.
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
RouteTarget	RouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)	Gets the RouteTarget instance matching the given target component and route parameters.
RouteTarget	SessionRouteRegistry.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)
boolean	RouteRegistry.hasMandatoryParameter(Class<? extends Component> navigationTarget)	Check if the given navigationTarget requires parameters.
void	RouteRegistry.removeRoute(Class<? extends Component> navigationTarget)	Remove the given navigation target route registration.
void	RouteRegistry.removeRoute(String path, Class<? extends Component> navigationTarget)	Remove navigationTarget for the path.
void	RouteRegistry.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

Modifier	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

Methods in com.vaadin.flow.server.auth that return types with arguments of type Component

Modifier and Type	Method	Description
protected Class<? extends Component>	NavigationAccessControl.getLoginView()	Gets the Flow login view.

Method parameters in com.vaadin.flow.server.auth with type arguments of type Component

Modifier and Type	Method	Description
final void	NavigationAccessControl.setLoginView(Class<? extends Component> loginView)	Sets the Flow login view to use.
void	ViewAccessChecker.setLoginView(Class<? extends Component> loginView)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the Flow login view to use.

Uses of Component in com.vaadin.flow.server.frontend

Method parameters in com.vaadin.flow.server.frontend with type arguments of type Component

Modifier and Type	Method	Description
static String	BundleUtils.getChunkId(Class<? extends Component> componentClass)	Gets the id for a chunk defined by the given class.

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
void	ApplicationRouteRegistry.setErrorNavigationTargets(Set<Class<? extends Component>> errorNavigationTargets)	Set error handler navigation targets.
void	ApplicationRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)
boolean	NavigationTargetFilter.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
final class	PropertyConfigurationImpl<C extends Component,P extends Serializable>	For internal use only.
final class	WebComponentBinding<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 specific Component type.

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
String	WebComponentExporterTagExtractor.apply(WebComponentExporterFactory<? extends Component> factory)
static String	WebComponentGenerator.generateModule(WebComponentConfiguration<? extends Component> webComponentConfiguration, String frontendURI, String themeName)	Generate web component html/JS for given tag and class.
static String	WebComponentGenerator.generateModule(WebComponentExporterFactory<? extends Component> factory, String frontendURI, String themeName)	Generate web component html/JS for given exporter factory.
boolean	WebComponentConfigurationRegistry.setConfigurations(Set<WebComponentConfiguration<? extends Component>> configurations)	Registers all available web component configurations to the registry.
protected void	WebComponentConfigurationRegistry.updateRegistry(Set<WebComponentConfiguration<? extends Component>> configurations)	Internal method for updating registry.

Uses of Component in com.vaadin.flow.spring

Methods in com.vaadin.flow.spring with type parameters of type Component

Modifier and Type	Method	Description
<T extends Component> T	SpringInstantiator.createComponent(Class<T> componentClass)

Uses of Component in com.vaadin.flow.spring.security

Method parameters in com.vaadin.flow.spring.security with type arguments of type Component

Modifier and Type	Method	Description
protected void	VaadinWebSecurity.setLoginView(org.springframework.security.config.annotation.web.builders.HttpSecurity http, Class<? extends Component> flowLoginView)	Sets up login for the application using the given Flow login view.
protected void	VaadinWebSecurity.setLoginView(org.springframework.security.config.annotation.web.builders.HttpSecurity http, Class<? extends Component> flowLoginView, String logoutSuccessUrl)	Sets up login for the application using the given Flow login view.
NavigationAccessControlConfigurer	NavigationAccessControlConfigurer.withLoginView(Class<? extends Component> loginView)	Sets the Flow login view to use.

Uses of Component in com.vaadin.testbench.unit

Classes in com.vaadin.testbench.unit with type parameters of type Component

Modifier and Type	Class	Description
class	ComponentQuery<T extends Component>	Query class used for finding a component inside a given search context.
class	ComponentTester<T extends Component>	Test wrapper for components with helpful methods for testing a component.

Methods in com.vaadin.testbench.unit with type parameters of type Component

Modifier and Type	Method	Description
<T extends Component> ComponentQuery<T>	BaseUIUnitTest.$(Class<T> componentType)	Gets a query object for finding a component inside the UI
<T extends Component> ComponentQuery<T>	BaseUIUnitTest.$(Class<T> componentType, Component fromThis)	Gets a query object for finding a component nested inside the given component.
<T extends Component> ComponentQuery<T>	BaseUIUnitTest.$view(Class<T> componentType)	Gets a query object for finding a component inside the current view
static <T extends Component> Predicate<T>	ElementConditions.containsText(String text)	Checks if text content of the component contains the given text.
static <T extends Component> Predicate<T>	ElementConditions.containsText(String text, boolean ignoreCase)	Checks if text content of the component contains the given text.
<R extends Component> ComponentQuery<R>	ComponentTester.find(Class<R> componentType)	Gets a ComponentQuery to search for component of the given type nested inside the wrapped component.
protected <R extends Component> List<R>	ComponentTester.findAllByQuery(Class<R> componentType, Consumer<ComponentQuery<R>> queryBuilder)	Searches for nested components of the given type that matches the conditions set on the component query.
protected <R extends Component> Optional<R>	ComponentTester.findByQuery(Class<R> componentType, Consumer<ComponentQuery<R>> queryBuilder)	Searches for a nested component of the given type that matches the conditions set on the component query.
static <T extends Component> Predicate<T>	ElementConditions.hasAttribute(String attribute)	Checks if the given attribute has been set on the component.
static <T extends Component> Predicate<T>	ElementConditions.hasAttribute(String attribute, String value)	Checks if the given attribute has been set on the component and has exactly the given value.
static <T extends Component> Predicate<T>	ElementConditions.hasNotAttribute(String attribute)	Checks if the given attribute has not been set on the component.
static <T extends Component> Predicate<T>	ElementConditions.hasNotAttribute(String attribute, String value)	Checks if the given attribute has been set on the component or has a value different from given one.
<T extends Component> T	BaseUIUnitTest.navigate(Class<T> navigationTarget)	Navigate to the given view class if it is registered.
<C, T extends Component & HasUrlParameter<C>> T	BaseUIUnitTest.navigate(Class<T> navigationTarget, C parameter)	Navigate to view with url parameter.
<T extends Component> T	BaseUIUnitTest.navigate(Class<T> navigationTarget, Map<String,String> parameters)	Navigate to view corresponding to the given navigation target with the specified parameters.
<T extends Component> T	BaseUIUnitTest.navigate(String location, Class<T> expectedTarget)	Navigate to given location string.
<T extends ComponentTester<Y>, Y extends Component> T	BaseUIUnitTest.test(Class<T> tester, Y component)	Wrap component in given ComponentTester.
<T extends ComponentTester<Y>, Y extends Component> T	BaseUIUnitTest.test(Y component)	Wrap component with ComponentTester best matching component type.
<E extends Component> ComponentQuery<E>	ComponentQuery.thenOn(int index, Class<E> componentType)	Gets a new ComponentQuery to search for given component type on the context of the matching component at given index for current query.
<E extends Component> ComponentQuery<E>	ComponentQuery.thenOnFirst(Class<E> componentType)	Gets a new ComponentQuery to search for given component type on the context of first matching component for current query.

Methods in com.vaadin.testbench.unit with parameters of type Component

Modifier and Type	Method	Description
<T extends Component> ComponentQuery<T>	BaseUIUnitTest.$(Class<T> componentType, Component fromThis)	Gets a query object for finding a component nested inside the given component.
protected static void	ComponentTester.ensureComponentIsUsable(Component component, Predicate<Component> usableTest)	Throws an IllegalStateException with details on the current state of the component if it is not usable according to the provided test.
protected static void	ComponentTester.ensureVisible(Component component)	Check that the given component is visible for the user.
ComponentQuery<T>	ComponentQuery.from(Component context)	Sets the context to search inside.
protected static boolean	ComponentTester.isUsable(Component component)	Validate that the given component can be interacted with and should be visible in the UI.
protected static void	ComponentTester.notUsableReasons(Component component, Consumer<String> collector)	Provides messages explaining why the given component is actually not usable.

Method parameters in com.vaadin.testbench.unit with type arguments of type Component

Modifier and Type	Method	Description
protected static void	ComponentTester.ensureComponentIsUsable(Component component, Predicate<Component> usableTest)	Throws an IllegalStateException with details on the current state of the component if it is not usable according to the provided test.