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

Packages that use Component

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.dependency
com.vaadin.flow.component.internal
com.vaadin.flow.component.template.internal
com.vaadin.flow.component.webcomponent
com.vaadin.flow.di
com.vaadin.flow.dom
com.vaadin.flow.internal
com.vaadin.flow.internal.nodefeature
com.vaadin.flow.router
com.vaadin.flow.router.internal
com.vaadin.flow.server
com.vaadin.flow.server.auth
com.vaadin.flow.server.startup
com.vaadin.flow.server.webcomponent

Uses of Component in com.vaadin.flow.component

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

Modifier and Type	Class	Description
class	AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T>	An abstract field class that is backed by a composite component.
static class	AbstractField.ComponentValueChangeEvent<C extends Component,V>	Value change event fired by components.
interface	BlurNotifier<T extends Component>	Mixin interface to handle blur events on components.
static class	BlurNotifier.BlurEvent<C extends Component>	Represents the DOM event "blur".
class	ClickEvent<C extends Component>	Event fired when a component is clicked.
interface	ClickNotifier<T extends Component>	Mixin interface for components that support adding click listeners to the their root elements.
class	ComponentEvent<T extends Component>	An event whose source is a Component.
class	Composite<T extends Component>	A composite encapsulates a Component tree to allow creation of new components by composing existing components.
interface	Focusable<T extends Component>	Represents a component that can gain and lose focus.
interface	FocusNotifier<T extends Component>	Mixin interface to handle focus events on components.
static class	FocusNotifier.FocusEvent<C extends Component>	Represents the DOM event "focus".
class	WebComponentExporter<C extends Component>	Exports a Component as a web component.
interface	WebComponentExporterFactory<C extends Component>	Exports a Component as a web component.
static class	WebComponentExporterFactory.DefaultWebComponentExporterFactory<C extends Component>	Default factory implementation which uses an exporter class to instantiate it using its default constructor.

Subclasses of Component in com.vaadin.flow.component

Modifier and Type	Class	Description
class	AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T>	An abstract field class that is backed by a composite component.
class	AbstractField<C extends AbstractField<C,T>,T>	An abstract implementation of a field, or a Component allowing user input.
class	AbstractSinglePropertyField<C extends AbstractField<C,T>,T>	Abstract field that is based on a single element property.
class	Composite<T extends Component>	A composite encapsulates a Component tree to allow creation of new components by composing existing components.
class	Html	A component which encapsulates a given HTML fragment with a single root element.
class	HtmlComponent	Base class for a Component that represents a single built-in HTML element.
class	HtmlContainer	Base class for a Component that represents a single built-in HTML element that can contain child components or text.
class	Text	A component which encapsulates the given text in a text node.
class	UI	The topmost component in any component hierarchy.

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

Modifier and Type	Method	Description
static <T extends Component> T	ComponentUtil.componentFromElement(Element element, Class<T> componentType, boolean mapComponent)	Creates a new component instance using the given element, maps the component to the element and optionally maps the element to the component (if mapComponent is true).
<T extends Component> WebComponentConfiguration<T>	WebComponentExporter.WebComponentConfigurationFactory.create(WebComponentExporter<T> exporter)	Creates a WebComponentConfiguration for the provided WebComponentExporter instances.
static <T extends Component> void	ComponentUtil.fireEvent(T component, ComponentEvent<? extends T> componentEvent)	Dispatches the event to all listeners registered for the event type.
static <T extends Component> T	Component.from(Element element, Class<T> componentType)	Creates a new component instance using the given element.
<T,C extends Component & HasUrlParameter<T>> Optional<C>	UI.navigate(Class<? extends C> navigationTarget, T parameter)	Updates this UI to show the view corresponding to the given navigation target with the specified parameter.
<T,C extends Component & HasUrlParameter<T>> Optional<C>	UI.navigate(Class<? extends C> navigationTarget, T parameter, QueryParameters queryParameters)	Updates this UI to show the view corresponding to the given navigation target with the specified parameter.
<T extends Component> Optional<T>	UI.navigate(Class<? extends T> navigationTarget, QueryParameters queryParameters)	Updates this UI to show the view corresponding to the given navigation target and query parameters.
<T extends Component> Optional<T>	UI.navigate(Class<T> navigationTarget)	Updates this UI to show the view corresponding to the given navigation target.
<T extends Component> Optional<T>	UI.navigate(Class<T> navigationTarget, RouteParameters parameters)	Updates this UI to show the view corresponding to the given navigation target with the specified parameters.

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

Modifier and Type	Method	Description
Component	UI.getActiveDragSourceComponent()	Gets the drag source of an active HTML5 drag event.
default Component	HasOrderedComponents.getComponentAt(int index)	Returns the component at the given position.
default Component	HasHelper.getHelperComponent()	Gets the component in the helper slot of this field.
static Component	ComponentUtil.getInnermostComponent(Composite<?> composite)	Returns the innermost component from a Composite chain, i.e.
static Component	ComponentUtil.getInnermostComponent(Element element)	Gets the innermost mapped component for the element.
Component	ShortcutEvent.getLifecycleOwner()	Component which owns the shortcut.
Component	ShortcutRegistration.getLifecycleOwner()	Component which controls when the shortcut is active and when it is not.
Component	ShortcutRegistration.getOwner()	Deprecated. This component has now multiple owners so this method has been replaced by #getOwners().
Component[]	ShortcutRegistration.getOwners()	The Components which own the shortcuts key event listeners.
static Component	ComponentUtil.getParentUsingComposite(Composite<?> composite, Component component)	Gets the parent of the given component, which is inside the given composite.
Component	ShortcutEvent.getSource()	Component which listened for the shortcut.

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

Modifier and Type	Method	Description
static Optional<Component>	ComponentUtil.findParentComponent(Element element)	Finds the first component by traversing upwards in the element hierarchy, starting from the given element.
Stream<Component>	Component.getChildren()	Gets the child components of this component.
Stream<Component>	Composite.getChildren()	Gets the child components of this composite.
Stream<Component>	HasOrderedComponents.getChildren()	Gets the children components of this component.
Optional<Component>	Component.getParent()	Gets the parent component of this component.
static Optional<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 Component

Modifier and Type	Method	Description
default void	HasComponents.add(Component... components)	Adds the given components as children of this component.
void	UI.add(Component... components)	Adds the given components to the UI.
default void	HasComponents.addComponentAsFirst(Component component)	Adds the given component as the first child of this component.
default void	HasComponents.addComponentAtIndex(int index, Component component)	Adds the given component as child of this component at the specific index.
static <T extends ComponentEvent<?>> Registration	ComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener)	Adds a listener for an event of the given type to the component.
static <T extends ComponentEvent<?>> Registration	ComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener, Consumer<DomListenerRegistration> domListenerConsumer)	Adds a listener for an event of the given type to the component, and customizes the corresponding DOM event listener with the given consumer.
void	UI.addModal(Component component)	Adds the given component as a modal child to the UI, making the UI and all other (existing) components added to the UI impossible for the user to interact with.
static ShortcutRegistration	Shortcuts.addShortcutListener(Component lifecycleOwner, ShortcutEventListener listener, Key key, KeyModifier... keyModifiers)	Invoke a ShortcutEventListener when the shortcut is invoked.
static ShortcutRegistration	Shortcuts.addShortcutListener(Component lifecycleOwner, Command command, Key key, KeyModifier... keyModifiers)	Invoke a Command when the shortcut is invoked.
void	UI.addToModalComponent(Component component)	Add component as child to modal component if one is active.
StateTree.ExecutionRegistration	UI.beforeClientResponse(Component component, SerializableConsumer<ExecutionContext> execution)	Registers a task to be executed before the response is sent to the client.
ShortcutRegistration	ShortcutRegistration.bindLifecycleTo(Component component)	Binds the shortcut's life cycle to that of the given Component.
static <T> T	ComponentUtil.getData(Component component, Class<T> type)	Gets a data instance with the given type, or null if there is no such instance.
static Object	ComponentUtil.getData(Component component, String key)	Gets a data instance with the given key, or null if no data has been set for that key.
static Collection<?>	ComponentUtil.getListeners(Component component, Class<? extends ComponentEvent> eventType)	Returns all listeners that match or extend the given event type.
static Component	ComponentUtil.getParentUsingComposite(Composite<?> composite, Component component)	Gets the parent of the given component, which is inside the given composite.
static Optional<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.
static <T extends ComponentEvent<?>> boolean	ComponentUtil.hasEventListener(Component component, Class<? extends T> eventType)	Check if the component has at least one registered listener of the given event type.
default int	HasOrderedComponents.indexOf(Component component)	Returns the index of the given component.
static boolean	ComponentUtil.isCompositeContent(Composite<?> composite, Component component)	Checks if the given component is inside a Composite chain, i.e.
ShortcutRegistration	ShortcutRegistration.listenOn(Component... listenOnComponents)	Fluently define the Component onto which the shortcut's listener is bound.
static void	ComponentUtil.onComponentAttach(Component component, boolean initialAttach)	Handles triggering the onAttach method and firing the AttachEvent for the given component when it has been attached to a UI.
static void	ComponentUtil.onComponentDetach(Component component)	Handles triggering the onDetach method and firing the DetachEvent for the given component right before it is detached from a UI.
default void	HasComponents.remove(Component... components)	Removes the given child components from this component.
default void	HasOrderedComponents.replace(Component oldComponent, Component newComponent)	Replaces the component in the container with another one without changing position.
void	UI.setChildComponentModal(Component childComponent, boolean modal)	Makes the child component modal or modeless.
static <T> void	ComponentUtil.setData(Component component, Class<T> type, T value)	Stores an instance of a specific type for the given component.
static void	ComponentUtil.setData(Component component, String key, Object value)	Stores a arbitrary value for the given component.
protected static void	Component.setElement(Component component, Element element)	Initializes the root element of a component.
default void	HasHelper.setHelperComponent(Component component)	Adds the given component into helper slot of component, replacing any existing helper component.
static Registration	Shortcuts.setShortcutListenOnElement(String elementLocatorJs, Component listenOnComponent)	Setup an element, that is only accessible on the browser (not server side), to listen for shortcut events on and delegate to the given component.

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

Modifier and Type	Method	Description
default void	HasComponents.add(Collection<Component> components)	Adds the given components as children of this component.
static void	ComponentUtil.findComponents(Element element, Consumer<Component> componentConsumer)	Finds the first component instance in each Element subtree by traversing the Element tree starting from the given element.
static ComponentMetaData.DependencyInfo	ComponentUtil.getDependencies(VaadinService service, Class<? extends Component> componentClass)	Gets the dependencies for the given class, defined using annotations ( JavaScript, StyleSheet and Uses).
static Collection<ComponentMetaData.SynchronizedPropertyInfo>	ComponentUtil.getSynchronizedProperties(Class<? extends Component> componentClass)	Gets the synchronized property infos of the properties that are defined declaratively for the given class with their RPC update mode.
static Stream<String>	ComponentUtil.getSynchronizedPropertyEvents(Class<? extends Component> componentClass)	Gets the name of the synchronized property event defined declaratively for the given class.
default void	HasComponents.remove(Collection<Component> components)	Removes the given child components from this component.

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

Constructor	Description
AttachEvent(Component source, boolean initialAttach)	Creates a new attach event with the given component as source.
ClickEvent(Component source)	Creates a new server-side click event with no additional information.
ClickEvent(Component source, boolean fromClient, int screenX, int screenY, int clientX, int clientY, int clickCount, int button, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey)	Creates a new click event.
ComponentEventBus(Component component)	Creates an event bus for the given component.
CompositionEndEvent(Component source)	Creates a new server-side composition event with no additional information.
CompositionEndEvent(Component source, boolean fromClient, String data, String locale)	Creates a new composition event.
CompositionStartEvent(Component source)	Creates a new server-side composition event with no additional information.
CompositionStartEvent(Component source, boolean fromClient, String data, String locale)	Creates a new composition event.
CompositionUpdateEvent(Component source)	Creates a new server-side composition event with no additional information.
CompositionUpdateEvent(Component source, boolean fromClient, String data, String locale)	Creates a new composition event.
DetachEvent(Component source)	Creates a new detach event with the given component as source.
HtmlContainer(Component... components)	Creates a component with the given child components.
HtmlContainer(String tagName, Component... components)	Creates a new component with the given contents and a new element with the given tag name.
InputEvent(Component source, boolean fromClient)	Creates a new input event.
KeyDownEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)	Creates a new keyboard event.
KeyDownEvent(Component source, String key)	Creates a new server-side keyboard event with no additional information.
KeyDownEvent(Component source, String key, String code)	Creates a new server-side keyboard event with no additional information.
KeyPressEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)	Creates a new keyboard event.
KeyPressEvent(Component source, String key)	Creates a new server-side keyboard event with no additional information.
KeyPressEvent(Component source, String key, String code)	Creates a new server-side keyboard event with no additional information.
KeyUpEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)	Creates a new keyboard event.
KeyUpEvent(Component source, String key)	Creates a new server-side keyboard event with no additional information.
KeyUpEvent(Component source, String key, String code)	Creates a new server-side keyboard event with no additional information.
ShortcutEvent(Component source, Component lifecycleOwner, Key key, Set<KeyModifier> keyModifiers)	Creates a new ShortcutEvent.

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

Methods in com.vaadin.flow.component.dependency that return types with arguments of type Component

Modifier and Type	Method	Description
Class<? extends Component>	value()	Marks the component class to depend on.

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

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

Modifier and Type	Class	Description
class	AbstractFieldSupport<C extends Component & HasValue<AbstractField.ComponentValueChangeEvent<C,T>,T>,T>	Encapsulates all the logic required for a typical field implementation.

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

Modifier and Type	Class	Description
class	JavaScriptBootstrapUI	Custom UI for JavaScriptBootstrapHandler.
static class	JavaScriptBootstrapUI.ClientViewPlaceholder	Placeholder view when navigating from server-side views to client-side views.

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

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

Methods in com.vaadin.flow.component.internal that return types with arguments of type Component

Modifier and Type	Method	Description
Stream<Component>	JavaScriptBootstrapUI.getChildren()

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

Modifier and Type	Method	Description
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.

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

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

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

Constructor	Description
AbstractAttachDetachEvent(Component source)	Creates a new event with the given component as source.
CompositionEvent(Component source)	Creates a new server-side composition event with no additional information.
CompositionEvent(Component source, boolean fromClient, String data, String locale)	Creates a new composition event.
KeyboardEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)	Creates a new keyboard event.
KeyboardEvent(Component source, String key)	Creates a new server-side keyboard event with no additional information.
KeyboardEvent(Component source, String key, String code)	Creates a new server-side keyboard event with no additional information.

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

Constructor	Description
ComponentMetaData(Class<? extends Component> componentClass)	Scans the given component class and creates a new instance based on found annotations.

Uses of Component in com.vaadin.flow.component.template.internal

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

Modifier and Type	Method	Description
Object	DeprecatedPolymerPublishedEventHandler.getTemplateItem(Component template, elemental.json.JsonObject argValue, Type convertedType)	Deprecated. Get the template model object and type.
boolean	DeprecatedPolymerPublishedEventHandler.isTemplateModelValue(Component instance, elemental.json.JsonValue argValue, Class<?> convertedType)	Deprecated. Validate that the given Component instance is a PolymerTemplate and that the value can be converted.

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

Constructor	Description
IdMapper(Component template)	Creates a mapper for the given template.

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

Classes in com.vaadin.flow.component.webcomponent with type parameters of type Component

Modifier and Type	Interface	Description
interface	PropertyConfiguration<C extends Component,P extends Serializable>	Offers a fluent API for configuring the properties of embedded web components produced by WebComponentExporter.
class	WebComponent<C extends Component>	Acts as a proxy to the web component root onto which the exporter Component is added.
interface	WebComponentConfiguration<C extends Component>	Result of defining an embeddable web component using WebComponentExporter.

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

Modifier and Type	Class	Description
class	WebComponentUI	Custom UI for use with WebComponents served from the server.
class	WebComponentWrapper	Wrapper component for a web component that exposes ClientCallable methods that the client-side components expect to be available.

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

Modifier and Type	Method	Description
<T,C extends Component & HasUrlParameter<T>> Optional<C>	WebComponentUI.navigate(Class<? extends C> navigationTarget, T parameter)
<T extends Component> Optional<T>	WebComponentUI.navigate(Class<T> navigationTarget)

Uses of Component in com.vaadin.flow.di

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

Modifier and Type	Method	Description
<T extends Component> T	DefaultInstantiator.createComponent(Class<T> componentClass)
<T extends Component> T	Instantiator.createComponent(Class<T> componentClass)	Creates an instance of a component by its componentClass.

Uses of Component in com.vaadin.flow.dom

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

Modifier and Type	Method	Description
<T extends Component> T	Element.as(Class<T> componentType)	Creates a new component instance using this element.

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

Modifier and Type	Method	Description
Optional<Component>	Element.getComponent()	Gets the component this element has been mapped to, if any.
default Optional<Component>	ElementStateProvider.getComponent(StateNode node)	Gets the component this element is mapped to.

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

Modifier and Type	Method	Description
default void	ElementStateProvider.setComponent(StateNode node, Component component)	Defines a mapping between the element and the given component.
static void	ElementUtil.setComponent(Element element, Component component)	Defines a mapping between this element and the given Component.

Uses of Component in com.vaadin.flow.internal

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

Modifier and Type	Method	Description
static List<CssImport>	AnnotationReader.getCssImportAnnotations(Class<? extends Component> componentClass)	Finds all CssImport annotations on the given Component class, its super classes and implemented interfaces.
static List<JavaScript>	AnnotationReader.getJavaScriptAnnotations(Class<? extends Component> componentClass)	Finds all JavaScript annotations on the given Component class, its super classes and implemented interfaces.
static List<JsModule>	AnnotationReader.getJsModuleAnnotations(Class<? extends Component> componentClass)	Finds all JsModule annotation on the given Component class, its super classes and implenented interfaces.
static List<StyleSheet>	AnnotationReader.getStyleSheetAnnotations(Class<? extends Component> componentClass)	Finds all StyleSheet annotations on the given Component class, its super classes and implemented interfaces.

Uses of Component in com.vaadin.flow.internal.nodefeature

Methods in com.vaadin.flow.internal.nodefeature that return types with arguments of type Component

Modifier and Type	Method	Description
Optional<Component>	ComponentMapping.getComponent()	Gets the component this node has been mapped to, if any.
static Optional<Component>	ComponentMapping.getComponent(StateNode node)	Gets the component mapped to the given state node.

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

Modifier and Type	Method	Description
void	ComponentMapping.setComponent(Component component)	Assigns the given component to this node.

Uses of Component in com.vaadin.flow.router

Subclasses of Component in com.vaadin.flow.router

Modifier and Type	Class	Description
class	InternalServerError	This is a basic default error view shown on exceptions during navigation.
class	RouteNotFoundError	This is a basic default error view shown on routing exceptions.
class	RouterLink	A link that handles navigation internally using Router instead of loading a new page in the browser.

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

Modifier and Type	Method	Description
<C extends Component> void	BeforeEvent.forwardTo(Class<? extends C> forwardTargetComponent, QueryParameters queryParameters)	Forward the navigation to show the given component with given query parameters instead of the component that is currently about to be displayed.
<C extends Component> void	BeforeEvent.forwardTo(Class<? extends C> forwardTargetComponent, RouteParameters routeParameters, QueryParameters queryParameters)	Forward the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> void	BeforeEvent.forwardTo(Class<? extends C> forwardTargetComponent, List<T> routeParameters)	Forward the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> void	BeforeEvent.forwardTo(Class<? extends C> forwardTargetComponent, T routeParameter)	Forward the navigation to show the given component with given route parameter instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> void	BeforeEvent.forwardTo(Class<? extends C> forwardTargetComponent, T routeParameter, QueryParameters queryParameters)	Forward the navigation to show the given component with given route parameter and query parameters instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> String	RouteConfiguration.getUrl(Class<? extends C> navigationTarget, List<T> parameters)	Get the url string for given navigation target with the parameters in the url.
<T,C extends Component & HasUrlParameter<T>> String	RouteConfiguration.getUrl(Class<? extends C> navigationTarget, T parameter)	Get the url string for given navigation target with the parameter in the url.
<C extends Component> void	BeforeEvent.rerouteTo(Class<? extends C> routeTargetType, QueryParameters queryParameters)	Reroutes the navigation to show the given component with given query parameters instead of the component that is currently about to be displayed.
<C extends Component> void	BeforeEvent.rerouteTo(Class<? extends C> routeTargetType, RouteParameters routeParameters, QueryParameters queryParameters)	Reroutes the navigation to show the given component with given route parameters and query parameters instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> void	BeforeEvent.rerouteTo(Class<? extends C> routeTargetType, List<T> routeParameters)	Reroutes the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> void	BeforeEvent.rerouteTo(Class<? extends C> routeTargetType, T routeParameter)	Reroutes the navigation to show the given component with given route parameter instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> void	BeforeEvent.rerouteTo(Class<? extends C> routeTargetType, T routeParameter, QueryParameters queryParameters)	Reroutes the navigation to show the given component with given route parameter and query parameters instead of the component that is currently about to be displayed.
<T,C extends Component & HasUrlParameter<T>> void	RouterLink.setRoute(Router router, Class<? extends C> navigationTarget, T parameter)	Set the navigation target for this link.
<T,C extends Component & HasUrlParameter<T>> void	RouterLink.setRoute(Class<? extends C> navigationTarget, T parameter)	Set the navigation target for this link.

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

Modifier and Type	Method	Description
List<Class<? extends Component>>	RoutesChangedEvent.getAddedNavigationTargets()	Get every single navigation targets of all added routes in this change.
Class<? extends Component>	BeforeEvent.getForwardTargetType()	Get the forward target type for forwarding.
Class<? extends Component>	NavigationState.getNavigationTarget()	Gets the navigation target of this state.
Class<? extends Component>	RouteBaseData.getNavigationTarget()	Get Route navigation target.
List<Class<? extends Component>>	RoutesChangedEvent.getRemovedNavigationTargets()	Get every single navigation targets of all removed routes in this change.
Class<? extends Component>	BeforeEvent.getRerouteTargetType()	Get the route target type for rerouting.
Optional<Class<? extends Component>>	RouteConfiguration.getRoute(String path)	Gets the registered route class for a given path.
Optional<Class<? extends Component>>	RouteConfiguration.getRoute(String path, List<String> segments)	Gets the optional navigation target class for a given Location matching with path segments.
Class<? extends Component>	BeforeEvent.getRouteTargetType()	Deprecated. use BeforeEvent.getRerouteTargetType() instead.

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

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

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

Constructor	Description
RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget)	AliasData constructor.
RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget)	AliasData constructor.
RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget)	RouteBaseData constructor.
RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget)	RouteBaseData constructor.
RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases)	RouteData constructor.
RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases)	RouteData constructor.
RouterLink(Router router, Class<? extends Component> navigationTarget)	Creates a new router link for the given navigation target.
RouterLink(Router router, Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given parameters.
RouterLink(Router router, String text, Class<? extends Component> navigationTarget)	Creates a new router link for the given navigation target using the given text.
RouterLink(Router router, String text, Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given text and parameters.
RouterLink(Class<? extends Component> navigationTarget)	Creates a new router link for the given navigation target.
RouterLink(Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given parameters.
RouterLink(String text, Class<? extends Component> navigationTarget)	Creates a new router link for the given navigation target using the given text.
RouterLink(String text, Class<? extends Component> navigationTarget, RouteParameters parameters)	Creates a new router link for the given navigation target using the given text and parameters.

Uses of Component in com.vaadin.flow.router.internal

Methods in com.vaadin.flow.router.internal that return types with arguments of type Component

Modifier and Type	Method	Description
protected Map<Class<? extends Component>,com.vaadin.flow.router.internal.RouteModel>	ConfiguredRoutes.copyTargetRouteModels(boolean mutable)	Make a copy of the target and route models mapping.
Class<? extends Component>	ConfiguredRoutes.getExceptionHandlerByClass(Class<?> exceptionClass)	Get a exception handler by exception class.
Map<Class<? extends Exception>,Class<? extends Component>>	ConfiguredRoutes.getExceptionHandlers()	Get all registered exception handlers as a exception-to-handler map.
Map<Class<? extends Exception>,Class<? extends Component>>	ConfigureRoutes.getExceptionHandlers()	Override so that the getters use the correct exception targets map for data.
Optional<Class<? extends Component>>	AbstractRouteRegistry.getNavigationTarget(String url)
Optional<Class<? extends Component>>	AbstractRouteRegistry.getNavigationTarget(String url, List<String> segments)
Class<? extends Component>	ErrorTargetEntry.getNavigationTarget()	Gets the navigation target type.
Optional<Class<? extends Component>>	ConfiguredRoutes.getRoute(String url, List<String> segments)	Get the route class matching the given path and path segments.
Optional<Class<? extends Component>>	ConfiguredRoutes.getTarget(String url)	Get the target class matching the given url.
Class<? extends Component>	RouteTarget.getTarget()	Get the component route target.
Map<Class<? extends Component>,String>	ConfiguredRoutes.getTargetRoutes()	Get all registered target routes for this configuration mapping the main template.
Map<Class<? extends Component>,String>	ConfigureRoutes.getTargetRoutes()	Override so that the getters use the correct target routes map for data.

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

Modifier and Type	Method	Description
protected abstract void	AbstractNavigationStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)	Notify the navigation target about the status of the navigation.
protected void	ErrorStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)
protected void	NavigationStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)

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

Modifier and Type	Method	Description
protected void	AbstractRouteRegistry.addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>,Class<? extends Component>> exceptionTargetsMap)	Add the given error target to the exceptionTargetMap.
protected void	AbstractRouteRegistry.addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>,Class<? extends Component>> exceptionTargetsMap)	Add the given error target to the exceptionTargetMap.
static void	HasUrlParameterFormat.checkMandatoryParameter(Class<? extends Component> navigationTarget, RouteParameters parameters)	Verify whether the navigationTarget has mandatory parameter and complies with the given parameter values.
boolean	RouteTarget.containsTarget(Class<? extends Component> target)	Check if navigation target is present in current target.
List<Class<? extends RouterLayout>>	ConfiguredRoutes.getParentLayouts(String path, Class<? extends Component> navigationTarget)	Deprecated. use ConfiguredRoutes.getNavigationRouteTarget(String) instead.
List<Class<? extends RouterLayout>>	AbstractRouteRegistry.getRouteLayouts(String path, Class<? extends Component> navigationTarget)	Deprecated. instead use AbstractRouteRegistry.getNavigationRouteTarget(String) and retrieve the list of route layouts from the RouteTarget contained in the NavigationRouteTarget.
protected List<String>	ConfiguredRoutes.getRoutePaths(Class<? extends Component> routeTarget)	Collect all routes for which given routeTarget is registered.
protected abstract List<Class<? extends RouterLayout>>	AbstractNavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> routeTargetType, Router router)	Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.
List<Class<? extends RouterLayout>>	ErrorStateRenderer.getRouterLayoutTypes(Class<? extends Component> targetType, Router router)	Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.
protected List<Class<? extends RouterLayout>>	NavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> targetType, Router router)
RouteTarget	AbstractRouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)
RouteTarget	ConfiguredRoutes.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)	Gets the RouteTarget instance matching the given target component and route parameters.
String	ConfiguredRoutes.getTargetRoute(Class<? extends Component> navigationTarget)	Get the route template String for the given navigation target class.
Optional<String>	AbstractRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget)
Optional<String>	AbstractRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)
String	ConfiguredRoutes.getTargetUrl(Class<? extends Component> navigationTarget)	Get the url path String for the given navigation target class.
String	ConfiguredRoutes.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)	Get the url path String for the given navigation target class and parameters.
Optional<String>	AbstractRouteRegistry.getTemplate(Class<? extends Component> navigationTarget)
String	ConfiguredRoutes.getTemplate(Class<? extends Component> navigationTarget)	Get the route template String for the given navigation target class.
String	ConfiguredRoutes.getTemplate(Class<? extends Component> navigationTarget, Set<RouteParameterFormatOption> format)	Get the route template String for the given navigation target class and using the specified parameters format.
static String	HasUrlParameterFormat.getTemplate(String urlBase, Class<? extends Component> navigationTarget)	Gets the template for the given url base by appending the parameter according to the given navigationTarget if it's implementing HasUrlParameter
boolean	AbstractRouteRegistry.hasMandatoryParameter(Class<? extends Component> navigationTarget)
boolean	ConfiguredRoutes.hasRouteTarget(Class<? extends Component> target)	Check it the given route target has been registered to the configuration.
void	AbstractRouteRegistry.removeRoute(Class<? extends Component> navigationTarget)
void	AbstractRouteRegistry.removeRoute(String path, Class<? extends Component> navigationTarget)
void	ConfigureRoutes.removeRoute(Class<? extends Component> target)	Remove the target completely from the configuration.
void	ConfigureRoutes.removeRoute(String template, Class<? extends Component> targetRoute)	Remove navigation target for given template.
void	AbstractRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)
void	ConfigureRoutes.setRoute(String template, Class<? extends Component> navigationTarget)	Set a new RouteTarget for the given template.
void	ConfigureRoutes.setRoute(String template, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)	Set a new RouteTarget for the given template.
void	ConfigureRoutes.setTargetRoute(Class<? extends Component> navigationTarget, String path)	Put a new target route for Class-to-path mapping.

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

Constructor	Description
ErrorTargetEntry(Class<? extends Component> navigationTarget, Class<? extends Exception> handledExceptionType)	Creates a new new entry with the given navigation target type and exception type.
RouteTarget(Class<? extends Component> target)	Create a new Route target holder with the given target registered and empty parent layouts.
RouteTarget(Class<? extends Component> target, List<Class<? extends RouterLayout>> parents)	Create a new Route target holder with the given target registered.

Uses of Component in com.vaadin.flow.server

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

Modifier and Type	Method	Description
Class<? extends Component>	AmbiguousRouteConfigurationException.getConfiguredNavigationTarget()	Returns the already configured navigation target component class which caused the exception.
Optional<Class<? extends Component>>	RouteRegistry.getNavigationTarget(String url)	Gets the optional navigation target class for a given path.
Optional<Class<? extends Component>>	RouteRegistry.getNavigationTarget(String url, List<String> segments)	Gets the optional navigation target class for a given Location matching with path segments.
Optional<Class<? extends Component>>	SessionRouteRegistry.getNavigationTarget(String url)
Optional<Class<? extends Component>>	SessionRouteRegistry.getNavigationTarget(String url, List<String> segments)

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

Modifier and Type	Method	Description
List<Class<? extends RouterLayout>>	RouteRegistry.getRouteLayouts(String path, Class<? extends Component> navigationTarget)	Deprecated. instead use RouteRegistry.getNavigationRouteTarget(String) and retrieve the list of route layouts from the RouteTarget contained in the NavigationRouteTarget.
List<Class<? extends RouterLayout>>	SessionRouteRegistry.getRouteLayouts(String path, Class<? extends Component> navigationTarget)	Deprecated. instead use SessionRouteRegistry.getNavigationRouteTarget(String) and retrieve the list of route layouts from the RouteTarget contained in the NavigationRouteTarget.
RouteTarget	RouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)	Gets the RouteTarget instance matching the given target component and route parameters.
RouteTarget	SessionRouteRegistry.getRouteTarget(Class<? extends Component> target, RouteParameters parameters)
Optional<String>	RouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget)	Get the url string for given navigation target.
Optional<String>	RouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)	Get the url string for given navigation target.
Optional<String>	SessionRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget)
Optional<String>	SessionRouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)
Optional<String>	RouteRegistry.getTemplate(Class<? extends Component> navigationTarget)	Get the main template for given navigation target.
Optional<String>	SessionRouteRegistry.getTemplate(Class<? extends Component> navigationTarget)
boolean	RouteRegistry.hasMandatoryParameter(Class<? extends Component> navigationTarget)	Check if the given navigationTarget requires parameters.
void	RouteRegistry.removeRoute(Class<? extends Component> navigationTarget)	Remove the given navigation target route registration.
void	RouteRegistry.removeRoute(String path, Class<? extends Component> navigationTarget)	Remove navigationTarget for the path.
void	RouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)	Register a navigation target with specified path and given parent layout chain.

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

Constructor	Description
AmbiguousRouteConfigurationException(String message, Class<? extends Component> navigationTarget)	Constructs a new invalid route configuration exception with the specified detail message and the existing navigation target component which already presents in the configuration with the route path.

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

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

Modifier and Type	Method	Description
void	ViewAccessChecker.setLoginView(Class<? extends Component> loginView)	Sets the Flow login view to use.

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

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

Modifier and Type	Method	Description
protected Set<Class<? extends Component>>	AbstractRouteRegistryInitializer.validateRouteClasses(VaadinContext context, Stream<Class<?>> routeClasses)	Validate the potential route classes stream and return them as a set.

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

Modifier and Type	Method	Description
void	ApplicationRouteRegistry.setErrorNavigationTargets(Set<Class<? extends Component>> errorNavigationTargets)	Set error handler navigation targets.
void	ApplicationRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)
boolean	NavigationTargetFilter.testNavigationTarget(Class<? extends Component> navigationTarget)	Tests whether the given navigation target class should be included.

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

Classes in com.vaadin.flow.server.webcomponent with type parameters of type Component

Modifier and Type	Class	Description
class	PropertyConfigurationImpl<C extends Component,P extends Serializable>	For internal use only.
class	WebComponentBinding<C extends Component>	Represents a single instance of a exported web component instance embedded onto a host page.

Methods in com.vaadin.flow.server.webcomponent with type parameters of type Component

Modifier and Type	Method	Description
<T extends Component> Set<WebComponentConfiguration<T>>	WebComponentConfigurationRegistry.getConfigurationsByComponentType(Class<T> componentClass)	Get an unmodifiable set containing all registered web component configurations for a specific Component type.

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

Modifier and Type	Method	Description
Optional<WebComponentConfiguration<? extends Component>>	WebComponentConfigurationRegistry.getConfiguration(String tag)	Get a web component configuration for given custom element tag if one is registered.
Set<WebComponentConfiguration<? extends Component>>	WebComponentConfigurationRegistry.getConfigurations()	Get an unmodifiable set containing all registered web component configurations.

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

Modifier and Type	Method	Description
String	WebComponentExporterTagExtractor.apply(WebComponentExporterFactory<? extends Component> factory)
static String	WebComponentGenerator.generateModule(WebComponentConfiguration<? extends Component> webComponentConfiguration, String frontendURI, boolean compatibilityMode, String themeName)	Generate web component html/JS for given tag and class.
static String	WebComponentGenerator.generateModule(WebComponentExporterFactory<? extends Component> factory, String frontendURI, boolean compatibilityMode, 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.