Uses of Class
com.vaadin.flow.component.Component
Packages that use Component
Package
Description
-
Uses of Component in com.vaadin.collaborationengine
Subclasses of Component in com.vaadin.collaborationengineModifier and TypeClassDescriptionclass
Extension of theAvatarGroup
component which integrates with theCollaborationEngine
.class
Extension of theMessageInput
component which integrates with theCollaborationMessageList
.class
Extension of theMessageList
component which integrates with theCollaborationEngine
.Methods in com.vaadin.collaborationengine with parameters of type ComponentModifier and TypeMethodDescriptionvoid
ComponentConnectionContext.addComponent
(Component component) Adds a component instance to track for this context.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 ComponentModifierConstructorDescriptionComponentConnectionContext
(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 ComponentModifier and TypeClassDescriptionclass
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 aComponent
.class
A composite encapsulates aComponent
tree to allow creation of new components by composing existing components.interface
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 aComponent
as a web component.interface
WebComponentExporterFactory<C extends Component>
Exports aComponent
as a web component.static class
Default factory implementation which uses an exporter class to instantiate it using its default constructor.Subclasses of Component in com.vaadin.flow.componentModifier and TypeClassDescriptionclass
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 aComponent
allowing user input.class
AbstractSinglePropertyField<C extends AbstractField<C,
T>, T> Abstract field that is based on a single element property.class
A composite encapsulates aComponent
tree to allow creation of new components by composing existing components.class
A component which encapsulates a given HTML fragment with a single root element.class
Base class for aComponent
that represents a single built-in HTML element.class
Base class for aComponent
that represents a single built-in HTML element that can contain child components or text.class
A component that displays a given SVG image.class
A component which encapsulates the given text in a text node.class
The topmost component in any component hierarchy.static class
Placeholder view when navigating from server-side views to client-side views.Methods in com.vaadin.flow.component with type parameters of type ComponentModifier and TypeMethodDescriptionstatic <T extends Component>
TComponentUtil.componentFromElement
(Element element, Class<T> componentType, boolean mapComponent) Creates a new component instance using the given element, maps the component to the element and optionally maps the element to the component (ifmapComponent
istrue
).<T extends Component>
WebComponentConfiguration<T>WebComponentExporter.WebComponentConfigurationFactory.create
(WebComponentExporter<T> exporter) Creates aWebComponentConfiguration
for the providedWebComponentExporter
instances.static <T extends Component>
voidComponentUtil.fireEvent
(T component, ComponentEvent<? extends T> componentEvent) Dispatches the event to all listeners registered for the event type.static <T extends Component>
TCreates a new component instance using the given element.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>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.UI.navigate
(Class<? extends T> navigationTarget, QueryParameters queryParameters) Updates this UI to show the view corresponding to the given navigation target and query parameters.Updates this UI to show the view corresponding to the given navigation target.UI.navigate
(Class<T> navigationTarget, RouteParam... parameters) Updates this UI to show the view corresponding to the given navigation target with the specified parameters.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 ComponentModifier and TypeMethodDescriptionGets the drag source of an active HTML5 drag event.default Component
HasOrderedComponents.getComponentAt
(int index) Returns the component at the given position.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 aComposite
chain, i.e.static Component
ComponentUtil.getInnermostComponent
(Element element) Gets the innermost mapped component for the element.ShortcutEvent.getLifecycleOwner()
Component which owns the shortcut.ShortcutRegistration.getLifecycleOwner()
Component
which controls when the shortcut is active and when it is not.ShortcutRegistration.getOwner()
Deprecated.This component has now multiple owners so this method has been replaced by #getOwners().ShortcutRegistration.getOwners()
TheComponent
s 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.ShortcutEvent.getSource()
Component which listened for the shortcut.Methods in com.vaadin.flow.component that return types with arguments of type ComponentModifier and TypeMethodDescriptionComponentUtil.findParentComponent
(Element element) Finds the first component by traversing upwards in the element hierarchy, starting from the given element.ComponentUtil.getAllTagMappings()
Provides access to the entire mapping of HTML tags to component classes.Component.getChildren()
Gets the child components of this component.Composite.getChildren()
Gets the child components of this composite.HasOrderedComponents.getChildren()
Gets the children components of this component.UI.getChildren()
ComponentUtil.getComponentsByTag
(String tag) Retrieves the set of component classes associated with a specific HTML tag.Component.getParent()
Gets the parent component of this component.ComponentUtil.getRouteComponent
(Component component) Walk up from given component until a Component with a Route annotation is found or empty if no Route is present in parents.Methods in com.vaadin.flow.component with parameters of type ComponentModifier and TypeMethodDescriptiondefault void
Adds the given components as children of this component.void
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<?>>
RegistrationComponentUtil.addListener
(Component component, Class<T> eventType, ComponentEventListener<T> listener) Adds a listener for an event of the given type to thecomponent
.static <T extends ComponentEvent<?>>
RegistrationComponentUtil.addListener
(Component component, Class<T> eventType, ComponentEventListener<T> listener, Consumer<DomListenerRegistration> domListenerConsumer) Adds a listener for an event of the given type to thecomponent
, and customizes the corresponding DOM event listener with the given consumer.void
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 aShortcutEventListener
when the shortcut is invoked.static ShortcutRegistration
Shortcuts.addShortcutListener
(Component lifecycleOwner, Command command, Key key, KeyModifier... keyModifiers) Invoke aCommand
when the shortcut is invoked.void
UI.addToModalComponent
(Component component) Add component as child to modal component if one is active.UI.beforeClientResponse
(Component component, SerializableConsumer<ExecutionContext> execution) Registers a task to be executed before the response is sent to the client.ShortcutRegistration.bindLifecycleTo
(Component component) Binds the shortcut's life cycle to that of the givenComponent
.static <T> T
Gets a data instance with the given type, ornull
if there is no such instance.static Object
Gets a data instance with the given key, ornull
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.ComponentUtil.getRouteComponent
(Component component) Walk up from given component until a Component with a Route annotation is found or empty if no Route is present in parents.static <T extends ComponentEvent<?>>
booleanComponentUtil.hasEventListener
(Component component, Class<? extends T> eventType) Check if the component has at least one registered listener of the given event type.default int
Returns the index of the given component.static boolean
ComponentUtil.isCompositeContent
(Composite<?> composite, Component component) Checks if the given component is inside aComposite
chain, i.e.Fluently define theComponent
onto which the shortcut's listener is bound.static void
ComponentUtil.onComponentAttach
(Component component, boolean initialAttach) Handles triggering theonAttach
method and firing theAttachEvent
for the given component when it has been attached to a UI.static void
ComponentUtil.onComponentDetach
(Component component) Handles triggering theonDetach
method and firing theDetachEvent
for the given component right before it is detached from a UI.default void
Removes the given child components from this component.default void
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
Stores an instance of a specific type for the given component.static void
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 ComponentModifier and TypeMethodDescriptiondefault void
HasComponents.add
(Collection<Component> components) Adds the given components as children of this component.static void
ComponentUtil.findComponents
(Element element, Consumer<Component> componentConsumer) ComponentUtil.getDependencies
(VaadinService service, Class<? extends Component> componentClass) Gets the dependencies for the given class, defined using annotations (JavaScript
,StyleSheet
andUses
).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.ComponentUtil.getSynchronizedPropertyEvents
(Class<? extends Component> componentClass) Gets the name of the synchronized property event defined declaratively for the given class.static void
ComponentUtil.registerComponentClass
(String tag, Class<? extends Component> componentClass) Registers a component class with a specific HTML tag.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 ComponentModifierConstructorDescriptionAttachEvent
(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 newShortcutEvent
. -
Uses of Component in com.vaadin.flow.component.accordion
Subclasses of Component in com.vaadin.flow.component.accordionModifier and TypeClassDescriptionclass
Accordion is a vertically stacked set of expandable panels.class
An accordion panel which could be opened or closed.Methods in com.vaadin.flow.component.accordion that return ComponentModifier and TypeMethodDescriptionprotected Component
AccordionPanel.createSummaryContainer()
Creates the summary container component.Methods in com.vaadin.flow.component.accordion with parameters of type ComponentModifier and TypeMethodDescriptionAdds a panel created from the given title and content.void
Removes a panel based on the contentConstructors in com.vaadin.flow.component.accordion with parameters of type ComponentModifierConstructorDescriptionAccordionPanel
(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.applayoutModifier and TypeClassDescriptionclass
App Layout is a component for building common application layouts.class
Server-side component for the<vaadin-drawer-toggle>
element.Methods in com.vaadin.flow.component.applayout that return ComponentMethods in com.vaadin.flow.component.applayout with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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
Removes the child components from the parent.void
AppLayout.setContent
(Component content) Sets the displayed content.void
-
Uses of Component in com.vaadin.flow.component.avatar
Subclasses of Component in com.vaadin.flow.component.avatarModifier and TypeClassDescriptionclass
Avatar is a graphical representation of an object or entity, for example a person or an organisation.class
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.boardModifier and TypeClassDescriptionclass
Vaadin Board allows creating responsive layouts in an easy way.class
Row class to define rows used in aBoard
instance.Methods in com.vaadin.flow.component.board with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Adds the given component(s) to the row.void
Adds the given component to the row using the given number of columns.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 -
Uses of Component in com.vaadin.flow.component.board.internal
Methods in com.vaadin.flow.component.board.internal with parameters of type ComponentModifier and TypeMethodDescriptionstatic 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.buttonModifier and TypeClassDescriptionclass
The Button component allows users to perform actions.Methods in com.vaadin.flow.component.button that return ComponentModifier and TypeMethodDescriptionButton.getIcon()
Gets the component that is defined as the icon of this button.Methods in com.vaadin.flow.component.button with parameters of type ComponentModifier and TypeMethodDescriptionprotected void
Removes the given child components from this component.void
Sets the given component as the icon of this button.Constructors in com.vaadin.flow.component.button with parameters of type ComponentModifierConstructorDescriptionCreates 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.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.chartsModifier and TypeClassDescriptionclass
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.checkboxModifier and TypeClassDescriptionclass
Checkbox is an input field representing a binary choice.class
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 ComponentModifier and TypeMethodDescriptionComponentRenderer<? extends Component,
T> CheckboxGroup.getItemRenderer()
Returns the item component renderer.Methods in com.vaadin.flow.component.checkbox with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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 ComponentModifier and TypeMethodDescriptionvoid
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.comboboxModifier and TypeClassDescriptionclass
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 asComboBox
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 ComponentModifierConstructorDescriptionComboBoxLazyDataView
(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.confirmdialogModifier and TypeClassDescriptionclass
Confirm Dialog is a modal Dialog used to confirm user actions.Methods in com.vaadin.flow.component.confirmdialog that return ComponentModifier and TypeMethodDescriptionConfirmDialog.getComponentAt
(int index) Deprecated.since v24.4, not supportedMethods in com.vaadin.flow.component.confirmdialog with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Deprecated.since v24.4, not supportedvoid
ConfirmDialog.addComponentAsFirst
(Component component) Deprecated.since v24.4, not supportedvoid
ConfirmDialog.addComponentAtIndex
(int index, Component component) Deprecated.since v24.4, not supportedint
Deprecated.since v24.4, not supportedvoid
Deprecated.since v24.4, not supportedvoid
Deprecated.since v24.4, not supportedvoid
ConfirmDialog.setCancelButton
(Component component) Sets custom cancel buttonvoid
ConfirmDialog.setConfirmButton
(Component component) Sets custom confirm buttonvoid
Sets confirmation dialog custom headervoid
ConfirmDialog.setRejectButton
(Component component) Sets custom Reject buttonvoid
Sets custom confirmation messageMethod parameters in com.vaadin.flow.component.confirmdialog with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
ConfirmDialog.add
(Collection<Component> components) Deprecated.since v24.4, not supportedvoid
ConfirmDialog.remove
(Collection<Component> components) Deprecated.since v24.4, not supported -
Uses of Component in com.vaadin.flow.component.cookieconsent
Subclasses of Component in com.vaadin.flow.component.cookieconsentModifier and TypeClassDescriptionclass
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.crudModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescriptionCrud.getNewButton()
Gets the Crud new item buttonBinderCrudEditor.getView()
Deprecated.This method should not be used outside.CrudEditor.getView()
Returns the user interface of an editor.Methods in com.vaadin.flow.component.crud with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Crud.setNewButton
(Component button) Sets the Crud new item buttonvoid
Crud.setToolbar
(Component... components) Sets the content of the toolbar.Constructors in com.vaadin.flow.component.crud with parameters of type ComponentModifierConstructorDescriptionBinderCrudEditor
(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.customfieldModifier and TypeClassDescriptionclass
CustomField<T>
AHasValue
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 -
Uses of Component in com.vaadin.flow.component.dashboard
Subclasses of Component in com.vaadin.flow.component.dashboardModifier and TypeClassDescriptionclass
Dashboard is a responsive layout component that allows users to organize widgets either directly within the dashboard or optionally group them into sections.class
DashboardSection is a container for organizing multipleDashboardWidget
instances within aDashboard
.class
DashboardWidget represents a customizable widget that can be placed within aDashboard
.Methods in com.vaadin.flow.component.dashboard that return ComponentModifier and TypeMethodDescriptionDashboardWidget.getContent()
Returns the content of the widget.DashboardWidget.getHeaderContent()
Gets the content in the header content slot of this widget.DashboardItemMovedEvent.getItem()
Returns the moved itemDashboardItemMoveModeChangedEvent.getItem()
Returns the item of which the move mode state has changedDashboardItemRemovedEvent.getItem()
Returns the removed itemDashboardItemResizeModeChangedEvent.getItem()
Returns the item of which the resize mode state has changed;DashboardItemSelectedChangedEvent.getItem()
Returns the item of which the selected state has changedMethods in com.vaadin.flow.component.dashboard that return types with arguments of type ComponentModifier and TypeMethodDescriptionDashboard.getChildren()
DashboardSection.getChildren()
DashboardItemMovedEvent.getItems()
Returns the root level items of the dashboardDashboardItemRemovedEvent.getItems()
Returns the root level items of the dashboardDashboardItemResizedEvent.getItems()
Returns the root level items of the dashboardMethods in com.vaadin.flow.component.dashboard with parameters of type ComponentModifier and TypeMethodDescriptionvoid
DashboardWidget.setContent
(Component content) Sets the content to the widget.void
DashboardWidget.setHeaderContent
(Component header) Sets the content in the header content slot of this widget, replacing any existing header content.Constructors in com.vaadin.flow.component.dashboard with parameters of type ComponentModifierConstructorDescriptionDashboardItemMovedEvent
(Dashboard source, boolean fromClient, Component item, List<Component> items, DashboardSection section) Creates a dashboard item moved event.DashboardItemRemovedEvent
(Dashboard source, boolean fromClient, Component item, List<Component> items) Creates a dashboard item removed event.DashboardWidget
(Component content) Creates a widget with the specified content.DashboardWidget
(String title, Component content) Creates a widget with the specified title and content.Constructor parameters in com.vaadin.flow.component.dashboard with type arguments of type ComponentModifierConstructorDescriptionDashboardItemMovedEvent
(Dashboard source, boolean fromClient, Component item, List<Component> items, DashboardSection section) Creates a dashboard item moved event.DashboardItemRemovedEvent
(Dashboard source, boolean fromClient, Component item, List<Component> items) Creates a dashboard item removed event.DashboardItemResizedEvent
(Dashboard source, boolean fromClient, DashboardWidget item, List<Component> items) Creates a dashboard item resized event. -
Uses of Component in com.vaadin.flow.component.datepicker
Subclasses of Component in com.vaadin.flow.component.datepickerModifier and TypeClassDescriptionclass
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.datetimepickerModifier and TypeClassDescriptionclass
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.detailsModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescriptionprotected Component
Details.createSummaryContainer()
Creates the summary container component.Details.getSummary()
Returns summary component which was set viaDetails.setSummary(Component)
orDetails.setSummaryText(String)
Methods in com.vaadin.flow.component.details that return types with arguments of type ComponentModifier and TypeMethodDescriptionDetails.getContent()
Returns the content components which were added viaHasComponents.add(Component...)
Methods in com.vaadin.flow.component.details with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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, useHasComponents.add(Component...)
instead.void
Details.setContent
(Component content) Deprecated.since v24.2, useDetails.removeAll()
andHasComponents.add(Component...)
instead.void
Details.setSummary
(Component summary) Sets the component summaryMethod parameters in com.vaadin.flow.component.details with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
Details.add
(Collection<Component> components) Adds components to the content sectionvoid
Details.remove
(Collection<Component> components) Removes specified components from the content sectionConstructors in com.vaadin.flow.component.details with parameters of type ComponentModifierConstructorDescriptionInitializes a new Details using the provided summary.Initializes a new Details using the provided summary and content.Initializes a new Details using the provided summary and content components.Initializes a new Details using the provided summary and content.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.dialogModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescriptionvoid
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 ComponentModifier and TypeMethodDescriptionvoid
Dialog.add
(Collection<Component> components) Adds the given components into this dialog.Constructors in com.vaadin.flow.component.dialog with parameters of type Component -
Uses of Component in com.vaadin.flow.component.dnd
Classes in com.vaadin.flow.component.dnd with type parameters of type ComponentModifier and TypeClassDescriptionclass
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
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 ComponentModifier and TypeMethodDescriptionstatic <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 ComponentModifier and TypeMethodDescriptiondefault Component
DragSource.getDragImage()
Get server side drag image.Methods in com.vaadin.flow.component.dnd that return types with arguments of type ComponentModifier and TypeMethodDescriptionDropEvent.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.Methods in com.vaadin.flow.component.dnd with parameters of type ComponentModifier and TypeMethodDescriptiondefault void
DragSource.setDragImage
(Component dragImage) Sets the drag image for the current drag source element.default void
DragSource.setDragImage
(Component dragImage, int offsetX, int offsetY) Sets the drag image for the current drag source element. -
Uses of Component in com.vaadin.flow.component.dnd.internal
Methods in com.vaadin.flow.component.dnd.internal with type parameters of type ComponentModifier and TypeMethodDescriptionstatic <T extends Component>
voidDndUtil.updateDragSourceActivation
(DragSource<T> dragSource) Triggers drag source activation method in JS connector once when the component has been attached.static <T extends Component>
voidDndUtil.updateDropTargetActivation
(DropTarget<T> dropTarget) Triggers drop target activation method in JS connector once when the component has been attached. -
Uses of Component in com.vaadin.flow.component.formlayout
Subclasses of Component in com.vaadin.flow.component.formlayoutModifier and TypeClassDescriptionclass
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
Server-side component for the<vaadin-form-item>
element.Methods in com.vaadin.flow.component.formlayout with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Adds a component with the desired colspan.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.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
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 ComponentModifierConstructorDescriptionConstructs 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.gridModifier and TypeClassDescriptionclass
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
Server side implementation for the flow specific grid selection column.Methods in com.vaadin.flow.component.grid with type parameters of type ComponentModifier and TypeMethodDescription<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 ComponentModifier and TypeMethodDescriptionGridTester.getCellComponent
(int row, int column) Get component for item in cell.GridTester.getCellComponent
(int row, String columnName) Get component for item in column.FooterRow.FooterCell.getComponent()
HeaderRow.HeaderCell.getComponent()
Grid.Column.getEditorComponent()
Gets the editor component that is used for this column.Grid.getEmptyStateComponent()
Returns the component that is displayed when the grid is empty.Methods in com.vaadin.flow.component.grid with parameters of type ComponentModifier and TypeMethodDescriptionvoid
FooterRow.FooterCell.setComponent
(Component component) void
HeaderRow.HeaderCell.setComponent
(Component component) Grid.Column.setEditorComponent
(Component editorComponent) Sets a component to use for editing values of this column in the editor row.void
Grid.setEmptyStateComponent
(Component emptyStateComponent) Sets the component to be displayed when the grid is empty.Sets a footer component to the column.Sets a header component to the column.Method parameters in com.vaadin.flow.component.grid with type arguments of type ComponentModifier and TypeMethodDescriptionGrid.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.editor
Method parameters in com.vaadin.flow.component.grid.editor with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
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.gridproModifier and TypeClassDescriptionclass
GridPro<E>
static class
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.htmlModifier and TypeClassDescriptionclass
Component representing an<a>
element.class
Component representing a<article>
element.class
Component representing a<aside>
element.class
Component representing a<dl>
element.static class
Component representing a<dd>
element.static class
Component representing a<dt>
element.class
Component representing a<div>
element.class
Component representing a<em>
element.class
Represents an HTML<fieldset>
element.static class
Represents an HTML<legend>
element.class
Component representing a<footer>
element.class
Component representing a<h1>
element.class
Component representing a<h2>
element.class
Component representing a<h3>
element.class
Component representing a<h4>
element.class
Component representing a<h5>
element.class
Component representing a<h6>
element.class
Component representing a<header>
element.class
Component representing a<hr>
element.class
Component representing a<object>
element.class
Component representing a<iframe>
element.class
Component representing a<img>
element.class
Component representing an<input>
element.class
Deprecated, for removal: This API element is subject to removal in a future version.UseNativeLabel
instead, if you need the HTML<label>
element, which is normally not needed within a Vaadin Flow application's high-level components.class
Component representing a<li>
element.class
Component representing a<main>
element.class
Component representing a<button>
element.class
Component representing a<details>
element.static class
Component representing a<summary>
element.class
Component for a<label>
element, which represents a caption for an input field in a user interface.class
Component representing a<table>
element.class
Component representing a<tbody>
element.class
Represents the table caption element (<caption>
).class
Component representing a<td>
element.class
Component representing a<tfoot>
element.class
Component representing a<thead>
element.class
Component representing a<th>
element.class
Component representing a<tr>
element.class
Component representing a<nav>
element.class
Component representing a<ol>
element.class
Component representing a<p>
element.class
Component representing a<param>
element for<param>
element.class
Component representing a<pre>
element.class
Creates a new input element with type "range".class
Component representing a<section>
element.class
Component representing a<span>
element.class
Component representing a<ul>
element.Methods in com.vaadin.flow.component.html that return ComponentModifier and TypeMethodDescriptionNativeDetails.getContent()
Returns the details content which was set viaNativeDetails.setContent(Component)
.Methods in com.vaadin.flow.component.html that return types with arguments of type ComponentModifier and TypeMethodDescriptionNativeTableRow.getAllCells()
Returns a list of all cells in this row.NativeTableRow.getCell
(int index) Returns the cell at a given position.FieldSet.getContent()
Returns the content of the fieldset.Methods in com.vaadin.flow.component.html with parameters of type ComponentModifier and TypeMethodDescriptionvoid
FieldSet.setContent
(Component... content) Sets the content of the fieldset and removes previously set content.void
NativeDetails.setContent
(Component content) Sets the details content and removes the previously set content.void
Deprecated, for removal: This API element is subject to removal in a future version.Sets the component that this label describes.void
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 ComponentModifierConstructorDescriptionCreates an anchor component with the given href and components as children of this component.Creates a new article with the given child components.Creates a new aside with the given child components.Description
(Component... components) Creates a new description with the given child components.Creates a new div with the given child components.Creates a new emphasis with the given child components.Creates a new fieldset with the given content.Creates a new fieldset using the provided legend text and content.Creates a new footer with the given child components.Creates a new heading with the given child components.Creates a new heading with the given child components.Creates a new heading with the given child components.Creates a new heading with the given child components.Creates a new heading with the given child components.Creates a new heading with the given child components.Creates a new header with the given child components.Creates a new list item with the given child 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.NativeTable
(Component... components) Creates a new table with the given children components.NativeTableBody
(Component... components) Creates a new table body with the given children components.NativeTableCell
(Component... components) Creates a new table cell with the given children components.NativeTableFooter
(Component... components) Creates a new table footer with the given children components.NativeTableHeader
(Component... components) Creates a new table header with the given children components.NativeTableHeaderCell
(Component... components) Creates a new header cell with the given children components.NativeTableRow
(Component... components) Creates a new table row with the given children components.Creates a new nav with the given child components.Creates a new paragraph with the given child components.Creates a new preformatted text block with the given child components.Creates a new section with the given child components.Creates a new span with the given child 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 ComponentModifier and TypeMethodDescriptionNativeDetailsTester.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.iconModifier and TypeClassDescriptionclass
AbstractIcon<T extends AbstractIcon<T>>
Abstract base class for icon componentsclass
Component for displaying an icon from a font icon collection.class
Component for displaying an icon from the Vaadin Icons collection.class
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 ComponentModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescriptionUIInternals.getActiveDragSourceComponent()
Gets the drag source of an active HTML5 drag event.UIInternals.getActiveModalComponent()
Get the active modal component if modal components set.Methods in com.vaadin.flow.component.internal with parameters of type ComponentModifier and TypeMethodDescriptionstatic ComponentTracker.Location
ComponentTracker.findAttach
(Component component) Finds the location where the given component instance was attached to a parent.static ComponentTracker.Location[]
ComponentTracker.findAttachLocations
(Component component) Finds the locations related to 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.static ComponentTracker.Location[]
ComponentTracker.findCreateLocations
(Component component) Finds the locations related to 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 ComponentModifier and TypeMethodDescriptionvoid
UIInternals.addComponentDependencies
(Class<? extends Component> componentClass) Adds the dependencies defined usingStyleSheet
orJavaScript
on the given Component class.Constructors in com.vaadin.flow.component.internal with parameters of type ComponentModifierConstructorDescriptionAbstractAttachDetachEvent
(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 ComponentModifierConstructorDescriptionComponentMetaData
(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.listboxModifier and TypeClassDescriptionclass
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 theListBox
andMultiSelectListBox
.class
Server-side component for thevaadin-list-box
element with multi-selection.Methods in com.vaadin.flow.component.listbox that return types with arguments of type ComponentModifier and TypeMethodDescriptionComponentRenderer<? extends Component,
ITEM> ListBoxBase.getItemRenderer()
Returns the item component renderer.Method parameters in com.vaadin.flow.component.listbox with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
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.littemplateModifier and TypeClassDescriptionclass
Component which renders a LitElement template.Methods in com.vaadin.flow.component.littemplate that return types with arguments of type ComponentModifier and TypeMethodDescriptionLitTemplate.getChildren()
Gets the child components of this component.Constructor parameters in com.vaadin.flow.component.littemplate with type arguments of type ComponentModifierConstructorDescriptionInjectableLitElementInitializer
(Element element, Class<? extends Component> templateClass) Creates an initializer for theelement
. -
Uses of Component in com.vaadin.flow.component.login
Subclasses of Component in com.vaadin.flow.component.loginModifier and TypeClassDescriptionclass
Abstract component for the<vaadin-login-overlay>
and<vaadin-login-form>
components.class
Login is a component that contains a login form.class
Server-side component for the<vaadin-login-overlay>
component.Methods in com.vaadin.flow.component.login that return ComponentModifier and TypeMethodDescriptionLoginOverlay.getTitle()
Returns custom title component which was set viaLoginOverlay.setTitle(Component)
Methods in com.vaadin.flow.component.login with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Sets the application title,null
to remove any previous title and to display title set viaLoginOverlay.setTitle(String)
. -
Uses of Component in com.vaadin.flow.component.map
Subclasses of Component in com.vaadin.flow.component.map -
Uses of Component in com.vaadin.flow.component.messages
Subclasses of Component in com.vaadin.flow.component.messagesModifier and TypeClassDescriptionclass
Message Input allows users to author and send messages.class
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.notificationModifier and TypeClassDescriptionclass
Notifications are used to provide feedback to the user.Methods in com.vaadin.flow.component.notification with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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 ComponentModifier and TypeMethodDescriptionvoid
Notification.add
(Collection<Component> components) Adds the given components into this notification.Constructors in com.vaadin.flow.component.notification with parameters of type ComponentModifierConstructorDescriptionNotification
(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.orderedlayoutModifier and TypeClassDescriptionclass
A layout component that implements Flexbox.class
Horizontal Layout places components side-by-side in a row.class
Scroller is a component container which enables scrolling overflowing content.class
Vertical Layout places components top-to-bottom in a column.Methods in com.vaadin.flow.component.orderedlayout that return ComponentMethods in com.vaadin.flow.component.orderedlayout with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Adds the given components as children of this component.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.void
HorizontalLayout.addComponentAtIndex
(int index, Component component) void
Adds the components to the middle slot of this layout.void
HorizontalLayout.addToMiddle
(Component... components) Adds the components to the middle slot of this layout.void
HorizontalLayout.addToStart
(Component... components) Adds the components to the start slot of this layout.default void
Expands the given components.VerticalLayout.getHorizontalComponentAlignment
(Component component) Gets the individual horizontal alignment of a given component.HorizontalLayout.getVerticalComponentAlignment
(Component component) Gets the individual vertical alignment of a given component.default void
void
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.Method parameters in com.vaadin.flow.component.orderedlayout with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
HorizontalLayout.add
(Collection<Component> components) Adds the given components as children of this component.void
HorizontalLayout.addToEnd
(Collection<Component> components) Adds the components to the end slot of this layout.void
HorizontalLayout.addToMiddle
(Collection<Component> components) Adds the components to the middle slot of this layout.void
HorizontalLayout.addToStart
(Collection<Component> components) Adds the components to the start slot of this layout.Constructors in com.vaadin.flow.component.orderedlayout with parameters of type ComponentModifierConstructorDescriptionFlexLayout
(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.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.popover
Subclasses of Component in com.vaadin.flow.component.popoverModifier and TypeClassDescriptionclass
Popover is a component for creating overlays that are positioned next to specified component (target).Methods in com.vaadin.flow.component.popover that return ComponentModifier and TypeMethodDescriptionPopover.getTarget()
Gets the target component of this popover, ornull
if it doesn't have a target.Methods in com.vaadin.flow.component.popover with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Popover.addComponentAtIndex
(int index, Component component) Adds the given component into this popover at the given index.void
Sets the target component for this popover.Method parameters in com.vaadin.flow.component.popover with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
Popover.add
(Collection<Component> components) Adds the given components into this popover.Constructors in com.vaadin.flow.component.popover with parameters of type Component -
Uses of Component in com.vaadin.flow.component.progressbar
Subclasses of Component in com.vaadin.flow.component.progressbarModifier and TypeClassDescriptionclass
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.radiobuttonModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescriptionComponentRenderer<? extends Component,
T> RadioButtonGroup.getItemRenderer()
Returns the item component renderer.Method parameters in com.vaadin.flow.component.radiobutton with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
RadioButtonGroup.setRenderer
(ComponentRenderer<? extends Component, T> renderer) Sets the item renderer for this radio button group. -
Uses of Component in com.vaadin.flow.component.react
Subclasses of Component in com.vaadin.flow.component.reactModifier and TypeClassDescriptionclass
An abstract implementation of an adapter for integrating with React components.class
Component used to create a ReactOutlet
element for binding a Hilla React view inside a Flow view. -
Uses of Component in com.vaadin.flow.component.richtexteditor
Subclasses of Component in com.vaadin.flow.component.richtexteditorModifier and TypeClassDescriptionclass
Rich Text Editor is an input field for entering rich text. -
Uses of Component in com.vaadin.flow.component.routerlink
Methods in com.vaadin.flow.component.routerlink that return types with arguments of type Component -
Uses of Component in com.vaadin.flow.component.select
Subclasses of Component in com.vaadin.flow.component.selectModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescriptionSelect.getChildren()
ComponentRenderer<? extends Component,
T> Select.getItemRenderer()
Returns the item component renderer.Methods in com.vaadin.flow.component.select with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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
Removes the given child components from this component.Method parameters in com.vaadin.flow.component.select with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
Select.setRenderer
(ComponentRenderer<? extends Component, T> renderer) Sets the item renderer for this select group. -
Uses of Component in com.vaadin.flow.component.splitlayout
Subclasses of Component in com.vaadin.flow.component.splitlayoutModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescriptionSplitLayout.getPrimaryComponent()
Get the component currently set to the primary split.SplitLayout.getSecondaryComponent()
Get the component currently set to the secondary split.Methods in com.vaadin.flow.component.splitlayout with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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
Removes the given child components from this component.Constructors in com.vaadin.flow.component.splitlayout with parameters of type ComponentModifierConstructorDescriptionSplitLayout
(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.tabsModifier and TypeClassDescriptionclass
This component provides an accessible and customizable tab to be used insideTabs
component.class
Tabs are used to organize and group content into sections that the user can navigate between.class
TabSheet consists of a set of tabs and the content area.Methods in com.vaadin.flow.component.tabs with type parameters of type ComponentModifier and TypeMethodDescription<E extends Component>
ETabSheetTester.getTabContent
(int index) Gets the content of the visible tab at given index.<E extends Component>
ETabSheetTester.getTabContent
(String label) Gets the content of the visible tab with the given label.Methods in com.vaadin.flow.component.tabs that return ComponentModifier and TypeMethodDescriptionTabSheet.getComponent
(Tab tab) Returns theComponent
instance associated with the given tab.Tabs.getComponentAt
(int index) Deprecated.since 24.0, useTabs.getTabAt(int)
instead.Methods in com.vaadin.flow.component.tabs with parameters of type ComponentModifier and TypeMethodDescriptionvoid
Deprecated.since 24.0, useTabs.add(Tab...)
instead.Adds a tab created from the given tab content and content.Adds a tab with the given content.Adds a tab with the given content to the given position.Adds a tab created from the given text and content.void
Tabs.addComponentAsFirst
(Component component) Deprecated.since 24.0, useTabs.addTabAsFirst(Tab)
instead.void
Tabs.addComponentAtIndex
(int index, Component component) Deprecated.since 24.0, useTabs.addTabAtIndex(int, Tab)
instead.Returns theTab
associated with the given component.int
Deprecated.since 24.0, useTabs.indexOf(Tab)
instead.void
Deprecated.since 24.0, useTabs.remove(Tab...)
instead.void
Removes a tab based on the contentvoid
Deprecated.since 24.0, useTabs.replace(Tab, Tab)
instead.Constructors in com.vaadin.flow.component.tabs with parameters of type Component -
Uses of Component in com.vaadin.flow.component.template.internal
Methods in com.vaadin.flow.component.template.internal with parameters of type ComponentModifier and TypeMethodDescriptionDeprecatedPolymerPublishedEventHandler.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 -
Uses of Component in com.vaadin.flow.component.textfield
Subclasses of Component in com.vaadin.flow.component.textfieldModifier and TypeClassDescriptionclass
AbstractNumberField<C extends AbstractNumberField<C,
T>, T extends Number> Abstract base class for components based onvaadin-number-field
element and its subclasses.class
BigDecimalField is an input field for handling decimal numbers with high precision.class
Email Field is an extension of Text Field that only accepts email addresses as input.class
IntegerField is an extension of Text Field that only accepts integer numbers.class
Number Field sports many of the same features as Text Field but only accepts numeric input.class
Password Field is an input field for entering passwords.class
Text Area is an input field component for multi-line text input.class
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 asTextField
.Methods in com.vaadin.flow.component.textfield with parameters of type ComponentModifier and TypeMethodDescriptionprotected 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.timepickerModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeClassDescriptionclass
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.treegridModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescription<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.uploadModifier and TypeClassDescriptionclass
Upload is a component for uploading one or more files.Methods in com.vaadin.flow.component.upload that return ComponentModifier and TypeMethodDescriptionUpload.getDropLabel()
Get the component set as the drop label.Upload.getDropLabelIcon()
Get the component set as the drop label icon.Upload.getUploadButton()
Get the component set as the upload button for the upload.Methods in com.vaadin.flow.component.upload with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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.virtuallistModifier and TypeClassDescriptionclass
VirtualList<T>
Virtual List allows you to render a long list of items inside a scrollable container without sacrificing performance.Methods in com.vaadin.flow.component.virtuallist that return ComponentModifier and TypeMethodDescriptionVirtualListTester.getItemComponent
(int index) Get an initialized copy of the component for the item. -
Uses of Component in com.vaadin.flow.component.webcomponent
Classes in com.vaadin.flow.component.webcomponent with type parameters of type ComponentModifier and TypeInterfaceDescriptioninterface
PropertyConfiguration<C extends Component,
P extends Serializable> Offers a fluent API for configuring the properties of embedded web components produced byWebComponentExporter
.final class
WebComponent<C extends Component>
Acts as a proxy to the web component root onto which the exporterComponent
is added.interface
WebComponentConfiguration<C extends Component>
Result of defining an embeddable web component usingWebComponentExporter
.Subclasses of Component in com.vaadin.flow.component.webcomponentModifier and TypeClassDescriptionclass
Custom UI for use with WebComponents served from the server.class
Wrapper component for a web component that exposesClientCallable
methods that the client-side components expect to be available.Methods in com.vaadin.flow.component.webcomponent with type parameters of type Component -
Uses of Component in com.vaadin.flow.data.binder
Methods in com.vaadin.flow.data.binder that return types with arguments of type ComponentModifier and TypeMethodDescriptionValueContext.getComponent()
Returns anOptional
for theComponent
related to value conversion.Methods in com.vaadin.flow.data.binder with parameters of type ComponentModifier and TypeMethodDescriptiondefault 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 ComponentModifierConstructorDescriptionValueContext
(Component component) Deprecated.Use the version with binder reference insteadValueContext
(Component component, HasValue<?, ?> hasValue) Deprecated.Use the version with binder reference insteadValueContext
(Component component, HasValue<?, ?> hasValue, Locale locale) Deprecated.Use the version with binder reference insteadValueContext
(Binder binder, Component component) Constructor forValueContext
.ValueContext
(Binder binder, Component component, HasValue<?, ?> hasValue) Constructor forValueContext
.ValueContext
(Binder binder, Component component, HasValue<?, ?> hasValue, Locale locale) Constructor forValueContext
. -
Uses of Component in com.vaadin.flow.data.event
Classes in com.vaadin.flow.data.event with type parameters of type ComponentModifier and TypeClassDescriptionclass
Event describing a change in sorting of aDataProvider
.static interface
SortEvent.SortNotifier<T extends Component,
S extends SortOrder<?>> The interface for adding and removing listeners forSortEvents
. -
Uses of Component in com.vaadin.flow.data.provider
Classes in com.vaadin.flow.data.provider with type parameters of type ComponentModifier and TypeClassDescriptionclass
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 ComponentMethods in com.vaadin.flow.data.provider that return ComponentModifier and TypeMethodDescriptionprotected 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 ComponentModifier and TypeMethodDescriptionstatic <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
Generates a data query with component's in-memory filter and sort comparator.static Query
Generates a data query with component's in-memory filter and sort comparator, which is optionally included ifwithSorting
is set totrue
.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 ComponentModifierConstructorDescriptionAbstractDataView
(SerializableSupplier<? extends DataProvider<T, ?>> dataProviderSupplier, Component component) Creates a new instance ofAbstractDataView
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 ofAbstractListDataView
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 ComponentModifier and TypeClassDescriptionclass
ComponentRenderer<COMPONENT extends Component,
SOURCE> Base class for all renderers that support arbitraryComponent
s.Methods in com.vaadin.flow.data.renderer that return ComponentModifier and TypeMethodDescriptionBasicRenderer.createComponent
(SOURCE item) protected Component
ComponentDataGenerator.createComponent
(T item) IconRenderer.createComponent
(ITEM item) NativeButtonRenderer.createComponent
(SOURCE item) TextRenderer.createComponent
(ITEM item) protected Component
ComponentDataGenerator.updateComponent
(Component currentComponent, T item) 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 ComponentModifier and TypeMethodDescriptionComponentRenderer<? extends Component,
T> ComponentDataGenerator.getComponentRenderer()
Methods in com.vaadin.flow.data.renderer with parameters of type ComponentModifier and TypeMethodDescriptionprotected Component
ComponentDataGenerator.updateComponent
(Component currentComponent, T item) 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 ComponentModifierConstructorDescriptionComponentDataGenerator
(ComponentRenderer<? extends Component, T> componentRenderer, ValueProvider<T, String> keyMapper) Creates a new generator.ComponentRenderer
(SerializableFunction<SOURCE, COMPONENT> componentFunction, SerializableBiFunction<Component, SOURCE, Component> componentUpdateFunction) ComponentRenderer
(SerializableFunction<SOURCE, COMPONENT> componentFunction, SerializableBiFunction<Component, SOURCE, Component> componentUpdateFunction) IconRenderer
(SerializableFunction<ITEM, ? extends Component> iconGenerator) Creates a new renderer instance using the defaultItemLabelGenerator
:String::valueOf
and the providediconGenerator
.IconRenderer
(SerializableFunction<ITEM, ? extends Component> iconGenerator, ItemLabelGenerator<ITEM> itemLabelGenerator) Creates a new renderer instance using the providediconGenerator
anditemLabelGenerator
. -
Uses of Component in com.vaadin.flow.data.selection
Classes in com.vaadin.flow.data.selection with type parameters of type ComponentModifier and TypeInterfaceDescriptioninterface
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 forSelectionEvent
.interface
SelectionModel<C extends Component,
T> Models the selection logic of aListing
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 ComponentModifier and TypeMethodDescription<T extends Component>
TDefaultInstantiator.createComponent
(Class<T> componentClass) <T extends Component>
TInstantiator.createComponent
(Class<T> componentClass) Creates an instance of a component by itscomponentClass
. -
Uses of Component in com.vaadin.flow.dom
Methods in com.vaadin.flow.dom with type parameters of type ComponentModifier and TypeMethodDescription<T extends Component>
TCreates a new component instance using this element.Methods in com.vaadin.flow.dom that return types with arguments of type ComponentModifier and TypeMethodDescriptionElement.getComponent()
Gets the component this element has been mapped to, if any.ElementStateProvider.getComponent
(StateNode node) Gets the component this element is mapped to.Methods in com.vaadin.flow.dom with parameters of type ComponentModifier and TypeMethodDescriptiondefault 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 givenComponent
. -
Uses of Component in com.vaadin.flow.internal
Method parameters in com.vaadin.flow.internal with type arguments of type ComponentModifier and TypeMethodDescriptionAnnotationReader.getCssImportAnnotations
(Class<? extends Component> componentClass) static List<JavaScript>
AnnotationReader.getJavaScriptAnnotations
(Class<? extends Component> componentClass) Finds allJavaScript
annotations on the givenComponent
class, its super classes and implemented interfaces.AnnotationReader.getJsModuleAnnotations
(Class<? extends Component> componentClass) static List<StyleSheet>
AnnotationReader.getStyleSheetAnnotations
(Class<? extends Component> componentClass) Finds allStyleSheet
annotations on the givenComponent
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 ComponentModifier and TypeMethodDescriptionComponentMapping.getComponent()
Gets the component this node has been mapped to, if any.ComponentMapping.getComponent
(StateNode node) Gets the component mapped to the given state node.Methods in com.vaadin.flow.internal.nodefeature with parameters of type ComponentModifier and TypeMethodDescriptionvoid
ComponentMapping.setComponent
(Component component) Assigns the given component to this node.Method parameters in com.vaadin.flow.internal.nodefeature with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
ElementData.setJavaClass
(Class<? extends Component> componentClass) -
Uses of Component in com.vaadin.flow.router
Subclasses of Component in com.vaadin.flow.routerModifier and TypeClassDescriptionclass
This is abstract error view for routing exceptions.class
This is a basic default error view shown on exceptions during navigation.class
This is a default error view shown on access denied routing exceptions.class
This is a basic default error view shown on routing exceptions.class
A link that handles navigation internally usingRouter
instead of loading a new page in the browser.Methods in com.vaadin.flow.router with type parameters of type ComponentModifier and TypeMethodDescription<C extends Component>
voidBeforeEvent.forwardTo
(Class<? extends C> forwardTargetComponent, QueryParameters queryParameters) Forward the navigation to show the given component with given query parameters instead of the component that is currently about to be displayed.<C extends Component>
voidBeforeEvent.forwardTo
(Class<? extends C> forwardTargetComponent, RouteParameters routeParameters, QueryParameters queryParameters) Forward the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.<T,
C extends Component & HasUrlParameter<T>>
voidForward 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>>
voidForward the navigation to show the given component with given route parameter instead of the component that is currently about to be displayed.<T,
C extends Component & HasUrlParameter<T>>
voidBeforeEvent.forwardTo
(Class<? extends C> forwardTargetComponent, T routeParameter, QueryParameters queryParameters) Forward the navigation to show the given component with given route parameter and query parameters instead of the component that is currently about to be displayed.<T,
C extends Component & HasUrlParameter<T>>
StringGet the url string for given navigation target with the parameters in the url.<T,
C extends Component & HasUrlParameter<T>>
StringGet the url string for given navigation target with the parameter in the url.<C extends Component>
voidBeforeEvent.rerouteTo
(Class<? extends C> routeTargetType, QueryParameters queryParameters) Reroutes the navigation to show the given component with given query parameters instead of the component that is currently about to be displayed.<C extends Component>
voidBeforeEvent.rerouteTo
(Class<? extends C> routeTargetType, RouteParameters routeParameters, QueryParameters queryParameters) Reroutes the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.<T,
C extends Component & HasUrlParameter<T>>
voidReroutes 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>>
voidReroutes the navigation to show the given component with given route parameter instead of the component that is currently about to be displayed.<T,
C extends Component & HasUrlParameter<T>>
voidBeforeEvent.rerouteTo
(Class<? extends C> routeTargetType, T routeParameter, QueryParameters queryParameters) Reroutes the navigation to show the given component with given route parameter and query parameters instead of the component that is currently about to be displayed.<T,
C extends Component & HasUrlParameter<T>>
voidSet the navigation target for this link.<T,
C extends Component & HasUrlParameter<T>>
voidSet the navigation target for this link.Methods in com.vaadin.flow.router that return types with arguments of type ComponentModifier and TypeMethodDescriptionRoutesChangedEvent.getAddedNavigationTargets()
Get every single navigation targets of all added routes in this change.BeforeEvent.getForwardTargetType()
Get the forward target type for forwarding.NavigationState.getNavigationTarget()
Gets the navigation target of this state.RouteBaseData.getNavigationTarget()
GetRoute
navigation target.RoutesChangedEvent.getRemovedNavigationTargets()
Get every single navigation targets of all removed routes in this change.BeforeEvent.getRerouteTargetType()
Get the route target type for rerouting.Gets the registered route class for a given path.Gets the optional navigation target class for a given Location matching with path segments.MenuData.menuClass()
Returns the value of themenuClass
record component.Method parameters in com.vaadin.flow.router with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
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, boolean useForwardCallback) 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.RouteConfiguration.getTemplate
(Class<? extends Component> navigationTarget) Gets the route template for the given target.Get the registered url string for given navigation target.RouteConfiguration.getUrl
(Class<? extends Component> navigationTarget, RouteParameters parameters) Gets the url which navigates to given navigationTarget using given parameters.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
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 theRoute
annotation to get the path and also register anyRouteAlias
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
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
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
Set the navigation target for this link.void
RouterLink.setRoute
(Class<? extends Component> navigationTarget, RouteParameters parameters) Set the navigation target for this link.NavigationStateBuilder.withTarget
(Class<? extends Component> navigationTarget) Assigns the given navigation target to the navigation state being built.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 ComponentModifierConstructorDescriptionMenuData
(String title, Double order, boolean exclude, String icon, Class<? extends Component> menuClass) Creates an instance of aMenuData
record class.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.RouteData
(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String, RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases, MenuData menuData) 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 ComponentModifier and TypeMethodDescriptionConfiguredRoutes.copyTargetRouteModels
(boolean mutable) Make a copy of the target and route models mapping.ConfiguredRoutes.getExceptionHandlerByClass
(Class<?> exceptionClass) Get a exception handler by exception class.ConfiguredRoutes.getExceptionHandlers()
Get all registered exception handlers as a exception-to-handler map.ConfigureRoutes.getExceptionHandlers()
Override so that the getters use the correct exception targets map for data.AbstractRouteRegistry.getNavigationTarget
(String url) AbstractRouteRegistry.getNavigationTarget
(String url, List<String> segments) ErrorTargetEntry.getNavigationTarget()
Gets the navigation target type.Get the route class matching the given path and path segments.Get the target class matching the given url.RouteTarget.getTarget()
Get the component route target.ConfiguredRoutes.getTargetRoutes()
Get all registered target routes for this configuration mapping the main template.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 ComponentModifier and TypeMethodDescriptionprotected 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 ComponentModifier and TypeMethodDescriptionprotected 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.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) AbstractRouteRegistry.getRouteTarget
(Class<? extends Component> target, RouteParameters parameters) ConfiguredRoutes.getRouteTarget
(Class<? extends Component> target, RouteParameters parameters) Gets theRouteTarget
instance matching the given target component and route parameters.ConfiguredRoutes.getTargetRoute
(Class<? extends Component> navigationTarget) Get the route template String for the given navigation target class.AbstractRouteRegistry.getTargetUrl
(Class<? extends Component> navigationTarget) AbstractRouteRegistry.getTargetUrl
(Class<? extends Component> navigationTarget, RouteParameters parameters) ConfiguredRoutes.getTargetUrl
(Class<? extends Component> navigationTarget) Get the url path String for the given navigation target class.ConfiguredRoutes.getTargetUrl
(Class<? extends Component> navigationTarget, RouteParameters parameters) Get the url path String for the given navigation target class and parameters.AbstractRouteRegistry.getTemplate
(Class<? extends Component> navigationTarget) ConfiguredRoutes.getTemplate
(Class<? extends Component> navigationTarget) Get the route template String for the given navigation target class.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 implementingHasUrlParameter
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
Set a newRouteTarget
for the given template.void
ConfigureRoutes.setRoute
(String template, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain) Set a newRouteTarget
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 ComponentModifierConstructorDescriptionErrorTargetEntry
(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 ComponentModifier and TypeMethodDescriptionErrorEvent.getComponent()
Get the Component that the error was thrown for.AmbiguousRouteConfigurationException.getConfiguredNavigationTarget()
Returns the already configured navigation target component class which caused the exception.RouteRegistry.getNavigationTarget
(String url) Gets the optional navigation target class for a given path.RouteRegistry.getNavigationTarget
(String url, List<String> segments) Gets the optional navigation target class for a given Location matching with path segments.SessionRouteRegistry.getNavigationTarget
(String url) SessionRouteRegistry.getNavigationTarget
(String url, List<String> segments) Method parameters in com.vaadin.flow.server with type arguments of type ComponentModifier and TypeMethodDescriptionRouteRegistry.getRouteTarget
(Class<? extends Component> target, RouteParameters parameters) Gets theRouteTarget
instance matching the given target component and route parameters.SessionRouteRegistry.getRouteTarget
(Class<? extends Component> target, RouteParameters parameters) RouteRegistry.getTargetUrl
(Class<? extends Component> navigationTarget) Get the url string for given navigation target.RouteRegistry.getTargetUrl
(Class<? extends Component> navigationTarget, RouteParameters parameters) Get the url string for given navigation target.SessionRouteRegistry.getTargetUrl
(Class<? extends Component> navigationTarget) SessionRouteRegistry.getTargetUrl
(Class<? extends Component> navigationTarget, RouteParameters parameters) RouteRegistry.getTemplate
(Class<? extends Component> navigationTarget) Get the main template for given navigation target.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 ComponentModifierConstructorDescriptionAmbiguousRouteConfigurationException
(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 ComponentModifier and TypeMethodDescriptionNavigationAccessControl.getLoginView()
Gets the Flow login view.Method parameters in com.vaadin.flow.server.auth with type arguments of type ComponentModifier and TypeMethodDescriptionfinal 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 ComponentModifier and TypeMethodDescriptionstatic 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 ComponentModifier and TypeMethodDescriptionAbstractRouteRegistryInitializer.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 ComponentModifier and TypeMethodDescriptionvoid
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 ComponentModifier and TypeClassDescriptionfinal 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 ComponentModifier and TypeMethodDescription<T extends Component>
Set<WebComponentConfiguration<T>>WebComponentConfigurationRegistry.getConfigurationsByComponentType
(Class<T> componentClass) Get an unmodifiable set containing all registered web component configurations for a specificComponent
type.Methods in com.vaadin.flow.server.webcomponent that return types with arguments of type ComponentModifier and TypeMethodDescriptionOptional<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 ComponentModifier and TypeMethodDescriptionWebComponentExporterTagExtractor.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 ComponentModifier and TypeMethodDescription<T extends Component>
TSpringInstantiator.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 ComponentModifier and TypeMethodDescriptionprotected 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.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 ComponentModifier and TypeClassDescriptionclass
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 ComponentModifier and TypeMethodDescription<T extends Component>
ComponentQuery<T>Gets a query object for finding a component inside the UI<T extends Component>
ComponentQuery<T>Gets a query object for finding a component nested inside the given component.<T extends Component>
ComponentQuery<T>Gets a query object for finding a component inside the current viewElementConditions.containsText
(String text) Checks if text content of the component contains the given text.ElementConditions.containsText
(String text, boolean ignoreCase) Checks if text content of the component contains the given text.<R extends Component>
ComponentQuery<R>Gets aComponentQuery
to search for component of the given type nested inside the wrapped component.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.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.ElementConditions.hasAttribute
(String attribute) Checks if the given attribute has been set on the component.ElementConditions.hasAttribute
(String attribute, String value) Checks if the given attribute has been set on the component and has exactly the given value.ElementConditions.hasNotAttribute
(String attribute) Checks if the given attribute has not been set on the component.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>
TNavigate to the given view class if it is registered.<C,
T extends Component & HasUrlParameter<C>>
TNavigate to view with url parameter.<T extends Component>
TNavigate to view corresponding to the given navigation target with the specified parameters.<T extends Component>
TNavigate to given location string.<T extends ComponentTester<Y>,
Y extends Component>
TWrap component in given ComponentTester.<T extends ComponentTester<Y>,
Y extends Component>
TBaseUIUnitTest.test
(Y component) Wrap component with ComponentTester best matching component type.<E extends Component>
ComponentQuery<E>Gets a newComponentQuery
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 newComponentQuery
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 ComponentModifier and TypeMethodDescription<T extends Component>
ComponentQuery<T>Gets a query object for finding a component nested inside the given component.protected static void
ComponentTester.ensureComponentIsUsable
(Component component, Predicate<Component> usableTest) Throws anIllegalStateException
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.Sets the context to search inside.protected static boolean
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 ComponentModifier and TypeMethodDescriptionprotected static void
ComponentTester.ensureComponentIsUsable
(Component component, Predicate<Component> usableTest) Throws anIllegalStateException
with details on the current state of the component if it is not usable according to the provided test.