Uses of Class
com.vaadin.flow.component.Component
Packages that use Component
Package
Description
-
Uses of Component in com.vaadin.flow.component
Classes in com.vaadin.flow.component with type parameters of type ComponentModifier and TypeClassDescriptionclassAbstractCompositeField<C extends Component,S extends AbstractCompositeField<C, S, T>, T> An abstract field class that is backed by a composite component.static classAbstractField.ComponentValueChangeEvent<C extends Component,V> Value change event fired by components.interfaceBlurNotifier<T extends Component>Mixin interface to handle blur events on components.static classBlurNotifier.BlurEvent<C extends Component>Represents the DOM event "blur".classClickEvent<C extends Component>Event fired when a component is clicked.interfaceClickNotifier<T extends Component>Mixin interface for components that support adding click listeners to the their root elements.classComponentEvent<T extends Component>An event whose source is aComponent.classA composite encapsulates aComponenttree to allow creation of new components by composing existing components.interfaceRepresents a component that can gain and lose focus.interfaceFocusNotifier<T extends Component>Mixin interface to handle focus events on components.static classFocusNotifier.FocusEvent<C extends Component>Represents the DOM event "focus".classWebComponentExporter<C extends Component>Exports aComponentas a web component.interfaceWebComponentExporterFactory<C extends Component>Exports aComponentas a web component.static classDefault factory implementation which uses an exporter class to instantiate it using its default constructor.Subclasses of Component in com.vaadin.flow.componentModifier and TypeClassDescriptionclassAbstractCompositeField<C extends Component,S extends AbstractCompositeField<C, S, T>, T> An abstract field class that is backed by a composite component.classAbstractField<C extends AbstractField<C,T>, T> An abstract implementation of a field, or aComponentallowing user input.classAbstractSinglePropertyField<C extends AbstractField<C,T>, T> Abstract field that is based on a single element property.classA composite encapsulates aComponenttree to allow creation of new components by composing existing components.classA component which encapsulates a given HTML fragment with a single root element.classBase class for aComponentthat represents a single built-in HTML element.classBase class for aComponentthat represents a single built-in HTML element that can contain child components or text.classA component that displays a given SVG image.classA component which encapsulates the given text in a text node.classThe topmost component in any component hierarchy.static classPlaceholder 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 <C extends Component,T>
RegistrationComponentEffect.bind(C owner, Signal<T> signal, SerializableBiConsumer<C, T> setter) Binds asignal's value to a given owner component in a way defined insetterfunction and creates a Signal effect function executing the setter whenever the signal value changes.static <T extends Component>
TComponentUtil.componentFromElement(Element element, Class<T> componentType, boolean mapComponent) Creates a new component instance using the given element, maps the component to the element and optionally maps the element to the component (ifmapComponentistrue).<T extends Component>
WebComponentConfiguration<T>WebComponentExporter.WebComponentConfigurationFactory.create(WebComponentExporter<T> exporter) Creates aWebComponentConfigurationfor the providedWebComponentExporterinstances.static <C extends Component>
RegistrationCreates a Signal effect that is owned by a given component.static <T extends Component>
voidComponentUtil.fireEvent(T component, ComponentEvent<? extends T> componentEvent) Dispatches the event to all listeners registered for the event type.static <C extends Component>
RegistrationComponentEffect.format(C owner, SerializableBiConsumer<C, String> setter, String format, Signal<?>... signals) Formats a string using the values of the provided signals and sets it on the owner component using the provided setter function.static <C extends Component>
RegistrationComponentEffect.format(C owner, SerializableBiConsumer<C, String> setter, Locale locale, String format, Signal<?>... signals) Formats a string using the values of the provided signals and the given locale, sets the formatted string on the owner component using the provided setter function.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 ComponentHasOrderedComponents.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 ComponentHasHelper.getHelperComponent()Gets the component in the helper slot of this field.static ComponentComponentUtil.getInnermostComponent(Composite<?> composite) static ComponentComponentUtil.getInnermostComponent(Element element) Gets the innermost mapped component for the element.ShortcutEvent.getLifecycleOwner()Component which owns the shortcut.ShortcutRegistration.getLifecycleOwner()Componentwhich 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()TheComponents which own the shortcuts key event listeners.static ComponentComponentUtil.getParentUsingComposite(Composite<?> composite, Component component) Gets the parent of the given component, which is inside the given composite.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 voidAdds the given components as children of this component.voidAdds the given components to the UI.default voidHasComponents.addComponentAsFirst(Component component) Adds the given component as the first child of this component.default voidHasComponents.addComponentAtIndex(int index, Component component) Adds the given component as child of this component at the specific index.static <T extends ComponentEvent<?>>
RegistrationComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener) Adds a listener for an event of the given type to thecomponent.static <T extends ComponentEvent<?>>
RegistrationComponentUtil.addListener(Component component, Class<T> eventType, ComponentEventListener<T> listener, Consumer<DomListenerRegistration> domListenerConsumer) Adds a listener for an event of the given type to thecomponent, and customizes the corresponding DOM event listener with the given consumer.voidAdds the given component as a modal child to the UI, making the UI and all other (existing) components added to the UI impossible for the user to interact with.static ShortcutRegistrationShortcuts.addShortcutListener(Component lifecycleOwner, ShortcutEventListener listener, Key key, KeyModifier... keyModifiers) Invoke aShortcutEventListenerwhen the shortcut is invoked.static ShortcutRegistrationShortcuts.addShortcutListener(Component lifecycleOwner, Command command, Key key, KeyModifier... keyModifiers) Invoke aCommandwhen the shortcut is invoked.voidUI.addToModalComponent(Component component) Add component as child to modal component if one is active.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> TGets a data instance with the given type, ornullif there is no such instance.static ObjectGets a data instance with the given key, ornullif no data has been set for that key.static Collection<?>ComponentUtil.getListeners(Component component, Class<? extends ComponentEvent> eventType) Returns all listeners that match or extend the given event type.static ComponentComponentUtil.getParentUsingComposite(Composite<?> composite, Component component) Gets the parent of the given component, which is inside the given composite.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 intReturns the index of the given component.static booleanComponentUtil.isCompositeContent(Composite<?> composite, Component component) Checks if the given component is inside aCompositechain, i.e.Fluently define theComponentonto which the shortcut's listener is bound.static voidComponentUtil.onComponentAttach(Component component, boolean initialAttach) Handles triggering theonAttachmethod and firing theAttachEventfor the given component when it has been attached to a UI.static voidComponentUtil.onComponentDetach(Component component) Handles triggering theonDetachmethod and firing theDetachEventfor the given component right before it is detached from a UI.default voidRemoves the given child components from this component.default voidReplaces the component in the container with another one without changing position.voidUI.setChildComponentModal(Component childComponent, boolean modal) Makes the child component modal or modeless.static <T> voidStores an instance of a specific type for the given component.static voidStores a arbitrary value for the given component.protected static voidComponent.setElement(Component component, Element element) Initializes the root element of a component.default voidHasHelper.setHelperComponent(Component component) Adds the given component into helper slot of component, replacing any existing helper component.static RegistrationShortcuts.setShortcutListenOnElement(String elementLocatorJs, Component listenOnComponent) Setup an element, that is only accessible on the browser (not server side), to listen for shortcut events on and delegate to the given component.Method parameters in com.vaadin.flow.component with type arguments of type ComponentModifier and TypeMethodDescriptiondefault voidHasComponents.add(Collection<Component> components) Adds the given components as children of this component.static voidComponentUtil.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,StyleSheetandUses).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 voidComponentUtil.registerComponentClass(String tag, Class<? extends Component> componentClass) Registers a component class with a specific HTML tag.default voidHasComponents.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.protectedHtmlContainer(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.internal
Classes in com.vaadin.flow.component.internal with type parameters of type ComponentModifier and TypeClassDescriptionclassAbstractFieldSupport<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.LocationComponentTracker.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.LocationComponentTracker.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.voidUIInternals.setActiveDragSourceComponent(Component activeDragSourceComponent) Sets the drag source of an active HTML5 drag event.voidUIInternals.setChildModal(Component child) Makes an existing child component modal.voidUIInternals.setChildModeless(Component child) Sets the given child modeless.voidUIInternals.showRouteTarget(Location viewLocation, Component target, List<RouterLayout> layouts) Shows a route target in the related UI.static voidComponentTracker.trackAttach(Component component) Tracks the location where the component was attached.static voidComponentTracker.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 TypeMethodDescriptionvoidUIInternals.addComponentDependencies(Class<? extends Component> componentClass) Adds the dependencies defined usingStyleSheetorJavaScripton the given Component class.Constructors in com.vaadin.flow.component.internal with parameters of type 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.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.booleanDeprecatedPolymerPublishedEventHandler.isTemplateModelValue(Component instance, elemental.json.JsonValue argValue, Class<?> convertedType) Deprecated.Validate that the given Component instance is a PolymerTemplate and that the value can be converted.Constructors in com.vaadin.flow.component.template.internal with parameters of type Component -
Uses of Component in com.vaadin.flow.component.webcomponent
Classes in com.vaadin.flow.component.webcomponent with type parameters of type ComponentModifier and TypeInterfaceDescriptioninterfacePropertyConfiguration<C extends Component,P extends Serializable> Offers a fluent API for configuring the properties of embedded web components produced byWebComponentExporter.final classWebComponent<C extends Component>Acts as a proxy to the web component root onto which the exporterComponentis added.interfaceWebComponentConfiguration<C extends Component>Result of defining an embeddable web component usingWebComponentExporter.Subclasses of Component in com.vaadin.flow.component.webcomponentModifier and TypeClassDescriptionclassCustom UI for use with WebComponents served from the server.classWrapper component for a web component that exposesClientCallablemethods that the client-side components expect to be available.Methods in com.vaadin.flow.component.webcomponent with type parameters of type Component -
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 voidElementStateProvider.setComponent(StateNode node, Component component) Defines a mapping between the element and the given component.static voidElementUtil.setComponent(Element element, Component component) Defines a mapping between this element and the givenComponent. -
Uses of Component in com.vaadin.flow.internal
Method parameters in com.vaadin.flow.internal with type arguments of type ComponentModifier and TypeMethodDescriptionAnnotationReader.getCssImportAnnotations(Class<? extends Component> componentClass) static List<JavaScript>AnnotationReader.getJavaScriptAnnotations(Class<? extends Component> componentClass) Finds allJavaScriptannotations on the givenComponentclass, its super classes and implemented interfaces.AnnotationReader.getJsModuleAnnotations(Class<? extends Component> componentClass) static List<StyleSheet>AnnotationReader.getStyleSheetAnnotations(Class<? extends Component> componentClass) Finds allStyleSheetannotations on the givenComponentclass, its super classes and implemented interfaces. -
Uses of Component in com.vaadin.flow.internal.nodefeature
Methods in com.vaadin.flow.internal.nodefeature that return types with arguments of type 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 TypeMethodDescriptionvoidComponentMapping.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 TypeMethodDescriptionvoidElementData.setJavaClass(Class<? extends Component> componentClass) -
Uses of Component in com.vaadin.flow.internal.streams
Constructors in com.vaadin.flow.internal.streams with parameters of type ComponentModifierConstructorDescriptionUploadCompleteEvent(Component source) Creates a new event using the given source.UploadStartEvent(Component source) Creates a new event using the given source. -
Uses of Component in com.vaadin.flow.router
Subclasses of Component in com.vaadin.flow.routerModifier and TypeClassDescriptionclassThis is abstract error view for routing exceptions.classThis is a basic default error view shown on exceptions during navigation.classThis is a default error view shown on access denied routing exceptions.classThis is a basic default error view shown on routing exceptions.classA link that handles navigation internally usingRouterinstead of loading a new page in the browser.Methods in com.vaadin.flow.router with type parameters of type 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()GetRoutenavigation 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 themenuClassrecord component.Method parameters in com.vaadin.flow.router with type arguments of type ComponentModifier and TypeMethodDescriptionvoidForward the navigation to show the given component instead of the component that is currently about to be displayed.voidBeforeEvent.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.voidBeforeEvent.forwardTo(Class<? extends Component> forwardTargetComponent, RouteParameters parameters) Forward the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.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.booleanRoutesChangedEvent.isRouteAdded(Class<? extends Component> clazz) Determines if a given route navigation target was added for this change.booleanRouteConfiguration.isRouteRegistered(Class<? extends Component> route) Check if the route is available as a registered target.booleanRoutesChangedEvent.isRouteRemoved(Class<? extends Component> clazz) Determines if a given route navigation target was removed for this change.voidRouteConfiguration.removeRoute(Class<? extends Component> navigationTarget) Remove the given navigation target route registration.voidRouteConfiguration.removeRoute(String path, Class<? extends Component> navigationTarget) Remove only the specified navigationTarget from the path and not other targets if they exist for the same path.voidReroutes the navigation to show the given component instead of the component that is currently about to be displayed.voidBeforeEvent.rerouteTo(Class<? extends Component> routeTargetType, RouteParameters parameters) Reroutes the navigation to show the given component with given route parameters instead of the component that is currently about to be displayed.voidRouteConfiguration.setAnnotatedRoute(Class<? extends Component> navigationTarget) Giving a navigation target here will handle theRouteannotation to get the path and also register anyRouteAliasthat may be on the class.voidNavigationState.setNavigationTarget(Class<? extends Component> navigationTarget) Sets the navigation target of this state.voidRouteConfiguration.setParentAnnotatedRoute(String path, Class<? extends Component> navigationTarget) Register a navigation target on the specified path.voidRegister a navigation target with specified path and with no parent layouts.voidRouteConfiguration.setRoute(String path, Class<? extends Component> navigationTarget, Class<? extends RouterLayout>... parentChain) Register a navigation target with specified path and given parent layout chain.voidRouteConfiguration.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain) Register a navigation target with specified path and given parent layout chain.voidSet the navigation target for this link.voidRouterLink.setRoute(Router router, Class<? extends Component> navigationTarget, RouteParameters parameters) Set the navigation target for this link.voidSet the navigation target for this link.voidRouterLink.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 aMenuDatarecord 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 voidAbstractNavigationStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent) Notify the navigation target about the status of the navigation.protected voidErrorStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent) protected voidNavigationStateRenderer.notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent) Method parameters in com.vaadin.flow.router.internal with type arguments of type ComponentModifier and TypeMethodDescriptionprotected voidAbstractRouteRegistry.addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>, Class<? extends Component>> exceptionTargetsMap) Add the given error target to the exceptionTargetMap.protected voidAbstractRouteRegistry.addErrorTarget(Class<? extends Component> target, Map<Class<? extends Exception>, Class<? extends Component>> exceptionTargetsMap) Add the given error target to the exceptionTargetMap.static voidHasUrlParameterFormat.checkMandatoryParameter(Class<? extends Component> navigationTarget, RouteParameters parameters) Verify whether the navigationTarget has mandatory parameter and complies with the given parameter values.booleanRouteTarget.containsTarget(Class<? extends Component> target) Check if navigation target is present in current target.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 theRouteTargetinstance 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 StringHasUrlParameterFormat.getTemplate(String urlBase, Class<? extends Component> navigationTarget) Gets the template for the given url base by appending the parameter according to the given navigationTarget if it's implementingHasUrlParameterbooleanAbstractRouteRegistry.hasMandatoryParameter(Class<? extends Component> navigationTarget) booleanConfiguredRoutes.hasRouteTarget(Class<? extends Component> target) Check it the given route target has been registered to the configuration.voidAbstractRouteRegistry.removeRoute(Class<? extends Component> navigationTarget) voidAbstractRouteRegistry.removeRoute(String path, Class<? extends Component> navigationTarget) voidConfigureRoutes.removeRoute(Class<? extends Component> target) Remove the target completely from the configuration.voidConfigureRoutes.removeRoute(String template, Class<? extends Component> targetRoute) Remove navigation target for given template.voidAbstractRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain) voidSet a newRouteTargetfor the given template.voidConfigureRoutes.setRoute(String template, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain) Set a newRouteTargetfor the given template.voidConfigureRoutes.setTargetRoute(Class<? extends Component> navigationTarget, String path) Put a new target route for Class-to-path mapping.Constructor parameters in com.vaadin.flow.router.internal with type arguments of type 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 theRouteTargetinstance 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) booleanRouteRegistry.hasMandatoryParameter(Class<? extends Component> navigationTarget) Check if the given navigationTarget requires parameters.voidRouteRegistry.removeRoute(Class<? extends Component> navigationTarget) Remove the given navigation target route registration.voidRouteRegistry.removeRoute(String path, Class<? extends Component> navigationTarget) Remove navigationTarget for the path.voidRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain) Register a navigation target with specified path and given parent layout chain.Constructor parameters in com.vaadin.flow.server with type arguments of type 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 voidNavigationAccessControl.setLoginView(Class<? extends Component> loginView) Sets the Flow login view to use.voidViewAccessChecker.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 StringBundleUtils.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 TypeMethodDescriptionvoidApplicationRouteRegistry.setErrorNavigationTargets(Set<Class<? extends Component>> errorNavigationTargets) Set error handler navigation targets.voidApplicationRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain) booleanNavigationTargetFilter.testNavigationTarget(Class<? extends Component> navigationTarget) Tests whether the given navigation target class should be included. -
Uses of Component in com.vaadin.flow.server.streams
Methods in com.vaadin.flow.server.streams that return ComponentModifier and TypeMethodDescriptionDownloadEvent.getOwningComponent()Get ownerComponentfor this event.TransferContext.getOwningComponent()Get ownerComponentfor this data transfer.UploadEvent.getOwningComponent()Get ownerComponentfor this event. -
Uses of Component in com.vaadin.flow.server.webcomponent
Classes in com.vaadin.flow.server.webcomponent with type parameters of type ComponentModifier and TypeClassDescriptionfinal classPropertyConfigurationImpl<C extends Component,P extends Serializable> For internal use only.final classWebComponentBinding<C extends Component>Represents a single instance of a exported web component instance embedded onto a host page.Methods in com.vaadin.flow.server.webcomponent with type parameters of type 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 specificComponenttype.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 StringWebComponentGenerator.generateModule(WebComponentConfiguration<? extends Component> webComponentConfiguration, String frontendURI, String themeName) Generate web component html/JS for given tag and class.static StringWebComponentGenerator.generateModule(WebComponentExporterFactory<? extends Component> factory, String frontendURI, String themeName) Generate web component html/JS for given exporter factory.booleanWebComponentConfigurationRegistry.setConfigurations(Set<WebComponentConfiguration<? extends Component>> configurations) Registers all available web component configurations to the registry.protected voidWebComponentConfigurationRegistry.updateRegistry(Set<WebComponentConfiguration<? extends Component>> configurations) Internal method for updating registry.