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

Packages that use Component

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.internal
com.vaadin.flow.component.polymertemplate
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.startup

Uses of Component in com.vaadin.flow.component

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

Modifier and Type	Class and 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> Class that 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> Interface with the methods implemented by components 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> Class that represents the DOM event "focus".
interface	HasOrderedComponents<T extends Component> A component which the children components are ordered, so the index of each child matters for the layout.

Subclasses of Component in com.vaadin.flow.component

Modifier and Type	Class and 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 and 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).
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>> void	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.

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

Modifier and Type	Method and Description
default Component	HasOrderedComponents.getComponentAt(int index) Returns the component at the given position.
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.
static Component	ComponentUtil.getParentUsingComposite(Composite<?> composite, Component component) Gets the parent of the given component, which is inside the given composite.

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

Modifier and Type	Method and 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.
Optional<Component>	Component.getParent() Gets the parent component of this component.

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

Modifier and Type	Method and 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.
StateTree.ExecutionRegistration	UI.beforeClientResponse(Component component, SerializableConsumer<ExecutionContext> execution) Registers a task to be executed before the response is sent to the client.
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 Component	ComponentUtil.getParentUsingComposite(Composite<?> composite, Component component) Gets the parent of the given component, which is inside the given composite.
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.
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.
static <T> void	ComponentUtil.setData(Component component, Class<T> type, T value) Stores a 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.

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

Modifier and Type	Method and Description
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 ( HtmlImport, 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.
void	UI.navigate(Class<? extends Component> navigationTarget) Updates this UI to show the view corresponding to the given navigation target.

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

Constructor and 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, 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.
KeyPressEvent(Component source, boolean fromClient, String key, 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.
KeyUpEvent(Component source, boolean fromClient, String key, 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.

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

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

Modifier and Type	Method and Description
void	UIInternals.showRouteTarget(Location viewLocation, String path, 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 and Description
void	UIInternals.addComponentDependencies(Class<? extends Component> componentClass) Adds the dependencies defined using StyleSheet, JavaScript or HtmlImport on the given Component class.

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

Constructor and 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, 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.

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

Constructor and 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.polymertemplate

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

Modifier and Type	Class and Description
class	AbstractTemplate<M>
class	PolymerTemplate<M extends TemplateModel> Component for an HTML element declared as a polymer component.

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

Modifier and Type	Method and Description
Stream<Component>	PolymerTemplate.getChildren() Gets the child components of this component.
static Optional<Class<? extends Component>>	TemplateInitializer.getUsesClass(Class<? extends PolymerTemplate<?>> templateType, String tagName) Looks for a component class with the given tag name among the classes used by the given polymer template class.

Uses of Component in com.vaadin.flow.di

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

Modifier and Type	Method and Description
default <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 and 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 and 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 and Description
static void	ElementUtil.setComponent(Element element, Component component) Defines a mapping between this element and the given Component.
default void	ElementStateProvider.setComponent(StateNode node, Component component) Defines a mapping between the 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 and Description
static List<HtmlImport>	AnnotationReader.getHtmlImportAnnotations(Class<? extends Component> componentClass) Finds all HtmlImport 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<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 and 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 and 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 and 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 and Description
<T,C extends Component & HasUrlParameter<T>> String	Router.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	Router.getUrl(Class<? extends C> navigationTarget, T parameter) Get the url string for given navigation target with the parameter in the url.
<T,C extends Component & HasUrlParameter<T>> void	RouterLink.setRoute(Router router, 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 and Description
Class<? extends Component>	NavigationState.getNavigationTarget() Gets the navigation target of this state.
Class<? extends Component>	RouteData.getNavigationTarget() Get Route navigation target.

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

Modifier and Type	Method and Description
String	Router.getUrl(Class<? extends Component> navigationTarget) Get the registered url string for given navigation target.
String	Router.getUrlBase(Class<? extends Component> navigationTarget) Return the url base without any url parameters.
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	NavigationState.setNavigationTarget(Class<? extends Component> navigationTarget) Sets the navigation target of this state.
void	RouterLink.setRoute(Router router, Class<? extends Component> navigationTarget) 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, List<String> urlParameters) Assigns the given navigation target with the given url parameter to the navigation state being built.

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

Constructor and Description
RouteData(Class<? extends RouterLayout> parentLayout, String url, List<Class<?>> parameters, Class<? extends Component> navigationTarget) RouteData constructor.
RouterLink(Router router, 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) Creates a new router link for the given navigation target using the given text.

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

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

Modifier and Type	Method and Description
protected void	NavigationStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)
protected abstract void	AbstractNavigationStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent) Notified the navigation target about the status of the navigation.
protected void	ErrorStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)
static void	RouterUtil.updatePageTitle(NavigationEvent navigationEvent, Component routeTarget) Updates the page title according to the currently visible component.

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

Modifier and Type	Method and Description
static void	RouterUtil.checkForDuplicates(Class<? extends Component> routeTargetType, Collection<Class<? extends RouterLayout>> routeLayoutTypes) Checks that the same component type is not used in multiple parts of a route chain.
protected List<Class<? extends RouterLayout>>	NavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> targetType)
protected abstract List<Class<? extends RouterLayout>>	AbstractNavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> routeTargetType) 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) Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.

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 and Description
Class<? extends Component>	RouteRegistry.ErrorTargetEntry.getNavigationTarget() Gets the navigation target type.
Optional<Class<? extends Component>>	RouteRegistry.getNavigationTarget(String pathString) Gets the optional navigation target class for a given Location.
Optional<Class<? extends Component>>	RouteRegistry.getNavigationTarget(String pathString, List<String> segments) Gets the optional navigation target class for a given Location matching with path segments.
Class<? extends Component>	RouteTarget.getTarget(List<String> segments) Get route target for given segments.
protected Set<Class<? extends Component>>	AbstractRouteRegistryInitializer.validateRouteClasses(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 and Description
void	RouteTarget.addRoute(Class<? extends Component> target) Add a new route navigation target.
Optional<String>	RouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget) Get the url string for given navigation target.
void	RouteRegistry.setErrorNavigationTargets(Set<Class<? extends Component>> errorNavigationTargets) Set error handler navigation targets.
void	RouteRegistry.setNavigationTargets(Set<Class<? extends Component>> navigationTargets) Registers a set of components as navigation targets.
boolean	NavigationTargetFilter.testNavigationTarget(Class<? extends Component> navigationTarget) Tests whether the given navigation target class should be included.

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

Constructor and 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.