Index

A B C D E F G H I J K L M N O P Q R S T U V W Y Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

A - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <a>.
ABORT - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
absolute() - Element in annotation interface com.vaadin.flow.router.Route
Ignore route prefixes from parent layouts and only use the path defined in this annotation.
absolute() - Element in annotation interface com.vaadin.flow.router.RouteAlias
Have the route chain break on defined class and not take into notice any more parent layout route prefixes.
absolute() - Element in annotation interface com.vaadin.flow.router.RoutePrefix
Have the route chain break on defined class and not take into notice any more parent layout route prefixes.
ABSOLUTE - Enum constant in enum class com.vaadin.flow.dom.Style.Position
 
AbstractAnnotationValidator - Class in com.vaadin.flow.server.startup
Validation class that contains common logic to checks that specific annotations are not configured wrong.
AbstractAnnotationValidator() - Constructor for class com.vaadin.flow.server.startup.AbstractAnnotationValidator
 
AbstractAttachDetachEvent - Class in com.vaadin.flow.component.internal
Internal helper for AttachEvent and DetachEvent.
AbstractAttachDetachEvent(Component) - Constructor for class com.vaadin.flow.component.internal.AbstractAttachDetachEvent
Creates a new event with the given component as source.
AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T> - Class in com.vaadin.flow.component
An abstract field class that is backed by a composite component.
AbstractCompositeField(T) - Constructor for class com.vaadin.flow.component.AbstractCompositeField
Creates a new field.
AbstractConfiguration - Interface in com.vaadin.flow.server
Defines a base contract for configuration (e.g.
AbstractConfigurationFactory - Class in com.vaadin.flow.server.startup
A configuration factory base logic which reads the token file.
AbstractConfigurationFactory() - Constructor for class com.vaadin.flow.server.startup.AbstractConfigurationFactory
 
AbstractDeploymentConfiguration - Class in com.vaadin.flow.server
An abstract base class for DeploymentConfiguration implementations.
AbstractDeploymentConfiguration(Map<String, String>) - Constructor for class com.vaadin.flow.server.AbstractDeploymentConfiguration
Creates a new configuration based on properties.
AbstractField<C extends AbstractField<C,T>,T> - Class in com.vaadin.flow.component
An abstract implementation of a field, or a Component allowing user input.
AbstractField(Element, T) - Constructor for class com.vaadin.flow.component.AbstractField
Creates a new field with the given element instance.
AbstractField(T) - Constructor for class com.vaadin.flow.component.AbstractField
Creates a new field with an element created based on the Tag annotation of the sub class.
AbstractField.ComponentValueChangeEvent<C extends Component,V> - Class in com.vaadin.flow.component
Value change event fired by components.
AbstractFieldSupport<C extends Component & HasValue<AbstractField.ComponentValueChangeEvent<C,T>,T>,T> - Class in com.vaadin.flow.component.internal
Encapsulates all the logic required for a typical field implementation.
AbstractFieldSupport(C, T, SerializableBiPredicate<T, T>, SerializableConsumer<T>) - Constructor for class com.vaadin.flow.component.internal.AbstractFieldSupport
Creates a new field support.
AbstractInjectableElementInitializer - Class in com.vaadin.flow.component.template.internal
Generic initializer logic.
AbstractInjectableElementInitializer(Element) - Constructor for class com.vaadin.flow.component.template.internal.AbstractInjectableElementInitializer
Creates an initializer for the element.
AbstractListChange<T extends Serializable> - Class in com.vaadin.flow.internal.change
Change describing an operation (add/remove) in a list node feature.
AbstractListChange(NodeList<T>, int) - Constructor for class com.vaadin.flow.internal.change.AbstractListChange
Creates a new list change.
AbstractLookupInitializer - Interface in com.vaadin.flow.di
SPI for customizing lookup in applications inside Servlet 5.0 containers.
AbstractNavigationStateRenderer - Class in com.vaadin.flow.router.internal
Base class for navigation handlers that target a navigation state.
AbstractNavigationStateRenderer(NavigationState) - Constructor for class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
Creates a new renderer for the given navigation state.
AbstractNodeStateProvider - Class in com.vaadin.flow.dom.impl
Abstract implementation of the ElementStateProvider related to the composition essence of the provider.
AbstractNodeStateProvider() - Constructor for class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
AbstractPropertyConfiguration - Class in com.vaadin.flow.server
Provides a configuration based on string properties.
AbstractPropertyConfiguration(Map<String, String>) - Constructor for class com.vaadin.flow.server.AbstractPropertyConfiguration
Creates a new instance with given properties.
AbstractPropertyMap - Class in com.vaadin.flow.internal.nodefeature
Abstract class to be used as a parent for node maps which supports setting properties in a map.
AbstractPropertyMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Creates a new element property map for the given node.
AbstractRouteRegistry - Class in com.vaadin.flow.router.internal
AbstractRouteRegistry with locking support and configuration.
AbstractRouteRegistry() - Constructor for class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
AbstractRouteRegistry.Configuration - Interface in com.vaadin.flow.router.internal
Configuration interface to use for updating the configuration entity.
AbstractRouteRegistryInitializer - Class in com.vaadin.flow.server.startup
Common validation methods for route registry initializer.
AbstractRouteRegistryInitializer() - Constructor for class com.vaadin.flow.server.startup.AbstractRouteRegistryInitializer
 
AbstractRpcInvocationHandler - Class in com.vaadin.flow.server.communication.rpc
Abstract invocation handler implementation with common methods.
AbstractRpcInvocationHandler() - Constructor for class com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
 
AbstractServerHandlers<T> - Class in com.vaadin.flow.internal.nodefeature
Abstract class for collecting Methods which are published as serverObject.<name> on the client side.
AbstractServerHandlers(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Creates a new meta information list for the given state node.
AbstractSinglePropertyField<C extends AbstractField<C,T>,T> - Class in com.vaadin.flow.component
Abstract field that is based on a single element property.
AbstractSinglePropertyField(String, T, boolean) - Constructor for class com.vaadin.flow.component.AbstractSinglePropertyField
Creates a new field that uses a property value without any conversion.
AbstractSinglePropertyField(String, T, Class<P>, SerializableBiFunction<C, P, T>, SerializableBiFunction<C, T, P>) - Constructor for class com.vaadin.flow.component.AbstractSinglePropertyField
Creates a new field that uses a property value with the given contextual converters for producing a model value.
AbstractSinglePropertyField(String, T, Class<P>, SerializableFunction<P, T>, SerializableFunction<T, P>) - Constructor for class com.vaadin.flow.component.AbstractSinglePropertyField
Creates a new field that uses a property value with the given stateless converters for producing a model value.
AbstractStreamResource - Class in com.vaadin.flow.server
Abstract stream resource class.
AbstractStreamResource() - Constructor for class com.vaadin.flow.server.AbstractStreamResource
 
AbstractTaskClientGenerator - Class in com.vaadin.flow.server.frontend
Abstract class for generating client files.
AbstractTaskClientGenerator() - Constructor for class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
 
AbstractTextElementStateProvider - Class in com.vaadin.flow.dom.impl
Abstract element state provider for text nodes.
AbstractTextElementStateProvider() - Constructor for class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
AbstractTheme - Interface in com.vaadin.flow.theme
Abstract theme definition class for defining theme variables when in use.
accept(Element) - Method in interface com.vaadin.flow.dom.ChildElementConsumer
This callback method is called when the request initiated by the Node.appendChild(Element...) method is successfully executed.
accept(NodeVisitor) - Method in class com.vaadin.flow.dom.Node
Applies the visitor for the node.
accept(OutputStream, VaadinSession) - Method in interface com.vaadin.flow.server.StreamResourceWriter
Handles stream (writes data to it) using session as a context.
accept(Map<String, String>) - Method in class com.vaadin.flow.component.template.internal.AbstractInjectableElementInitializer
 
accept(T, U, V) - Method in interface com.vaadin.flow.function.SerializableTriConsumer
Performs the action.
ACCEPT - Static variable in interface com.vaadin.flow.component.Key
The Accept, Commit, or OK key or button.
ACCEPTED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (202) indicating that a request was accepted for processing, but was not completed.
acceptsBrotliResource(HttpServletRequest) - Method in class com.vaadin.flow.internal.ResponseWriter
Returns whether it is ok to serve a Brotli version of the given resource.
acceptsGzippedResource(HttpServletRequest) - Method in class com.vaadin.flow.internal.ResponseWriter
Returns whether it is ok to serve a gzipped version of the given resource.
access(Command) - Method in class com.vaadin.flow.component.UI
Provides exclusive access to this UI from outside a request handling thread.
access(Command) - Method in class com.vaadin.flow.server.VaadinSession
Provides exclusive access to this session from outside a request handling thread.
AccessAnnotationChecker - Class in com.vaadin.flow.server.auth
Checks if a given user has access to a given method.
AccessAnnotationChecker() - Constructor for class com.vaadin.flow.server.auth.AccessAnnotationChecker
 
accessLater(SerializableConsumer<T>, SerializableRunnable) - Method in class com.vaadin.flow.component.UI
Wraps the given access task as a consumer that passes a value to the given task with this UI locked.
accessLater(SerializableRunnable, SerializableRunnable) - Method in class com.vaadin.flow.component.UI
Wraps the given access task as a runnable that runs the given task with this UI locked.
accessSession(VaadinSession, Command) - Method in class com.vaadin.flow.server.VaadinService
Implementation for VaadinSession.access(Command).
accessSynchronously(Command) - Method in class com.vaadin.flow.component.UI
Locks the session of this UI and runs the provided command right away.
accessSynchronously(Command) - Method in class com.vaadin.flow.server.VaadinSession
Locks this session and runs the provided Command right away.
add(int, StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
add(int, StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
add(int, StateNode) - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
add(int, StateNode, String) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Inserts an item supplied with payload type at the given index of the list.
add(int, StateNode, String, JsonValue) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Inserts an item supplied with payload data at the given index of the list.
add(int, StateNode, String, String) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Inserts an item supplied with payload data at the given index of the list.
add(int, T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Inserts an item at the given index of the list.
add(int, T) - Method in class com.vaadin.flow.internal.nodefeature.SerializableNodeList
 
add(Component...) - Method in interface com.vaadin.flow.component.HasComponents
Adds the given components as children of this component.
add(Component...) - Method in class com.vaadin.flow.component.UI
Adds the given components to the UI.
add(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
add(Dependency) - Method in class com.vaadin.flow.component.internal.DependencyList
Adds the given dependency to be loaded by the client side.
add(String) - Method in interface com.vaadin.flow.component.HasComponents
Add the given text as a child of this component.
add(String) - Method in class com.vaadin.flow.dom.impl.ImmutableClassList
 
add(String) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
add(String, DomEventListener) - Method in class com.vaadin.flow.internal.nodefeature.ElementListenerMap
Add eventData for an event type.
add(String, String[]) - Method in class com.vaadin.flow.internal.nodefeature.PolymerEventListenerMap
Adds a listener for a event created from a template method.
add(Collection<Component>) - Method in interface com.vaadin.flow.component.HasComponents
Adds the given components as children of this component.
add(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Adds an item to the end of the list.
add(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
ADD - Static variable in interface com.vaadin.flow.component.Key
The numeric keypad's addition key, +.
addAfterNavigationListener(AfterNavigationListener) - Method in class com.vaadin.flow.component.internal.UIInternals
Add a listener that will be informed when new components have been attached and all navigation tasks have resolved.
addAfterNavigationListener(AfterNavigationListener) - Method in class com.vaadin.flow.component.UI
Add a listener that will be informed when new components have been attached and all navigation tasks have resolved.
addAll(Collection<? extends StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
addAll(Collection<? extends StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
addAll(Collection<? extends String>) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
addAll(Collection<? extends T>) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Adds all provided items to the end of the list.
addAndRemove(Collection<T>, T) - Static method in interface com.vaadin.flow.shared.Registration
Creates a registration by adding an item to a collection immediately and removing the item from the collection when the registration is removed.
addAttachListener(ComponentEventListener<AttachEvent>) - Method in interface com.vaadin.flow.component.AttachNotifier
Adds a attach listener to this component.
addAttachListener(ElementAttachListener) - Method in class com.vaadin.flow.dom.Element
Adds an attach listener for this element.
addAttachListener(Command) - Method in class com.vaadin.flow.internal.StateNode
Adds a command as an attach listener.
addBeforeClientResponseEntry(StateTree.BeforeClientResponseEntry) - Method in class com.vaadin.flow.internal.StateNode
Adds an entry to be executed before the next client response for this node.
addBeforeEnterListener(BeforeEnterListener) - Method in class com.vaadin.flow.component.internal.UIInternals
Add a listener that will be informed when a new set of components are going to be attached.
addBeforeEnterListener(BeforeEnterListener) - Method in class com.vaadin.flow.component.UI
Add a listener that will be informed when a new set of components are going to be attached.
addBeforeLeaveListener(BeforeLeaveListener) - Method in class com.vaadin.flow.component.internal.UIInternals
Add a listener that will be informed when old components are detached.
addBeforeLeaveListener(BeforeLeaveListener) - Method in class com.vaadin.flow.component.UI
Add a listener that will be informed when old components are detached.
addBlurListener(ComponentEventListener<BlurNotifier.BlurEvent<T>>) - Method in interface com.vaadin.flow.component.BlurNotifier
Add a listener to blur DOM events.
addBrowserWindowResizeListener(BrowserWindowResizeListener) - Method in class com.vaadin.flow.component.page.Page
Adds a new BrowserWindowResizeListener to this UI.
addClassName(String) - Method in interface com.vaadin.flow.component.HasStyle
Adds a CSS class name to this component.
addClassNames(String...) - Method in interface com.vaadin.flow.component.HasStyle
Adds one or more CSS class names to this component.
addClearAllAction(Runnable) - Static method in class com.vaadin.flow.internal.ReflectionCache
Adds an action that will be run when all reflection caches are cleared.
addClickListener(ComponentEventListener<ClickEvent<T>>) - Method in interface com.vaadin.flow.component.ClickNotifier
Adds a click listener to this component.
addClickShortcut(Key, KeyModifier...) - Method in interface com.vaadin.flow.component.ClickNotifier
Adds a shortcut which 'clicks' the Component which implements ClickNotifier interface.
addComponentAsFirst(Component) - Method in interface com.vaadin.flow.component.HasComponents
Adds the given component as the first child of this component.
addComponentAtIndex(int, Component) - Method in interface com.vaadin.flow.component.HasComponents
Adds the given component as child of this component at the specific index.
addComponentDependencies(Class<? extends Component>) - Method in class com.vaadin.flow.component.internal.UIInternals
Adds the dependencies defined using StyleSheet or JavaScript on the given Component class.
addCompositionEndListener(ComponentEventListener<CompositionEndEvent>) - Method in interface com.vaadin.flow.component.CompositionNotifier
Adds a compositionend listener to this component.
addCompositionStartListener(ComponentEventListener<CompositionStartEvent>) - Method in interface com.vaadin.flow.component.CompositionNotifier
Adds a compositionstart listener to this component.
addCompositionUpdateListener(ComponentEventListener<CompositionUpdateEvent>) - Method in interface com.vaadin.flow.component.CompositionNotifier
Adds a compositionupdate listener to this component.
addCookie(Cookie) - Method in interface com.vaadin.flow.server.VaadinResponse
Adds the specified cookie to the response.
addCssLines(Collection<String>, CssData, int) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
addDependencyFilter(DependencyFilter) - Method in class com.vaadin.flow.server.ServiceInitEvent
Adds a new dependency filter that will be used by this service.
addDetachListener(ComponentEventListener<DetachEvent>) - Method in interface com.vaadin.flow.component.DetachNotifier
Adds a detach listener to this component.
addDetachListener(ElementDetachListener) - Method in class com.vaadin.flow.dom.Element
Adds a detach listener for this element.
addDetachListener(Command) - Method in class com.vaadin.flow.internal.StateNode
Adds a command as a detach listener.
addDoubleClickListener(ComponentEventListener<ClickEvent<T>>) - Method in interface com.vaadin.flow.component.ClickNotifier
Adds a double click listener to this component.
addDynamicImport(String) - Method in class com.vaadin.flow.component.page.Page
Adds a dynamic import using a JavaScript expression which is supposed to return a JavaScript Promise.
addErrorTarget(Class<? extends Component>, Map<Class<? extends Exception>, Class<? extends Component>>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
Add the given error target to the exceptionTargetMap.
addEventData(String) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Add a JavaScript expression for extracting event data.
addEventDataElement(String) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Add a JavaScript expression for extracting an element as event data.
addEventListener(StateNode, String, DomEventListener) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Adds a DOM event listener.
addEventListener(StateNode, String, DomEventListener) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
addEventListener(StateNode, String, DomEventListener) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
addEventListener(StateNode, String, DomEventListener) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
addEventListener(String, DomEventListener) - Method in class com.vaadin.flow.dom.Element
Adds an event listener for the given event type.
addFavIcon(Inline.Position, String, String, String) - Method in class com.vaadin.flow.server.AppShellSettings
Append a fav icon link to initial page head.
addFavIcon(String, String, String) - Method in class com.vaadin.flow.server.AppShellSettings
Append a fav icon link to initial page head.
addFocusListener(ComponentEventListener<FocusNotifier.FocusEvent<T>>) - Method in interface com.vaadin.flow.component.FocusNotifier
Add a listener to focus DOM events.
addFocusShortcut(Key, KeyModifier...) - Method in interface com.vaadin.flow.component.Focusable
Adds a shortcut which focuses the Component which implements Focusable interface.
addGeneratedIndexContent(DeploymentConfiguration, Document) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
addGetParameter(String, String, int) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Adds the given get parameter to the URI and returns the new URI.
addGetParameter(String, String, String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Adds the given get parameter to the URI and returns the new URI.
addGetParameters(String, String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Adds the get parameters to the uri and returns the new uri that contains the parameters.
addHandlerMethod(Method, Collection<Method>) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Add a handler to the NodeList.
addHandlerMethod(Method, Collection<Method>) - Method in class com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers
Deprecated.
 
addHeartbeatListener(HeartbeatListener) - Method in class com.vaadin.flow.component.internal.UIInternals
 
addHeartbeatListener(HeartbeatListener) - Method in class com.vaadin.flow.component.UI
Add a listener that will be informed when this UI received a heartbeat from the client-side.
addIndexHtmlRequestListener(IndexHtmlRequestListener) - Method in class com.vaadin.flow.server.ServiceInitEvent
Adds a new Index HTML request listener that will be used by this service.
addInlineDependency(Inline, VaadinService) - Method in class com.vaadin.flow.server.InlineTargets
Inline contents from classpath file to head of initial page.
addInlineFromFile(Inline.Position, String, Inline.Wrapping) - Method in class com.vaadin.flow.server.AppShellSettings
Inline contents from classpath file to head of initial page.
addInlineFromFile(TargetElement, Inline.Position, String, Inline.Wrapping) - Method in class com.vaadin.flow.server.AppShellSettings
Inline contents from classpath file to head of initial page.
addInlineFromFile(String, Inline.Wrapping) - Method in class com.vaadin.flow.server.AppShellSettings
Inline contents from classpath file to append to head of initial page.
addInlineWithContents(Inline.Position, String, Inline.Wrapping) - Method in class com.vaadin.flow.server.AppShellSettings
Add content to head of initial page.
addInlineWithContents(TargetElement, Inline.Position, String, Inline.Wrapping) - Method in class com.vaadin.flow.server.AppShellSettings
Add content to the specified target of initial page.
addInlineWithContents(String, Inline.Wrapping) - Method in class com.vaadin.flow.server.AppShellSettings
Add content to append to head of initial page.
addInputListener(ComponentEventListener<InputEvent>) - Method in interface com.vaadin.flow.component.InputNotifier
Adds an input listener to this component.
ADDITIONAL_POSTINSTALL_PACKAGES - Static variable in class com.vaadin.flow.server.InitParameters
Packages, in addition to the internally used ones, to run postinstall scripts for.
addJavaScript(String) - Method in class com.vaadin.flow.component.page.Page
Adds the given JavaScript to the page and ensures that it is loaded successfully.
addJavaScript(String, LoadMode) - Method in class com.vaadin.flow.component.page.Page
Adds the given JavaScript to the page and ensures that it is loaded successfully.
addJavaScriptInvocation(PendingJavaScriptInvocation) - Method in class com.vaadin.flow.component.internal.UIInternals
Adds a JavaScript invocation to be sent to the client.
addJsModule(String) - Method in class com.vaadin.flow.component.page.Page
Adds the given external JavaScript module to the page and ensures that it is loaded successfully.
addKeyDownListener(ComponentEventListener<KeyDownEvent>) - Method in interface com.vaadin.flow.component.KeyNotifier
Adds a keydown listener to this component.
addKeyDownListener(Key, ComponentEventListener<KeyDownEvent>, KeyModifier...) - Method in interface com.vaadin.flow.component.KeyNotifier
Adds a keydown listener to this component, which will trigger only if the keys involved in the event match the key and modifiers parameters.
addKeyPressListener(ComponentEventListener<KeyPressEvent>) - Method in interface com.vaadin.flow.component.KeyNotifier
Adds a keypress listener to this component.
addKeyPressListener(Key, ComponentEventListener<KeyPressEvent>, KeyModifier...) - Method in interface com.vaadin.flow.component.KeyNotifier
Adds a keypress listener to this component, which will trigger only if the keys involved in the event match the key and modifiers parameters.
addKeyUpListener(ComponentEventListener<KeyUpEvent>) - Method in interface com.vaadin.flow.component.KeyNotifier
Adds a keyup listener to this component.
addKeyUpListener(Key, ComponentEventListener<KeyUpEvent>, KeyModifier...) - Method in interface com.vaadin.flow.component.KeyNotifier
Adds a keyup listener to this component, which will trigger only if the keys involved in the event match the key and modifiers parameters.
addLicenseChecker(Document) - Static method in class com.vaadin.flow.server.communication.IndexHtmlRequestHandler
Adds the needed overrides for the license checker to work when in development mode.
addLines(Collection<String>, String) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
addLink(Inline.Position, String) - Method in class com.vaadin.flow.server.AppShellSettings
Add a link to initial page head.
addLink(Inline.Position, String, String) - Method in class com.vaadin.flow.server.AppShellSettings
Add a link to initial page head.
addLink(Inline.Position, String, Map<String, String>) - Method in class com.vaadin.flow.server.AppShellSettings
Add a link to initial page head.
addLink(String) - Method in class com.vaadin.flow.server.AppShellSettings
Add a link to be appended to initial page head.
addLink(String, String) - Method in class com.vaadin.flow.server.AppShellSettings
Append a link to initial page head.
addLink(String, Map<String, String>) - Method in class com.vaadin.flow.server.AppShellSettings
Append a link to initial page head.
addListener(Component, Class<T>, ComponentEventListener<T>) - Static method in class com.vaadin.flow.component.ComponentUtil
Adds a listener for an event of the given type to the component.
addListener(Component, Class<T>, ComponentEventListener<T>, Consumer<DomListenerRegistration>) - Static method in class com.vaadin.flow.component.ComponentUtil
Adds a listener for an event of the given type to the component, and customizes the corresponding DOM event listener with the given consumer.
addListener(Class<T>, ComponentEventListener<T>) - Method in class com.vaadin.flow.component.Component
Adds a listener for an event of the given type.
addListener(Class<T>, ComponentEventListener<T>) - Method in class com.vaadin.flow.component.ComponentEventBus
Adds a listener for the given event type.
addListener(Class<T>, ComponentEventListener<T>, Consumer<DomListenerRegistration>) - Method in class com.vaadin.flow.component.ComponentEventBus
Adds a listener for the given event type, and customizes the corresponding DOM event listener with the given consumer.
addMetaTag(Inline.Position, String, String) - Method in class com.vaadin.flow.server.AppShellSettings
Add a meta tag to initial page head.
addMetaTag(String, String) - Method in class com.vaadin.flow.server.AppShellSettings
Add a meta tag to be appended to initial page head.
addModal(Component) - Method in class com.vaadin.flow.component.UI
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.
addPollListener(ComponentEventListener<PollEvent>) - Method in interface com.vaadin.flow.component.PollNotifier
Add a poll listener.
addProperty(String, boolean) - Method in class com.vaadin.flow.component.WebComponentExporter
Add an Boolean property to the exported web component identified by name.
addProperty(String, double) - Method in class com.vaadin.flow.component.WebComponentExporter
Add an Double property to the exported web component identified by name.
addProperty(String, int) - Method in class com.vaadin.flow.component.WebComponentExporter
Add an Integer property to the exported web component identified by name.
addProperty(String, JsonValue) - Method in class com.vaadin.flow.component.WebComponentExporter
Add an JsonValue property to the exported web component identified by name.
addProperty(String, String) - Method in class com.vaadin.flow.component.WebComponentExporter
Add an String property to the exported web component identified by name.
addPropertyChangeListener(StateNode, String, PropertyChangeListener) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Adds a property change listener.
addPropertyChangeListener(StateNode, String, PropertyChangeListener) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
addPropertyChangeListener(StateNode, String, PropertyChangeListener) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
addPropertyChangeListener(StateNode, String, PropertyChangeListener) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
addPropertyChangeListener(String, PropertyChangeListener) - Method in class com.vaadin.flow.dom.Element
Adds a property change listener which is triggered when the property's value is updated on the server side.
addPropertyChangeListener(String, PropertyChangeListener) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Adds a property change listener.
addPropertyChangeListener(String, String, PropertyChangeListener) - Method in class com.vaadin.flow.dom.Element
Adds a property change listener and configures the property to be synchronized to the server when a given DOM event is fired.
addRequestHandler(RequestHandler) - Method in class com.vaadin.flow.server.ServiceInitEvent
Adds a new request handler that will be used by this service.
addRequestHandler(RequestHandler) - Method in class com.vaadin.flow.server.VaadinSession
Adds a request handler to this session.
addRoutesChangeListener(RoutesChangedListener) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
addRoutesChangeListener(RoutesChangedListener) - Method in class com.vaadin.flow.router.RouteConfiguration
Add a listener that is notified when routes change for the registry.
addRoutesChangeListener(RoutesChangedListener) - Method in interface com.vaadin.flow.server.RouteRegistry
Adds the given route change listener to the registry.
addRoutesChangeListener(RoutesChangedListener) - Method in class com.vaadin.flow.server.SessionRouteRegistry
Adds the given route change listener to the registry.
addServiceDestroyListener(ServiceDestroyListener) - Method in class com.vaadin.flow.server.VaadinService
Adds a service destroy listener that gets notified when this service is destroyed.
addSessionDestroyListener(SessionDestroyListener) - Method in class com.vaadin.flow.server.VaadinService
Adds a listener that gets notified when a Vaadin service session that has been initialized for this service is destroyed.
addSessionInitListener(SessionInitListener) - Method in class com.vaadin.flow.server.VaadinService
Adds a listener that gets notified when a new Vaadin service session is initialized for this service.
addShortcutListener(Component, ShortcutEventListener, Key, KeyModifier...) - Static method in class com.vaadin.flow.component.Shortcuts
Invoke a ShortcutEventListener when the shortcut is invoked.
addShortcutListener(Component, Command, Key, KeyModifier...) - Static method in class com.vaadin.flow.component.Shortcuts
Invoke a Command when the shortcut is invoked.
addShortcutListener(ShortcutEventListener, Key, KeyModifier...) - Method in class com.vaadin.flow.component.UI
Registers a global shortcut tied to the UI which executes the given ComponentEventListener when invoked.
addShortcutListener(Command, Key, KeyModifier...) - Method in class com.vaadin.flow.component.UI
Registers a global shortcut tied to the UI which executes the given Command when invoked.
addSingleClickListener(ComponentEventListener<ClickEvent<T>>) - Method in interface com.vaadin.flow.component.ClickNotifier
Adds a single click listener to this component.
addStyleSheet(String) - Method in class com.vaadin.flow.component.page.Page
Adds the given style sheet to the page and ensures that it is loaded successfully.
addStyleSheet(String, LoadMode) - Method in class com.vaadin.flow.component.page.Page
Adds the given style sheet to the page and ensures that it is loaded successfully.
addThemeName(String) - Method in interface com.vaadin.flow.component.HasTheme
Adds a theme name to this component.
addThemeNames(String...) - Method in interface com.vaadin.flow.component.HasTheme
Adds one or more theme names to this component.
addTokenAsMetaTagsToHeadIfPresentInRequest(Element, VaadinRequest) - Static method in class com.vaadin.flow.internal.springcsrf.SpringCsrfTokenUtil
 
addToModalComponent(Component) - Method in class com.vaadin.flow.component.UI
Add component as child to modal component if one is active.
addUI(UI) - Method in class com.vaadin.flow.server.VaadinSession
Adds an initialized UI to this session.
addUIInitListener(UIInitListener) - Method in class com.vaadin.flow.server.VaadinService
Adds a listener that gets notified when a new UI has been initialized.
addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<C, T>>) - Method in class com.vaadin.flow.component.AbstractField
 
addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<C, T>>) - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<S, T>>) - Method in class com.vaadin.flow.component.AbstractCompositeField
 
addValueChangeListener(HasValue.ValueChangeListener<? super E>) - Method in interface com.vaadin.flow.component.HasValue
Adds a value change listener.
afterNavigation(AfterNavigationEvent) - Method in interface com.vaadin.flow.router.internal.AfterNavigationHandler
Callback executed after navigation has been executed.
afterNavigation(AfterNavigationEvent) - Method in class com.vaadin.flow.router.RouterLink
 
AfterNavigationEvent - Class in com.vaadin.flow.router
Event created after navigation completed.
AfterNavigationEvent(LocationChangeEvent) - Constructor for class com.vaadin.flow.router.AfterNavigationEvent
Construct event from a NavigationEvent.
AfterNavigationHandler - Interface in com.vaadin.flow.router.internal
The base interface for every AfterNavigationEvent handler.
AfterNavigationListener - Interface in com.vaadin.flow.router
A listener that may be added to the UI using UI.addAfterNavigationListener(AfterNavigationListener).
AfterNavigationObserver - Interface in com.vaadin.flow.router
Any attached component implementing this interface will receive an event after all navigation tasks have resolved.
AGAIN - Static variable in interface com.vaadin.flow.component.Key
The Again key.
ALL_CANDIDATES - Static variable in interface com.vaadin.flow.component.Key
The All Candidates key, which starts multi-candidate mode, in which multiple candidates are displayed for the ongoing input.
ALLOW_APPSHELL_ANNOTATIONS - Static variable in class com.vaadin.flow.server.Constants
Internal parameter which prevent validation for annotations which are allowed on an AppShell class
allowBrowserDefault() - Method in class com.vaadin.flow.component.ShortcutRegistration
Allows the default keyboard event handling when the shortcut is invoked.
allowEventPropagation() - Method in class com.vaadin.flow.component.ShortcutRegistration
Allow the event to propagate upwards in the DOM tree, when the shortcut is invoked.
allowInert(UI, JsonObject) - Method in class com.vaadin.flow.server.communication.ReturnChannelHandler
 
allowInert(UI, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
Specifies whether inert status should be ignored for an RPC invocation or not.
allowInert(UI, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.PublishedServerEventHandlerRpcHandler
 
AllowInert - Annotation Interface in com.vaadin.flow.component.internal
Makes a @ClientCallable method callable even if the UI is inert.
allowsChanges() - Method in class com.vaadin.flow.internal.nodefeature.ElementData
 
allowsChanges() - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Returns true if the underlying node may report its changes.
allowUpdates() - Element in annotation interface com.vaadin.flow.component.DomEvent
Controls RPC for the listener when the element is disabled.
allowUpdates() - Element in annotation interface com.vaadin.flow.component.Synchronize
Controls updates for the property from the client side to the server side when the element is disabled.
ALPHANUMERIC - Static variable in interface com.vaadin.flow.component.Key
The Alphanumeric key.
ALPINE_RELEASE_FILE_PATH - Static variable in class com.vaadin.flow.server.frontend.installer.Platform
 
ALT - Enum constant in enum class com.vaadin.flow.component.KeyModifier
KeyModifier for "Alt" key.
ALT - Static variable in interface com.vaadin.flow.component.Key
The Alt (Alternative) key.
ALT_GRAPH - Enum constant in enum class com.vaadin.flow.component.KeyModifier
KeyModifier for "Alt Graph" key.
ALT_GRAPH - Static variable in interface com.vaadin.flow.component.Key
The AltGr or AltGraph (Alternate Graphics) key.
ALT_LEFT - Static variable in interface com.vaadin.flow.component.Key
Alt , Option or .
ALT_RIGHT - Static variable in interface com.vaadin.flow.component.Key
Alt , Option or .This is labelled AltGr key on many keyboard layouts.
always() - Static method in class com.vaadin.flow.router.HighlightConditions
Always highlight.
ALWAYS - Enum constant in enum class com.vaadin.flow.dom.DisabledUpdateMode
If used then updates from the client side are allowed even for disabled element.
ALWAYS_TRUE_FILTER - Static variable in class com.vaadin.flow.internal.nodefeature.ElementListenerMap
Dummy filter string that always passes.
ALWAYS_USE_XHR_TO_SERVER - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
AmbiguousRouteConfigurationException - Exception in com.vaadin.flow.server
Exception indicating that the application's routes already has the navigation target with the given path.
AmbiguousRouteConfigurationException(String, Class<? extends Component>) - Constructor for exception com.vaadin.flow.server.AmbiguousRouteConfigurationException
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.
and(Predicate<? super T>) - Method in interface com.vaadin.flow.function.SerializablePredicate
 
ANDROID - Enum constant in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
 
AnnotationReader - Class in com.vaadin.flow.internal
Helper class for reading annotation data.
AnnotationValidator - Class in com.vaadin.flow.server.startup
Validation class that is run during servlet container initialization which checks that specific annotations are not configured wrong.
AnnotationValidator() - Constructor for class com.vaadin.flow.server.startup.AnnotationValidator
 
AnonymousAllowed - Annotation Interface in com.vaadin.flow.server.auth
A security annotation, granting anonymous access to the Vaadin endpoint (or its method) it is placed onto.
APP_SWITCH - Static variable in interface com.vaadin.flow.component.Key
Presents a list of recently-used applications which lets the user change apps quickly.
APP_THEME_ASSETS_PATTERN - Static variable in class com.vaadin.flow.server.StaticFileServer
 
APP_WC_MODE - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Whether the application is run in as a exported Web Component.
append(StateNode, String) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Appends an item supplied with payload type as last in the list.
append(StateNode, String, JsonValue) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Appends an item supplied with payload data as last in the list.
append(StateNode, String, String) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Appends an item supplied with payload data as last in the list.
append(Reader) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection.FragmentedMessage
Appends all the data from the given Reader to this message and returns whether the message was completed.
APPEND - Enum constant in enum class com.vaadin.flow.component.page.Inline.Position
 
appendChild(Element...) - Method in class com.vaadin.flow.dom.Node
Adds the given children as the last children of this element.
appendChild(Collection<Element>) - Method in class com.vaadin.flow.dom.Node
Adds the given children as the last children of this element.
appendVirtualChild(Element...) - Method in class com.vaadin.flow.dom.Node
Appends the given children as the virtual children of the element.
appendVirtualChild(StateNode, Element, String, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Append the given element as a virtual child.
appendVirtualChild(StateNode, Element, String, String) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
appendVirtualChild(StateNode, Element, String, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
appendVirtualChild(Collection<Element>) - Method in class com.vaadin.flow.dom.Node
Appends the given children as the virtual children of the element.
APPLICATION_META_INF_RESOURCES - Static variable in class com.vaadin.flow.server.frontend.TaskUpdateThemeImport
 
APPLICATION_PARAMETER_DEVMODE_ENABLE_SERIALIZE_SESSION - Static variable in class com.vaadin.flow.server.InitParameters
Configuration parameter name for enabling session serialization in development.
APPLICATION_STATIC_RESOURCES - Static variable in class com.vaadin.flow.server.frontend.TaskUpdateThemeImport
 
APPLICATION_THEME_ROOT - Static variable in class com.vaadin.flow.server.Constants
The name of the application theme root folder.
ApplicationClassLoaderAccess - Interface in com.vaadin.flow.internal
Allows to access the web application classloader.
ApplicationConfiguration - Interface in com.vaadin.flow.server.startup
Configuration on the application level.
ApplicationConfigurationFactory - Interface in com.vaadin.flow.server.startup
ApplicationConfigurationImpl(VaadinContext, Map<String, String>) - Constructor for class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl
 
ApplicationConstants - Class in com.vaadin.flow.shared
A utility class providing static constants.
ApplicationConstants() - Constructor for class com.vaadin.flow.shared.ApplicationConstants
 
ApplicationRouteRegistry - Class in com.vaadin.flow.server.startup
Registry for holding navigation target components found on servlet initialization.
ApplicationRouteRegistry(VaadinContext) - Constructor for class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Creates a new uninitialized route registry.
ApplicationRouteRegistry.ApplicationRouteRegistryWrapper - Class in com.vaadin.flow.server.startup
RouteRegistry wrapper class for storing the ApplicationRouteRegistry.
ApplicationRouteRegistryWrapper(ApplicationRouteRegistry) - Constructor for class com.vaadin.flow.server.startup.ApplicationRouteRegistry.ApplicationRouteRegistryWrapper
Create a application route registry wrapper.
apply(WebComponentExporterFactory<? extends Component>) - Method in class com.vaadin.flow.server.webcomponent.WebComponentExporterTagExtractor
 
apply(Field, String, String) - Method in interface com.vaadin.flow.component.template.internal.InjectableFieldConsumer
Performs this operation on the given arguments.
apply(SOURCE) - Method in interface com.vaadin.flow.function.ValueProvider
Provides a value from the given source object.
apply(T) - Method in interface com.vaadin.flow.component.ItemLabelGenerator
Gets a caption for the item.
AppShellConfigurator - Interface in com.vaadin.flow.component.page
An interface to configure application features and the host page where the Vaadin application is running.
AppShellPredicate - Interface in com.vaadin.flow.server.startup
Checks whether the provided class is an AppShellConfigurator eligible for the web application.
AppShellPredicateImpl() - Constructor for class com.vaadin.flow.di.LookupInitializer.AppShellPredicateImpl
Creates a new instance.
AppShellRegistry - Class in com.vaadin.flow.server
The registry class for AppShellConfigurator annotations.
AppShellRegistry.AppShellRegistryWrapper - Class in com.vaadin.flow.server
A wrapper class for storing the AppShellRegistry instance in the servlet context.
AppShellRegistryWrapper(AppShellRegistry) - Constructor for class com.vaadin.flow.server.AppShellRegistry.AppShellRegistryWrapper
Construct a wraper for an app-shell registry.
AppShellSettings - Class in com.vaadin.flow.server
Initial page settings class for modifying the application shell.
AppShellSettings() - Constructor for class com.vaadin.flow.server.AppShellSettings
 
ArchiveExtractionException - Exception in com.vaadin.flow.server.frontend.installer
Exception indicating a failure during extraction of an archive file.
ArchiveExtractionException(String) - Constructor for exception com.vaadin.flow.server.frontend.installer.ArchiveExtractionException
Exception with message.
ArchiveExtractionException(String, Throwable) - Constructor for exception com.vaadin.flow.server.frontend.installer.ArchiveExtractionException
Exceptioon with message and cause.
ARIA_LABEL_ATTRIBUTE_NAME - Static variable in class com.vaadin.flow.dom.ElementConstants
The aria-label attribute.
ARIA_LABEL_PROPERTY_NAME - Static variable in class com.vaadin.flow.dom.ElementConstants
ARIA_LABELLEDBY_ATTRIBUTE_NAME - Static variable in class com.vaadin.flow.dom.ElementConstants
The aria-labelledby attribute.
ARRAY_TYPE - Static variable in class com.vaadin.flow.internal.JsonCodec
Type id for a complex type array containing a JsonArray.
ARROW_DOWN - Static variable in interface com.vaadin.flow.component.Key
The down arrow key ().
ARROW_LEFT - Static variable in interface com.vaadin.flow.component.Key
The left arrow key ().
ARROW_RIGHT - Static variable in interface com.vaadin.flow.component.Key
The right arrow key ().
ARROW_UP - Static variable in interface com.vaadin.flow.component.Key
The up arrow key ().
ARTICLE - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <article>.
as(Class<T>) - Method in class com.vaadin.flow.dom.Element
Creates a new component instance using this element.
asArray() - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a collector that collects values into a JSON array.
asElement() - Method in class com.vaadin.flow.server.PwaIcon
Gets an Element presentation of the icon.
ASIDE - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <aside>.
ASSETS - Static variable in class com.vaadin.flow.server.Constants
The directory name inside dev bundle for the frontend assets.
ATMOSPHERE_MISSING_ERROR - Static variable in class com.vaadin.flow.server.VaadinService
 
AtmospherePushConnection - Class in com.vaadin.flow.server.communication
A PushConnection implementation using the Atmosphere push support that is by default included in Vaadin.
AtmospherePushConnection(UI) - Constructor for class com.vaadin.flow.server.communication.AtmospherePushConnection
Creates an instance connected to the given UI.
AtmospherePushConnection.FragmentedMessage - Class in com.vaadin.flow.server.communication
Represents a message that can arrive as multiple fragments.
AtmospherePushConnection.State - Enum Class in com.vaadin.flow.server.communication
 
ATTACH_EXISTING_ELEMENT - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
AttachEvent - Class in com.vaadin.flow.component
Event fired after a Component is attached to the UI.
AttachEvent(Component, boolean) - Constructor for class com.vaadin.flow.component.AttachEvent
Creates a new attach event with the given component as source.
attachExistingElement(StateNode, String, Element, ChildElementConsumer) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Attaches a child element with the given tagName which is the next sibling for the previousSibling.
attachExistingElement(StateNode, String, Element, ChildElementConsumer) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
attachExistingElement(StateNode, String, Element, ChildElementConsumer) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
AttachExistingElementFeature - Class in com.vaadin.flow.internal.nodefeature
Temporary storage of data required to handle existing element attachment callback from the client side.
AttachExistingElementFeature(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.AttachExistingElementFeature
Creates a new instance for the given node.
AttachExistingElementRpcHandler - Class in com.vaadin.flow.server.communication.rpc
RPC handler for a client-side response on attach existing element request.
AttachExistingElementRpcHandler() - Constructor for class com.vaadin.flow.server.communication.rpc.AttachExistingElementRpcHandler
 
AttachNotifier - Interface in com.vaadin.flow.component
Mixin interface for components that support adding attach listeners.
attachPotentialChild(Object) - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Attaches an object if it is a StateNode.
attachShadow() - Method in class com.vaadin.flow.dom.Element
Attaches shadow root node.
attachShadow(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Attaches the shadow root for the node.
attachShadow(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
attachShadow(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
attachShadow(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
AttachTemplateChildRpcHandler - Class in com.vaadin.flow.server.communication.rpc
RPC handler for a client-side response on attach existing element by id request.
AttachTemplateChildRpcHandler() - Constructor for class com.vaadin.flow.server.communication.rpc.AttachTemplateChildRpcHandler
 
ATTN - Static variable in interface com.vaadin.flow.component.Key
The Attn (Attention) key.
attributes() - Method in class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Gets the attribute names.
Attributes - Class in com.vaadin.flow.server
The Attributes class represents a set of attributes.
Attributes() - Constructor for class com.vaadin.flow.server.Attributes
 
attributeWithDefault(String, String) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for an attribute of the component's root element with a non-null default value.
attributeWithDefault(String, String, boolean) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for an attribute of the component's root element with a non-null default value.
AUDIO_BALANCE_LEFT - Static variable in interface com.vaadin.flow.component.Key
Adjusts audio balance toward the left.
AUDIO_BALANCE_RIGHT - Static variable in interface com.vaadin.flow.component.Key
Adjusts audio balance toward the right.
AUDIO_BASS_BOOST_DOWN - Static variable in interface com.vaadin.flow.component.Key
Reduces bass boosting or cycles downward through bass boost modes or states.
AUDIO_BASS_BOOST_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles bass boosting on and off.
AUDIO_BASS_BOOST_UP - Static variable in interface com.vaadin.flow.component.Key
Increases the amount of bass boosting, or cycles upward through a set of bass boost modes or states.
AUDIO_BASS_DOWN - Static variable in interface com.vaadin.flow.component.Key
Decreases the amount of bass.
AUDIO_BASS_UP - Static variable in interface com.vaadin.flow.component.Key
Increases the amount of bass.
AUDIO_FADER_FRONT - Static variable in interface com.vaadin.flow.component.Key
Adjusts the audio fader toward the front.
AUDIO_FADER_REAR - Static variable in interface com.vaadin.flow.component.Key
Adjusts the audio fader toward the rear.
AUDIO_SURROUND_MODE_NEXT - Static variable in interface com.vaadin.flow.component.Key
Selects the next available surround sound mode.
AUDIO_TREBLE_DOWN - Static variable in interface com.vaadin.flow.component.Key
Decreases the amount of treble.
AUDIO_TREBLE_UP - Static variable in interface com.vaadin.flow.component.Key
Increases the amount of treble.
AUDIO_VOLUME_DOWN - Static variable in interface com.vaadin.flow.component.Key
Decreases the audio volume.
AUDIO_VOLUME_MUTE - Static variable in interface com.vaadin.flow.component.Key
Mutes the audio.
AUDIO_VOLUME_UP - Static variable in interface com.vaadin.flow.component.Key
Increases the audio volume.
AUTO - Enum constant in enum class com.vaadin.flow.component.ScrollOptions.Behavior
 
AUTO - Enum constant in enum class com.vaadin.flow.dom.Style.Overflow
 
AUTOMATIC - Enum constant in enum class com.vaadin.flow.component.page.Inline.Wrapping
 
AUTOMATIC - Enum constant in enum class com.vaadin.flow.shared.communication.PushMode
Push is enabled.
AVR_INPUT - Static variable in interface com.vaadin.flow.component.Key
Changes the input mode on an external audio/video receiver (AVR) unit.
AVR_POWER - Static variable in interface com.vaadin.flow.component.Key
Toggles the power on an external AVR unit.

B

back() - Method in class com.vaadin.flow.component.page.History
Navigates back.
backgroundColor() - Element in annotation interface com.vaadin.flow.server.PWA
Background color of the application.
BACKQUOTE - Static variable in interface com.vaadin.flow.component.Key
`~ on a US keyboard.
BACKSLASH - Static variable in interface com.vaadin.flow.component.Key
Used for both the US \| (on the 101-key layout) and also for the keylocated between the " and Enter keys on row C of the 102-, 104- and 106-key layouts.
BACKSPACE - Static variable in interface com.vaadin.flow.component.Key
Backspace or .
BAD_GATEWAY - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.
BAD_REQUEST - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (400) indicating the request sent by the client was syntactically incorrect.
BASE_PROTOCOL_PREFIX - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Protocol used for referencing resources relative the base URI of the loaded page.
BASIC_TYPE_VALUE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
BasicElementStateProvider - Class in com.vaadin.flow.dom.impl
Implementation which stores data for basic elements, i.e.
BasicElementStyle - Class in com.vaadin.flow.dom.impl
Implementation of Style for BasicElementStateProvider.
BasicElementStyle(ElementStylePropertyMap) - Constructor for class com.vaadin.flow.dom.impl.BasicElementStyle
Creates an instance connected to the given map.
BasicTextElementStateProvider - Class in com.vaadin.flow.dom.impl
Handles storing and retrieval of the state information for a text node using a state node.
BasicTypeValue - Class in com.vaadin.flow.internal.nodefeature
The feature contains a value of the basic type.
BasicTypeValue(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.BasicTypeValue
Creates a new value map for the given node.
beanToJson(Object) - Static method in class com.vaadin.flow.internal.JsonUtils
Converts the given bean to JSON.
BeanUtil - Class in com.vaadin.flow.internal
Utility class for Java Beans information access.
beforeClientResponse(Component, SerializableConsumer<ExecutionContext>) - Method in class com.vaadin.flow.component.UI
Registers a task to be executed before the response is sent to the client.
beforeClientResponse(StateNode, SerializableConsumer<ExecutionContext>) - Method in class com.vaadin.flow.internal.StateTree
Registers a task to be executed before the response is sent to the client.
beforeEnter(BeforeEnterEvent) - Method in interface com.vaadin.flow.router.internal.BeforeEnterHandler
Callback executed before navigation to attaching Component chain is made.
beforeEnter(BeforeEnterEvent) - Method in class com.vaadin.flow.server.auth.ViewAccessChecker
 
BeforeEnterEvent - Class in com.vaadin.flow.router
Event created before navigation happens.
BeforeEnterEvent(NavigationEvent, Class<?>, RouteParameters, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEnterEvent
Constructs event from a NavigationEvent.
BeforeEnterEvent(NavigationEvent, Class<?>, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEnterEvent
Constructs event from a NavigationEvent.
BeforeEnterEvent(Router, NavigationTrigger, Location, Class<?>, UI, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEnterEvent
Constructs a new BeforeEnterEvent.
BeforeEnterEvent(Router, NavigationTrigger, Location, Class<?>, RouteParameters, UI, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEnterEvent
Constructs a new BeforeEnterEvent.
BeforeEnterHandler - Interface in com.vaadin.flow.router.internal
The base interface for every BeforeEnterEvent handler.
BeforeEnterListener - Interface in com.vaadin.flow.router
A listener that may be added to the UI using UI.addBeforeEnterListener(BeforeEnterListener).
BeforeEnterObserver - Interface in com.vaadin.flow.router
Any attached component implementing this interface will receive an event before a new navigation state is entered.
BeforeEvent - Class in com.vaadin.flow.router
Abstract before event class that has the common functionalities for BeforeLeaveEvent and BeforeEnterEvent.
BeforeEvent(NavigationEvent, Class<?>, RouteParameters, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEvent
Constructs event from a NavigationEvent.
BeforeEvent(NavigationEvent, Class<?>, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEvent
Constructs event from a NavigationEvent.
BeforeEvent(Router, NavigationTrigger, Location, Class<?>, UI, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEvent
Constructs a new BeforeEvent.
BeforeEvent(Router, NavigationTrigger, Location, Class<?>, RouteParameters, UI, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeEvent
Constructs a new BeforeEvent.
beforeLeave(BeforeLeaveEvent) - Method in interface com.vaadin.flow.router.internal.BeforeLeaveHandler
Callback executed before navigation to detaching Component chain is made.
BeforeLeaveEvent - Class in com.vaadin.flow.router
Event created before navigation happens.
BeforeLeaveEvent(NavigationEvent, Class<?>, RouteParameters, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeLeaveEvent
Constructs event from a NavigationEvent.
BeforeLeaveEvent(NavigationEvent, Class<?>, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeLeaveEvent
Constructs event from a NavigationEvent.
BeforeLeaveEvent(Router, NavigationTrigger, Location, Class<?>, UI, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeLeaveEvent
Constructs a new BeforeLeaveEvent.
BeforeLeaveEvent(Router, NavigationTrigger, Location, Class<?>, RouteParameters, UI, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.BeforeLeaveEvent
Constructs a new BeforeLeaveEvent.
BeforeLeaveEvent.ContinueNavigationAction - Class in com.vaadin.flow.router
The action to resume a postponed BeforeEnterEvent.
BeforeLeaveHandler - Interface in com.vaadin.flow.router.internal
The base interface for every BeforeLeaveEvent handler.
BeforeLeaveListener - Interface in com.vaadin.flow.router
A listener that may be added to the UI using UI.addBeforeLeaveListener(BeforeLeaveListener).
BeforeLeaveObserver - Interface in com.vaadin.flow.router
Any attached component implementing this interface will receive an event before leaving the current navigation state.
between(int, int) - Static method in class com.vaadin.flow.internal.Range
Creates a range between two integers.
bindLifecycleTo(Component) - Method in class com.vaadin.flow.component.ShortcutRegistration
Binds the shortcut's life cycle to that of the given Component.
bindProperty(PropertyConfigurationImpl<C, ? extends Serializable>, boolean, JsonValue) - Method in class com.vaadin.flow.server.webcomponent.WebComponentBinding
Adds a property to this web component binding based on the propertyConfiguration.
BLOCK - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
blur() - Method in interface com.vaadin.flow.component.Focusable
Calls the blur function at the client, making the component lose keyboard focus.
BlurEvent(C, boolean) - Constructor for class com.vaadin.flow.component.BlurNotifier.BlurEvent
BlurEvent base constructor.
BlurNotifier<T extends Component> - Interface in com.vaadin.flow.component
Mixin interface to handle blur events on components.
BlurNotifier.BlurEvent<C extends Component> - Class in com.vaadin.flow.component
Represents the DOM event "blur".
BODY - Enum constant in enum class com.vaadin.flow.component.page.TargetElement
 
BodySize - Annotation Interface in com.vaadin.flow.component.page
Defines the body size that will be added to the HTML of the host pages.
BOOLEAN - Static variable in class com.vaadin.flow.router.RouteParameterRegex
Boolean type regex.
booleanEqual(JsonValue, JsonValue) - Static method in class com.vaadin.flow.internal.JsonUtils
 
bootstrap(Lookup) - Method in interface com.vaadin.flow.function.VaadinApplicationInitializationBootstrap
Bootstraps Vaadin application initialization.
BOOTSTRAP_FILE_NAME - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the bootstrap file that is generated in frontend FrontendUtils.GENERATED folder.
BootstrapContext(VaadinRequest, VaadinResponse, VaadinSession, UI, Function<VaadinRequest, String>) - Constructor for class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Creates a new context instance using the given parameters.
BootstrapContext(VaadinRequest, VaadinResponse, VaadinSession, UI, Function<VaadinRequest, String>, Function<VaadinRequest, Location>) - Constructor for class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Creates a new context instance using the given parameters.
BootstrapException - Exception in com.vaadin.flow.server
A Vaadin internal runtime exception thrown when the writing of the bootstrap page in BootstrapHandler fails for some reason.
BootstrapException(String) - Constructor for exception com.vaadin.flow.server.BootstrapException
Constructs a new bootstrap exception with the specified detail message.
BootstrapException(String, Throwable) - Constructor for exception com.vaadin.flow.server.BootstrapException
Constructs a new bootstrap exception with the specified detail message and cause.
BootstrapHandler - Class in com.vaadin.flow.server
Request handler which handles bootstrapping of the application, i.e.
BootstrapHandler() - Constructor for class com.vaadin.flow.server.BootstrapHandler
Creates an instance of the handler with default BootstrapHandler.PageBuilder.
BootstrapHandler(BootstrapHandler.PageBuilder) - Constructor for class com.vaadin.flow.server.BootstrapHandler
Creates an instance of the handler using provided page builder.
BootstrapHandler.BootstrapContext - Class in com.vaadin.flow.server
Provides context information for the bootstrap process.
BootstrapHandler.BootstrapPageBuilder - Class in com.vaadin.flow.server
Builds bootstrap pages.
BootstrapHandler.BootstrapUriResolver - Class in com.vaadin.flow.server
The URI resolver used in the bootstrap process.
BootstrapHandler.PageBuilder - Interface in com.vaadin.flow.server
Interface for objects capable of building the bootstrap page.
BootstrapHandlerHelper - Class in com.vaadin.flow.internal
Helper methods for use in bootstrapping.
BootstrapInitialPredicate - Interface in com.vaadin.flow.server
The callback used by bootstrap handlers in order to know when a request needs to pre-render the UI and include the initial UIDL in the page.
bootstrapNpm() - Method in class com.vaadin.flow.server.communication.WebComponentProvider
 
BootstrapPageBuilder() - Constructor for class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
BootstrapUriResolver(UI) - Constructor for class com.vaadin.flow.server.BootstrapHandler.BootstrapUriResolver
Creates a new bootstrap resolver based on the given ui.
BootstrapUriResolver(String, VaadinSession) - Constructor for class com.vaadin.flow.server.BootstrapHandler.BootstrapUriResolver
Creates a new bootstrap resolver based on the given session.
BootstrapUrlPredicate - Interface in com.vaadin.flow.server
The callback used by bootstrap handlers in order to know when a request is a valid URL to render the page.
BORDER_BOX - Enum constant in enum class com.vaadin.flow.dom.Style.BoxSizing
 
BOTH - Enum constant in enum class com.vaadin.flow.dom.Style.Clear
 
BR - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <br>.
BRACKET_LEFT - Static variable in interface com.vaadin.flow.component.Key
[{ on a US keyboard.
BRACKET_RIGHT - Static variable in interface com.vaadin.flow.component.Key
]} on a US keyboard.
BREAK_SPACES - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
The behavior is identical to that of pre-wrap, except that: Any sequence of preserved white space always takes up space, including at the end of the line.
BRIGHT_BLUE - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 
BRIGHTNESS_DOWN - Static variable in interface com.vaadin.flow.component.Key
The Brightness Down key.
BRIGHTNESS_UP - Static variable in interface com.vaadin.flow.component.Key
The Brightness Up key.
browser - Variable in class com.vaadin.flow.server.VaadinSession
 
BROWSER_BACK - Static variable in interface com.vaadin.flow.component.Key
Navigates to the previous content or page in the current Web view's history.
BROWSER_FAVORITES - Static variable in interface com.vaadin.flow.component.Key
Opens the user's list of bookmarks/favorites.
BROWSER_FORWARD - Static variable in interface com.vaadin.flow.component.Key
Navigates to the next content or page in the current Web view's history.
BROWSER_HOME - Static variable in interface com.vaadin.flow.component.Key
Navigates to the user's preferred home page.
BROWSER_REFRESH - Static variable in interface com.vaadin.flow.component.Key
Refreshes the current page or content.
BROWSER_SEARCH - Static variable in interface com.vaadin.flow.component.Key
Activates the user's preferred search engine or the search interface within their browser.
BROWSER_STOP - Static variable in interface com.vaadin.flow.component.Key
Stops loading the currently displayed Web view or content.
BROWSER_TOO_OLD - Enum constant in enum class com.vaadin.flow.server.HandlerHelper.RequestType
Page showing that the browser is unsupported.
BrowserDetails - Class in com.vaadin.flow.shared
Parses the user agent string from the browser and provides information about the browser.
BrowserDetails(String) - Constructor for class com.vaadin.flow.shared.BrowserDetails
Create an instance based on the given user agent.
BrowserDetails.OperatingSystem - Enum Class in com.vaadin.flow.shared
Detected operating systems.
browserHasNewestVersion(HttpServletRequest, long) - Method in class com.vaadin.flow.server.StaticFileServer
Checks if the browser has an up to date cached version of requested resource using the "If-Modified-Since" header.
BrowserLiveReload - Interface in com.vaadin.flow.internal
Provides a way to reload browser tabs via web socket connection passed as a AtmosphereResource.
BrowserLiveReload.Backend - Enum Class in com.vaadin.flow.internal
Live reload enabling technology detected.
BrowserLiveReloadAccess - Class in com.vaadin.flow.internal
Deprecated.
BrowserLiveReloadAccess() - Constructor for class com.vaadin.flow.internal.BrowserLiveReloadAccess
Deprecated.
 
BrowserLiveReloadAccessor - Interface in com.vaadin.flow.internal
Provides API to access to the BrowserLiveReload instance by a VaadinService.
browserWindowResized(BrowserWindowResizeEvent) - Method in interface com.vaadin.flow.component.page.BrowserWindowResizeListener
Invoked when the browser window containing a UI has been resized.
BrowserWindowResizeEvent - Class in com.vaadin.flow.component.page
Event that is fired when a browser window containing a uI is resized.
BrowserWindowResizeEvent(Page, int, int) - Constructor for class com.vaadin.flow.component.page.BrowserWindowResizeEvent
Creates a new event.
BrowserWindowResizeListener - Interface in com.vaadin.flow.component.page
Listener that gets notified when the size of the browser window containing the uI has changed.
build() - Method in class com.vaadin.flow.router.NavigationStateBuilder
Returns the NavigationState instance that has been built so far and resets the internal state of this builder.
BUILD_FOLDER - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for the build folder.
BundleUtils - Class in com.vaadin.flow.server.frontend
 
BundleValidationUtil - Class in com.vaadin.flow.server.frontend
Bundle handling methods.
BundleValidationUtil() - Constructor for class com.vaadin.flow.server.frontend.BundleValidationUtil
 
BUTTON - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <button>.

C

CachedClassFinder(ClassFinder) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
It uses specified classFinder and caches scanned annotation.
calculateHash(String) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
CALL - Static variable in interface com.vaadin.flow.component.Key
The Call key; dials the number which has been entered.
callJsFunction(String, Serializable...) - Method in class com.vaadin.flow.dom.Element
Calls the given function on the element with the given arguments.
camelCaseToDashSeparated(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Converts a camelCase string into dash ("-") separated.
camelCaseToHumanFriendly(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Converts a camelCaseString to a human friendly format (Camel case string).
CAMERA - Static variable in interface com.vaadin.flow.component.Key
The Camera key; activates the camera.
CAMERA_FOCUS - Static variable in interface com.vaadin.flow.component.Key
The Focus key; focuses the camera.
CANCEL - Static variable in interface com.vaadin.flow.component.Key
The Cancel key.
cancelExecution() - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
 
cancelExecution() - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Cancel the javascript execution, if it was not yet sent to the browser for execution.
cancelPendingTitleUpdate() - Method in class com.vaadin.flow.component.internal.UIInternals
Cancels any pending page title update set via UIInternals.setTitle(String).
canEncodeWithoutTypeInfo(Class<?>) - Static method in class com.vaadin.flow.internal.JsonCodec
Helper for checking whether the type is supported by JsonCodec.encodeWithoutTypeInfo(Object).
canEncodeWithTypeInfo(Class<?>) - Static method in class com.vaadin.flow.internal.JsonCodec
Helper for checking whether the type is supported by JsonCodec.encodeWithTypeInfo(Object).
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.BootstrapHandler
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.HeartbeatHandler
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.IndexHtmlRequestHandler
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.UidlRequestHandler
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.WebComponentProvider
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.SynchronizedRequestHandler
Check whether a request may be handled by this handler.
CANNOT_ACQUIRE_CLASSLOADER_SEVERE - Static variable in class com.vaadin.flow.server.VaadinService
 
capitalize(String) - Static method in class com.vaadin.flow.internal.CaseUtil
Capitalizes the first character in the given string in a way suitable for use in code (methods, properties etc).
capitalize(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Capitalizes the first character in the given string in a way suitable for use in code (methods, properties etc).
CAPS_LOCK - Static variable in interface com.vaadin.flow.component.Key
The CapsLock or key.
CaseUtil - Class in com.vaadin.flow.internal
Utilities related to various case operations.
CENTER - Enum constant in enum class com.vaadin.flow.component.ScrollOptions.Alignment
 
CENTER - Enum constant in enum class com.vaadin.flow.dom.Style.TextAlign
 
CH - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the width of the "0" (zero).
CHANGE_FEATURE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the feature of a change.
CHANGE_FEATURE_TYPE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the feature type.
CHANGE_MAP_KEY - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the map key of the change.
CHANGE_NODE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding id of the node affected by a change.
CHANGE_PUT_NODE_VALUE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holder the node value of a put change.
CHANGE_PUT_VALUE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the value of a put change.
CHANGE_SPLICE_ADD - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding values to add for a splice.
CHANGE_SPLICE_ADD_NODES - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding nodes to add for a splice.
CHANGE_SPLICE_INDEX - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the index of a splice.
CHANGE_SPLICE_REMOVE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the number of items to remove for a splice.
CHANGE_TYPE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the type of a change.
CHANGE_TYPE_ATTACH - Static variable in class com.vaadin.flow.shared.JsonConstants
Change type for attaching nodes.
CHANGE_TYPE_CLEAR - Static variable in class com.vaadin.flow.shared.JsonConstants
Change type for list clear changes.
CHANGE_TYPE_DETACH - Static variable in class com.vaadin.flow.shared.JsonConstants
Change type for detaching nodes.
CHANGE_TYPE_NOOP - Static variable in class com.vaadin.flow.shared.JsonConstants
Change type for empty change (populate the feature on the client side only).
CHANGE_TYPE_PUT - Static variable in class com.vaadin.flow.shared.JsonConstants
Change type for map put changes.
CHANGE_TYPE_REMOVE - Static variable in class com.vaadin.flow.shared.JsonConstants
Change type for map remove changes.
CHANGE_TYPE_SPLICE - Static variable in class com.vaadin.flow.shared.JsonConstants
Change type for list splice changes.
CHANNEL_DOWN - Static variable in interface com.vaadin.flow.component.Key
Switches to the previous channel.
CHANNEL_UP - Static variable in interface com.vaadin.flow.component.Key
Switches to the next channel.
checkBeanValidationAvailable() - Static method in class com.vaadin.flow.internal.BeanUtil
Returns whether an implementation of JSR-303 version 1.0 or 1.1 is present on the classpath.
checkClassAccessibility(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Makes a check whether the clazz is externally accessible for instantiation (e.g.
checkHasLock() - Method in class com.vaadin.flow.server.VaadinSession
Potentially checks whether this session is currently locked by the current thread, and fails with a standard error message if not.
checkHasLock(String) - Method in class com.vaadin.flow.server.VaadinSession
Potentially checks whether this session is currently locked by the current thread, and fails with the given message if not.
checkMandatoryParameter(Class<? extends Component>, RouteParameters) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Verify whether the navigationTarget has mandatory parameter and complies with the given parameter values.
ChildElementConsumer - Interface in com.vaadin.flow.dom
Callback which allows to handle request to map a client side DOM element to the server Element instance.
CHROMEOS - Enum constant in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
 
ChunkInfo - Class in com.vaadin.flow.server.frontend.scanner
Identifier for a chunk or part of the JS bundle.
ChunkInfo(EntryPointType, String, List<String>, boolean) - Constructor for class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
CHUNKS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
A key in a Json object for chunks list.
CI_BUILD - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for enabling ci build for npm/pnpm.
CLASS_LIST - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ClassAttributeHandler - Class in com.vaadin.flow.dom.impl
Emulates the class attribute by delegating to Element.getClassList().
ClassAttributeHandler() - Constructor for class com.vaadin.flow.dom.impl.ClassAttributeHandler
 
ClassFinder - Interface in com.vaadin.flow.server.frontend.scanner
Interface for annotated and subclass class searches.
ClassFinder.CachedClassFinder - Class in com.vaadin.flow.server.frontend.scanner
Implementation that proxy and cache a real ClassFinder.
ClassFinder.DefaultClassFinder - Class in com.vaadin.flow.server.frontend.scanner
Implementation that searches for annotated classes or subclasses in a list of classes.
ClassInfo - Class in com.vaadin.flow.server.frontend.scanner
 
ClassInfo(String) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassInfo
 
ClassList - Interface in com.vaadin.flow.dom
Representation of the class names for an Element.
ClassLoaderAwareServletContainerInitializer - Interface in com.vaadin.flow.server.startup
Allows to load the implementation class by one classloader but accepts classes in ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext) method loaded by another classloader.
className() - Method in class com.vaadin.flow.component.internal.ComponentTracker.Location
 
clean() - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
clean() - Method in interface com.vaadin.flow.server.RouteRegistry
Clear all registered routes from the registry.
clear() - Method in interface com.vaadin.flow.component.HasValue
Resets the value to the empty one.
clear() - Method in class com.vaadin.flow.component.internal.DependencyTreeCache
Clears all the contents of the cache.
clear() - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
clear() - Method in class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
clear() - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
clear() - Method in interface com.vaadin.flow.dom.Style
Removes all set style properties.
clear() - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
clear() - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
clear() - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Removes all nodes, including those not known by the server.
clear() - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
clear() - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Removes the values for all stored keys.
clear() - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
clear() - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 
clear() - Method in class com.vaadin.flow.internal.ReflectionCache
Removes all mappings from this cache.
clear() - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Clear all maps from this configuration.
CLEAR - Static variable in interface com.vaadin.flow.component.Key
The Clear key.
clearAll() - Static method in class com.vaadin.flow.internal.CurrentInstance
Clears all current instances.
clearAll() - Static method in class com.vaadin.flow.internal.ReflectionCache
Clears all mappings from all reflection caches and related resources.
clearChanges() - Method in class com.vaadin.flow.internal.StateNode
Clears all changes recorded for this node.
clearLastHandledNavigation() - Method in class com.vaadin.flow.component.internal.UIInternals
Clear latest handled navigation location.
clearPendingSendToClient() - Method in class com.vaadin.flow.component.internal.DependencyList
Clears the list of dependencies which should be sent to the client.
ClickEvent<C extends Component> - Class in com.vaadin.flow.component
Event fired when a component is clicked.
ClickEvent(Component) - Constructor for class com.vaadin.flow.component.ClickEvent
Creates a new server-side click event with no additional information.
ClickEvent(Component, boolean, int, int, int, int, int, int, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.ClickEvent
Creates a new click event.
ClickNotifier<T extends Component> - Interface in com.vaadin.flow.component
Mixin interface for components that support adding click listeners to the their root elements.
CLIENT_DELEGATE_HANDLERS - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
CLIENT_ENGINE_PATH - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Path to the Vaadin client engine folder, relative to the context root.
CLIENT_NAVIGATE_TO - Static variable in class com.vaadin.flow.component.UI
 
CLIENT_SIDE - Enum constant in enum class com.vaadin.flow.router.NavigationTrigger
Navigation was triggered by client-side.
CLIENT_TO_SERVER_ID - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the parameter used to transmit the id of the client to server messages.
ClientCallable - Annotation Interface in com.vaadin.flow.component
Publishes the annotated method so it can be invoked from the client side using the notation this.$server.method().
ClientCallableHandlers - Class in com.vaadin.flow.internal.nodefeature
Methods which are published as element.$server.<name> on the client side.
ClientCallableHandlers(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ClientCallableHandlers
Creates a new meta information list for the given state node.
ClientViewPlaceholder() - Constructor for class com.vaadin.flow.component.UI.ClientViewPlaceholder
 
CLIP - Enum constant in enum class com.vaadin.flow.dom.Style.Overflow
 
close() - Method in class com.vaadin.flow.component.UI
Marks this UI to be detached from the session at the end of the current request, or the next request if there is no current request (if called from a background thread, for instance.)
close() - Method in class com.vaadin.flow.server.VaadinSession
Sets this session to be closed and all UI state to be discarded at the end of the current request, or at the end of the next request if there is no ongoing one.
CLOSE - Static variable in interface com.vaadin.flow.component.Key
Closes the current document or message.
CLOSED - Enum constant in enum class com.vaadin.flow.server.VaadinSessionState
The session is closed; all the UIs have been removed and SessionDestroyListeners have been called.
CLOSED_CAPTION_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles closed captioning on and off.
closeSession(VaadinSession) - Method in class com.vaadin.flow.server.VaadinService
Sets the given session to be closed and all its UI state to be discarded at the end of the current request, or at the end of the next request if there is no ongoing one.
CLOSING - Enum constant in enum class com.vaadin.flow.server.VaadinSessionState
The close method has been called; the session will be closed as soon as the current request ends.
CM - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing centimeters.
CODE_INPUT - Static variable in interface com.vaadin.flow.component.Key
The Code Input key, which enables code input mode, which lets the user enter characters by typing their code points (their Unicode character numbers, typically).
COLLABORATION_ENGINE_BACKEND - Static variable in class com.vaadin.experimental.FeatureFlags
 
COLLAPSE - Enum constant in enum class com.vaadin.flow.dom.Style.Visibility
 
collectAfterNavigationObservers(UI) - Static method in class com.vaadin.flow.router.EventUtil
Collect all Components implementing AfterNavigationObserver that are found in the given UI.
collectBeforeEnterObservers(Collection<? extends HasElement>, Collection<? extends HasElement>) - Static method in class com.vaadin.flow.router.EventUtil
Collect before enter observer instances based on what will be attached when a new view chain is applied.
collectBeforeEnterObserversFromChain(Collection<? extends HasElement>, Collection<? extends HasElement>) - Static method in class com.vaadin.flow.router.EventUtil
Collect before enter observer instances based on what will be attached when a new view chain is applied.
collectBeforeEnterObserversFromChainElement(HasElement, Collection<? extends HasElement>) - Static method in class com.vaadin.flow.router.EventUtil
Collect before enter observer instances in the element's hierarchy.
collectBeforeLeaveObservers(UI) - Static method in class com.vaadin.flow.router.EventUtil
Collect all Components implementing BeforeLeaveObserver connected to the given UI.
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.nodefeature.InertData
 
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Collects all changes that are recorded for this feature.
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
 
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
 
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.nodefeature.NodeValue
 
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.nodefeature.ServerSideFeature
 
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.StateNode
Collects all changes made to this node since the last time StateNode.collectChanges(Consumer) has been called.
collectChanges(Consumer<NodeChange>) - Method in class com.vaadin.flow.internal.StateTree
Collects all changes made to this tree since the last time StateTree.collectChanges(Consumer) has been called.
collectDirtyNodes() - Method in class com.vaadin.flow.internal.StateTree
Gets all the nodes that have been marked.
collectHandlerMethods(Class<?>) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Collect methods annotated with the handler annotation for given class.
collectHandlerMethods(Class<?>, Collection<Method>) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Collect all Methods annotated with the handler annotation.
collectInjectedIds(Set<String>) - Method in class com.vaadin.flow.component.template.internal.IdCollector
Scans the given template class and finds fields mapped using @Id.
collectLocaleChangeObservers(Element) - Static method in class com.vaadin.flow.router.EventUtil
Collect all Components implementing LocaleChangeObserver connected to the given element tree.
collectLocaleChangeObservers(List<HasElement>) - Static method in class com.vaadin.flow.router.EventUtil
Collect all Components implementing LocaleChangeObserver connected to the tree of all given Components in list.
COLOR_F0_RED - Static variable in interface com.vaadin.flow.component.Key
General-purpose media function key, color-coded red; this has index 0 among the colored keys.
COLOR_F1_GREEN - Static variable in interface com.vaadin.flow.component.Key
General-purpose media function key, color-coded green; this has index 1 among the colored keys.
COLOR_F2_YELLOW - Static variable in interface com.vaadin.flow.component.Key
General-purpose media function key, color-coded yellow; this has index 2 among the colored keys.
COLOR_F3_BLUE - Static variable in interface com.vaadin.flow.component.Key
General-purpose media function key, color-coded blue; this has index 3 among the colored keys.
COLOR_F4_GREY - Static variable in interface com.vaadin.flow.component.Key
General-purpose media function key, color-coded grey; this has index 4 among the colored keys.
COLOR_F5_BROWN - Static variable in interface com.vaadin.flow.component.Key
General-purpose media function key, color-coded brown; this has index 5 among the colored keys.
com.vaadin.experimental - package com.vaadin.experimental
 
com.vaadin.flow.component - package com.vaadin.flow.component
 
com.vaadin.flow.component.dependency - package com.vaadin.flow.component.dependency
 
com.vaadin.flow.component.internal - package com.vaadin.flow.component.internal
 
com.vaadin.flow.component.page - package com.vaadin.flow.component.page
 
com.vaadin.flow.component.template - package com.vaadin.flow.component.template
 
com.vaadin.flow.component.template.internal - package com.vaadin.flow.component.template.internal
 
com.vaadin.flow.component.webcomponent - package com.vaadin.flow.component.webcomponent
 
com.vaadin.flow.di - package com.vaadin.flow.di
 
com.vaadin.flow.dom - package com.vaadin.flow.dom
 
com.vaadin.flow.dom.impl - package com.vaadin.flow.dom.impl
 
com.vaadin.flow.function - package com.vaadin.flow.function
 
com.vaadin.flow.i18n - package com.vaadin.flow.i18n
 
com.vaadin.flow.internal - package com.vaadin.flow.internal
 
com.vaadin.flow.internal.change - package com.vaadin.flow.internal.change
 
com.vaadin.flow.internal.hilla - package com.vaadin.flow.internal.hilla
 
com.vaadin.flow.internal.nodefeature - package com.vaadin.flow.internal.nodefeature
 
com.vaadin.flow.internal.springcsrf - package com.vaadin.flow.internal.springcsrf
 
com.vaadin.flow.router - package com.vaadin.flow.router
 
com.vaadin.flow.router.internal - package com.vaadin.flow.router.internal
 
com.vaadin.flow.server - package com.vaadin.flow.server
 
com.vaadin.flow.server.auth - package com.vaadin.flow.server.auth
 
com.vaadin.flow.server.communication - package com.vaadin.flow.server.communication
 
com.vaadin.flow.server.communication.rpc - package com.vaadin.flow.server.communication.rpc
 
com.vaadin.flow.server.communication.streaming - package com.vaadin.flow.server.communication.streaming
 
com.vaadin.flow.server.frontend - package com.vaadin.flow.server.frontend
 
com.vaadin.flow.server.frontend.installer - package com.vaadin.flow.server.frontend.installer
 
com.vaadin.flow.server.frontend.scanner - package com.vaadin.flow.server.frontend.scanner
 
com.vaadin.flow.server.startup - package com.vaadin.flow.server.startup
 
com.vaadin.flow.server.webcomponent - package com.vaadin.flow.server.webcomponent
 
com.vaadin.flow.shared - package com.vaadin.flow.shared
 
com.vaadin.flow.shared.communication - package com.vaadin.flow.shared.communication
 
com.vaadin.flow.shared.ui - package com.vaadin.flow.shared.ui
 
com.vaadin.flow.shared.util - package com.vaadin.flow.shared.util
 
com.vaadin.flow.theme - package com.vaadin.flow.theme
 
combine(Registration...) - Static method in interface com.vaadin.flow.shared.Registration
Creates a registration that will remove multiple registrations.
combineWith(Range) - Method in class com.vaadin.flow.internal.Range
Combines two ranges to create a range containing all values in both ranges, provided there are no gaps between the ranges.
COMMA - Static variable in interface com.vaadin.flow.component.Key
,< on a US keyboard.
Command - Interface in com.vaadin.flow.server
A generic command interface meant to be used for passing lambdas around.
CommandExecutionException(int) - Constructor for exception com.vaadin.flow.server.frontend.FrontendUtils.CommandExecutionException
Constructs an exception telling what code the command execution process was exited with.
CommandExecutionException(int, String, String) - Constructor for exception com.vaadin.flow.server.frontend.FrontendUtils.CommandExecutionException
Constructs an exception telling what code the command execution process was exited with and the output that it produced.
CommandExecutionException(Throwable) - Constructor for exception com.vaadin.flow.server.frontend.FrontendUtils.CommandExecutionException
Constructs an exception telling what was the original exception the command execution process failed with.
commandToString(String, List<String>) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Pretty prints a command line order.
commitJsonResponse(VaadinResponse, String) - Static method in class com.vaadin.flow.server.communication.UidlRequestHandler
Commit the JSON response.
compareTo(FrontendVersion) - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Compare version numbers and return order as -1, 0 and 1.
compareTo(T) - Method in class com.vaadin.flow.router.RouteBaseData
 
COMPATIBILITY_RESOURCES_FRONTEND_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Location for the frontend resources in jar files for compatibility mode (also obsolete but supported for npm mode).
COMPILED_WEB_COMPONENTS_PATH - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for the parameter that sets the compiled web components path.
complete(JsonValue) - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
Completes this invocation with the given return value from the client.
completeExceptionally(JsonValue) - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
Completes this invocation with the given exception value from the client.
Component - Class in com.vaadin.flow.component
A Component is a higher level abstraction of an Element or a hierarchy of Elements.
Component() - Constructor for class com.vaadin.flow.component.Component
Creates a component instance with an element created based on the Tag annotation of the sub class.
Component(Element) - Constructor for class com.vaadin.flow.component.Component
Creates a component instance based on the given element.
COMPONENT_MAPPING - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ComponentEvent<T extends Component> - Class in com.vaadin.flow.component
An event whose source is a Component.
ComponentEvent(T, boolean) - Constructor for class com.vaadin.flow.component.ComponentEvent
Creates a new event using the given source and indicator whether the event originated from the client side or the server side.
ComponentEventBus - Class in com.vaadin.flow.component
An event bus for Components.
ComponentEventBus(Component) - Constructor for class com.vaadin.flow.component.ComponentEventBus
Creates an event bus for the given component.
ComponentEventBusUtil - Class in com.vaadin.flow.component
Static helpers and caching functionality for ComponentEventBus.
ComponentEventListener<T extends ComponentEvent<?>> - Interface in com.vaadin.flow.component
Generic listener for component events.
componentFromElement(Element, Class<T>, boolean) - Static method in class com.vaadin.flow.component.ComponentUtil
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).
ComponentMapping - Class in com.vaadin.flow.internal.nodefeature
A server side only node feature for mapping a node to a component.
ComponentMapping(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ComponentMapping
Creates an instance of this node feature.
ComponentMetaData - Class in com.vaadin.flow.component.internal
Immutable meta data related to a component class.
ComponentMetaData(Class<? extends Component>) - Constructor for class com.vaadin.flow.component.internal.ComponentMetaData
Scans the given component class and creates a new instance based on found annotations.
ComponentMetaData.DependencyInfo - Class in com.vaadin.flow.component.internal
Dependencies defined for a Component class.
ComponentMetaData.SynchronizedPropertyInfo - Class in com.vaadin.flow.component.internal
Synchronized properties defined for a Component class.
componentSet(T) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Called by ComponentMapping whenever a component instance has been set for the node.
ComponentTracker - Class in com.vaadin.flow.component.internal
Tracks the location in source code where components were instantiated.
ComponentTracker() - Constructor for class com.vaadin.flow.component.internal.ComponentTracker
 
ComponentTracker.Location - Class in com.vaadin.flow.component.internal
Represents a location in the source code.
ComponentUtil - Class in com.vaadin.flow.component
Utility methods for Component.
ComponentValueChangeEvent(C, HasValue<?, V>, V, boolean) - Constructor for class com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent
Creates a new component value change event.
compose(Lookup, Lookup) - Static method in interface com.vaadin.flow.di.Lookup
Make a composite lookup which contains the services from both lookup1 and lookup2.
COMPOSE - Static variable in interface com.vaadin.flow.component.Key
The Compose key.
Composite<T extends Component> - Class in com.vaadin.flow.component
A composite encapsulates a Component tree to allow creation of new components by composing existing components.
Composite() - Constructor for class com.vaadin.flow.component.Composite
Creates a new composite.
CompositionEndEvent - Class in com.vaadin.flow.component
The event when a composition is ended.
CompositionEndEvent(Component) - Constructor for class com.vaadin.flow.component.CompositionEndEvent
Creates a new server-side composition event with no additional information.
CompositionEndEvent(Component, boolean, String, String) - Constructor for class com.vaadin.flow.component.CompositionEndEvent
Creates a new composition event.
CompositionEvent - Class in com.vaadin.flow.component.internal
Abstract class for composition events.
CompositionEvent(Component) - Constructor for class com.vaadin.flow.component.internal.CompositionEvent
Creates a new server-side composition event with no additional information.
CompositionEvent(Component, boolean, String, String) - Constructor for class com.vaadin.flow.component.internal.CompositionEvent
Creates a new composition event.
CompositionNotifier - Interface in com.vaadin.flow.component
Mixin interface for components that support adding composition listeners to the their root elements.
CompositionStartEvent - Class in com.vaadin.flow.component
The event when a composition is started.
CompositionStartEvent(Component) - Constructor for class com.vaadin.flow.component.CompositionStartEvent
Creates a new server-side composition event with no additional information.
CompositionStartEvent(Component, boolean, String, String) - Constructor for class com.vaadin.flow.component.CompositionStartEvent
Creates a new composition event.
CompositionUpdateEvent - Class in com.vaadin.flow.component
The event when a composition is updated.
CompositionUpdateEvent(Component) - Constructor for class com.vaadin.flow.component.CompositionUpdateEvent
Creates a new server-side composition event with no additional information.
CompositionUpdateEvent(Component, boolean, String, String) - Constructor for class com.vaadin.flow.component.CompositionUpdateEvent
Creates a new composition event.
configure(AbstractRouteRegistry.Configuration) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
Thread-safe update of the RouteConfiguration.
configure(ConfigureRoutes) - Method in interface com.vaadin.flow.router.internal.AbstractRouteRegistry.Configuration
Configure the given configurable route holder object.
ConfiguredRoutes - Class in com.vaadin.flow.router.internal
Route configuration class that is used as a value object.
ConfiguredRoutes() - Constructor for class com.vaadin.flow.router.internal.ConfiguredRoutes
Create an immutable RouteConfiguration.
ConfiguredRoutes(ConfigureRoutes) - Constructor for class com.vaadin.flow.router.internal.ConfiguredRoutes
Create a mutable or immutable configuration with original configuration information.
configureInstance(WebComponent<C>, C) - Method in class com.vaadin.flow.component.WebComponentExporter
If custom initialization for the created Component instance is needed, it can be done here.
configurePage(AppShellSettings) - Method in interface com.vaadin.flow.component.page.AppShellConfigurator
Configure the initial application shell settings when called.
ConfigureRoutes - Class in com.vaadin.flow.router.internal
Configuration class for editing routes.
ConfigureRoutes() - Constructor for class com.vaadin.flow.router.internal.ConfigureRoutes
Create an immutable RouteConfiguration.
ConfigureRoutes(ConfiguredRoutes) - Constructor for class com.vaadin.flow.router.internal.ConfigureRoutes
Create a mutable or immutable configuration with original configuration information.
CONFLICT - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.
connect(AtmosphereResource) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Associates this AtmospherePushConnection with the given AtmosphereResource representing an established push connection.
CONNECT_APPLICATION_PROPERTIES_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
CONNECT_JAVA_SOURCE_FOLDER_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
CONNECT_OPEN_API_FILE_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
connectClient(String, String, String, JsonValue, String) - Method in class com.vaadin.flow.component.UI
Connect a client with the server side UI.
CONNECTED - Enum constant in enum class com.vaadin.flow.server.communication.AtmospherePushConnection.State
Connected.
connectionLost() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Called when the connection to the client has been lost.
console(String, Object) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Intentionally send to console instead to log, useful when executing external processes.
ConstantPool - Class in com.vaadin.flow.internal
Keeps track of ConstantPoolKey values that have already been sent to the client.
ConstantPool() - Constructor for class com.vaadin.flow.internal.ConstantPool
 
ConstantPoolKey - Class in com.vaadin.flow.internal
Wraps a JSON value that should be stored in the ConstantPool shared between the client and the server.
ConstantPoolKey(JsonValue) - Constructor for class com.vaadin.flow.internal.ConstantPoolKey
Creates a new constant pool key for the given JSON value.
Constants - Class in com.vaadin.flow.server
Constants used by the server side framework.
constructVaadinContext() - Method in class com.vaadin.flow.server.VaadinService
Constructs VaadinContext for this service.
constructVaadinContext() - Method in class com.vaadin.flow.server.VaadinServletService
 
consumeProcessStreams(Process) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Reads input and error stream from the give process asynchronously.
contains(int) - Method in class com.vaadin.flow.internal.Range
Checks whether an integer is found within this range.
contains(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
Returns true if this list contains the specified node.
contains(Class<? extends C>) - Method in class com.vaadin.flow.internal.ReflectionCache
Checks whether this cache contains an entry for the given type.
contains(Object) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
contains(Object) - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
contains(String) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Checks whether a value is stored for the given key.
contains(String) - Static method in enum class com.vaadin.flow.shared.ui.Dependency.Type
Check if the given value is contained as a enum value.
containsAll(Collection<?>) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
containsPath(File, String) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
Checks if a jar file contains a path specified (case sensitive).
containsTarget(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.RouteTarget
Check if navigation target is present in current target.
content() - Element in annotation interface com.vaadin.flow.component.page.Meta
Gets the custom tag content.
CONTENT_BOX - Enum constant in enum class com.vaadin.flow.dom.Style.BoxSizing
 
CONTENT_TYPE_TEXT_HTML_UTF_8 - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Content type to use for text/html responses (should always be UTF-8).
CONTENT_TYPE_TEXT_JAVASCRIPT_UTF_8 - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Content type to use for text/javascript responses (should always be UTF-8).
CONTENTS - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
ContentTypeResolver - Interface in com.vaadin.flow.function
Content type resolver.
CONTEXT_MENU - Static variable in interface com.vaadin.flow.component.Key
Shows the context menu.
CONTEXT_PROTOCOL_PREFIX - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Protocol used for referencing the application context path.
CONTEXT_ROOT_URL - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Configuration parameter giving the (in some cases relative) URL to the web application context root.
contextDestroyed(ServletContextEvent) - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
 
contextDestroyed(ServletContextEvent) - Method in class com.vaadin.flow.server.startup.ServletContextListeners
 
contextDestroyed(ServletContextEvent) - Method in class com.vaadin.flow.server.startup.ServletDeployer
 
contextDestroyed(ServletContextEvent) - Method in class com.vaadin.flow.server.startup.VaadinAppShellInitializer
 
contextInitialized(ServletContextEvent) - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
 
contextInitialized(ServletContextEvent) - Method in class com.vaadin.flow.server.startup.ServletContextListeners
 
contextInitialized(ServletContextEvent) - Method in class com.vaadin.flow.server.startup.ServletDeployer
 
contextInitialized(ServletContextEvent) - Method in class com.vaadin.flow.server.startup.VaadinAppShellInitializer
 
CONTINUE - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (100) indicating the client can continue.
CONTROL - Enum constant in enum class com.vaadin.flow.component.KeyModifier
KeyModifier for "Control" key.
CONTROL - Static variable in interface com.vaadin.flow.component.Key
The Control, Ctrl, or Ctl key.
CONTROL_LEFT - Static variable in interface com.vaadin.flow.component.Key
Control or
CONTROL_RIGHT - Static variable in interface com.vaadin.flow.component.Key
Control or
CONVERT - Static variable in interface com.vaadin.flow.component.Key
The Convert key, which instructs the IME to convert the current input method sequence into the resulting character.
convertPrimitiveType(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Converts the given primitive type to its boxed version.
cookiesDisabledCaption - Variable in class com.vaadin.flow.server.SystemMessages
 
cookiesDisabledMessage - Variable in class com.vaadin.flow.server.SystemMessages
 
cookiesDisabledNotificationEnabled - Variable in class com.vaadin.flow.server.SystemMessages
 
cookiesDisabledURL - Variable in class com.vaadin.flow.server.SystemMessages
 
copy(int) - Method in class com.vaadin.flow.internal.change.AbstractListChange
Gets a copy of the change with the same data except index.
copy(int) - Method in class com.vaadin.flow.internal.change.ListAddChange
 
copy(int) - Method in class com.vaadin.flow.internal.change.ListClearChange
 
copy(int) - Method in class com.vaadin.flow.internal.change.ListRemoveChange
 
copy(List<? extends T>) - Method in class com.vaadin.flow.internal.change.ListAddChange
Gets a copy of the change with the same data except a list of new items.
COPY - Static variable in interface com.vaadin.flow.component.Key
The Copy key (on certain extended keyboards).
copyFilesFromJarTrimmingBasePath(File, String, File, String...) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
Copies files from the jar file to the output directory.
copyIncludedFilesFromJarTrimmingBasePath(File, String, File, String...) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
Copies files matching the inclusion filters from the jar file to the output directory.
copyLocalResources(File) - Method in class com.vaadin.flow.server.frontend.Options
Set local frontend files to be copied from given folder.
copyPackageLockFromBundle(Options) - Static method in class com.vaadin.flow.server.frontend.BundleUtils
Copy package-lock.json/.yaml file from existing dev-bundle for building new bundle.
copyResources(Set<File>) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether copy resources from classpath to the appropriate npm package folder so as they are available for webpack build.
copyTargetRouteModels(boolean) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Make a copy of the target and route models mapping.
CR_SEL - Static variable in interface com.vaadin.flow.component.Key
The Cursor Select key, CrSel.
create() - Method in interface com.vaadin.flow.component.WebComponentExporterFactory
Creates a new WebComponentExporter instance and configures the tag name of the web component created based on this exporter.
create() - Method in class com.vaadin.flow.component.WebComponentExporterFactory.DefaultWebComponentExporterFactory
 
create(WebComponentExporter<T>) - Method in class com.vaadin.flow.component.WebComponentExporter.WebComponentConfigurationFactory
Creates a WebComponentConfiguration for the provided WebComponentExporter instances.
create(VaadinContext) - Method in interface com.vaadin.flow.server.startup.ApplicationConfigurationFactory
Creates a new instance of ApplicationConfiguration for the given context.
create(VaadinContext) - Method in class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory
 
create(Class<? extends NodeFeature>, StateNode) - Static method in class com.vaadin.flow.internal.nodefeature.NodeFeatureRegistry
Creates a feature of the given type for a node.
createAnchor() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;a> element.
createAnchor(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;a> with the given href attribute.
createAnchor(String, String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;a> element with the given href attribute and text content.
createAndInitUI(Class<? extends UI>, VaadinRequest, VaadinResponse, VaadinSession) - Method in class com.vaadin.flow.server.BootstrapHandler
 
createAndInitUI(Class<? extends UI>, VaadinRequest, VaadinResponse, VaadinSession) - Method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
 
createAndInitUI(Class<? extends UI>, VaadinRequest, VaadinResponse, VaadinSession) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
 
createArray(JsonValue...) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a new JSON array with the given values.
createBootstrapContext(VaadinRequest, VaadinResponse, UI, Function<VaadinRequest, String>) - Method in class com.vaadin.flow.server.BootstrapHandler
Creates a new instance of BootstrapHandler.BootstrapContext for given request, response and ui.
createBootstrapContext(VaadinRequest, VaadinResponse, UI, Function<VaadinRequest, String>) - Method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
 
createBootstrapContext(VaadinRequest, VaadinResponse, UI, Function<VaadinRequest, String>) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
 
createBr() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;br> element.
createButton() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;button> element.
createButton(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;button> with the given text content.
createComponent(Class<T>) - Method in class com.vaadin.flow.di.DefaultInstantiator
 
createComponent(Class<T>) - Method in interface com.vaadin.flow.di.Instantiator
Creates an instance of a component by its componentClass.
createCriticalNotificationJSON(String, String, String, String) - Static method in class com.vaadin.flow.server.VaadinService
Creates a JSON message which, when sent to client as-is, will cause a critical error to be shown with the given details.
createCriticalNotificationJSON(String, String, String, String, String) - Static method in class com.vaadin.flow.server.VaadinService
Creates a JSON message which, when sent to client as-is, will cause a critical error to be shown with the given details.
CREATED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (201) indicating the request succeeded and created a new resource on the server.
createDeploymentConfiguration() - Method in class com.vaadin.flow.server.VaadinServlet
Creates a deployment configuration to be used for the creation of a VaadinService.
createDeploymentConfiguration(Class<?>, VaadinConfig) - Method in class com.vaadin.flow.server.DeploymentConfigurationFactory
Creates a DeploymentConfiguration instance that is filled with all parameters, specified for the current app.
createDeploymentConfiguration(Properties) - Method in class com.vaadin.flow.server.VaadinServlet
Creates a deployment configuration to be used for the creation of a VaadinService.
createDiv() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;div> element.
createDiv(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;div> with the given text content.
createEmphasis() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;em> element.
createEmphasis(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;em> element with the given text content.
createHandler(VaadinService) - Method in interface com.vaadin.flow.server.StaticFileHandlerFactory
Creates a new instance of StaticFileHandler for the given service.
createHeading1() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;h1> element.
createHeading1(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;h1> element with the given text content.
createHeading2() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;h2> element.
createHeading2(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;h2> element with the given text content.
createHeading3() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;h3> element.
createHeading3(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;h3> element with the given text content.
createHeading4() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;h4> element.
createHeading4(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;h4> element with the given text content.
createHeading5() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;h5> element.
createHeading5(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;h5> element with the given text content.
createHeading6() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;h6> element.
createHeading6(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;h6> element with the given text content.
createHr() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;hr> element.
createInitParameters(Class<?>, VaadinConfig) - Method in class com.vaadin.flow.server.DeploymentConfigurationFactory
Generate Property containing parameters for with all parameters contained in current application.
createInlineJavaScriptElement(String) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
createInput() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;input> element.
createInput(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;input> element with the given type.
createInputStream() - Method in interface com.vaadin.flow.server.InputStreamFactory
Produce InputStream instance to read resource data.
createInstance(Class<T>) - Static method in class com.vaadin.flow.internal.ReflectTools
Creates an instance of the given class with a no-arg constructor.
createInstantiator() - Method in class com.vaadin.flow.server.VaadinService
Creates an instantiator to use with this service.
createInstantitor(VaadinService) - Method in interface com.vaadin.flow.di.InstantiatorFactory
Create an Instantiator using the provided service.
createJavaScriptElement(String) - Static method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
createJavaScriptElement(String, boolean) - Static method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
createJavaScriptElement(String, boolean, String) - Static method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
createJavaScriptModuleElement(String, boolean) - Static method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
createLabel() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;label> element.
createLabel(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;label> element with the given text content.
createListItem() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;li> element.
createListItem(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;li> element with the given text content.
createLookup(VaadinContext, Map<Class<?>, Collection<Class<?>>>) - Method in class com.vaadin.flow.di.LookupInitializer
Creates a lookup based on provided services.
createMetadata(UI, boolean, boolean, SystemMessages) - Method in class com.vaadin.flow.server.communication.MetadataWriter
Creates a JSON object containing metadata related to the given UI.
createMissingPackageJson(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether to create the package file if missing.
createObject(Map<String, T>, Function<T, JsonValue>) - Static method in class com.vaadin.flow.internal.JsonUtils
Converts the given map into a JSON object by converting each map value to a JSON value.
createOption() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;option> element.
createOption(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;option> element with the given text content.
createParagraph() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;p> element.
createParagraph(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;p> element with the given text content.
createParameterizedType(Class<?>, Type) - Static method in class com.vaadin.flow.internal.ReflectTools
Creates a parameterized type, e.g.
createPreformatted() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;pre> element.
createPreformatted(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;pre> element with the given text content.
createProcessBuilder(List<String>) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Creates a process builder for the given list of program and arguments.
createPropertyDeploymentConfiguration(Class<?>, VaadinConfig) - Method in class com.vaadin.flow.server.DeploymentConfigurationFactory
Creates a DeploymentConfiguration instance that has all parameters, specified for the current app without doing checks so property states and only returns default.
createProxyInstance(Class<T>, Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Creates an instance of the given proxyClass with no-arg constructor.
createPushHandler(VaadinServletService) - Method in class com.vaadin.flow.server.communication.PushRequestHandler
Creates a push handler for this request handler.
createRequestHandlers() - Method in class com.vaadin.flow.server.VaadinService
Called during initialization to add the request handlers for the service.
createRequestHandlers() - Method in class com.vaadin.flow.server.VaadinServletService
 
createRouterLink(String, String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates an &lt;a> element with the given href attribute, text content and the router link attribute.
createRouteTarget(Class<T>, NavigationEvent) - Method in interface com.vaadin.flow.di.Instantiator
Creates an instance of a navigation target or router layout.
createRpcHandler() - Method in class com.vaadin.flow.server.communication.UidlRequestHandler
Creates the ServerRpcHandler to use.
createScanner(boolean, ClassFinder, boolean) - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner.FrontendDependenciesScannerFactory
Produces scanner implementation based on allDependenciesScan value.
createScanner(boolean, ClassFinder, boolean, FeatureFlags) - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner.FrontendDependenciesScannerFactory
Produces scanner implementation based on allDependenciesScan value.
createSelect() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;select> element.
createServletService() - Method in class com.vaadin.flow.server.VaadinServlet
Creates a vaadin servlet service.
createServletService(DeploymentConfiguration) - Method in class com.vaadin.flow.server.VaadinServlet
Creates a vaadin servlet service.
createSessionExpiredJSON(boolean) - Static method in class com.vaadin.flow.server.VaadinService
Creates the JSON to send to the client when the session has expired.
createShadowRootNode(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
Create a new shadow root node for the given element node.
createSpan() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;span> element.
createSpan(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;span> element with the given text content.
createStateNode(String) - Static method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
Creates a compatible element state node using the given tag.
createStateNode(String) - Static method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
Creates a compatible text state node using the given text.
createStaticFileHandler(VaadinService) - Method in class com.vaadin.flow.server.VaadinServlet
Creates a new instance of StaticFileHandler, that is responsible to find and serve static resources.
createStreamResourceRegistry() - Method in class com.vaadin.flow.server.VaadinSession
Creates the StreamResourceRegistry for this session.
createStrong() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;strong> element.
createStrong(String) - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;strong> element with the given text content.
createTaskGenerateEndpoint(Options) - Method in interface com.vaadin.flow.server.frontend.EndpointGeneratorTaskFactory
Create a task for generating TS files based.
createTaskGenerateOpenAPI(Options) - Method in interface com.vaadin.flow.server.frontend.EndpointGeneratorTaskFactory
Create a task for generating OpenAPI spec.
createText(String) - Static method in class com.vaadin.flow.dom.Element
Creates a text node with the given text.
createTextarea() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;textarea> element.
createUidl(UI, boolean) - Method in class com.vaadin.flow.server.communication.UidlWriter
Creates a JSON object containing all pending changes to the given UI.
createUidl(UI, boolean, boolean) - Method in class com.vaadin.flow.server.communication.UidlWriter
Creates a JSON object containing all pending changes to the given UI.
createUINotFoundJSON(boolean) - Static method in class com.vaadin.flow.server.VaadinService
Creates the JSON to send to the client when the UI cannot be found.
createUnorderedList() - Static method in interface com.vaadin.flow.dom.ElementFactory
Creates a &lt;ul> element.
createVaadinRequest(HttpServletRequest) - Method in class com.vaadin.flow.server.VaadinServlet
Creates a Vaadin request for a http servlet request.
createVaadinSession(VaadinRequest) - Method in class com.vaadin.flow.server.VaadinService
Creates a new Vaadin session for this service and request.
createWebComponentBinding(Instantiator, Element, JsonObject) - Method in interface com.vaadin.flow.component.webcomponent.WebComponentConfiguration
Creates a new WebComponentBinding instance.
CSRF_TOKEN - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the parameter used to transmit the CSRF token.
CSRF_TOKEN_DEFAULT_VALUE - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Default value to use in case the security protection is disabled.
CSS_IMPORTS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
A key in a Json object for css imports data.
CssBundler - Class in com.vaadin.flow.server.frontend
 
CssBundler() - Constructor for class com.vaadin.flow.server.frontend.CssBundler
 
CssData - Class in com.vaadin.flow.server.frontend.scanner
A container for CssImport information when scanning the class path.
CssData() - Constructor for class com.vaadin.flow.server.frontend.scanner.CssData
 
CssData(String, String, String, String) - Constructor for class com.vaadin.flow.server.frontend.scanner.CssData
 
CssImport - Annotation Interface in com.vaadin.flow.component.dependency
Imports a CSS file into the application bundle.
CssImport.Container - Annotation Interface in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple CssImport annotations.
CurrentInstance - Class in com.vaadin.flow.internal
Keeps track of various current instances for the current thread.
CustomAttribute - Class in com.vaadin.flow.dom.impl
Callback for handling attributes with special semantics.
CustomAttribute() - Constructor for class com.vaadin.flow.dom.impl.CustomAttribute
 
CustomElementNameValidator - Class in com.vaadin.flow.internal
Validates custom-element name according to definition in Custom element name
CustomElementNameValidator() - Constructor for class com.vaadin.flow.internal.CustomElementNameValidator
 
CustomizedSystemMessages - Class in com.vaadin.flow.server
Contains the system messages used to notify the user about various critical situations that can occur.
CustomizedSystemMessages() - Constructor for class com.vaadin.flow.server.CustomizedSystemMessages
 
CUT - Static variable in interface com.vaadin.flow.component.Key
The Cut key (on certain extended keyboards).
CvdlProducts - Class in com.vaadin.flow.server.frontend
Utilities for commercial product handling.
CvdlProducts() - Constructor for class com.vaadin.flow.server.frontend.CvdlProducts
 

D

dashSeparatedToCamelCase(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Converts a dash ("-") separated string into camelCase.
DD - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <dd>.
DEAD - Static variable in interface com.vaadin.flow.component.Key
A dead "combining" key; that is, a key which is used in tandem with other keys to generate accented and other modified characters.
DeadlockDetectingCompletableFuture<T> - Class in com.vaadin.flow.component.internal
A completable future that will throw from blocking operations if the current thread holds the session lock.
DeadlockDetectingCompletableFuture(VaadinSession) - Constructor for class com.vaadin.flow.component.internal.DeadlockDetectingCompletableFuture
Creates a new deadlock detecting completable future tied to the given session.
debounce() - Element in annotation interface com.vaadin.flow.component.DomEvent
The debounce settings to use with this event.
debounce(int) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Configures this listener to be notified only when at least timeout milliseconds has passed since the last time the event was triggered.
debounce(int, DebouncePhase, DebouncePhase...) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Configures the debouncing phases for which this listener should be triggered.
DebouncePhase - Enum Class in com.vaadin.flow.dom
Defines phases for an event that is debounced.
DebounceSettings - Annotation Interface in com.vaadin.flow.component
Debounce settings for declaratively defined client-side event handlers.
DEBUG_WINDOW_CONNECTION - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Web socket parameter which identifies connection as live reload connection.
DECIMAL - Static variable in interface com.vaadin.flow.component.Key
The decimal point key (typically . or ,) depending on the region.
decode(JsonValue, Class<T>) - Method in class com.vaadin.flow.server.communication.rpc.DefaultRpcDecoder
 
decode(JsonValue, Class<T>) - Method in interface com.vaadin.flow.server.communication.rpc.RpcDecoder
Decode the given value to the required type.
decode(JsonValue, Class<T>) - Method in class com.vaadin.flow.server.communication.rpc.StringToEnumDecoder
 
decode(JsonValue, Class<T>) - Method in class com.vaadin.flow.server.communication.rpc.StringToNumberDecoder
 
decodeAs(JsonValue, Class<T>) - Static method in class com.vaadin.flow.internal.JsonCodec
Decodes the given JSON value as the given type.
decodeWithoutTypeInfo(JsonValue) - Static method in class com.vaadin.flow.internal.JsonCodec
Helper for decoding any "primitive" value that is directly supported in JSON.
DEFAULT - Static variable in annotation interface com.vaadin.flow.component.page.Viewport
Sets the viewport at the width of the device.
DEFAULT_BACKGROUND_COLOR - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_CLOSE_IDLE_SESSIONS - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
DEFAULT_DEVMODE_STATS - Static variable in class com.vaadin.flow.server.Constants
The default value for whether usage statistics is enabled.
DEFAULT_DISPLAY - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_EXTERNAL_STATS_URL - Static variable in class com.vaadin.flow.server.Constants
Default location to look for the external stats.json.
DEFAULT_FRONTEND_DIR - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Path of the folder containing application frontend source files, it needs to be relative to the FrontendUtils.DEFAULT_NODE_DIR By default it is /frontend in the project folder.
DEFAULT_HEARTBEAT_INTERVAL - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
DEFAULT_ICON - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_MAX_MESSAGE_SUSPEND_TIMEOUT - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
DEFAULT_NAME - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_NODE_AUTO_UPDATE - Static variable in class com.vaadin.flow.server.Constants
The default value for InitParameters.NODE_AUTO_UPDATE.
DEFAULT_NODE_DIR - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Default folder for the node related content.
DEFAULT_NODE_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
This is the version that is installed if there is no node installed or the installed version is older than FrontendTools.SUPPORTED_NODE_VERSION, i.e.
DEFAULT_NODEJS_DOWNLOAD_ROOT - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
 
DEFAULT_NPM_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
This is the version shipped with the default Node version.
DEFAULT_OFFLINE_PATH - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_OFFLINE_STUB_PATH - Static variable in class com.vaadin.flow.server.communication.PwaHandler
 
DEFAULT_PATH - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_PNPM_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
 
DEFAULT_PROJECT_FRONTEND_GENERATED_DIR - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Default generated path for generated frontend files.
DEFAULT_REQUIRE_HOME_NODE_EXECUTABLE - Static variable in class com.vaadin.flow.server.Constants
DEFAULT_SEND_URLS_AS_PARAMETERS - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
DEFAULT_START_URL - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_STREAMING_PROGRESS_EVENT_INTERVAL_MS - Static variable in class com.vaadin.flow.server.communication.StreamReceiverHandler
 
DEFAULT_SYNC_ID_CHECK - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
DEFAULT_THEME_APPLIED_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
DEFAULT_THEME_APPLIED_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
DEFAULT_THEME_COLOR - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_WEB_COMPONENT_DISCONNECT - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
DefaultApplicationConfigurationFactory - Class in com.vaadin.flow.server.startup
Default implementation of ApplicationConfigurationFactory.
DefaultApplicationConfigurationFactory() - Constructor for class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory
 
DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl - Class in com.vaadin.flow.server.startup
 
DefaultArchiveExtractor - Class in com.vaadin.flow.server.frontend.installer
Default implementation for file archive extraction.
DefaultArchiveExtractor() - Constructor for class com.vaadin.flow.server.frontend.installer.DefaultArchiveExtractor
 
DefaultClassFinder(ClassLoader, Class<?>...) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
ClassFinder using a specified ClassLoader to load classes and a list of classes where to look for annotations or subclasses.
DefaultClassFinder(Set<Class<?>>) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
It uses current classloader for getting resources or loading classes.
DefaultDeploymentConfiguration - Class in com.vaadin.flow.server
The default implementation of DeploymentConfiguration based on a base class for resolving system properties and a set of init parameters.
DefaultDeploymentConfiguration(ApplicationConfiguration, Class<?>, Properties) - Constructor for class com.vaadin.flow.server.DefaultDeploymentConfiguration
Create a new deployment configuration instance.
DefaultErrorHandler - Class in com.vaadin.flow.server
The default implementation of ErrorHandler.
DefaultErrorHandler - Annotation Interface in com.vaadin.flow.router.internal
Marks an HasErrorParameter view as Framework default handler so it can be disregarded if there is a custom view for the same Exception.
DefaultErrorHandler() - Constructor for class com.vaadin.flow.server.DefaultErrorHandler
 
DefaultFileDownloader - Class in com.vaadin.flow.server.frontend.installer
Default file downloader implementation.
DefaultFileDownloader(ProxyConfig) - Constructor for class com.vaadin.flow.server.frontend.installer.DefaultFileDownloader
Construct file downloader with given proxy configuration.
DefaultInstantiator - Class in com.vaadin.flow.di
Default instantiator that is used if no other instantiator has been registered.
DefaultInstantiator(VaadinService) - Constructor for class com.vaadin.flow.di.DefaultInstantiator
Creates a new instantiator for the given service.
DefaultRoutePathProvider - Class in com.vaadin.flow.router
Default implementation for RoutePathProvider.
DefaultRoutePathProvider() - Constructor for class com.vaadin.flow.router.DefaultRoutePathProvider
 
DefaultRouteResolver - Class in com.vaadin.flow.router.internal
Default implementation of the RouteResolver interface.
DefaultRouteResolver() - Constructor for class com.vaadin.flow.router.internal.DefaultRouteResolver
 
DefaultRpcDecoder - Class in com.vaadin.flow.server.communication.rpc
Decodes the standard basic types from their JSON representation.
DefaultRpcDecoder() - Constructor for class com.vaadin.flow.server.communication.rpc.DefaultRpcDecoder
 
DefaultSystemMessagesProvider - Class in com.vaadin.flow.server
System messages provider using the built-in default system messages.
DefaultWebComponentExporterFactory(Class<? extends WebComponentExporter<C>>) - Constructor for class com.vaadin.flow.component.WebComponentExporterFactory.DefaultWebComponentExporterFactory
Creates a WebComponentConfiguration from the provided WebComponentExporter class.
deferredUpdateFromClient(String, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Updates a property value from the client and returns a Runnable for firing the associated PropertyChangeEvent.
DELETE - Static variable in interface com.vaadin.flow.component.Key
The Delete key, Del, and .
deleteDirectory(File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Recursively delete given directory and contents.
deleteNodeModules(File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Try to remove the node_modules directory, if it exists inside the given base directory.
DEP_NAME_FLOW_DEPS - Static variable in class com.vaadin.flow.server.frontend.NodeUpdater
Deprecated.
DEP_NAME_FLOW_JARS - Static variable in class com.vaadin.flow.server.frontend.NodeUpdater
Deprecated.
Dependency - Class in com.vaadin.flow.shared.ui
Represents an html import, stylesheet or JavaScript to include on the page.
Dependency(Dependency.Type, String) - Constructor for class com.vaadin.flow.shared.ui.Dependency
Creates a new dependency of the given type, to be loaded using JS expression which is supposed to return a Promise.
Dependency(Dependency.Type, String, LoadMode) - Constructor for class com.vaadin.flow.shared.ui.Dependency
Creates a new dependency of the given type, to be loaded from the given URL.
Dependency.Type - Enum Class in com.vaadin.flow.shared.ui
The type of a dependency.
DependencyFilter - Interface in com.vaadin.flow.server
Filter for dependencies loaded using @StyleSheet, and * @JavaScript.
DependencyInfo() - Constructor for class com.vaadin.flow.component.internal.ComponentMetaData.DependencyInfo
 
DependencyList - Class in com.vaadin.flow.component.internal
List for storing dependencies/files (JavaScript, Stylesheets) to be loaded and included on the client side.
DependencyList() - Constructor for class com.vaadin.flow.component.internal.DependencyList
Creates a new instance.
DependencyTreeCache<T> - Class in com.vaadin.flow.component.internal
A caching tree traverser for collecting and parsing dependencies.
DependencyTreeCache(SerializableFunction<T, Collection<T>>) - Constructor for class com.vaadin.flow.component.internal.DependencyTreeCache
Creates a dependency cache with the given dependency parser.
DependencyTrigger - Annotation Interface in com.vaadin.flow.router.internal
Marks which classes should trigger loading of a chunk defined by a route.
DeploymentConfiguration - Interface in com.vaadin.flow.function
A collection of properties configured at deploy time as well as a way of accessing third party properties not explicitly supported by this class.
DeploymentConfigurationFactory - Class in com.vaadin.flow.server
Creates DeploymentConfiguration filled with all parameters specified by the framework users.
DeploymentConfigurationFactory() - Constructor for class com.vaadin.flow.server.DeploymentConfigurationFactory
 
DeprecatedPolymerPublishedEventHandler - Interface in com.vaadin.flow.component.template.internal
Deprecated.
Polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.
DeprecatedPolymerTemplate - Interface in com.vaadin.flow.component.template.internal
Deprecated.
Polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.
description() - Element in annotation interface com.vaadin.flow.server.PWA
Description of the application.
deserializeParameter(Class<T>, String, String) - Static method in class com.vaadin.flow.router.ParameterDeserializer
Deserializer method for known parameter types.
deserializeRouteParameters(Class<?>, List<String>) - Static method in class com.vaadin.flow.router.ParameterDeserializer
Deserializes the list of url segments to an instance of the parameter type.
destroy() - Method in class com.vaadin.flow.server.communication.PushRequestHandler
Frees any resources currently in use.
destroy() - Method in class com.vaadin.flow.server.VaadinService
Called when the servlet or similar for this service is being destroyed.
destroy() - Method in class com.vaadin.flow.server.VaadinServlet
 
DetachEvent - Class in com.vaadin.flow.component
Event fired before a Component is detached from the UI.
DetachEvent(Component) - Constructor for class com.vaadin.flow.component.DetachEvent
Creates a new detach event with the given component as source.
DetachNotifier - Interface in com.vaadin.flow.component
Mixin interface for components that support adding detach listeners.
DETAILS - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <details>.
detatchPotentialChild(Object) - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Detaches an object if it is a StateNode.
determinePushServletMapping(VaadinSession) - Static method in class com.vaadin.flow.internal.BootstrapHandlerHelper
 
DEV_BUNDLE_JAR_PATH - Static variable in class com.vaadin.flow.server.Constants
The path part where dev-bundle is located inside the jar.
DEV_BUNDLE_LOCATION - Static variable in class com.vaadin.flow.server.Constants
The folder in the project where Flow generates Express Build mode application dev bundle.
DEV_BUNDLE_NAME - Static variable in class com.vaadin.flow.server.Constants
The name of the default dev bundle for the Express Build mode.
DEV_FOLDER_MISSING_MESSAGE - Static variable in class com.vaadin.flow.server.startup.AbstractConfigurationFactory
 
DEV_SETTINGS_FILE - Static variable in class com.vaadin.flow.server.frontend.TaskUpdateSettingsFile
 
DEV_TOOLS_ENABLED - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Boolean client configuration parameter enabling the development tools.
DevBundleUtils - Class in com.vaadin.flow.server.frontend
Helpers related to the development bundle.
DEVELOPMENT_BUNDLE - Enum constant in enum class com.vaadin.flow.server.Mode
 
DEVELOPMENT_FRONTEND_LIVERELOAD - Enum constant in enum class com.vaadin.flow.server.Mode
 
DEVICE_DIMENSIONS - Static variable in annotation interface com.vaadin.flow.component.page.Viewport
Sets the viewport at the width and height of the device.
DEVICE_HEIGHT - Static variable in annotation interface com.vaadin.flow.component.page.Viewport
Sets the viewport to the height of the device rather than the rendered space.
DevModeHandler - Interface in com.vaadin.flow.internal
 
DevModeHandlerManager - Interface in com.vaadin.flow.internal
Provides API to access to the DevModeHandler instance by a VaadinService.
DIALOG_TEXT_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
DIALOG_TEXT_GAVE_UP_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
DIALOG_TEXT_GAVE_UP_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
DIALOG_TEXT_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
DIGIT_0 - Static variable in interface com.vaadin.flow.component.Key
0) on a US keyboard.
DIGIT_1 - Static variable in interface com.vaadin.flow.component.Key
1! on a US keyboard.
DIGIT_2 - Static variable in interface com.vaadin.flow.component.Key
2@ on a US keyboard.
DIGIT_3 - Static variable in interface com.vaadin.flow.component.Key
3# on a US keyboard.
DIGIT_4 - Static variable in interface com.vaadin.flow.component.Key
4$ on a US keyboard.
DIGIT_5 - Static variable in interface com.vaadin.flow.component.Key
5% on a US keyboard.
DIGIT_6 - Static variable in interface com.vaadin.flow.component.Key
6^ on a US keyboard.
DIGIT_7 - Static variable in interface com.vaadin.flow.component.Key
7& on a US keyboard.
DIGIT_8 - Static variable in interface com.vaadin.flow.component.Key
8* on a US keyboard.
DIGIT_9 - Static variable in interface com.vaadin.flow.component.Key
9( on a US keyboard.
DIMMER - Static variable in interface com.vaadin.flow.component.Key
Adjusts the brightness of the device by toggling between two brightness levels or by cycling among multiple brightness levels.
Direction - Enum Class in com.vaadin.flow.component
Specifies the direction of the text and other content inside of an element.
DirectoryWriter() - Constructor for class com.vaadin.flow.server.webcomponent.WebComponentModulesWriter.DirectoryWriter
 
DISABLE_AUTOMATIC_SERVLET_REGISTRATION - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for the parameter that determines if Flow should automatically register servlets needed for the application to work.
DISABLE_CHECK - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 
disableAutomaticServletRegistration() - Method in interface com.vaadin.flow.server.startup.ApplicationConfiguration
Determines if Flow should automatically register servlets.
DISABLED - Enum constant in enum class com.vaadin.flow.shared.communication.PushMode
Push is disabled.
DisabledUpdateMode - Enum Class in com.vaadin.flow.dom
Controls RPC communication from the client side to the server side respecting enabled state.
disconnect() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
 
disconnect() - Method in interface com.vaadin.flow.server.communication.PushConnection
Closes the connection.
disconnected() - Method in class com.vaadin.flow.component.webcomponent.WebComponentWrapper
A WebComponent disconnected from the dom will be scheduled for cleaning if it doesn't get reconnected before times up.
DISCONNECTED - Enum constant in enum class com.vaadin.flow.server.communication.AtmospherePushConnection.State
Not connected.
display() - Element in annotation interface com.vaadin.flow.server.PWA
Defines the developers’ preferred display mode for the website.
DISPLAY_SWAP - Static variable in interface com.vaadin.flow.component.Key
Cycles among video sources.
disposeStreamVariable() - Method in class com.vaadin.flow.server.communication.streaming.StreamingStartEventImpl
 
disposeStreamVariable() - Method in interface com.vaadin.flow.server.StreamVariable.StreamingStartEvent
The owner of the StreamVariable can call this method to inform the implementation that this StreamVariable will not be used to accept more post.
DIV - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <div>.
DIVIDE - Static variable in interface com.vaadin.flow.component.Key
The numeric keypad's division key, /.
DL - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <dl>.
doCreate(VaadinContext, Map<String, String>) - Method in class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory
Creates application configuration instance based on provided data.
doHandleMultipartFileUpload(VaadinSession, VaadinRequest, VaadinResponse, StreamReceiver, StateNode) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
Streams content from a multipart request to given StreamVariable.
doHandleXhrFilePost(VaadinSession, VaadinRequest, VaadinResponse, StreamReceiver, StateNode, long) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
Used to stream plain file post (aka XHR2.post(File))
doInit(VaadinRequest, int) - Method in class com.vaadin.flow.component.UI
Deprecated.
doInit(VaadinRequest, int, String) - Method in class com.vaadin.flow.component.UI
Internal initialization method, should not be overridden.
doInit(VaadinRequest, int, String) - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI
 
DOM_EVENT_NAME - Static variable in class com.vaadin.flow.component.PollEvent
 
DomEvent - Class in com.vaadin.flow.dom
Server-side representation of a DOM event fired in the browser.
DomEvent - Annotation Interface in com.vaadin.flow.component
Maps a DOM event to a ComponentEvent.
DomEvent(Element, String, JsonObject) - Constructor for class com.vaadin.flow.dom.DomEvent
Creates a new DOM event.
DomEventListener - Interface in com.vaadin.flow.dom
Server-side listener for client-side DOM events.
DomListenerRegistration - Interface in com.vaadin.flow.dom
A registration for configuring or removing a DOM event listener added to an element.
download(URI, File, String, String) - Method in class com.vaadin.flow.server.frontend.installer.DefaultFileDownloader
 
DT - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <dt>.
dumpBeforeClientResponseEntries() - Method in class com.vaadin.flow.internal.StateNode
Gets the current list of pending execution entries for this node and clears the current list.
dumpConstants() - Method in class com.vaadin.flow.internal.ConstantPool
Encodes all new constants to a JSON object and marks those constants as non-new.
dumpPendingJavaScriptInvocations() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets all the pending JavaScript invocations that are ready to be sent to a client.
DuplicateNavigationTitleException - Exception in com.vaadin.flow.server.startup
Exception indicating a conflict between a route target implementing HasDynamicTitle while also having a PageTitle annotation.
DuplicateNavigationTitleException(String) - Constructor for exception com.vaadin.flow.server.startup.DuplicateNavigationTitleException
Constructs a new exception with the specified detail message.
DVR - Static variable in interface com.vaadin.flow.component.Key
Switches the input source to the Digital Video Recorder (DVR).
DYN_RES_PREFIX - Static variable in class com.vaadin.flow.server.communication.StreamRequestHandler
Dynamic resource URI prefix.
DYNAMIC_IMPORT - Enum constant in enum class com.vaadin.flow.shared.ui.Dependency.Type
 

E

EAGER - Enum constant in enum class com.vaadin.flow.shared.ui.LoadMode
Forces the dependency being loaded before the initial page load.
EISU - Static variable in interface com.vaadin.flow.component.Key
The Eisu key.
EJECT - Static variable in interface com.vaadin.flow.component.Key
The Eject or key.
Element - Class in com.vaadin.flow.dom
Represents an element in the DOM.
Element(StateNode, ElementStateProvider) - Constructor for class com.vaadin.flow.dom.Element
Private constructor for initializing with an existing node and state provider.
Element(String) - Constructor for class com.vaadin.flow.dom.Element
Creates an element using the given tag name.
ELEMENT_ATTRIBUTES - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ELEMENT_CHILDREN - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ELEMENT_DATA - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
Id for ElementData.
ELEMENT_LISTENERS - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ELEMENT_PROPERTIES - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ELEMENT_STYLE_PROPERTIES - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ElementAttachEvent - Class in com.vaadin.flow.dom
Event fired after an Element has been attached to the UI.
ElementAttachEvent(Element) - Constructor for class com.vaadin.flow.dom.ElementAttachEvent
Creates a new attach event with the given element as source.
ElementAttachListener - Interface in com.vaadin.flow.dom
Listener for element attach events.
ElementAttributeMap - Class in com.vaadin.flow.internal.nodefeature
Map for element attribute values.
ElementAttributeMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Creates a new element attribute map for the given node.
ElementChildrenList - Class in com.vaadin.flow.internal.nodefeature
List of nodes describing the child elements of an element.
ElementChildrenList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ElementChildrenList
Creates a new element children list for the given node.
ElementClassList - Class in com.vaadin.flow.internal.nodefeature
Handles CSS class names for an element.
ElementClassList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ElementClassList
Creates a new class list for the given node.
ElementConstants - Class in com.vaadin.flow.dom
Constants for common element attribute, property, style names.
ElementData - Class in com.vaadin.flow.internal.nodefeature
Map of basic element information.
ElementData(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ElementData
Creates a new element data map for the given node.
ElementDetachEvent - Class in com.vaadin.flow.dom
Event fired after an element has been detached from the UI.
ElementDetachEvent(Element) - Constructor for class com.vaadin.flow.dom.ElementDetachEvent
Creates a new detach event with the given element as source.
ElementDetachListener - Interface in com.vaadin.flow.dom
Listener for element detach events.
ElementFactory - Interface in com.vaadin.flow.dom
Helpers to create Element instances.
ElementListenerMap - Class in com.vaadin.flow.internal.nodefeature
Map of DOM events with server-side listeners.
ElementListenerMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ElementListenerMap
Creates a new element listener map for the given node.
ElementPropertyMap - Class in com.vaadin.flow.internal.nodefeature
Map for element property values.
ElementPropertyMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Creates a new element property map for the given node.
ElementStateProvider - Interface in com.vaadin.flow.dom
Handles storing and retrieval of the state information for an element using a state node.
ElementStylePropertyMap - Class in com.vaadin.flow.internal.nodefeature
Map for element style values.
ElementStylePropertyMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ElementStylePropertyMap
Creates a new element style map for the given node.
ElementUtil - Class in com.vaadin.flow.dom
Provides utility methods for Element.
EM - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the font-size of the relevant font.
EM - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <em>.
empty() - Static method in class com.vaadin.flow.router.QueryParameters
Creates an empty query parameters information.
empty() - Static method in class com.vaadin.flow.router.RouteParameters
Creates an empty RouteParameters instance.
EmptyChange - Class in com.vaadin.flow.internal.change
Empty change for the feature to report its presence for the client (send the feature information even though its data is empty).
EmptyChange(NodeFeature) - Constructor for class com.vaadin.flow.internal.change.EmptyChange
Creates a new empty change.
enable() - Method in class com.vaadin.flow.server.auth.ViewAccessChecker
Enables the access checker.
ENABLE_PNPM_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Constant for whether pnpm is default or not.
enableAtmosphereDebugLogging() - Static method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Internal method used for reconfiguring loggers to show all Atmosphere log messages in the console.
enableImportsUpdate(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether to enable imports file update.
enableNpmFileCleaning(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Deprecated.
enablePackagesUpdate(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether to enable packages and webpack file updates.
encodeURI(String) - Static method in class com.vaadin.flow.internal.UrlUtil
Encodes a full URI.
encodeURIComponent(String) - Static method in class com.vaadin.flow.internal.UrlUtil
Encodes a path segment of a URI.
EncodeUtil - Class in com.vaadin.flow.internal
Utilities related to various encoding schemes.
encodeWithConstantPool(Object, ConstantPool) - Static method in class com.vaadin.flow.internal.JsonCodec
Encodes a "primitive" value or a constant pool reference to JSON.
encodeWithoutTypeInfo(Object) - Static method in class com.vaadin.flow.internal.JsonCodec
Helper for encoding any "primitive" value that is directly supported in JSON.
encodeWithTypeInfo(Object) - Static method in class com.vaadin.flow.internal.JsonCodec
Helper for encoding values that might not have a native representation in JSON.
END - Enum constant in enum class com.vaadin.flow.component.ScrollOptions.Alignment
 
END - Static variable in interface com.vaadin.flow.component.Key
The End key.
END_CALL - Static variable in interface com.vaadin.flow.component.Key
The End Call or Hang Up button.
EndpointGeneratorTaskFactory - Interface in com.vaadin.flow.server.frontend
A factory for creating Vaadin Endpoint generator tasks.
EndpointRequestUtil - Interface in com.vaadin.flow.internal.hilla
A container for utility methods related with Hilla endpoints.
endsAfter(Range) - Method in class com.vaadin.flow.internal.Range
Checks whether this range ends after the end of another range.
endsBefore(Range) - Method in class com.vaadin.flow.internal.Range
Checks whether this range ends before the start of another range.
ensureAccessQueuePurged(VaadinSession) - Method in class com.vaadin.flow.server.VaadinService
Makes sure the pending access queue is purged for the provided session.
ensureChildHasParent(Element, boolean) - Method in class com.vaadin.flow.dom.Node
Ensures that the child has the correct parent.
ensurePushAvailable() - Method in class com.vaadin.flow.server.VaadinService
Enables push if push support is available and push has not yet been enabled.
ensureRelativeNonNull(String) - Static method in class com.vaadin.flow.router.LocationUtil
Handles given location when it is either null or starts with "/".
ensureService(Map<Class<?>, Collection<Class<?>>>, Class<T>, Class<? extends T>) - Method in class com.vaadin.flow.di.LookupInitializer
Ensures that provided services contain implementation for serviceType SPI.
ensureSupportedParameterTypes(Method) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Validate parameter support for given method.
ensureSupportedParameterTypes(Method) - Method in class com.vaadin.flow.internal.nodefeature.ClientCallableHandlers
 
ensureSupportedParameterTypes(Method) - Method in class com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers
Deprecated.
 
ensureSupportedReturnType(Method) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Validate return type support for given method.
ensureSupportedReturnType(Method) - Method in class com.vaadin.flow.internal.nodefeature.ClientCallableHandlers
 
ENTER - Static variable in interface com.vaadin.flow.component.Key
The Enter or key.
EntryPointData - Class in com.vaadin.flow.server.frontend.scanner
A simple container with the information related to an application entry point, i.e.
EntryPointType - Enum Class in com.vaadin.flow.server.frontend.scanner
The type of an entry point (scanned for frontend dependencies).
EQUAL - Static variable in interface com.vaadin.flow.component.Key
=+ on a US keyboard.
equals(Object) - Method in class com.vaadin.experimental.Feature
 
equals(Object) - Method in class com.vaadin.flow.component.internal.ComponentTracker.Location
 
equals(Object) - Method in class com.vaadin.flow.dom.Node
 
equals(Object) - Method in class com.vaadin.flow.internal.Range
 
equals(Object) - Method in class com.vaadin.flow.router.QueryParameters
 
equals(Object) - Method in class com.vaadin.flow.router.RouteAliasData
 
equals(Object) - Method in class com.vaadin.flow.router.RouteBaseData
 
equals(Object) - Method in class com.vaadin.flow.router.RouteData
 
equals(Object) - Method in class com.vaadin.flow.router.RouteParameters
 
equals(Object) - Method in class com.vaadin.flow.server.frontend.FrontendVersion
 
equals(Object) - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
equals(Object) - Method in class com.vaadin.flow.server.frontend.scanner.CssData
 
equals(Object) - Method in class com.vaadin.flow.server.webcomponent.PropertyConfigurationImpl
 
equals(Object) - Method in class com.vaadin.flow.server.webcomponent.PropertyData
 
equals(Object) - Method in class com.vaadin.flow.shared.ui.Dependency
 
equals(Object) - Method in class com.vaadin.flow.shared.util.UniqueSerializable
 
ERASE_EOF - Static variable in interface com.vaadin.flow.component.Key
Erase to End of Field.
error(ErrorEvent) - Method in class com.vaadin.flow.server.DefaultErrorHandler
 
error(ErrorEvent) - Method in interface com.vaadin.flow.server.ErrorHandler
Invoked when an error occurs.
ERROR_HEADER_NO_SHELL - Static variable in class com.vaadin.flow.server.AppShellRegistry
 
ERROR_HEADER_OFFENDING_PWA - Static variable in class com.vaadin.flow.server.AppShellRegistry
 
ERROR_INVALID_LOAD_DEPENDENCIES_ANNOTATION - Static variable in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
 
ERROR_INVALID_PWA_ANNOTATION - Static variable in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
 
ERROR_MESSAGE_BEGINNING - Static variable in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
 
ErrorEvent - Class in com.vaadin.flow.server
An error thrown by the framework and handled by an ErrorHandler.
ErrorEvent(Throwable) - Constructor for class com.vaadin.flow.server.ErrorEvent
Creates an error event which wraps the given throwable.
ErrorHandler - Interface in com.vaadin.flow.server
Application errors handler.
ErrorHandlingCommand - Interface in com.vaadin.flow.server
Defines the interface to handle exceptions thrown during the execution of a FutureAccess.
ErrorNavigationEvent - Class in com.vaadin.flow.router
Event object with data related to error navigation.
ErrorNavigationEvent(Router, Location, UI, NavigationTrigger, ErrorParameter<?>) - Constructor for class com.vaadin.flow.router.ErrorNavigationEvent
Creates a new navigation event.
ErrorNavigationEvent(Router, Location, UI, NavigationTrigger, ErrorParameter<?>, JsonValue) - Constructor for class com.vaadin.flow.router.ErrorNavigationEvent
Creates a new navigation event.
ErrorNavigationTargetInitializer - Class in com.vaadin.flow.server.startup
Servlet initializer for collecting all available error handler navigation targets implementing HasErrorParameter on startup.
ErrorNavigationTargetInitializer() - Constructor for class com.vaadin.flow.server.startup.ErrorNavigationTargetInitializer
 
ErrorParameter<T extends Exception> - Class in com.vaadin.flow.router
Navigation error parameter class containing thrown exception and possibly a custom message.
ErrorParameter(Class<T>, Exception) - Constructor for class com.vaadin.flow.router.ErrorParameter
Create ErrorParameter for exception.
ErrorParameter(Class<T>, Exception, String) - Constructor for class com.vaadin.flow.router.ErrorParameter
Create ErrorParameter for exception with a custom message.
ErrorRouteRegistry - Interface in com.vaadin.flow.server
Interface class for RouteRegistries that can be used to request for error navigation views for Exceptions.
ErrorStateRenderer - Class in com.vaadin.flow.router.internal
Handles error navigation rendering in the target UI.
ErrorStateRenderer(NavigationState) - Constructor for class com.vaadin.flow.router.internal.ErrorStateRenderer
Constructs a new state renderer for the given navigation state.
ErrorTargetEntry - Class in com.vaadin.flow.router.internal
A pair of a navigation target for handling exceptions and the exception type handled by the navigation target.
ErrorTargetEntry(Class<? extends Component>, Class<? extends Exception>) - Constructor for class com.vaadin.flow.router.internal.ErrorTargetEntry
Creates a new new entry with the given navigation target type and exception type.
escape(String) - Static method in class com.vaadin.flow.internal.HtmlUtils
Escape a string which may contain html.
ESCAPE - Static variable in interface com.vaadin.flow.component.Key
The Esc (Escape) or key.
EVENT_DATA_PHASE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the debounce phase for an event data map from the client.
EVENT_PHASE_INTERMEDIATE - Static variable in class com.vaadin.flow.shared.JsonConstants
Character used for representing DebouncePhase.INTERMEDIATE.
EVENT_PHASE_LEADING - Static variable in class com.vaadin.flow.shared.JsonConstants
Character used for representing DebouncePhase.LEADING.
EVENT_PHASE_TRAILING - Static variable in class com.vaadin.flow.shared.JsonConstants
Character used for representing DebouncePhase.TRAILING.
EventData - Annotation Interface in com.vaadin.flow.component
Maps data from a DOM event to a ComponentEvent.
EventDataCache - Class in com.vaadin.flow.component.internal
Cache for tracking global information related to ComponentEvent types.
EventDataCache() - Constructor for class com.vaadin.flow.component.internal.EventDataCache
 
EventOptions - Class in com.vaadin.flow.component.webcomponent
EventOptions is used to configure the custom event published by an exported web component.
EventOptions() - Constructor for class com.vaadin.flow.component.webcomponent.EventOptions
Create EventOptions used to configure the custom event published by an exported web component.
EventOptions(boolean) - Constructor for class com.vaadin.flow.component.webcomponent.EventOptions
Create EventOptions used to configure the custom event published by an exported web component.
EventOptions(boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.webcomponent.EventOptions
Create EventOptions used to configure the custom event published by an exported web component.
EventRpcHandler - Class in com.vaadin.flow.server.communication.rpc
RPC handler for events.
EventRpcHandler() - Constructor for class com.vaadin.flow.server.communication.rpc.EventRpcHandler
 
EventUtil - Class in com.vaadin.flow.router
Event handling utilities.
EX - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the x-height of the relevant font.
EX_SEL - Static variable in interface com.vaadin.flow.component.Key
The ExSel (Extend Selection) key.
EXAMPLE - Static variable in class com.vaadin.experimental.FeatureFlags
 
execute() - Method in interface com.vaadin.flow.server.Command
Runs the given command.
execute() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
 
execute() - Method in interface com.vaadin.flow.server.frontend.FallibleCommand
Runs the given command.
execute() - Method in class com.vaadin.flow.server.frontend.NodeTasks
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskCleanFrontendFiles
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskCopyFrontendFiles
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskCopyLocalFrontendFiles
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskCopyTemplateFiles
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskGeneratePackageJson
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskInstallFrontendBuildPlugins
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskPrepareProdBundle
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskRunDevBundleBuild
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskRunNpmInstall
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateImports
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateOldIndexTs
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdatePackages
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateSettingsFile
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateThemeImport
 
execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateVite
 
EXECUTE - Static variable in interface com.vaadin.flow.component.Key
The Execute key.
executeCommand(List<String>) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Executes a given command as a native process.
executeJs(String, Serializable...) - Method in class com.vaadin.flow.component.page.Page
Asynchronously runs the given JavaScript expression in the browser.
executeJs(String, Serializable...) - Method in class com.vaadin.flow.dom.Element
Asynchronously runs the given JavaScript expression in the browser in the context of this element.
ExecutionContext - Class in com.vaadin.flow.internal
ExecutionContext(UI, boolean) - Constructor for class com.vaadin.flow.internal.ExecutionContext
Creates a new, immutable context.
ExecutionFailedException - Exception in com.vaadin.flow.server
Thrown by FallibleCommand if it's unable to complete its execution.
ExecutionFailedException() - Constructor for exception com.vaadin.flow.server.ExecutionFailedException
Creates a new exception instance.
ExecutionFailedException(String) - Constructor for exception com.vaadin.flow.server.ExecutionFailedException
Creates a new exception instance with the given message.
ExecutionFailedException(String, Throwable) - Constructor for exception com.vaadin.flow.server.ExecutionFailedException
Creates a new exception instance with the given message and cause.
ExecutionFailedException(Throwable) - Constructor for exception com.vaadin.flow.server.ExecutionFailedException
Creates a new exception instance with the given cause.
EXIT - Static variable in interface com.vaadin.flow.component.Key
The Exit button, which exits the current application or menu.
expand(int, int) - Method in class com.vaadin.flow.internal.Range
Creates a range that is expanded the given amounts in both ends.
EXPECTATION_FAILED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (417) indicating that the server could not meet the expectation given in the Expect request header.
export(JsonObject) - Method in class com.vaadin.flow.internal.ConstantPoolKey
Exports this key into a JSON object to send to the client.
EXPORT_CHUNK - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The entry-point key used for the exported bundle.
exportedWebComponents(JsonObject, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
exportUsageStatisticsToDocument(Document) - Static method in class com.vaadin.flow.internal.UsageStatisticsExporter
Export UsageStatistics entries to a document.
ExtendedClientDetails - Class in com.vaadin.flow.component.page
Provides extended information about the web browser, such as screen resolution and time zone.
EXTERNAL_STATS_FILE - Static variable in class com.vaadin.flow.server.Constants
Property boolean for marking stats.json to be fetched from external location.
EXTERNAL_STATS_FILE_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
EXTERNAL_STATS_URL - Static variable in class com.vaadin.flow.server.Constants
Property String for external stats.json location url.
EXTERNAL_STATS_URL_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
extract(File, File) - Method in class com.vaadin.flow.server.frontend.installer.DefaultArchiveExtractor
 

F

F1 - Static variable in interface com.vaadin.flow.component.Key
The first general-purpose function key, F1.
F10 - Static variable in interface com.vaadin.flow.component.Key
The F10 key.
F11 - Static variable in interface com.vaadin.flow.component.Key
The F11 key.
F12 - Static variable in interface com.vaadin.flow.component.Key
The F12 key.
F13 - Static variable in interface com.vaadin.flow.component.Key
The F13 key.
F14 - Static variable in interface com.vaadin.flow.component.Key
The F14 key.
F15 - Static variable in interface com.vaadin.flow.component.Key
The F15 key.
F16 - Static variable in interface com.vaadin.flow.component.Key
The F16 key.
F17 - Static variable in interface com.vaadin.flow.component.Key
The F17 key.
F18 - Static variable in interface com.vaadin.flow.component.Key
The F18 key.
F19 - Static variable in interface com.vaadin.flow.component.Key
The F19 key.
F2 - Static variable in interface com.vaadin.flow.component.Key
The F2 key.
F20 - Static variable in interface com.vaadin.flow.component.Key
The F20 key.
F3 - Static variable in interface com.vaadin.flow.component.Key
The F3 key.
F4 - Static variable in interface com.vaadin.flow.component.Key
The F4 key.
F5 - Static variable in interface com.vaadin.flow.component.Key
The F5 key.
F6 - Static variable in interface com.vaadin.flow.component.Key
The F6 key.
F7 - Static variable in interface com.vaadin.flow.component.Key
The F7 key.
F8 - Static variable in interface com.vaadin.flow.component.Key
The F8 key.
F9 - Static variable in interface com.vaadin.flow.component.Key
The F9 key.
FakeServletConfig(ServletRegistration, ServletContext) - Constructor for class com.vaadin.flow.server.communication.JSR356WebsocketInitializer.FakeServletConfig
Creates an instance based on the given servlet registration and servlet context.
FALLBACK_TRANSPORT_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
FallibleCommand - Interface in com.vaadin.flow.server.frontend
A generic command which may fail.
FaviconHandler - Class in com.vaadin.flow.server.communication
Handles the favicon request explicitly and return 404 for it.
FaviconHandler() - Constructor for class com.vaadin.flow.server.communication.FaviconHandler
 
FAVORITE_CLEAR0 - Static variable in interface com.vaadin.flow.component.Key
Clears the program or content stored in the first favorites list slot.
FAVORITE_CLEAR1 - Static variable in interface com.vaadin.flow.component.Key
Clears the program or content stored in the second favorites list slot.
FAVORITE_CLEAR2 - Static variable in interface com.vaadin.flow.component.Key
Clears the program or content stored in the third favorites list slot.
FAVORITE_CLEAR3 - Static variable in interface com.vaadin.flow.component.Key
Clears the program or content stored in the fourth favorites list slot.
FAVORITE_RECALL0 - Static variable in interface com.vaadin.flow.component.Key
Selects (recalls) the program or content stored in the first favorites list slot.
FAVORITE_RECALL1 - Static variable in interface com.vaadin.flow.component.Key
Selects (recalls) the program or content stored in the second favorites list slot.
FAVORITE_RECALL2 - Static variable in interface com.vaadin.flow.component.Key
Selects (recalls) the program or content stored in the third favorites list slot.
FAVORITE_RECALL3 - Static variable in interface com.vaadin.flow.component.Key
Selects (recalls) the program or content stored in the fourth favorites list slot.
FAVORITE_STORE0 - Static variable in interface com.vaadin.flow.component.Key
Stores the current program or content into the first favorites list slot.
FAVORITE_STORE1 - Static variable in interface com.vaadin.flow.component.Key
Stores the current program or content into the second favorites list slot.
FAVORITE_STORE2 - Static variable in interface com.vaadin.flow.component.Key
Stores the current program or content into the third favorites list slot.
FAVORITE_STORE3 - Static variable in interface com.vaadin.flow.component.Key
Stores the current program or content into the fourth favorites list slot.
Feature - Class in com.vaadin.experimental
Information about a feature available behind a flag.
Feature(Feature) - Constructor for class com.vaadin.experimental.Feature
Create a copy of the given feature.
Feature(String, String, String, boolean, String) - Constructor for class com.vaadin.experimental.Feature
Creates a new feature with the given options.
FEATURE_FLAGS_FILE_NAME - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the feature flags file that is generated in frontend FrontendUtils.GENERATED folder.
FeatureFlags - Class in com.vaadin.experimental
Tracks available feature flags and their status.
FeatureFlags(Lookup) - Constructor for class com.vaadin.experimental.FeatureFlags
Generate FeatureFlags with given lookup data.
FeatureFlags.FeatureFlagsWrapper - Class in com.vaadin.experimental
FeatureFlags wrapper class for storing the FeatureFlags object.
FeatureFlagsWrapper(FeatureFlags) - Constructor for class com.vaadin.experimental.FeatureFlags.FeatureFlagsWrapper
Create a feature flags wrapper.
fetchCurrentURL(SerializableConsumer<URL>) - Method in class com.vaadin.flow.component.page.Page
Retrieves the current url from the browser.
fetchPageDirection(SerializableConsumer<Direction>) - Method in class com.vaadin.flow.component.page.Page
Retrieves document.dir of the current UI from the browser and passes it to the callback parameter.
FileIOUtils - Class in com.vaadin.flow.server.frontend
 
filename() - Method in class com.vaadin.flow.component.internal.ComponentTracker.Location
 
filter() - Element in annotation interface com.vaadin.flow.component.DomEvent
The filter expression to run in the browser to determine whether fired events should be passed to the server.
filter(String, Object, Object) - Method in class com.vaadin.flow.server.communication.LongPollingCacheFilter
 
filter(String, AtmosphereResource, Object, Object) - Method in class com.vaadin.flow.server.communication.LongPollingCacheFilter
 
filter(List<Dependency>, VaadinService) - Method in interface com.vaadin.flow.server.DependencyFilter
Filters the list of dependencies and returns a (possibly) updated version.
FINAL_MODE - Static variable in interface com.vaadin.flow.component.Key
The Final (Final Mode) key is used on some Asian keyboards to enter final mode when using IMEs.
FIND - Static variable in interface com.vaadin.flow.component.Key
The Find key.
findAncestor(Class<T>) - Method in class com.vaadin.flow.component.Component
Traverses the component tree up and returns the first ancestor component that matches the given type.
findAttach(Component) - Static method in class com.vaadin.flow.component.internal.ComponentTracker
Finds the location where the given component instance was attached to a parent.
findBundleFile(File, String) - Static method in class com.vaadin.flow.server.frontend.DevBundleUtils
Finds the given file inside the current development bundle.
findBundleStatsJson(File) - Static method in class com.vaadin.flow.server.frontend.DevBundleUtils
Get the stats.json for the application specific development bundle.
findClosestCommonClassLoaderAncestor(ClassLoader, ClassLoader) - Static method in class com.vaadin.flow.internal.ReflectTools
Finds the common ancestor of the two ClassLoaders.
findCommonBaseType(Class<?>, Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Finds the most specific class that both provided classes extend from.
findComponents(Element, Consumer<Component>) - Static method in class com.vaadin.flow.component.ComponentUtil
Finds the first component instance in each Element subtree by traversing the Element tree starting from the given element.
findCreate(Component) - Static method in class com.vaadin.flow.component.internal.ComponentTracker
Finds the location where the given component instance was created.
findElement(int, int) - Method in class com.vaadin.flow.server.VaadinSession
Finds the given element in the session.
findErrorHandler(VaadinSession) - Static method in class com.vaadin.flow.server.ErrorEvent
Finds the error handler for the given session.
findFiles(File, String, String) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
Finds all files (not directories) in the jar with the name specified and in the directory specified.
findFirstUrlMapping(ServletRegistration) - Static method in class com.vaadin.flow.internal.BootstrapHandlerHelper
Returns the first of sorted URL mappings of the given ServletRegistration, ignoring '/VAADIN/*' and '/vaadinServlet/*' mapping.
findLocale(VaadinSession, VaadinRequest) - Static method in class com.vaadin.flow.server.HandlerHelper
Helper to find the most most suitable Locale.
findMethod(Class<?>, String, Class<?>...) - Static method in class com.vaadin.flow.internal.ReflectTools
Locates the method in the given class.
findParentComponent(Element) - Static method in class com.vaadin.flow.component.ComponentUtil
Finds the first component by traversing upwards in the element hierarchy, starting from the given element.
findProdBundleStatsJson(ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
findRelevantThrowable(Throwable) - Static method in class com.vaadin.flow.server.DefaultErrorHandler
Vaadin wraps exceptions in its own and due to reflection usage there might be also other irrelevant exceptions that make no sense for Vaadin users (~developers using Vaadin).
findUI(VaadinRequest) - Method in class com.vaadin.flow.server.VaadinService
Finds the UI that belongs to the provided request.
findVaadinSession(VaadinRequest) - Method in class com.vaadin.flow.server.VaadinService
Attempts to find a Vaadin service session associated with this request.
FINISH - Static variable in interface com.vaadin.flow.component.Key
The Finish key.
fireEvent(ComponentEvent) - Method in class com.vaadin.flow.component.ComponentEventBus
Dispatches the event to all listeners registered for the event type.
fireEvent(ComponentEvent<?>) - Method in class com.vaadin.flow.component.Component
Dispatches the event to all listeners registered for the event type.
fireEvent(DomEvent) - Method in class com.vaadin.flow.internal.nodefeature.ElementListenerMap
Fires an event to all listeners registered for the given type.
fireEvent(RoutesChangedEvent) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
Fire routes changed event to all registered listeners.
fireEvent(String) - Method in class com.vaadin.flow.component.webcomponent.WebComponent
Fires a custom event on the client-side originating from the web component.
fireEvent(String, JsonValue) - Method in class com.vaadin.flow.component.webcomponent.WebComponent
Fires a custom event on the client-side originating from the web component with custom event data.
fireEvent(String, JsonValue, EventOptions) - Method in class com.vaadin.flow.component.webcomponent.WebComponent
Fires a custom event on the client-side originating from the web component with custom event data.
fireEvent(T, ComponentEvent<? extends T>) - Static method in class com.vaadin.flow.component.ComponentUtil
Dispatches the event to all listeners registered for the event type.
fireSessionDestroy(VaadinSession) - Method in class com.vaadin.flow.server.VaadinService
Handles destruction of the given session.
fireUIInitListeners(UI) - Method in class com.vaadin.flow.server.VaadinService
Fire UI initialization event to all registered UIInitListeners.
FIRST_DELAY_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
FIRST_DELAY_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
firstToLower(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Changes the first character in the given string to lower case in a way suitable for use in code (methods, properties etc).
FIXED - Enum constant in enum class com.vaadin.flow.dom.Style.Position
 
FLEX - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
FN - Static variable in interface com.vaadin.flow.component.Key
The Fn (Function modifier) key.
FN_LOCK - Static variable in interface com.vaadin.flow.component.Key
The FnLock or F-Lock (Function Lock) key.
focus() - Method in interface com.vaadin.flow.component.Focusable
Calls the focus function at the client, making the component keyboard focused.
Focusable<T extends Component> - Interface in com.vaadin.flow.component
Represents a component that can gain and lose focus.
FocusEvent(C, boolean) - Constructor for class com.vaadin.flow.component.FocusNotifier.FocusEvent
FocusEvent base constructor.
FocusNotifier<T extends Component> - Interface in com.vaadin.flow.component
Mixin interface to handle focus events on components.
FocusNotifier.FocusEvent<C extends Component> - Class in com.vaadin.flow.component
Represents the DOM event "focus".
FOOTER - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <footer>.
forApplicationScope() - Static method in class com.vaadin.flow.router.RouteConfiguration
Get a RouteConfiguration that edits the application scope routes.
FORBIDDEN - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (403) indicating the server understood the request but refused to fulfill it.
FORCE_PRODUCTION_BUILD - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for forcing optimized production bundle build.
forceAlternativeNodeExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Locate node executable from the alternative directory given.
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.AttachExistingElementFeature
 
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Passes each child node instance to the given consumer.
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
 
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
 
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.NodeValue
 
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.ServerSideFeature
 
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
forEachChild(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.StateNode
Executes the given action for each child node of this state node.
forEachInjectedField(InjectableFieldConsumer) - Method in class com.vaadin.flow.component.template.internal.ParserData
Applies the given consumer to each mapped field.
forIdentifier(String) - Static method in enum class com.vaadin.flow.dom.DebouncePhase
Gets the phase that corresponds to the given identifier character.
forRegistry(RouteRegistry) - Static method in class com.vaadin.flow.router.RouteConfiguration
Get a RouteConfiguration for editing the given RouteRegistry implementation.
forSessionScope() - Static method in class com.vaadin.flow.router.RouteConfiguration
Get a RouteConfiguration that edits the session scope routes.
forString(String) - Static method in enum class com.vaadin.flow.component.HasText.WhiteSpace
 
forward() - Method in class com.vaadin.flow.component.page.History
Navigates forward.
forwardTo(NavigationHandler, NavigationState) - Method in class com.vaadin.flow.router.BeforeEvent
Forward the navigation to use the provided navigation handler instead of the currently used handler.
forwardTo(NavigationState) - Method in class com.vaadin.flow.router.BeforeEvent
Forward the navigation to the given navigation state.
forwardTo(Class<? extends Component>) - Method in class com.vaadin.flow.router.BeforeEvent
Forward the navigation to show the given component instead of the component that is currently about to be displayed.
forwardTo(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.BeforeEvent
Forward the navigation to show the given component instead of the component that is currently about to be displayed.
forwardTo(String) - Method in class com.vaadin.flow.router.BeforeEvent
Forward to navigation component registered for given location string instead of the component about to be displayed.
forwardTo(String, List<T>) - Method in class com.vaadin.flow.router.BeforeEvent
Forward to navigation component registered for given location string with given location parameters instead of the component about to be displayed.
forwardTo(String, T) - Method in class com.vaadin.flow.router.BeforeEvent
Forward to navigation component registered for given location string with given location parameter instead of the component about to be displayed.
forwardToUrl(String) - Method in class com.vaadin.flow.router.BeforeEvent
Forward to the given URL instead of the component about to be displayed.
FOUND - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (302) indicating that the resource reside temporarily under a different URI.
FragmentedMessage(Reader) - Constructor for class com.vaadin.flow.server.communication.AtmospherePushConnection.FragmentedMessage
Creates a message by reading from the given reader.
from(Element, Class<T>) - Static method in class com.vaadin.flow.component.Component
Creates a new component instance using the given element.
fromJsoup(Node) - Static method in class com.vaadin.flow.dom.ElementUtil
Converts a given JSoup Node and its children into a matching Element hierarchy.
fromString(String) - Static method in class com.vaadin.flow.router.QueryParameters
Creates parameters from a query string.
frontDeps - Variable in class com.vaadin.flow.server.frontend.NodeUpdater
The FrontendDependencies object representing the application dependencies.
FRONTEND - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Default folder used for source and generated folders.
FRONTEND_FOLDER_ALIAS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
A special prefix used to map imports placed in the FrontendUtils.DEFAULT_FRONTEND_DIR.
FRONTEND_GENERATED_FLOW_IMPORT_PATH - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The prefix used to import files generated by Flow.
FRONTEND_HOTDEPLOY - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for enabling development using the frontend development server instead of using an application bundle.
FRONTEND_HOTDEPLOY_DEPENDENCIES - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for adding dependencies on other projects when using the frontend development server.
FRONTEND_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
FRONTEND_URL_ES6 - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Configuration parameter for the build URL of ES6 web components.
FrontendDependencies - Class in com.vaadin.flow.server.frontend.scanner
Represents the class dependency tree of the application.
FrontendDependencies(ClassFinder) - Constructor for class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Default Constructor.
FrontendDependencies(ClassFinder, boolean) - Constructor for class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Secondary constructor, which allows declaring whether embeddable web components should be checked for resource dependencies.
FrontendDependencies(ClassFinder, boolean, FeatureFlags) - Constructor for class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Tertiary constructor, which allows declaring whether embeddable web components should be checked for resource dependencies.
FrontendDependenciesScanner - Interface in com.vaadin.flow.server.frontend.scanner
Frontend dependencies scanner.
FrontendDependenciesScanner.FrontendDependenciesScannerFactory - Class in com.vaadin.flow.server.frontend.scanner
Frontend dependencies scanner factory.
FrontendDependenciesScannerFactory() - Constructor for class com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner.FrontendDependenciesScannerFactory
 
frontendHotdeploy() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Deprecated.
frontendHotdeploy() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
frontendHotdeploy() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
frontendImportsFound(JsonObject, Options, ClassFinder, FrontendDependenciesScanner) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
FrontendTools - Class in com.vaadin.flow.server.frontend
Provides access to frontend tools (Node.js and npm, pnpm) and optionally installs the tools if needed.
FrontendTools(FrontendToolsSettings) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
Creates an instance of the class using the baseDir as a base directory to locate the tools and the directory returned by the alternativeDirGetter as a directory to install tools if they are not found and use it as an alternative tools location.
FrontendTools(ApplicationConfiguration, File) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
Creates an instance using the the given project directory and application configuration.
FrontendTools(String, Supplier<String>, boolean) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
Deprecated.
use FrontendTools(FrontendToolsSettings) instead, as it simplifies configuring the frontend tools and gives the default values to configuration parameters.
FrontendTools(String, Supplier<String>, String, URI) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
Deprecated.
use FrontendTools(FrontendToolsSettings) instead, as it simplifies configuring the frontend tools and gives the default values to configuration parameters.
FrontendTools(String, Supplier<String>, String, URI, boolean, boolean) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
Deprecated.
use FrontendTools(FrontendToolsSettings) instead, as it simplifies configuring the frontend tools and gives the default values to configuration parameters.
FrontendTools(String, Supplier<String>, String, URI, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
Deprecated.
use FrontendTools(FrontendToolsSettings) instead, as it simplifies configuring the frontend tools and gives the default values to configuration parameters.
FrontendToolsLocator - Class in com.vaadin.flow.server.frontend
Helps to locate the tools in the system by their names.
FrontendToolsLocator() - Constructor for class com.vaadin.flow.server.frontend.FrontendToolsLocator
 
FrontendToolsSettings - Class in com.vaadin.flow.server.frontend
Configuration object for controlling the FrontendTools features.
FrontendToolsSettings(String, SerializableSupplier<String>) - Constructor for class com.vaadin.flow.server.frontend.FrontendToolsSettings
Create a tools configuration object.
FrontendUtils - Class in com.vaadin.flow.server.frontend
A class for static methods and definitions that might be used in different locations.
FrontendUtils.CommandExecutionException - Exception in com.vaadin.flow.server.frontend
Thrown when the command execution fails.
FrontendUtils.UnknownVersionException - Exception in com.vaadin.flow.server.frontend
Thrown when detecting the version of a tool fails.
FrontendVersion - Class in com.vaadin.flow.server.frontend
Version object for frontend versions comparison and handling.
FrontendVersion(int, int) - Constructor for class com.vaadin.flow.server.frontend.FrontendVersion
Create a version of format "major.minor.0".
FrontendVersion(int, int, int) - Constructor for class com.vaadin.flow.server.frontend.FrontendVersion
Create a version of format "major.minor.revision".
FrontendVersion(int, int, int, String) - Constructor for class com.vaadin.flow.server.frontend.FrontendVersion
Create a version of format "major.minor.revision.build"
FrontendVersion(String) - Constructor for class com.vaadin.flow.server.frontend.FrontendVersion
Parse version numbers from version string with the format "major.minor.revision[.build]".
FrontendVersion(String, String) - Constructor for class com.vaadin.flow.server.frontend.FrontendVersion
Parse version numbers from version string with the format "major.minor.revision[.build]".
FrontendWebComponentGenerator - Class in com.vaadin.flow.server.frontend
Generates embeddable web component files in npm mode, hiding the complexity caused by using a different class loader.
FrontendWebComponentGenerator(ClassFinder) - Constructor for class com.vaadin.flow.server.frontend.FrontendWebComponentGenerator
Creates a new instances and stores the finder to be used for locating WebComponentModulesWriter and WebComponentExporter/WebComponentExporterFactory classes.
full(Map<String, String[]>) - Static method in class com.vaadin.flow.router.QueryParameters
Creates parameters from full representation, where each parameter name may correspond to multiple values.
FutureAccess - Class in com.vaadin.flow.server
Encapsulates a Command submitted using VaadinSession.access(Command).
FutureAccess(VaadinSession, Command) - Constructor for class com.vaadin.flow.server.FutureAccess
Creates an instance for the given command.

G

GATEWAY_TIMEOUT - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (504) indicating that the server did not receive a timely response from the upstream server while acting as a gateway or proxy.
generateChangesFromEmpty() - Method in class com.vaadin.flow.internal.nodefeature.InertData
 
generateChangesFromEmpty() - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Generates all changes that would be needed to take this node from its initial empty state to its current state.
generateChangesFromEmpty() - Method in class com.vaadin.flow.internal.nodefeature.NodeList
 
generateChangesFromEmpty() - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
 
generateChangesFromEmpty() - Method in class com.vaadin.flow.internal.nodefeature.NodeValue
 
generateChangesFromEmpty() - Method in class com.vaadin.flow.internal.nodefeature.ServerSideFeature
 
GENERATED - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Default folder for client-side generated files inside the project root frontend folder.
GenerateMainImports - Class in com.vaadin.flow.server.frontend
Collect generated-flow-imports content for project to use to determine if dev-bundle contains all required imports.
GenerateMainImports(ClassFinder, FrontendDependenciesScanner, Options, JsonObject) - Constructor for class com.vaadin.flow.server.frontend.GenerateMainImports
 
generateModule(WebComponentConfiguration<? extends Component>, String, String) - Static method in class com.vaadin.flow.server.webcomponent.WebComponentGenerator
Generate web component html/JS for given tag and class.
generateModule(WebComponentExporterFactory<? extends Component>, String, String) - Static method in class com.vaadin.flow.server.webcomponent.WebComponentGenerator
Generate web component html/JS for given exporter factory.
generateNPMResponse(String, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.WebComponentProvider
Generate the npm response for the web component.
generateURI(String, String) - Static method in class com.vaadin.flow.server.communication.StreamRequestHandler
Generates URI string for a dynamic resource using its id and name.
generateVersionsJson(JsonObject) - Method in class com.vaadin.flow.server.frontend.NodeUpdater
Generate versions json file for version locking.
generateWebComponents(File, ThemeDefinition) - Method in class com.vaadin.flow.server.frontend.FrontendWebComponentGenerator
Collects WebComponentModulesWriter class and classes that extend WebComponentExporter/WebComponentExporterFactory using finder.
generateWebComponentsToDirectory(Class<?>, Set<Class<?>>, File, String) - Static method in class com.vaadin.flow.server.webcomponent.WebComponentModulesWriter.DirectoryWriter
Calls WebComponentModulesWriter.writeWebComponentsToDirectory(java.util.Set, java.io.File, java.lang.String) via reflection on the supplied writer.
get() - Method in class com.vaadin.flow.component.internal.DeadlockDetectingCompletableFuture
 
get() - Static method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
Gets the one and only instance.
get() - Static method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
Gets the one and only instance.
get() - Static method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
Gets the one and only instance.
get() - Static method in class com.vaadin.flow.internal.NullOwner
Gets the singleton null owner instance.
get() - Static method in class com.vaadin.flow.server.DefaultSystemMessagesProvider
Gets the instance.
get() - Method in class com.vaadin.flow.server.FutureAccess
 
get(int) - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
get(int) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
get(int) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Gets the item at the given index.
get(int) - Method in class com.vaadin.flow.internal.nodefeature.ReturnChannelMap
Gets the return channel registration registered with the provided id, or null if no channel is registered with that id.
get(int) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 
get(long, TimeUnit) - Method in class com.vaadin.flow.component.internal.DeadlockDetectingCompletableFuture
 
get(HasElement) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Gets the property value for the given component.
get(PropertyDescriptor<?, T>) - Method in class com.vaadin.flow.component.Component
Gets the value of the given component property.
get(UI) - Static method in interface com.vaadin.flow.di.Instantiator
Gets the instantiator to use for the given UI.
get(Element) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Gets the property value for the given element.
get(StateNode) - Static method in class com.vaadin.flow.dom.Element
Gets the element mapped to the given state node.
get(StateNode) - Static method in class com.vaadin.flow.dom.ShadowRoot
Gets the shadow root instance mapped to the given state node.
get(StateNode, ElementStateProvider) - Static method in class com.vaadin.flow.dom.Element
Gets the element mapped to the given state node and element state provider.
get(VaadinContext) - Static method in class com.vaadin.experimental.FeatureFlags
Gets the FeatureFlags for the given Vaadin context.
get(VaadinContext) - Static method in interface com.vaadin.flow.server.startup.ApplicationConfiguration
Gets a configuration instance for the given {code context}.
get(Class<? extends C>) - Method in class com.vaadin.flow.internal.ReflectionCache
Gets a cached value.
get(Class<T>) - Static method in class com.vaadin.flow.internal.CurrentInstance
Gets the current instance of a specific type if available.
get(String) - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
get(String) - Static method in class com.vaadin.flow.dom.impl.CustomAttribute
Gets the custom attribute with the provided name, if present.
get(String) - Method in class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
get(String) - Method in interface com.vaadin.flow.dom.Style
Gets the value of the given style property.
get(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Gets the value of an attribute.
get(String) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Gets the value corresponding to the given key.
get(String) - Method in class com.vaadin.flow.router.RouteParameters
Gets the string representation of a parameter.
getActiveChain() - Method in class com.vaadin.flow.router.AfterNavigationEvent
Get the active chain that we have after navigation.
getActiveDragSourceComponent() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the drag source of an active HTML5 drag event.
getActiveDragSourceComponent() - Method in class com.vaadin.flow.component.UI
Gets the drag source of an active HTML5 drag event.
getActiveModalComponent() - Method in class com.vaadin.flow.component.internal.UIInternals
Get the active modal component if modal components set.
getActiveRouterTargetsChain() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the currently active router target and parent layouts.
getActiveThemes(VaadinContext) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
Gets the active themes in parent to child order, starting from the application theme.
getActiveViewLocation() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the location of the currently shown view.
getAddedDependencyFilters() - Method in class com.vaadin.flow.server.ServiceInitEvent
Gets a stream of all dependency filters that have been added for the service.
getAddedIndexHtmlRequestListeners() - Method in class com.vaadin.flow.server.ServiceInitEvent
Gets a stream of all Index HTML request listeners that have been added for the service.
getAddedNavigationTargets() - Method in class com.vaadin.flow.router.RoutesChangedEvent
Get every single navigation targets of all added routes in this change.
getAddedRequestHandlers() - Method in class com.vaadin.flow.server.ServiceInitEvent
Gets a stream of all custom request handlers that have been added for the service.
getAddedRoutes() - Method in class com.vaadin.flow.router.RoutesChangedEvent
Get all routes added for this change.
getAddedURLs() - Method in class com.vaadin.flow.router.RoutesChangedEvent
Get every single URL of all added routes in this change.
getAddress() - Method in class com.vaadin.flow.server.WebBrowser
Gets the IP-address of the web browser, if available.
getAllSessions(HttpSession) - Static method in class com.vaadin.flow.server.VaadinSession
Retrieves all VaadinSessions which are stored in the given HTTP session.
getAlternativeDirGetter() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Get the alternative directory getter.
getAnnotatedClasses(Class<? extends Annotation>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
 
getAnnotatedClasses(Class<? extends Annotation>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
 
getAnnotatedClasses(Class<? extends Annotation>) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
Get annotated classes in the classloader.
getAnnotatedClasses(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
Get annotated classes in the classloader.
getAnnotation(AnnotatedElement, String) - Static method in class com.vaadin.flow.internal.ReflectTools
Gets annotation of element whose FQN is annotationFqn.
getAnnotationFor(Class<?>, Class<T>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Helper to get an annotation for a class.
getAnnotationFor(Field, Class<T>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Helper to get an annotation for a field.
getAnnotationMethodValue(Annotation, String) - Static method in class com.vaadin.flow.internal.ReflectTools
Gets the annotation method return value.
getAnnotations() - Method in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
Gets the annotations that are subject to validate.
getAnnotations() - Method in class com.vaadin.flow.server.startup.AnnotationValidator
 
getAnnotations() - Method in class com.vaadin.flow.server.startup.WebComponentExporterAwareValidator
 
getAnnotationsFor(Class<?>, Class<T>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Helper to get annotations for a class by searching recursively the class and all its super classes and implemented interfaces and their parent interfaces.
getAnnotationValueFor(Class<?>, Class<A>, Function<A, T>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Gets a value from an annotation for a class.
getAnnotationValuesFor(Class<?>, Class<A>, Function<A, T>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Gets values from annotations for a class by searching recursively the class and all its super classes and implemented interfaces and their parent interfaces.
getAppId() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the application id tied with this UI.
getAppId() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the application id.
getApplicationOrSystemProperty(String, T, Function<String, T>) - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Gets a configured property.
getApplicationOrSystemProperty(String, T, Function<String, T>) - Method in class com.vaadin.flow.server.AbstractPropertyConfiguration
Gets a configured property.
getApplicationParameters() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the application parameters specified by the BootstrapHandler.
getApplicationProperty(String) - Method in class com.vaadin.flow.server.AbstractPropertyConfiguration
Gets an application property value.
getApplicationProperty(String) - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
Gets an application property value.
getApplicationProperty(Function<String, String>, String) - Method in class com.vaadin.flow.server.AbstractPropertyConfiguration
Gets application property value using the valueProvider.
getApplicationResource(String) - Method in class com.vaadin.flow.di.LookupInitializer.ResourceProviderImpl
 
getApplicationResource(String) - Method in interface com.vaadin.flow.di.ResourceProvider
Gets the resource identified by path located in the application bundle (jar) which may be found using this resource provider instance.
getApplicationResources(String) - Method in class com.vaadin.flow.di.LookupInitializer.ResourceProviderImpl
 
getApplicationResources(String) - Method in interface com.vaadin.flow.di.ResourceProvider
Gets all the resources identified by path located in in the application bundle (jar) which may be found using this resource provider.
getAppName() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the application name.
getAppShellTitle() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the stored app shell title.
getArchitecture() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Get platform architecture.
getArchiveExtension() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Get the archive extension used with this platform.
getAriaLabel() - Method in interface com.vaadin.flow.component.HasAriaLabel
Gets the aria-label of the component.
getAriaLabelledBy() - Method in interface com.vaadin.flow.component.HasAriaLabel
Gets the aria-labelledby of the component
getAtmosphereVersion() - Static method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Gets the Atmosphere version in use, as reported by Version.getRawVersion().
getAttribute(Element) - Method in class com.vaadin.flow.dom.impl.ClassAttributeHandler
 
getAttribute(Element) - Method in class com.vaadin.flow.dom.impl.CustomAttribute
Gets the value that should be returned by Element.getAttribute(String) for this attribute.
getAttribute(Element) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
getAttribute(StateNode, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the value of the given attribute.
getAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getAttribute(Class<T>) - Method in class com.vaadin.flow.server.Attributes
Gets a stored attribute value.
getAttribute(Class<T>) - Method in interface com.vaadin.flow.server.VaadinContext
Returns value of the specified attribute.
getAttribute(Class<T>) - Method in class com.vaadin.flow.server.VaadinSession
Gets a stored attribute value.
getAttribute(Class<T>, Supplier<T>) - Method in interface com.vaadin.flow.server.VaadinContext
Returns value of the specified attribute, creating and storing a default value if attribute not present.
getAttribute(Class<T>, Supplier<T>) - Method in class com.vaadin.flow.server.VaadinServletContext
 
getAttribute(String) - Method in class com.vaadin.flow.dom.Element
Gets the value of the given attribute.
getAttribute(String) - Method in class com.vaadin.flow.server.Attributes
Gets a stored attribute value.
getAttribute(String) - Method in interface com.vaadin.flow.server.VaadinRequest
Gets a request attribute.
getAttribute(String) - Method in class com.vaadin.flow.server.VaadinSession
Gets a stored attribute value.
getAttribute(String) - Method in class com.vaadin.flow.server.WrappedHttpSession
 
getAttribute(String) - Method in interface com.vaadin.flow.server.WrappedSession
Gets an attribute from this session.
getAttributeJson() - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI.WebComponentConnectEvent
Gets the initial attribute values.
getAttributeName(String) - Static method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
Returns the name of the attribute in the servlet context where the pre-initialized Atmosphere object is stored.
getAttributeNames() - Method in class com.vaadin.flow.dom.Element
Gets the defined attribute names.
getAttributeNames() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns an Enumeration containing the names of the attributes available to this request.
getAttributeNames() - Method in class com.vaadin.flow.server.WrappedHttpSession
 
getAttributeNames() - Method in interface com.vaadin.flow.server.WrappedSession
Gets the current set of attribute names stored in this session.
getAttributeNames(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the defined attribute names.
getAttributeNames(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getAttributeNames(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getAttributeNames(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getAttributes() - Method in class com.vaadin.flow.component.template.internal.IdCollector
Gets a map from field ids to their parsed attributes values.
getAttributes(String) - Method in class com.vaadin.flow.component.template.internal.ParserData
Gets template element data (attribute values).
getAuthType() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the name of the authentication scheme used for the connection between client and server, for example, BASIC_AUTH, CLIENT_CERT_AUTH, a custom one or null if there was no authentication.
getAvailableRoutes() - Method in class com.vaadin.flow.router.RouteConfiguration
Get the RouteData for all registered navigation targets.
getBackend() - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Detects and return enabling live reload backend technology.
getBackgroundColor() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the background color of the application.
getBaseDir() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Get the defined base dir.
getBaseUrl() - Method in interface com.vaadin.flow.theme.AbstractTheme
The url for the base component implementation.
getBeanPropertyDescriptors(Class<?>) - Static method in class com.vaadin.flow.internal.BeanUtil
Returns the property descriptors of a class or an interface.
getBehavior() - Method in class com.vaadin.flow.component.ScrollOptions
Gets the scroll behavior.
getBlock() - Method in class com.vaadin.flow.component.ScrollOptions
Gets the vertical alignment.
getBodyClientHeight() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Gets the height of the body element in the document in pixels.
getBodyClientWidth() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Gets the width of the body element in the document in pixels.
getBooleanProperty(String, boolean) - Method in interface com.vaadin.flow.function.DeploymentConfiguration
getBooleanProperty(String, boolean) - Method in interface com.vaadin.flow.server.AbstractConfiguration
Gets a configured property as a boolean.
getBooleanProperty(String, boolean) - Method in class com.vaadin.flow.server.AbstractPropertyConfiguration
 
getBootstrapInitialPredicate() - Method in class com.vaadin.flow.server.VaadinService
Get the predicate for including the initial Uidl fragment in the bootstrap page.
getBootstrapPage(BootstrapHandler.BootstrapContext) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
Returns the bootstrap page for the given context.
getBootstrapPage(BootstrapHandler.BootstrapContext) - Method in interface com.vaadin.flow.server.BootstrapHandler.PageBuilder
Creates the bootstrap page.
getBootstrapScript(JsonValue, BootstrapHandler.BootstrapContext) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
getBootstrapUrlPredicate() - Method in class com.vaadin.flow.server.VaadinService
Get the predicate for testing whether the request has a valid URL for rendering the bootstrap page.
getBrowser() - Method in class com.vaadin.flow.server.AppShellSettings
Get the web browser used for the request used for these settings.
getBrowser() - Method in class com.vaadin.flow.server.communication.UidlWriter.ResolveContext
Gets the browser info used for resolving.
getBrowser() - Method in class com.vaadin.flow.server.VaadinSession
Get the web browser associated with this session.
getBrowserApplication() - Method in class com.vaadin.flow.server.WebBrowser
Get the browser user-agent string.
getBrowserEngineVersion() - Method in class com.vaadin.flow.shared.BrowserDetails
Returns the version of the browser engine.
getBrowserMajorVersion() - Method in class com.vaadin.flow.server.WebBrowser
Gets the major version of the browser the user is using.
getBrowserMajorVersion() - Method in class com.vaadin.flow.shared.BrowserDetails
Returns the browser major version e.g., 3 for Firefox 3.5, 4 for Chrome 4, 8 for Internet Explorer 8.
getBrowserMinorVersion() - Method in class com.vaadin.flow.server.WebBrowser
Gets the minor version of the browser the user is using.
getBrowserMinorVersion() - Method in class com.vaadin.flow.shared.BrowserDetails
Returns the browser minor version e.g., 5 for Firefox 3.5.
getBuildDirectory() - Method in class com.vaadin.flow.server.frontend.Options
Gets the directory used for the build output.
getBuildDirectoryName() - Method in class com.vaadin.flow.server.frontend.Options
Get the name of the used build directory.
getBuildFolder() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Return the defined build folder for the used build system.
getBuildFolder() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getBuildIdentifier() - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Gets the version qualifier, qualifier in x.y.z.qualifier.
getBuildIdentifier() - Static method in class com.vaadin.flow.server.Version
Gets the version qualifier, qualifier in x.y.z.qualifier.
getButton() - Method in class com.vaadin.flow.component.ClickEvent
Gets the id of the pressed mouse button.
getByIdentifier(String) - Static method in enum class com.vaadin.flow.shared.ui.Transport
Returns a Transport by its identifier.
getBytesReceived() - Method in class com.vaadin.flow.server.communication.streaming.StreamingEndEventImpl
 
getBytesReceived() - Method in interface com.vaadin.flow.server.StreamVariable.StreamingEvent
Get the number of bytes streamed.
getCacheFormat() - Method in class com.vaadin.flow.server.PwaIcon
Gets the cache-string used in Google Workbox caching.
getCacheTime() - Method in class com.vaadin.flow.server.AbstractStreamResource
Gets the length of cache expiration time.
getCacheTime(String) - Method in class com.vaadin.flow.server.StaticFileServer
Calculates the cache lifetime for the given filename in seconds.
getCallback(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.AttachExistingElementFeature
Gets callback of the registered node.
getCancelingRelativePath(String) - Static method in class com.vaadin.flow.server.HandlerHelper
Gets a relative path that cancels the provided path.
getCaughtException() - Method in class com.vaadin.flow.router.ErrorParameter
Gets the originally caught exception.
getChangeTracker() - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Gets or creates the list used to track changes that should be sent to the client.
getChangeTracker(NodeFeature, Supplier<T>) - Method in class com.vaadin.flow.internal.StateNode
Gets or creates a change tracker object for the provided feature.
getChannelId() - Method in interface com.vaadin.flow.internal.nodefeature.ReturnChannelRegistration
Gets the id that identifies this channel within its state node.
getCharacterEncoding() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the name of the character encoding used in the body of this request.
getChild(int) - Method in class com.vaadin.flow.dom.Element
Returns the child element at the given position.
getChild(int) - Method in class com.vaadin.flow.dom.Node
Returns the child element at the given position.
getChild(StateNode, int) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Returns the child element at the given position.
getChild(StateNode, int) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
getChild(StateNode, int) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getChildCount() - Method in class com.vaadin.flow.dom.Element
Gets the number of child elements.
getChildCount() - Method in class com.vaadin.flow.dom.Node
Gets the number of child elements.
getChildCount(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the number of child elements.
getChildCount(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
getChildCount(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getChildren() - Method in class com.vaadin.flow.component.Component
Gets the child components of this component.
getChildren() - Method in class com.vaadin.flow.component.Composite
Gets the child components of this composite.
getChildren() - Method in interface com.vaadin.flow.component.HasOrderedComponents
Gets the children components of this component.
getChildren() - Method in class com.vaadin.flow.component.UI
 
getChildren() - Method in class com.vaadin.flow.dom.Element
Gets all the children of this element.
getChildren() - Method in class com.vaadin.flow.dom.Node
Gets all the children of this element.
getChunkId(Class<? extends Component>) - Static method in class com.vaadin.flow.server.frontend.BundleUtils
Gets the id for a chunk defined by the given class.
getChunkId(String) - Static method in class com.vaadin.flow.server.frontend.BundleUtils
Gets the id for a chunk defined by the given class.
getChunkKeys(JsonObject) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
Return the list of chunk keys that should be considered by the bootstrap handler.
getClassAnnotations(Class<?>) - Method in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
Returns the validation annotations declared for the clazz.
getClassAnnotations(Class<?>, List<Class<?>>) - Static method in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
Returns annotations declared for the clazz.
getClasses() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get all Java classes considered when looking for used dependencies.
getClasses() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get all Java classes considered when looking for used dependencies.
getClassFinder() - Method in class com.vaadin.flow.server.frontend.Options
Gets the used class finder.
getClassList() - Method in class com.vaadin.flow.dom.Element
Gets the set of CSS class names used for this element.
getClassList() - Method in class com.vaadin.flow.internal.nodefeature.ElementClassList
Creates a view into this list.
getClassList(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets a list representation of all CSS class names set for an element.
getClassList(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getClassList(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getClassList(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getClassloader() - Method in interface com.vaadin.flow.internal.ApplicationClassLoaderAccess
Gets the web application classloader.
getClassLoader() - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
 
getClassLoader() - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
 
getClassLoader() - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
Get class loader which is used to find classes.
getClassLoader() - Method in class com.vaadin.flow.server.VaadinService
Gets the class loader to use for loading classes loaded by name, e.g.
getClassLoaderName() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Gets class loader configuration option value.
getClassLoaderName() - Method in class com.vaadin.flow.server.AbstractDeploymentConfiguration
 
getClassName() - Method in interface com.vaadin.flow.component.HasStyle
Gets the CSS class names for this component.
getClassNames() - Method in interface com.vaadin.flow.component.HasStyle
Gets the set of CSS class names used for this element.
getClassType(Class<?>) - Static method in class com.vaadin.flow.router.ParameterDeserializer
Get the parameter type class.
getCleanedPushServletMapping(String) - Static method in class com.vaadin.flow.internal.BootstrapHandlerHelper
Cleans up the given push servlet mapping value for proper use.
getCleanupTimeMs() - Method in class com.vaadin.flow.server.frontend.TaskRunNpmInstall.Stats
Gets the time spent doing cleanup before npm install.
getClickCount() - Method in class com.vaadin.flow.component.ClickEvent
Gets the number of consecutive clicks recently recorded.
getClientForwardRoute() - Method in class com.vaadin.flow.component.internal.JavaScriptNavigationStateRenderer
Gets the client forward route.
getClientName() - Method in enum class com.vaadin.flow.component.Direction
Gets the value applied as the dir attribute in html for document.
getClientResource(String) - Method in class com.vaadin.flow.di.LookupInitializer.ResourceProviderImpl
 
getClientResource(String) - Method in interface com.vaadin.flow.di.ResourceProvider
Gets "flow-client" bundle resource identified by the path.
getClientResourceAsStream(String) - Method in class com.vaadin.flow.di.LookupInitializer.ResourceProviderImpl
 
getClientResourceAsStream(String) - Method in interface com.vaadin.flow.di.ResourceProvider
Gets "flow-client" bundle resource content identified by the path.
getClientToServerId() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Gets the id of the client to server message.
getClientX() - Method in class com.vaadin.flow.component.ClickEvent
Gets the x coordinate of the click event, relative to the upper left corner of the browser viewport.
getClientY() - Method in class com.vaadin.flow.component.ClickEvent
Gets the y coordinate of the click event, relative to the upper left corner of the browser viewport.
getCode() - Method in class com.vaadin.flow.component.internal.KeyboardEvent
Gets the code of the event.
getCode() - Method in enum class com.vaadin.flow.server.HttpStatusCode
Gets the integer representation of the HTTP status code.
getCodename() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Get the codename used with this Platform.
getCompiledWebComponentsPath() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
 
getComponent() - Method in class com.vaadin.flow.dom.Element
Gets the component this element has been mapped to, if any.
getComponent() - Method in class com.vaadin.flow.internal.nodefeature.ComponentMapping
Gets the component this node has been mapped to, if any.
getComponent() - Method in class com.vaadin.flow.server.webcomponent.WebComponentBinding
Retrieves the bound Component instance.
getComponent(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the component this element is mapped to.
getComponent(StateNode) - Static method in class com.vaadin.flow.internal.nodefeature.ComponentMapping
Gets the component mapped to the given state node.
getComponentAt(int) - Method in interface com.vaadin.flow.component.HasOrderedComponents
Returns the component at the given position.
getComponentClass() - Method in interface com.vaadin.flow.component.webcomponent.WebComponentConfiguration
Retrieve the type of the component.
getComponentClass() - Method in class com.vaadin.flow.component.WebComponentExporter
The concrete component class object.
getComponentClassName() - Method in class com.vaadin.experimental.Feature
 
getComponentCount() - Method in interface com.vaadin.flow.component.HasOrderedComponents
Gets the number of children components.
getConfigParameter(String) - Method in interface com.vaadin.flow.server.VaadinConfig
Returns the value for the requested parameter, or null if the parameter does not exist.
getConfigParameter(String) - Method in class com.vaadin.flow.server.VaadinServletConfig
 
getConfigParameterNames() - Method in interface com.vaadin.flow.server.VaadinConfig
Returns the names of the initialization parameters as an Enumeration, or an empty Enumeration if there are o initialization parameters.
getConfigParameterNames() - Method in class com.vaadin.flow.server.VaadinServletConfig
 
getConfigParametersUsingTokenData(JsonObject) - Method in class com.vaadin.flow.server.startup.AbstractConfigurationFactory
Returns the config parameters from the token file data buildInfo.
getConfiguration() - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
Get the current valid configuration.
getConfiguration() - Method in class com.vaadin.flow.server.VaadinSession
Gets the configuration for this session.
getConfiguration(String) - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Get a web component configuration for given custom element tag if one is registered.
getConfigurations() - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Get an unmodifiable set containing all registered web component configurations.
getConfigurationsByComponentType(Class<T>) - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Get an unmodifiable set containing all registered web component configurations for a specific Component type.
getConfiguredNavigationTarget() - Method in exception com.vaadin.flow.server.AmbiguousRouteConfigurationException
Returns the already configured navigation target component class which caused the exception.
getConstantId(ConstantPoolKey) - Method in class com.vaadin.flow.internal.ConstantPool
Gets the id of a given constant, registering the constant with this constant pool if it hasn't already been encountered.
getConstantIntValues(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Collect all the integer values for public static final constants found for the given class.
getConstantPool() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the constant pool that is used for keeping track of constants shared with the client for this UI.
getContainerTag() - Method in class com.vaadin.flow.component.internal.UIInternals
 
getContent() - Method in class com.vaadin.flow.component.Composite
Gets the content of the composite, i.e.
getContentLength() - Method in class com.vaadin.flow.server.communication.streaming.StreamingEndEventImpl
 
getContentLength() - Method in interface com.vaadin.flow.server.StreamVariable.StreamingEvent
Get the content length.
getContentLength() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the length of the request content that can be read from the input stream returned by VaadinRequest.getInputStream().
getContentLengthLong() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the length of the request content that can be read from the input stream returned by VaadinRequest.getInputStream().
getContentType() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the MIME type of the body of the request, or null if the type is not known.
getContentTypeResolver() - Method in class com.vaadin.flow.server.StreamResource
Gets the resolver which is used to lookup the content type of the resource.
getContext() - Method in interface com.vaadin.flow.server.RouteRegistry
Gets the Vaadin context which the registry belongs to.
getContext() - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getContext() - Method in interface com.vaadin.flow.server.startup.ApplicationConfiguration
The context which the configuration is based on.
getContext() - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
 
getContext() - Method in class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl
 
getContext() - Method in class com.vaadin.flow.server.VaadinService
Returns VaadinContext for this service.
getContext() - Method in class com.vaadin.flow.server.VaadinServletContext
Returns the underlying context.
getContextParameter(String) - Method in interface com.vaadin.flow.server.VaadinContext
Returns the value for the requested parameter, or null if the parameter does not exist.
getContextParameter(String) - Method in class com.vaadin.flow.server.VaadinServletContext
 
getContextParameterNames() - Method in interface com.vaadin.flow.server.VaadinContext
Returns the names of the initialization parameters as an Enumeration, or an empty Enumeration if there are o initialization parameters.
getContextParameterNames() - Method in class com.vaadin.flow.server.VaadinServletContext
 
getContextPath() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the portion of the request URI that indicates the context of the request.
getContextRootRelativePath() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the relative path from the UI (servlet) path to the context root.
getContextRootRelativePath(VaadinRequest) - Method in class com.vaadin.flow.server.VaadinService
Returns relative context path for given request.
getContextRootRelativePath(VaadinRequest) - Method in class com.vaadin.flow.server.VaadinServletService
 
getContinueNavigationAction() - Method in class com.vaadin.flow.component.internal.UIInternals
getContinueNavigationAction() - Method in class com.vaadin.flow.router.BeforeLeaveEvent
Gets the action used to resume this event, if it was postponed.
getCookies() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns an array containing all of the Cookie objects the client sent with this request.
getCookiesDisabledCaption() - Method in class com.vaadin.flow.server.SystemMessages
Gets the caption to show in a "cookies disabled" notification.
getCookiesDisabledMessage() - Method in class com.vaadin.flow.server.SystemMessages
Gets the message to show in a "cookies disabled" notification.
getCookiesDisabledURL() - Method in class com.vaadin.flow.server.SystemMessages
Gets the URL the user will be redirected to after dismissing a "cookies disabled" message.
getCreationTime() - Method in class com.vaadin.flow.server.WrappedHttpSession
 
getCreationTime() - Method in interface com.vaadin.flow.server.WrappedSession
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getCsrfToken() - Method in class com.vaadin.flow.component.UI
Gets the CSRF token (synchronizer token pattern) that is used to protect against Cross Site Request Forgery attacks.
getCsrfToken() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Gets the CSRF security token (synchronizer token pattern) for this request.
getCsrfTokenAttributeName() - Static method in class com.vaadin.flow.server.VaadinService
Get the name of the CSRF Token attribute in HTTP session.
getCss() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
 
getCss() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get all the CSS files used by the application.
getCss() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get all the CSS files used by the application.
getCssImportAnnotations(Class<? extends Component>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Finds all CssImport annotations on the given Component class, its super classes and implemented interfaces.
getCssLines(List<CssData>) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
Returns the JS code lines representing the CSS data provided as a parameter.
getCssSize(float, Unit) - Static method in interface com.vaadin.flow.component.HasSize
Utility method for internal use.
getCumulativeRequestDuration() - Method in class com.vaadin.flow.server.VaadinSession
 
getCurrent() - Static method in class com.vaadin.flow.component.UI
Gets the currently used UI.
getCurrent() - Static method in interface com.vaadin.flow.server.VaadinRequest
Gets the currently processed Vaadin request.
getCurrent() - Static method in interface com.vaadin.flow.server.VaadinResponse
Gets the currently processed Vaadin response.
getCurrent() - Static method in class com.vaadin.flow.server.VaadinService
Gets the currently used Vaadin service.
getCurrent() - Static method in class com.vaadin.flow.server.VaadinServlet
Gets the currently used Vaadin servlet.
getCurrent() - Static method in class com.vaadin.flow.server.VaadinServletRequest
Gets the currently processed Vaadin servlet request.
getCurrent() - Static method in class com.vaadin.flow.server.VaadinServletResponse
Gets the currently processed Vaadin servlet response.
getCurrent() - Static method in class com.vaadin.flow.server.VaadinSession
Gets the currently used session.
getCurrentDate() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Returns the current date and time of the browser.
getCurrentRequest() - Static method in class com.vaadin.flow.server.VaadinService
Gets the currently processed Vaadin request.
getCurrentResponse() - Static method in class com.vaadin.flow.server.VaadinService
Gets the currently processed Vaadin response.
getCurrentResponse() - Static method in class com.vaadin.flow.server.VaadinServletService
 
getCurrentServletRequest() - Static method in class com.vaadin.flow.server.VaadinServletService
 
getCurrentView() - Method in class com.vaadin.flow.component.UI
Returns the currently active route aka navigation target shown in this UI.
getCustomMessage() - Method in class com.vaadin.flow.router.ErrorParameter
Get the set custom message.
getData() - Method in class com.vaadin.flow.component.internal.CompositionEvent
Gets the string being composed.
getData(Component, Class<T>) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets a data instance with the given type, or null if there is no such instance.
getData(Component, String) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets a data instance with the given key, or null if no data has been set for that key.
getDataExpressions(Class<? extends ComponentEvent<?>>) - Method in class com.vaadin.flow.component.internal.EventDataCache
Gets the cached data expressions for the given event type.
getDateHeader(String) - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the value of the specified request header as a long value that represents a Date object.
getDebouncePhases() - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Gets the debouncing phases for which this listener should be triggered.
getDebounceTimeout() - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Gets the debounce timeout that is configured by debounce or throttle.
getDefaultImplementations() - Static method in class com.vaadin.flow.di.LookupInitializer
Returns the default implementation classes included.
getDefaultPackageJson(Options, FrontendDependenciesScanner, ClassFinder, JsonObject) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
getDefaultValue() - Method in class com.vaadin.flow.server.webcomponent.PropertyData
Getter for the initial value if given.
getDependencies(VaadinService, Class<? extends Component>) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets the dependencies for the given class, defined using annotations ( JavaScript, StyleSheet and Uses).
getDependencies(T) - Method in class com.vaadin.flow.component.internal.DependencyTreeCache
Collects all transitive dependencies of the given node, including the node itself.
getDependencyFilters() - Method in class com.vaadin.flow.server.VaadinService
Gets the filters which all resource dependencies are passed through before being sent to the client for loading.
getDependencyFilters(Stream<DependencyFilter>) - Method in interface com.vaadin.flow.di.Instantiator
Processes the available dependency filters.
getDependencyInfo(VaadinService) - Method in class com.vaadin.flow.component.internal.ComponentMetaData
Gets the dependencies, defined using annotations (JsModule, JavaScript, StyleSheet and Uses).
getDependencyList() - Method in class com.vaadin.flow.component.internal.UIInternals
Returns the helper which handles loading of dependencies (css, js).
getDependencyTriggers() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
getDependencyTriggers() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
 
getDeploymentConfiguration() - Method in class com.vaadin.flow.server.VaadinService
Gets the deployment configuration.
getDescription() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the application description.
getDevBundleFolder(File) - Static method in class com.vaadin.flow.server.frontend.DevBundleUtils
Get the folder where an application specific bundle is stored.
getDevicePixelRatio() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Gets the device pixel ratio, window.devicePixelRatio.
getDevModeHandler() - Method in interface com.vaadin.flow.internal.DevModeHandlerManager
Returns a DevModeHandler instance for the given service.
getDevModeHandler(VaadinContext) - Static method in interface com.vaadin.flow.internal.DevModeHandlerManager
Gets the DevModeHandler.
getDevModeHandler(VaadinService) - Static method in interface com.vaadin.flow.internal.DevModeHandlerManager
Gets the DevModeHandler.
getDialogText() - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Gets the text to show in the reconnect dialog when trying to re-establish the server connection.
getDialogText() - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
getDialogTextGaveUp() - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Gets the text to show in the reconnect dialog after giving up trying to reconnect (ReconnectDialogConfiguration.getReconnectAttempts() reached).
getDialogTextGaveUp() - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
getDisabledUpdateMode() - Method in interface com.vaadin.flow.internal.nodefeature.ReturnChannelRegistration
Gets the setting for whether this channel will receive updates in case the state node is disabled.
getDisabledUpdateMode(String) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Gets RPC control mode from the client side to the server side for disabled element.
getDisplay() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the the developers’ preferred display mode for the website.
getDocument() - Method in class com.vaadin.flow.server.communication.IndexHtmlResponse
Get the index.html response in form of a Document instance.
getDomain() - Method in class com.vaadin.flow.server.PwaIcon
Gets the icon PwaIcon.Domain.
getDSTSavings() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Returns the offset in milliseconds between the browser's GMT TimeZone and DST.
getElement() - Method in class com.vaadin.flow.component.Component
Gets the low level root element of this component.
getElement() - Method in class com.vaadin.flow.component.Composite
Gets the root element of this composite.
getElement() - Method in interface com.vaadin.flow.component.HasElement
Gets the element associated with this instance.
getElement() - Method in class com.vaadin.flow.component.template.internal.AbstractInjectableElementInitializer
Returns server side element to initialize.
getElement() - Method in class com.vaadin.flow.component.UI
Gets the element for this UI.
getEmbeddedApplicationAnnotation(Class<T>) - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Returns configuration annotation for embedded application.
getEmptyValue() - Method in class com.vaadin.flow.component.AbstractCompositeField
 
getEmptyValue() - Method in class com.vaadin.flow.component.AbstractField
 
getEmptyValue() - Method in interface com.vaadin.flow.component.HasValue
Returns the value that represents an empty value.
getEmptyValue() - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
Delegate method for HasValue.getEmptyValue().
getEnableHelperMessage(Feature) - Method in class com.vaadin.experimental.FeatureFlags
 
getEnd() - Method in class com.vaadin.flow.internal.Range
Returns the exclusive end point of this range.
getEntries() - Static method in class com.vaadin.flow.internal.UsageStatistics
Gets a stream of the current usage entries.
getEntryPoints() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get all entryPoints in the application.
getErrorHandler() - Method in class com.vaadin.flow.server.VaadinSession
Gets the session's error handler.
getErrorHint() - Method in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
Returns a hint for the discovered validation errors.
getErrorHint() - Method in class com.vaadin.flow.server.startup.WebComponentExporterAwareValidator
 
getErrorMessage() - Method in interface com.vaadin.flow.component.HasValidation
Gets current error message from the component.
getErrorNavigationTarget(Exception) - Method in class com.vaadin.flow.router.Router
Get a registered navigation target for given exception.
getErrorNavigationTarget(Exception) - Method in interface com.vaadin.flow.server.ErrorRouteRegistry
Get a registered navigation target for given exception.
getErrorNavigationTarget(Exception) - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
 
getErrorParameter() - Method in class com.vaadin.flow.router.BeforeEvent
Get the set error parameter.
getErrorParameter() - Method in class com.vaadin.flow.router.ErrorNavigationEvent
Gets the ErrorParameter if set.
getEventBus() - Method in class com.vaadin.flow.component.Component
Gets the event bus for this component.
getEventConstructor(Class<T>) - Static method in class com.vaadin.flow.component.ComponentEventBusUtil
Gets the constructor to use for firing a component event, of the given type, based on a DOM event.
getEventConstructor(Class<T>) - Method in class com.vaadin.flow.component.internal.EventDataCache
Gets the cached DOM event constructor for the given event type.
getEventData() - Method in class com.vaadin.flow.dom.DomEvent
Gets additional data related to the event.
getEventDataElement(String) - Method in class com.vaadin.flow.dom.DomEvent
Gets the closest Element corresponding to the given event data expression.
getEventDataExpressions(Class<? extends ComponentEvent<?>>) - Static method in class com.vaadin.flow.component.ComponentEventBusUtil
Gets a map of event data expression (for DomListenerRegistration.addEventData(String) ) to Java type, with the same order as the parameters for the event constructor (as returned by ComponentEventBusUtil.getEventConstructor(Class)).
getEventNames() - Method in class com.vaadin.flow.component.internal.ComponentMetaData.SynchronizedPropertyInfo
 
getEventTarget() - Method in class com.vaadin.flow.dom.DomEvent
Gets the closest Element that corresponds to the event.target for the DOM event.
getEventType() - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Gets the event type that the listener is registered for.
getExactLocaleMatch(VaadinRequest, List<Locale>) - Static method in class com.vaadin.flow.internal.LocaleUtil
Get the exact locale match for the given request in the provided locales.
getException() - Method in class com.vaadin.flow.router.ErrorParameter
Get the error parameter exception.
getException() - Method in class com.vaadin.flow.server.communication.streaming.StreamingErrorEventImpl
 
getException() - Method in interface com.vaadin.flow.server.StreamVariable.StreamingErrorEvent
Get the exception that failed the stream.
getExceptionHandlerByClass(Class<?>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get a exception handler by exception class.
getExceptionHandlers() - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get all registered exception handlers as a exception-to-handler map.
getExceptionHandlers() - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Override so that the getters use the correct exception targets map for data.
getExecution() - Method in class com.vaadin.flow.internal.StateTree.BeforeClientResponseEntry
 
getExistingSession(VaadinRequest, boolean) - Method in class com.vaadin.flow.server.VaadinService
 
getExporterClass() - Method in interface com.vaadin.flow.component.webcomponent.WebComponentConfiguration
Retrieves the type of the WebComponentExporter from which this configuration has been generated.
getExpression() - Method in class com.vaadin.flow.component.internal.UIInternals.JavaScriptInvocation
Gets the JavaScript expression to invoke.
getExpressions(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementListenerMap
Gets the event data expressions defined for the given event name.
getExtendedClientDetails() - Method in class com.vaadin.flow.component.internal.UIInternals
The extended client details, if obtained, are cached in this field.
getExternalForwardUrl() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the external forward url.
getExternalStatsUrl() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Get the url from where stats.json should be retrieved from.
getFactories(Set<Class<?>>) - Static method in class com.vaadin.flow.server.webcomponent.WebComponentExporterUtils
Returns exported web component factories based on exporters and factories types.
getFailedOutput() - Method in interface com.vaadin.flow.internal.DevModeHandler
Return the dev server console output when a compilation error happened.
getFallbackTransport() - Method in interface com.vaadin.flow.component.PushConfiguration
Returns the fallback transport type for push.
getFallbackTransport() - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
getFeature() - Method in class com.vaadin.flow.internal.change.NodeFeatureChange
Gets the feature affected by the change.
getFeature(int) - Static method in class com.vaadin.flow.internal.nodefeature.NodeFeatureRegistry
Finds the node feature type corresponding to the give node feature id.
getFeature(Class<T>) - Method in class com.vaadin.flow.internal.StateNode
Gets the feature of the given type, creating one if necessary.
getFeatureFlags() - Method in class com.vaadin.experimental.FeatureFlags.FeatureFlagsWrapper
Get the featureFlags.
getFeatureFlags() - Method in class com.vaadin.flow.server.frontend.Options
 
getFeatureIfInitialized(Class<T>) - Method in class com.vaadin.flow.internal.StateNode
Gets the feature of the given type if it has been initialized.
getFeatures() - Method in class com.vaadin.experimental.FeatureFlags
Get a list of all available features and their status.
getFeatures() - Static method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
Gets all the features used by an element node.
getFeatures() - Static method in class com.vaadin.flow.internal.nodefeature.NodeFeatureRegistry
Gets all registered feature types.
getFileContent() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
Get file content for writing to the generated file.
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateBootstrap
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateFeatureFlags
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexHtml
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexTs
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateServiceWorker
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateViteDevMode
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentBootstrap
 
getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentHtml
 
getFileContents(File, String) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
Tries to find a file by its path (case sensitive) in jar file.
getFileCountMax() - Method in class com.vaadin.flow.server.communication.StreamRequestHandler
Returns maximum file part count for upload.
getFileName() - Method in class com.vaadin.flow.server.communication.streaming.StreamingEndEventImpl
 
getFileName() - Method in interface com.vaadin.flow.server.StreamVariable.StreamingEvent
Get the file name for the stream.
getFileSizeMax() - Method in class com.vaadin.flow.server.communication.StreamRequestHandler
Returns maximum file size for upload.
getFilter() - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Gets the currently set filter expression.
getFinder() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
 
getFirst() - Method in class com.vaadin.flow.internal.Pair
Gets the first component of the pair.
getFirstDelay() - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Returns the delay before the loading indicator is shown.
getFirstDelay() - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
getFirstSegment() - Method in class com.vaadin.flow.router.Location
Gets the first segment of this path.
getFlowGeneratedFolder(File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Gets the folder where Flow generated frontend files are placed.
getFlowGeneratedImports(File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Gets the location of the generated import file for Flow.
getFlowGeneratedWebComponentsFolder(File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Gets the folder where exported web components are generated.
getForwardTarget() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the forward target handler to use if the user should be forwarded to some other view.
getForwardTargetRouteParameters() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the URL parameters of the forward target.
getForwardTargetType() - Method in class com.vaadin.flow.router.BeforeEvent
Get the forward target type for forwarding.
getForwardToClientUrl() - Method in class com.vaadin.flow.component.UI
Gets the new forward url.
getForwardUrl() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the reroute url.
getFreePort() - Static method in class com.vaadin.flow.internal.NetworkUtil
Returns an available tcp port in the system.
getFrontendDirectory() - Method in class com.vaadin.flow.server.frontend.Options
Get the defined frontend directory.
getFrontendFileFromDevModeHandler(VaadinService, String) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Get the contents of a frontend file from the running dev server.
getFrontendGeneratedFolder() - Method in class com.vaadin.flow.server.frontend.Options
Gets the folder where frontend files should be generated.
getFrontendGeneratedFolder(File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
 
getFrontendMapping() - Static method in class com.vaadin.flow.server.VaadinServlet
For internal use only.
getFrontendServletPath(ServletContext) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Gets the servlet path (excluding the context path) for the servlet used for serving the VAADIN frontend bundle.
getFullAppId() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the full app id, which funnily enough is not the same as appId.
getFullVersion() - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Gets the full version, in format x.y.z or x.y.z.qualifier.
getFullVersion() - Static method in class com.vaadin.flow.server.Version
Gets the full version, in format x.y.z or x.y.z.qualifier.
getFunctionalMethod(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Get the functional interface method name defined for given interface class.
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
Get the generated file where content will be written.
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateBootstrap
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateFeatureFlags
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexHtml
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexTs
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateServiceWorker
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateViteDevMode
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentBootstrap
 
getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentHtml
 
getGenericInterfaceType(Class<?>, Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Finds the Class type for the generic interface class extended by given class if exists.
getGenericInterfaceTypes(Class<?>, Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Finds the Class type for all parameters defined by the generic interface class extended by given class if exists.
getGetter(Class<? extends Object>, String) - Static method in class com.vaadin.flow.internal.ReflectTools
Finds a getter for a property in a bean type.
getGetterMethods(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Return all the getter methods from the given type.
getHandledExceptionType() - Method in class com.vaadin.flow.router.internal.ErrorTargetEntry
Gets the exception type handled by the navigation target.
getHandledRegistry() - Method in class com.vaadin.flow.router.RouteConfiguration
Get the registry that this configuration is working with.
getHandlerAnnotationFqn() - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Gets the annotation FQN which is used to mark methods as handlers.
getHandlerAnnotationFqn() - Method in class com.vaadin.flow.internal.nodefeature.ClientCallableHandlers
 
getHandlerAnnotationFqn() - Method in class com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers
Deprecated.
 
getHandlesTypes() - Method in interface com.vaadin.flow.internal.DevModeHandlerManager
The annotations the dev mode handler is interested in having scanned from the class path.
getHash(String) - Static method in class com.vaadin.flow.internal.StringUtil
Generate a hash for given content.
getHash(String, Charset) - Static method in class com.vaadin.flow.internal.StringUtil
Generate hash for content using given charset for string byte encoding.
getHasValue() - Method in class com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent
getHasValue() - Method in interface com.vaadin.flow.component.HasValue.ValueChangeEvent
 
getHeader(String) - Method in class com.vaadin.flow.server.StreamResource
Gets the value for header name set for the resource.
getHeader(String) - Method in interface com.vaadin.flow.server.VaadinRequest
Gets the value of a request header, e.g.
getHeaderIcons() - Method in class com.vaadin.flow.server.PwaRegistry
List of PwaIcon:s that should be added to header.
getHeaderInlineContents() - Method in interface com.vaadin.flow.theme.AbstractTheme
Return a list of contents to inline to the bootstrap header.
getHeaderName() - Method in class com.vaadin.flow.internal.springcsrf.SpringCsrfToken
 
getHeaderNames() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns an enumeration of all the header names this request contains.
getHeaders() - Method in class com.vaadin.flow.server.StreamResource
Gets the additionally configured headers for the resource.
getHeaders(String) - Method in interface com.vaadin.flow.server.VaadinRequest
Returns all the values of the specified request header as an Enumeration of String objects.
getHeartbeatInterval() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns the number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
getHeartbeatInterval() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns the number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
getHeartbeatInterval() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getHeartbeatTime() - Method in class com.vaadin.flow.component.HeartbeatEvent
 
getHeight() - Method in interface com.vaadin.flow.component.HasSize
Gets the height defined for the component.
getHeight() - Method in class com.vaadin.flow.component.page.BrowserWindowResizeEvent
Gets the new browser window height.
getHeight() - Method in class com.vaadin.flow.server.PwaIcon
Gets height of an icon.
getHeightUnit() - Method in interface com.vaadin.flow.component.HasSize
Gets the height unit of the component, if defined.
getHelperComponent() - Method in interface com.vaadin.flow.component.HasHelper
Gets the component in the helper slot of this field.
getHelperText() - Method in interface com.vaadin.flow.component.HasHelper
String used for the helper text.
getHighlightAction() - Method in class com.vaadin.flow.router.RouterLink
Gets the HighlightAction of this link.
getHighlightCondition() - Method in class com.vaadin.flow.router.RouterLink
Gets the HighlightCondition of this link.
getHistory() - Method in class com.vaadin.flow.component.page.Page
Gets a representation of window.history for this page.
getHistoryStateChangeHandler() - Method in class com.vaadin.flow.component.page.History
Gets the handler that is notified history state has changed.
getHost() - Method in class com.vaadin.flow.dom.ShadowRoot
 
getHost() - Method in class com.vaadin.flow.internal.nodefeature.ShadowRootHost
Gets the host state node of the shadow root node.
getHref() - Method in class com.vaadin.flow.router.RouterLink
Gets the href (the URL) of this link.
getHref() - Method in class com.vaadin.flow.server.PwaIcon
Gets the value of the href attribute.
getHtmlAttributes(String) - Method in interface com.vaadin.flow.theme.AbstractTheme
Gets the attributes that should be set on the <html> element when the Theme variant is applied.
getHttpServletRequest() - Method in class com.vaadin.flow.server.VaadinServletRequest
Gets the original, unwrapped HTTP servlet request.
getHttpServletResponse() - Method in class com.vaadin.flow.server.VaadinServletResponse
Gets the original unwrapped HttpServletResponse.
getHttpSession() - Method in class com.vaadin.flow.server.WrappedHttpSession
Gets the wrapped HttpSession.
getI18NProvider() - Method in class com.vaadin.flow.di.DefaultInstantiator
 
getI18NProvider() - Method in interface com.vaadin.flow.di.Instantiator
Get the I18NProvider if one has been defined.
getI18NProvider() - Static method in class com.vaadin.flow.internal.LocaleUtil
Get the I18nProvider from the current VaadinService.
getIconPath() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the path to the application icon file.
getIcons() - Method in class com.vaadin.flow.server.PwaRegistry
List of all icons managed by PwaRegistry.
getId() - Method in class com.vaadin.experimental.Feature
 
getId() - Method in class com.vaadin.flow.component.Component
Gets the id of the root element of this component.
getId() - Method in class com.vaadin.flow.internal.ConstantPoolKey
Gets the id used to identify the referenced JSON constant.
getId() - Method in class com.vaadin.flow.internal.StateNode
Gets the id of this node.
getId() - Method in class com.vaadin.flow.server.AbstractStreamResource
Gets unique identifier of the resource.
getId() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
The id getter.
getId() - Method in class com.vaadin.flow.server.WrappedHttpSession
 
getId() - Method in interface com.vaadin.flow.server.WrappedSession
Gets a string with a unique identifier for the session.
getId(Class<? extends NodeFeature>) - Static method in class com.vaadin.flow.internal.nodefeature.NodeFeatureRegistry
Gets the id of a node feature.
getIdByField() - Method in class com.vaadin.flow.component.template.internal.IdCollector
Gets a map from fields to their ids.
getIdentifier() - Method in enum class com.vaadin.flow.dom.DebouncePhase
Gets the string that is used to identify this phase.
getIdentifier() - Method in enum class com.vaadin.flow.server.HandlerHelper.RequestType
Returns the identifier for the request type.
getIdentifier() - Method in enum class com.vaadin.flow.shared.ui.Transport
Gets the low level identifier for the transport.
getImplementingComponents(Stream<Element>, Class<T>) - Static method in class com.vaadin.flow.router.EventUtil
Collect elements with Component implementing listener of type T.
getImportsNotFoundMessage() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
getInclude() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
The include getter.
getIndex() - Method in class com.vaadin.flow.internal.change.AbstractListChange
Gets the index of the change.
getIndexHtmlContent(VaadinService) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Gets the content of the frontend/index.html file which is served by vite in dev-mode and read from classpath in production mode.
getIndexHtmlRequestListeners(Stream<IndexHtmlRequestListener>) - Method in interface com.vaadin.flow.di.Instantiator
Processes the available Index HTML request listeners.
getInitialJson(VaadinRequest, VaadinResponse, VaadinSession) - Method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
Returns the JSON object with the application config and UIDL info that can be used in the bootstrapper to embed that info in the initial page.
getInitialUidl(UI) - Static method in class com.vaadin.flow.server.BootstrapHandler
Generates the initial UIDL message which is included in the initial bootstrap page.
getInitParameter(String) - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer.FakeServletConfig
 
getInitParameterNames() - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer.FakeServletConfig
 
getInitParameters() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Gets the properties configured for the deployment, e.g.
getInitParameters() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getInline() - Method in class com.vaadin.flow.component.ScrollOptions
Gets the horizontal alignment.
getInlineBody(Inline.Position) - Method in class com.vaadin.flow.server.InlineTargets
Get the list of inline objects to add to body.
getInlineHead(Inline.Position) - Method in class com.vaadin.flow.server.InlineTargets
Get the list of inline objects to add to head.
getInnerHtml() - Method in class com.vaadin.flow.component.Html
Gets the inner HTML, i.e.
getInnermostComponent(Composite<?>) - Static method in class com.vaadin.flow.component.ComponentUtil
Returns the innermost component from a Composite chain, i.e.
getInnermostComponent(Element) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets the innermost mapped component for the element.
getInputStream() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns an input stream from which the request content can be read.
getInsecureProxy() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
Get first proxy that is not secure.
getInstallDirectory() - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
 
getInstallTimeMs() - Method in class com.vaadin.flow.server.frontend.TaskRunNpmInstall.Stats
Gets the time spent running npm install.
getInstance(VaadinContext) - Static method in class com.vaadin.flow.server.AppShellRegistry
Returns the instance of the registry, or create a new one if it does not exist yet.
getInstance(VaadinContext) - Static method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Gets the route registry for the given Vaadin context.
getInstance(VaadinContext) - Static method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Get WebComponentRegistry instance for given servlet context.
getInstance(ServletContext) - Static method in class com.vaadin.flow.server.PwaRegistry
Gets the pwa registry for the given servlet context.
getInstances() - Static method in class com.vaadin.flow.internal.CurrentInstance
Gets the currently set instances so that they can later be restored using CurrentInstance.restoreInstances(Map).
getInstantiator() - Method in class com.vaadin.flow.server.VaadinService
Gets the instantiator used by this service.
getInteger(String) - Method in class com.vaadin.flow.router.RouteParameters
Gets the int representation of a parameter.
getInternalErrorCaption() - Method in class com.vaadin.flow.server.SystemMessages
Gets the caption to show in an "internal error" notification.
getInternalErrorMessage() - Method in class com.vaadin.flow.server.SystemMessages
Gets the message to show in a "internal error" notification.
getInternalErrorURL() - Method in class com.vaadin.flow.server.SystemMessages
Gets the URL the user will be redirected to after dismissing an internal error message.
getInternals() - Method in class com.vaadin.flow.component.UI
Gets the framework data object for this UI.
getInvocation() - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
Gets the underlying JavaScript invocation that this pending invocation is based on.
getInvocationHandlers() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler
Gets RpcInvocationHandlers map where the key is the type of the handler gotten via RpcInvocationHandler.getRpcType().
getItemIterator(VaadinRequest) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
 
getJarFiles() - Method in class com.vaadin.flow.server.frontend.Options
 
getJarFrontendResourcesFolder() - Method in class com.vaadin.flow.server.frontend.Options
Gets the folder to which frontend resources from add-on jars are copied.
getJarResourcesFolder(File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Get the front-end resources folder.
getJarResourceString(String, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Get resource from JAR package.
getJavaFieldValue(Object, Field) - Static method in class com.vaadin.flow.internal.ReflectTools
Returns the value of the java field.
getJavaFieldValue(Object, Field, Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Returns the value of the java field that is assignable to the property type.
getJavaResourceFolder() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Gets the folder where resource sources are stored.
getJavaResourceFolder() - Method in class com.vaadin.flow.server.frontend.Options
Gets the folder containing java resources, typically src/main/resources in a Maven project.
getJavaResourceFolder() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getJavaScriptAnnotations(Class<? extends Component>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Finds all JavaScript annotations on the given Component class, its super classes and implemented interfaces.
getJavaSourceFolder() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Gets the folder where sources are stored.
getJavaSourceFolder() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getJsModuleAnnotations(Class<? extends Component>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Finds all JsModule annotation on the given Component class, its super classes and implenented interfaces.
getKey() - Method in class com.vaadin.flow.component.internal.KeyboardEvent
Gets the key of the event.
getKey() - Method in class com.vaadin.flow.component.ShortcutEvent
Primary Key that triggered the shortcut.
getKey() - Method in class com.vaadin.flow.component.ShortcutRegistration
Get the primary Key of the shortcut.
getKey() - Method in class com.vaadin.flow.internal.change.MapPutChange
Gets the key of the change.
getKey() - Method in class com.vaadin.flow.internal.change.MapRemoveChange
Gets the removed key.
getKey() - Method in class com.vaadin.flow.internal.nodefeature.BasicTypeValue
 
getKey() - Method in class com.vaadin.flow.internal.nodefeature.NodeValue
Gets the key that should be used when the value of this feature is sent to the client.
getKey() - Method in class com.vaadin.flow.internal.nodefeature.ShadowRootData
 
getKey() - Method in class com.vaadin.flow.internal.nodefeature.TextNodeMap
 
getKeyModifiers() - Method in class com.vaadin.flow.component.ShortcutEvent
Set of KeyModifiers that, in combination with the primary key, triggered the shortcut.
getKeys() - Method in interface com.vaadin.flow.component.Key
Returns the list (with at least one element) of printable representations of the key, which should reflect the key property in the JavaScript KeyboardEvent.
getKeys() - Method in enum class com.vaadin.flow.component.KeyModifier
Gets the key value.
getLabel() - Method in interface com.vaadin.flow.component.HasLabel
Gets the label of the component.
getLastAccessedTime() - Method in class com.vaadin.flow.server.WrappedHttpSession
 
getLastAccessedTime() - Method in interface com.vaadin.flow.server.WrappedSession
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.
getLastHandledLocation() - Method in class com.vaadin.flow.component.internal.UIInternals
Get the latest handled location or empty optional if no active navigation.
getLastHeartbeatTimestamp() - Method in class com.vaadin.flow.component.internal.UIInternals
Returns the timestamp of the last received heartbeat for the related UI.
getLastInstallStats() - Static method in class com.vaadin.flow.server.frontend.TaskRunNpmInstall
Returns timing information for the last operation.
getLastLocked() - Method in class com.vaadin.flow.server.VaadinSession
Gets the timestamp of the most recent lock operation performed on this session.
getLastPathParameter(String) - Static method in class com.vaadin.flow.server.VaadinServlet
Finds any path parameter added to the last part of the uri.
getLastProcessedClientToServerId() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the last processed server message id.
getLastProcessedMessageHash() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the hash of the last processed message from the client.
getLastRequestDuration() - Method in class com.vaadin.flow.server.VaadinSession
 
getLastRequestTimestamp() - Method in class com.vaadin.flow.server.VaadinSession
Returns the time when the last request was serviced in this session.
getLastUnlocked() - Method in class com.vaadin.flow.server.VaadinSession
Gets the timestamp of the most recent unlock operation performed on this session.
getLayouts() - Method in class com.vaadin.flow.router.BeforeEvent
Get the layout chain for the navigation target.
getLeaveObservers() - Method in class com.vaadin.flow.router.internal.Postpone
Get BeforeLeaveHandlers that have been left over from a postpone.
getLifecycleOwner() - Method in class com.vaadin.flow.component.ShortcutEvent
Component which owns the shortcut.
getLifecycleOwner() - Method in class com.vaadin.flow.component.ShortcutRegistration
Component which controls when the shortcut is active and when it is not.
getLines() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
getListeners(Component, Class<? extends ComponentEvent>) - Static method in class com.vaadin.flow.component.ComponentUtil
Returns all listeners that match or extend the given event type.
getListeners(Class<? extends ComponentEvent>) - Method in class com.vaadin.flow.component.Component
Returns all listeners that match or extend the given event type.
getListeners(Class<? extends ComponentEvent>) - Method in class com.vaadin.flow.component.ComponentEventBus
Returns all listeners that match or extend the given event type.
getListeners(Class<E>) - Method in class com.vaadin.flow.component.internal.UIInternals
Get all registered listeners for given navigation handler type.
getLiveReload(VaadinContext) - Method in interface com.vaadin.flow.internal.BrowserLiveReloadAccessor
Returns a BrowserLiveReload instance for the given context.
getLiveReload(VaadinService) - Method in class com.vaadin.flow.internal.BrowserLiveReloadAccess
Deprecated.
Returns a BrowserLiveReload instance for the given service.
getLiveReload(VaadinService) - Method in interface com.vaadin.flow.internal.BrowserLiveReloadAccessor
Returns a BrowserLiveReload instance for the given service.
getLiveReloadFromContext(VaadinContext) - Static method in interface com.vaadin.flow.internal.BrowserLiveReloadAccessor
Create a BrowserLiveReload if factory available.
getLiveReloadFromService(VaadinService) - Static method in interface com.vaadin.flow.internal.BrowserLiveReloadAccessor
Create a BrowserLiveReload if factory available.
getLoadingIndicatorConfiguration() - Method in class com.vaadin.flow.component.UI
Retrieves the object used for configuring the loading indicator.
getLoadMode() - Method in class com.vaadin.flow.shared.ui.Dependency
Gets load mode that will be used for dependency loading.
getLocale() - Method in class com.vaadin.flow.component.Component
Gets the locale for this component.
getLocale() - Method in class com.vaadin.flow.component.internal.CompositionEvent
Gets the optional Locale of the event.
getLocale() - Method in class com.vaadin.flow.component.UI
Gets the locale for this UI.
getLocale() - Method in class com.vaadin.flow.i18n.LocaleChangeEvent
Get the new locale that was set.
getLocale() - Method in class com.vaadin.flow.server.SystemMessagesInfo
The locale of the UI related to the SystemMessages request.
getLocale() - Method in interface com.vaadin.flow.server.VaadinRequest
Gets locale information from the query, e.g.
getLocale() - Method in class com.vaadin.flow.server.VaadinSession
Gets the locale for this session.
getLocale() - Method in class com.vaadin.flow.server.WebBrowser
Gets the locale reported by the browser.
getLocale(Supplier<Optional<I18NProvider>>) - Static method in class com.vaadin.flow.internal.LocaleUtil
Get the locale for the given UI.
getLocaleMatchByLanguage(VaadinRequest, List<Locale>) - Static method in class com.vaadin.flow.internal.LocaleUtil
Get the locale matching the language of the request locale in the provided locales.
getLocales() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.
getLocalResourcesFolder() - Method in class com.vaadin.flow.server.frontend.Options
 
getLocation() - Method in class com.vaadin.flow.component.internal.KeyboardEvent
Gets the KeyLocation of the event.
getLocation() - Method in enum class com.vaadin.flow.component.KeyLocation
Gets the key location integer value.
getLocation() - Method in class com.vaadin.flow.component.page.History.HistoryStateChangeEvent
Gets the location that was opened.
getLocation() - Method in class com.vaadin.flow.router.AfterNavigationEvent
Gets the new location.
getLocation() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the new location.
getLocation() - Method in class com.vaadin.flow.router.internal.ResolveRequest
Gets the location that is requested to be resolved.
getLocation() - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets the new location.
getLocation() - Method in class com.vaadin.flow.router.NavigationEvent
Gets the new location.
getLocationChangeEvent() - Method in class com.vaadin.flow.router.AfterNavigationEvent
getLockInstance() - Method in class com.vaadin.flow.server.VaadinSession
Gets the Lock instance that is used for protecting the data of this session from concurrent access.
getLogger() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
getLong(String) - Method in class com.vaadin.flow.router.RouteParameters
Gets the long representation of a parameter.
getLongPollingSuspendTimeout() - Method in class com.vaadin.flow.server.communication.PushHandler
Gets the timeout used for suspend calls when using long polling.
getLookup() - Method in class com.vaadin.flow.server.frontend.Options
Gets the lookup instance to use for internal lookups.
getLumoTheme() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
 
getMainDivId(VaadinSession, VaadinRequest) - Method in class com.vaadin.flow.server.VaadinService
Creates and returns a unique ID for the DIV where the UI is to be rendered.
getMainDivId(VaadinSession, VaadinRequest) - Method in class com.vaadin.flow.server.VaadinServletService
 
getMajorVersion() - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Gets the major version, x in x.y.z.qualifier.
getMajorVersion() - Static method in class com.vaadin.flow.server.Version
Gets the major version, x in x.y.z.qualifier.
getManifestIcons() - Method in class com.vaadin.flow.server.PwaRegistry
List of PwaIcon:s that should be added to manifest.webmanifest.
getManifestJson() - Method in class com.vaadin.flow.server.PwaRegistry
manifest.webmanifest contents as a String.
getManifestPath() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the path to the manifest.webmanifest.
getMaxHeight() - Method in interface com.vaadin.flow.component.HasSize
Gets the max-height defined for the component.
getMaxInactiveInterval() - Method in class com.vaadin.flow.server.WrappedHttpSession
 
getMaxInactiveInterval() - Method in interface com.vaadin.flow.server.WrappedSession
Returns the maximum time interval, in seconds, that this session will be kept open between client accesses.
getMaxMessageSuspendTimeout() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
In certain cases, such as when combining XmlHttpRequests and push over low bandwidth connections, messages may be received out of order by the client.
getMaxMessageSuspendTimeout() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
In certain cases, such as when combining XmlHttpRequests and push over low bandwidth connections, messages may be received out of order by the client.
getMaxMessageSuspendTimeout() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getMaxWidth() - Method in interface com.vaadin.flow.component.HasSize
Gets the max-width defined for the component.
getMessage(Reader) - Method in class com.vaadin.flow.server.communication.ServerRpcHandler
 
getMethod() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
getMimeType() - Method in class com.vaadin.flow.server.communication.streaming.StreamingEndEventImpl
 
getMimeType() - Method in interface com.vaadin.flow.server.StreamVariable.StreamingEvent
Get the mime type for the stream.
getMimeType(String) - Method in class com.vaadin.flow.server.VaadinService
Returns the MIME type of the specified file, or null if the MIME type is not known.
getMimeType(String) - Method in class com.vaadin.flow.server.VaadinServletService
 
getMinHeight() - Method in interface com.vaadin.flow.component.HasSize
Gets the min-height defined for the component.
getMinorVersion() - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Gets the minor version, y in x.y.z.qualifier.
getMinorVersion() - Static method in class com.vaadin.flow.server.Version
Gets the minor version, y in x.y.z.qualifier.
getMinWidth() - Method in interface com.vaadin.flow.component.HasSize
Gets the min-width defined for the component.
getMode() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Gets the mode the application is running in.
getModel(StateNode) - Static method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Gets the model map for the given node.
getModifiers() - Method in class com.vaadin.flow.component.internal.KeyboardEvent
Gets the set of KeyModifier of the event.
getModifiers() - Method in class com.vaadin.flow.component.ShortcutRegistration
Get a set of keys where each key is an instance of a KeyModifier.
getModules() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
 
getModules() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get all JS modules needed for run the application.
getModules() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get all ES6 modules needed for run the application.
getMoreInfoLink() - Method in class com.vaadin.experimental.Feature
 
getName() - Method in class com.vaadin.flow.internal.UsageStatistics.UsageEntry
Gets the feature name.
getName() - Method in class com.vaadin.flow.router.RouteParam
Gets the name of the parameter.
getName() - Method in class com.vaadin.flow.server.AbstractStreamResource
Get the resource name.
getName() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
getName() - Method in class com.vaadin.flow.server.StreamReceiver
 
getName() - Method in class com.vaadin.flow.server.StreamResource
 
getName() - Method in class com.vaadin.flow.server.webcomponent.PropertyData
Getter for the property name.
getName() - Method in class com.vaadin.flow.theme.ThemeDefinition
Gets the name of the theme.
getName(String) - Static method in class com.vaadin.flow.router.RouteParameterRegex
Gets the name representation of the regex.
getNames() - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
getNames() - Static method in class com.vaadin.flow.dom.impl.CustomAttribute
Gets an unmodifiable set of custom attribute names.
getNames() - Method in class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
getNames() - Method in interface com.vaadin.flow.dom.Style
Gets the defined style property names.
getNavigationListeners(Class<E>) - Method in class com.vaadin.flow.component.UI
Get all the registered listeners of the given navigation handler type.
getNavigationObservers() - Method in class com.vaadin.flow.router.internal.Postpone
Get BeforeEnterHandlers that have been left over from a postpone.
getNavigationRouteTarget(String) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getNavigationRouteTarget(String) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Search for a route target using given navigation url argument.
getNavigationRouteTarget(String) - Method in interface com.vaadin.flow.server.RouteRegistry
Search for a route target using given navigation url argument.
getNavigationRouteTarget(String) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getNavigationState() - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
Gets the targeted navigation state.
getNavigationTarget() - Method in class com.vaadin.flow.router.BeforeEvent
Get the navigation target.
getNavigationTarget() - Method in class com.vaadin.flow.router.internal.ErrorTargetEntry
Gets the navigation target type.
getNavigationTarget() - Method in class com.vaadin.flow.router.NavigationState
Gets the navigation target of this state.
getNavigationTarget() - Method in class com.vaadin.flow.router.RouteBaseData
Get Route navigation target.
getNavigationTarget(String) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getNavigationTarget(String) - Method in interface com.vaadin.flow.server.RouteRegistry
Gets the optional navigation target class for a given path.
getNavigationTarget(String) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getNavigationTarget(String, List<String>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getNavigationTarget(String, List<String>) - Method in interface com.vaadin.flow.server.RouteRegistry
Gets the optional navigation target class for a given Location matching with path segments.
getNavigationTarget(String, List<String>) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getNewItems() - Method in class com.vaadin.flow.internal.change.ListAddChange
Gets the added items.
getNextUIid() - Method in class com.vaadin.flow.server.VaadinSession
Creates a new unique id for a UI.
getNode() - Method in class com.vaadin.flow.dom.Node
Gets the node this element is connected to.
getNode() - Method in class com.vaadin.flow.internal.change.NodeChange
Gets the changed node.
getNode() - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Gets the node that this feature belongs to.
getNode() - Method in class com.vaadin.flow.server.StreamReceiver
Get the node that this stream receiver is linked to.
getNode(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
Gets the flyweight instance for the node supported by the provider.
getNode(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getNode(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getNodeBinary() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Gets a path to the used node binary.
getNodeById(int) - Method in class com.vaadin.flow.internal.StateTree
Finds a node with the given id.
getNodeClassifier(FrontendVersion) - Method in class com.vaadin.flow.server.frontend.installer.Platform
Get the node classifier for current platform.
getNodeDownloadRoot() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Get the node download root to be used for downloading node.
getNodeDownloadRoot() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Gets the platform dependent download root.
getNodeDownloadRoot() - Method in class com.vaadin.flow.server.frontend.Options
 
getNodeExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Locate node executable.
getNodeId(JsonObject) - Static method in class com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
 
getNodeList() - Method in class com.vaadin.flow.internal.change.AbstractListChange
Gets a changed list.
getNodeModulesFolder() - Method in class com.vaadin.flow.server.frontend.Options
 
getNodeVersion() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Gets the version of the node executable.
getNodeVersion() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Get the defined node version.
getNodeVersion() - Method in class com.vaadin.flow.server.frontend.Options
 
getNpmExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Locate npm executable.
getNpmFolder() - Method in class com.vaadin.flow.server.frontend.Options
Get the npm folder used for this build.
getNpmVersion() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Executes npm --version to and parses the result.
getOfflineHtml() - Method in class com.vaadin.flow.server.PwaRegistry
Static offline page as String.
getOfflinePath() - Method in class com.vaadin.flow.server.PwaConfiguration
Path to static offline html file.
getOfflineResources() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the list of files to be added to pre cache.
getOldValue() - Method in class com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent
 
getOldValue() - Method in interface com.vaadin.flow.component.HasValue.ValueChangeEvent
Returns the value of the source before this value change event occurred.
getOldValue() - Method in class com.vaadin.flow.dom.PropertyChangeEvent
Returns the value of the source before this value change event occurred.
getOnChangeHandler() - Method in class com.vaadin.flow.server.webcomponent.PropertyConfigurationImpl
Retrieves the onChangeHandler tied to this property, if one exists.
getOperatingSystemMajorVersion() - Method in class com.vaadin.flow.shared.BrowserDetails
Returns the major version of the operating system.
getOperatingSystemMinorVersion() - Method in class com.vaadin.flow.shared.BrowserDetails
Returns the minor version of the operating system.
getOptionalValue() - Method in interface com.vaadin.flow.component.HasValue
Returns the current value of this object, wrapped in an Optional.
getOrCreate(Class<T>) - Method in class com.vaadin.flow.di.DefaultInstantiator
 
getOrCreate(Class<T>) - Method in interface com.vaadin.flow.di.Instantiator
Provides an instance of any given type, this is an abstraction that allows to make use of DI-frameworks from add-ons.
getOrCreateShadowRoot() - Method in class com.vaadin.flow.component.template.internal.IdMapper
Gets the shadow root for the template.
getOrDefault(String, boolean) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Gets the value corresponding to the given key, or the given default value if no value is stored for the given key or the value is null.
getOrDefault(String, int) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Gets the value corresponding to the given key, or the given default value if no value is stored for the given key or the value is null.
getOrDefault(String, String) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Gets the value corresponding to the given key, or the given default value if no value is stored for the given key or the value is null.
getOs() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Get platform OS.
getOsName() - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Get the Operating System name from the os.name system property.
getOuterHTML() - Method in class com.vaadin.flow.dom.Element
Gets the outer HTML for the element.
getOutputStream() - Method in interface com.vaadin.flow.server.StreamVariable
Invoked when a new upload arrives, after StreamVariable.streamingStarted(StreamingStartEvent) method has been called.
getOutputStream() - Method in interface com.vaadin.flow.server.VaadinResponse
Returns a OutputStream for writing binary data in the response.
getOwner() - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
Gets the state node that this invocation belongs to.
getOwner() - Method in class com.vaadin.flow.component.ShortcutRegistration
Deprecated.
This component has now multiple owners so this method has been replaced by #getOwners().
getOwner() - Method in class com.vaadin.flow.internal.StateNode
Gets the node owner that this node currently belongs to.
getOwners() - Method in class com.vaadin.flow.component.ShortcutRegistration
The Components which own the shortcuts key event listeners.
getPackageJson(Options, FrontendDependenciesScanner, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
Get the package.json file from disk if available else generate in memory.
getPackageJsonFile() - Method in class com.vaadin.flow.server.frontend.NodeUpdater
 
getPackageJsonHash(JsonObject) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
getPackageLockFile() - Method in class com.vaadin.flow.server.frontend.NodeUpdater
 
getPackageManager() - Method in class com.vaadin.flow.server.frontend.TaskRunNpmInstall.Stats
Gets the package manager used for installation.
getPackages() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get all npm packages the application depends on.
getPackages() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get all npm packages the application depends on.
getPackageVersionFromJson(JsonObject, String, String) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Tries to parse the given package's frontend version or if it doesn't exist, returns null.
getPage() - Method in class com.vaadin.flow.component.UI
Gets the object representing the page on which this UI exists.
getPageBuilder() - Method in class com.vaadin.flow.server.BootstrapHandler
Returns the current page builder object.
getPageConfigurationAnnotation(Class<T>) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets an annotation from the topmost class in the current navigation target hierarchy.
getPageConfigurationAnnotations(Class<T>) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets a a list of annotations from the topmost class in the current navigation target hierarchy.
getPageTitle() - Method in interface com.vaadin.flow.router.HasDynamicTitle
Gets the title of this navigation target.
getParameter(String) - Method in interface com.vaadin.flow.component.PushConfiguration
Returns the given parameter, if set.
getParameter(String) - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
getParameter(String) - Method in interface com.vaadin.flow.server.VaadinRequest
Gets the named request parameter This is typically a HTTP GET or POST parameter, though other request types might have other ways of representing parameters.
getParameterMap() - Method in interface com.vaadin.flow.server.VaadinRequest
Gets all the parameters of the request.
getParameterName() - Method in class com.vaadin.flow.internal.springcsrf.SpringCsrfToken
 
getParameterNames() - Method in interface com.vaadin.flow.component.PushConfiguration
Returns the parameters which have been defined.
getParameterNames() - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
getParameterNames() - Method in class com.vaadin.flow.router.RouteParameters
Gets the available parameter names.
getParameters() - Method in class com.vaadin.flow.component.internal.UIInternals.JavaScriptInvocation
Gets the parameters to use when invoking the script.
getParameters() - Method in class com.vaadin.flow.router.QueryParameters
Returns query parameters information with support for multiple values corresponding to single parameter name.
getParameters(String) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Gets the parameters defined by the given template.
getParameters(List<T>) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Transform the HasUrlParameter values into a RouteParameters object.
getParameters(T) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Transform the HasUrlParameter value into a RouteParameters object.
getParameterTypes(Collection<String>) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Gets the types of the parameters from string format.
getParameterValues(RouteParameters) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Gets the values for the HasUrlParameter from the specified route parameters.
getParent() - Method in class com.vaadin.flow.component.Component
Gets the parent component of this component.
getParent() - Method in class com.vaadin.flow.dom.Element
Gets the parent element.
getParent() - Method in class com.vaadin.flow.internal.StateNode
Gets the parent node that this node belongs to.
getParent(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the parent element.
getParent(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
getParent(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getParent(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
 
getParent(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.AttachExistingElementFeature
Gets parent Node of the registered node.
getParentConfiguration() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
Returns parent application configuration.
getParentLayout() - Method in class com.vaadin.flow.router.RouteBaseData
Get the parent layout of Route.
getParentLayouts() - Method in class com.vaadin.flow.router.internal.RouteTarget
Get the parent layout chain.
getParentLayouts() - Method in class com.vaadin.flow.router.RouteBaseData
Return the whole parent layout chain of route target.
getParentLayouts(VaadinContext, Class<?>, String) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Get parent layouts for navigation target according to the Route or RouteAlias annotation.
getParentLayoutsForNonRouteTarget(Class<?>) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Collect possible route parent layouts for a navigation target that is not annotated with Route nor RouteAlias, but may still contain ParentLayout.
getParentNode() - Method in class com.vaadin.flow.dom.Node
Gets the parent node.
getParentNode() - Method in class com.vaadin.flow.dom.ShadowRoot
 
getParentThemeName(JsonObject) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
 
getParentUsingComposite(Composite<?>, Component) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets the parent of the given component, which is inside the given composite.
getParts(VaadinRequest) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
 
getPath() - Method in class com.vaadin.flow.router.internal.NavigationRouteTarget
Gets the input path for the search.
getPath() - Method in class com.vaadin.flow.router.Location
Gets the path of this location as a string.
getPath(String, List<String>) - Static method in class com.vaadin.flow.router.internal.PathUtil
Join the segments into a url path.
getPath(List<String>) - Static method in class com.vaadin.flow.router.internal.PathUtil
Join the segments into a url path.
getPathIfInsideServlet(String, String) - Static method in class com.vaadin.flow.server.HandlerHelper
Returns the rest of the path after the servlet mapping part, if the requested path targets a path inside the servlet.
getPathInfo() - Method in interface com.vaadin.flow.server.VaadinRequest
Gets the path of the requested resource relative to the application.
getPathWithQueryParameters() - Method in class com.vaadin.flow.router.Location
Gets the path string with QueryParameters and including the possible fragment if one existed.
getPayload() - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Gets the payload data of the element.
getPendingAccessQueue() - Method in class com.vaadin.flow.server.VaadinSession
Gets the queue of tasks submitted using VaadinSession.access(Command).
getPendingSendToClient() - Method in class com.vaadin.flow.component.internal.DependencyList
Returns a list of dependencies which should be sent to the client.
getPhase() - Method in class com.vaadin.flow.dom.DomEvent
Gets the debounce phase for which this event is fired.
getPnpmExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Locate pnpm executable.
getPollInterval() - Method in class com.vaadin.flow.component.UI
Returns the interval with which the UI polls the server.
getPollInterval() - Method in class com.vaadin.flow.internal.nodefeature.PollConfigurationMap
Gets the poll interval.
getPolyfills() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns an array with polyfills to be loaded when the app is loaded.
getPort() - Method in interface com.vaadin.flow.internal.DevModeHandler
Get the listening port of the dev server.
getPostinstallPackages() - Method in class com.vaadin.flow.server.frontend.Options
 
getPreviousSibling(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.AttachExistingElementFeature
Gets previous sibling of the registered node.
getPrimitiveDefaultValue(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Gets default value for given primitiveType.
getPrincipal(VaadinRequest) - Method in class com.vaadin.flow.server.auth.ViewAccessChecker
Gets the principal for the currently logged in user.
getProdBundleResource(String, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
getProductIfCvdl(File, String) - Static method in class com.vaadin.flow.server.frontend.CvdlProducts
Returns product information if the given npm module refers to a Vaadin commercial component.
getProgressEventInterval() - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
To prevent event storming, streaming progress events are sent in this interval rather than every time the buffer is filled.
getProjectFolder() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Return the project root folder.
getProjectFolderFromClasspath() - Static method in class com.vaadin.flow.server.frontend.FileIOUtils
Try determining the project folder from the classpath.
getProjectFrontendDir(AbstractConfiguration) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Get directory where project's frontend files are located.
getProjectRoot() - Method in interface com.vaadin.flow.internal.DevModeHandler
Gets the project root folder.
getProperties() - Method in class com.vaadin.flow.server.AbstractPropertyConfiguration
Gets unmodifiable underlying properties.
getProperty() - Method in class com.vaadin.flow.component.internal.ComponentMetaData.SynchronizedPropertyInfo
 
getProperty(StateNode, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the value of the given property.
getProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getProperty(String) - Method in class com.vaadin.flow.dom.Element
Gets the value of the given property as a string.
getProperty(String) - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Gets the value of the given property.
getProperty(String, boolean) - Method in class com.vaadin.flow.dom.Element
Gets the value of the given property as a boolean, or the given default value if the underlying value is null.
getProperty(String, double) - Method in class com.vaadin.flow.dom.Element
Gets the value of the given property as a double, or the given default value if the underlying value is null
getProperty(String, int) - Method in class com.vaadin.flow.dom.Element
Gets the value of the given property as an integer, or the given default value if the underlying value is null
getProperty(String, String) - Method in class com.vaadin.flow.dom.Element
Gets the value of the given property as a string.
getPropertyData() - Method in class com.vaadin.flow.server.webcomponent.PropertyConfigurationImpl
Computed PropertyData based on the configuration details.
getPropertyDataSet() - Method in interface com.vaadin.flow.component.webcomponent.WebComponentConfiguration
Set of all the PropertyData objects defining the web component's properties.
getPropertyDescriptor(Class<?>, String) - Static method in class com.vaadin.flow.internal.BeanUtil
Returns the property descriptor for the property of the given name and declaring class.
getPropertyName() - Method in interface com.vaadin.flow.component.PropertyDescriptor
Gets the name of the property.
getPropertyName() - Method in class com.vaadin.flow.dom.PropertyChangeEvent
Returns the property name.
getPropertyName(Method) - Static method in class com.vaadin.flow.internal.ReflectTools
Parses the property name from the given getter or setter method.
getPropertyNames() - Method in class com.vaadin.flow.dom.Element
Gets the defined property names.
getPropertyNames() - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Gets the property names.
getPropertyNames() - Method in interface com.vaadin.flow.server.startup.ApplicationConfiguration
Returns the names of the configuration properties as an Enumeration, or an empty Enumeration if there are o initialization parameters.
getPropertyNames() - Method in class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl
 
getPropertyNames(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the defined property names.
getPropertyNames(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getPropertyNames(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getPropertyNames(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getPropertyRaw(String) - Method in class com.vaadin.flow.dom.Element
Gets the raw property value without any value conversion.
getPropertySynchronizationMode(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementListenerMap
Gets the most permissive update mode for any event registration that is configured to synchronize the given property.
getPropertyType(Class<?>, String) - Static method in class com.vaadin.flow.internal.BeanUtil
Returns the type of the property with the given name and declaring class.
getPropertyType(Method) - Static method in class com.vaadin.flow.internal.ReflectTools
Returns property type from the given getter or setter method.
getPropertyType(String) - Method in interface com.vaadin.flow.component.webcomponent.WebComponentConfiguration
Retrieve the type of a property's value.
getPropertyType(String) - Method in class com.vaadin.flow.server.webcomponent.WebComponentBinding
Retrieve the type of a property's value.
getProvidedLocales() - Method in interface com.vaadin.flow.i18n.I18NProvider
Get the locales that we have translations for.
getProviderFeatures() - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
Returns the features supported by the provider.
getProviderFeatures() - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getProviderFeatures() - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getProxies() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Read list of configured proxies in order from system properties, .npmrc file in the project root folder, .npmrc file in user root folder and system environment variables.
getProxyForUrl(String) - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
Get a proxy for url.
getPublicResources() - Static method in class com.vaadin.flow.server.HandlerHelper
URLs matching these patterns should be publicly available for applications to work.
getPublicResourcesRequiringSecurityContext() - Static method in class com.vaadin.flow.server.HandlerHelper
URLs matching these patterns should be publicly available for applications to work but might require a security context, i.e.
getPublicResourcesRoot() - Static method in class com.vaadin.flow.server.HandlerHelper
URLs matching these patterns should be publicly available for applications to work.
getPushConfiguration() - Method in class com.vaadin.flow.component.UI
Retrieves the object used for configuring the push channel.
getPushConnection() - Method in class com.vaadin.flow.component.internal.UIInternals
Returns the internal push connection object used by the related UI.
getPushId() - Method in class com.vaadin.flow.server.VaadinSession
Gets the push connection identifier for this session.
getPushMode() - Method in interface com.vaadin.flow.component.PushConfiguration
Returns the mode of bidirectional ("push") communication that is used.
getPushMode() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns the mode of bidirectional ("push") client-server communication that should be used.
getPushMode() - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
getPushMode() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the push mode to use.
getPushMode() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns the mode of bidirectional ("push") client-server communication that should be used.
getPushMode() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getPushScript(BootstrapHandler.BootstrapContext) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
getPushServletMapping() - Method in interface com.vaadin.flow.component.PushConfiguration
Returns the servlet mapping to use for push requests.
getPushServletMapping() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns the servlet mapping that bidirectional ("push") client-server communication should use.
getPushServletMapping() - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
getPushServletMapping() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns the servlet mapping that bidirectional ("push") client-server communication should use.
getPushURL(VaadinSession, VaadinRequest) - Static method in class com.vaadin.flow.internal.BootstrapHandlerHelper
Gets the push URL as a URL relative to the request URI.
getPwaConfiguration() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get the PWA configuration of the application.
getPwaConfiguration() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get the PwaConfiguration of the application.
getPwaConfiguration() - Method in class com.vaadin.flow.server.PwaRegistry
 
getPwaConfigurationClass() - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Gets pwa configuration class.
getPwaRegistry() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets a pwa registry instance.
getPwaRegistry() - Method in class com.vaadin.flow.server.VaadinService
 
getPwaRegistry() - Method in class com.vaadin.flow.server.VaadinServletService
 
getQueryParameter(String) - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets first parameter that corresponds to specified parameterName.
getQueryParameters() - Method in class com.vaadin.flow.router.Location
Gets the request parameters used for current location.
getQueryParameters() - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets the query parameters used for navigation.
getQueryParameters() - Method in class com.vaadin.flow.router.RouterLink
Gets the QueryParameters of this link.
getQueryString() - Method in class com.vaadin.flow.router.QueryParameters
Returns a UTF-8 encoded query string containing all parameter names and values suitable for appending to a URL after the ? character.
getRawJson() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Gets the entire request in JSON format, as it was received from the client.
getRawTimezoneOffset() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Returns the browser-reported TimeZone offset in milliseconds from GMT ignoring possible daylight saving adjustments that may be in effect in the browser.
getReader() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection.FragmentedMessage
 
getReader() - Method in interface com.vaadin.flow.server.VaadinRequest
Retrieves the body of the request as character data using a BufferedReader.
getReconnectAttempts() - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Gets the number of times to try to reconnect to the server before giving up.
getReconnectAttempts() - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
getReconnectDialogConfiguration() - Method in class com.vaadin.flow.component.UI
Retrieves the object used for configuring the reconnect dialog.
getReconnectInterval() - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Gets the interval (in milliseconds) between reconnect attempts.
getReconnectInterval() - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
getRegex() - Method in class com.vaadin.flow.router.RouteParameterData
Gets the regex of the parameter.
getRegex(Class<?>) - Static method in class com.vaadin.flow.router.RouteParameterRegex
Gets the regex used for the given parameterType.
getRegisteredRoutes() - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getRegisteredRoutes() - Method in interface com.vaadin.flow.server.RouteRegistry
Get the RouteData for all registered navigation targets.
getRegisteredRoutes() - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getRegistry() - Method in class com.vaadin.flow.router.Router
 
getRegistry() - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry.ApplicationRouteRegistryWrapper
Get the application route registry.
getRelHref() - Method in class com.vaadin.flow.server.PwaIcon
Return href with '/' -prefix and removed possible ?[fileHash].
getRemoteAddr() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the IP address from which the request came.
getRemoteHost() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the fully qualified name of the client or the last proxy that sent the request.
getRemotePort() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
getRemoteUser() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
getRemovedItem() - Method in class com.vaadin.flow.internal.change.ListRemoveChange
Gets the removed item.
getRemovedNavigationTargets() - Method in class com.vaadin.flow.router.RoutesChangedEvent
Get every single navigation targets of all removed routes in this change.
getRemovedRoutes() - Method in class com.vaadin.flow.router.RoutesChangedEvent
Get all routes removed in this change.
getRemovedURLs() - Method in class com.vaadin.flow.router.RoutesChangedEvent
Get every single URL of all removed routes in this change.
getRequest() - Method in class com.vaadin.flow.server.AppShellSettings
Get the current request.
getRequest() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the Vaadin/HTTP request.
getRequest() - Method in class com.vaadin.flow.server.SessionInitEvent
Gets the request that triggered the initialization.
getRequest() - Method in class com.vaadin.flow.server.SystemMessagesInfo
Gets the request currently in progress.
getRequestHandlers() - Method in class com.vaadin.flow.server.VaadinService
Returns the request handlers that are registered with this service.
getRequestHandlers() - Method in class com.vaadin.flow.server.VaadinSession
Gets the request handlers that are registered to the session.
getRequestPathInsideContext(HttpServletRequest) - Static method in class com.vaadin.flow.server.HandlerHelper
Returns the requested path inside the context root.
getRequestSizeMax() - Method in class com.vaadin.flow.server.communication.StreamRequestHandler
Returns maximum request size for upload.
getRequestUrl(VaadinRequest) - Method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
 
getRequestUrl(VaadinRequest) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
Returns the request's base url to use in constructing and initialising ui.
getRerouteTarget() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the reroute target handler to use if the user should be rerouted to some other view.
getRerouteTarget() - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets the reroute target to use if the user should be rerouted to some other view.
getRerouteTargetRouteParameters() - Method in class com.vaadin.flow.router.BeforeEvent
Get the URL parameters of the reroute target.
getRerouteTargetType() - Method in class com.vaadin.flow.router.BeforeEvent
Get the route target type for rerouting.
getRerouteUrl() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the reroute url.
getResolvedPath() - Method in class com.vaadin.flow.router.NavigationState
Get the resolved path details for this navigation state.
getResource() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
 
getResource() - Method in interface com.vaadin.flow.server.StreamRegistration
Get the stream resource whose registration result is represented by this StreamRegistration instance.
getResource(Class<T>, URI) - Method in class com.vaadin.flow.server.StreamResourceRegistry
Get a registered resource of given type.
getResource(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
 
getResource(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
 
getResource(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
Get a resource from the classpath.
getResource(String) - Method in class com.vaadin.flow.server.VaadinService
Returns a URL to the resource at the given Vaadin URI.
getResource(String) - Method in class com.vaadin.flow.server.VaadinServletService
 
getResource(URI) - Method in class com.vaadin.flow.server.StreamResourceRegistry
Get a registered resource for given URI.
getResourceAsStream(String) - Method in class com.vaadin.flow.server.VaadinService
Opens a stream to to the resource at the given Vaadin URI.
getResourceAsStream(String) - Method in class com.vaadin.flow.server.VaadinServletService
 
getResourceInServletContext(String) - Method in class com.vaadin.flow.server.VaadinServletService
Finds the given resource in the servlet context.
getResourceOutputDirectory() - Method in class com.vaadin.flow.server.frontend.Options
 
getResourceRegistry() - Method in class com.vaadin.flow.server.VaadinSession
Get resource registry instance.
getResourceUri() - Method in interface com.vaadin.flow.server.StreamRegistration
Get resource URI for registered StreamResource instance.
getResponse() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the Vaadin/HTTP response.
getRevision() - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Gets the revision, z in x.y.z.qualifier.
getRevision() - Static method in class com.vaadin.flow.server.Version
Gets the revision, z in x.y.z.qualifier.
getRolesChecker(VaadinRequest) - Method in class com.vaadin.flow.server.auth.ViewAccessChecker
Gets a function for checking roles for the currently logged in user.
getRootNode() - Method in class com.vaadin.flow.internal.StateTree
Gets the root node of this state tree.
getRoute() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the location of the route that should be activated for this bootstrap request.
getRoute(String) - Method in class com.vaadin.flow.router.RouteConfiguration
Gets the registered route class for a given path.
getRoute(String, List<String>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the route class matching the given path and path segments.
getRoute(String, List<String>) - Method in class com.vaadin.flow.router.RouteConfiguration
Gets the optional navigation target class for a given Location matching with path segments.
getRouteAliases() - Method in class com.vaadin.flow.router.RouteData
Get all RouteAliases for this registered path.
getRouteAliasPath(Class<?>, RouteAlias) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Get the actual route path including all parent layout RoutePrefix.
getRouteParameters() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the route parameters associated with this event.
getRouteParameters() - Method in class com.vaadin.flow.router.internal.NavigationRouteTarget
Gets the route parameters for this search response.
getRouteParameters() - Method in class com.vaadin.flow.router.NavigationState
Gets the route parameters map.
getRouteParameters() - Method in class com.vaadin.flow.router.RouteBaseData
Get Route route parameters if any.
getRoutePath(VaadinContext, Class<?>) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Get the actual route path including all parent layout RoutePrefix.
getRoutePath(Class<?>) - Method in class com.vaadin.flow.router.DefaultRoutePathProvider
 
getRoutePath(Class<?>) - Method in interface com.vaadin.flow.router.RoutePathProvider
Produces a path for the navigationTarget component class.
getRoutePath(String, Class<?>) - Static method in class com.vaadin.flow.router.DefaultRoutePathProvider
 
getRoutePaths(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Collect all routes for which given routeTarget is registered.
getRouter() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the router used for navigating in this UI, if the router was active when this UI was initialized.
getRouter() - Method in class com.vaadin.flow.component.UI
Deprecated.
For internal use only. Will be removed in the future.
getRouter() - Method in class com.vaadin.flow.router.internal.ResolveRequest
Gets the router that this request originates from.
getRouter() - Method in class com.vaadin.flow.server.VaadinService
Gets the router used for UIs served by this service.
getRouter(HasElement) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets the router instance for the given component.
getRouteRegistry() - Method in class com.vaadin.flow.server.VaadinService
Find a route registry to use for this service.
getRouteRegistry() - Method in class com.vaadin.flow.server.VaadinServletService
 
getRouterLayoutTypes(Class<? extends Component>, Router) - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.
getRouterLayoutTypes(Class<? extends Component>, Router) - Method in class com.vaadin.flow.router.internal.ErrorStateRenderer
Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.
getRouterLayoutTypes(Class<? extends Component>, Router) - Method in class com.vaadin.flow.router.internal.NavigationStateRenderer
 
getRoutes() - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get all registered paths that have been registered.
getRoutesMap() - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
 
getRoutesMap() - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Override so that the getters use the correct routes map for data.
getRouteTarget() - Method in class com.vaadin.flow.router.internal.NavigationRouteTarget
Gets the route target.
getRouteTarget() - Method in class com.vaadin.flow.router.NavigationState
Gets the route target for this navigation state.
getRouteTarget(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getRouteTarget(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Gets the RouteTarget instance matching the given target component and route parameters.
getRouteTarget(Class<? extends Component>, RouteParameters) - Method in interface com.vaadin.flow.server.RouteRegistry
Gets the RouteTarget instance matching the given target component and route parameters.
getRouteTarget(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getRouteTarget(String) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the RouteTarget stored for the given template.
getRouteTargetChain() - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets the chain of route targets that will be nested inside the UI, starting from the most deeply nested component.
getRpcInvocationsData() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Gets the data to recreate the RPC as requested by the client side.
getRpcType() - Method in class com.vaadin.flow.server.communication.ReturnChannelHandler
 
getRpcType() - Method in class com.vaadin.flow.server.communication.rpc.AttachExistingElementRpcHandler
 
getRpcType() - Method in class com.vaadin.flow.server.communication.rpc.AttachTemplateChildRpcHandler
 
getRpcType() - Method in class com.vaadin.flow.server.communication.rpc.EventRpcHandler
 
getRpcType() - Method in class com.vaadin.flow.server.communication.rpc.MapSyncRpcHandler
 
getRpcType() - Method in class com.vaadin.flow.server.communication.rpc.NavigationRpcHandler
 
getRpcType() - Method in class com.vaadin.flow.server.communication.rpc.PublishedServerEventHandlerRpcHandler
 
getRpcType() - Method in interface com.vaadin.flow.server.communication.rpc.RpcInvocationHandler
Gets unique RPC type which this handler is applicable for.
getRuntimeServiceWorkerJs() - Method in class com.vaadin.flow.server.PwaRegistry
sw-runtime.js (service worker JavaScript for precaching runtime generated resources) as a String.
getScreenHeight() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Gets the height of the screen in pixels.
getScreenWidth() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Gets the width of the screen in pixels.
getScreenX() - Method in class com.vaadin.flow.component.ClickEvent
Gets the x coordinate of the click event, relative to the upper left corner of the screen.
getScreenY() - Method in class com.vaadin.flow.component.ClickEvent
Gets the y coordinate of the click event, relative to the upper left corner of the screen.
getScripts() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
 
getScripts() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get all the JS files used by the application.
getScripts() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get all the JS files used by the application.
getSecond() - Method in class com.vaadin.flow.internal.Pair
Gets the second component of the pair.
getSecondDelay() - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Returns the delay before the loading indicator goes into the "second" state.
getSecondDelay() - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
getSecureProxy() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
Get a defined secure proxy.
getSecurityTarget(Class<?>) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Gets the class to check for security restrictions.
getSecurityTarget(Method) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Gets the method or class to check for security restrictions.
getSegments() - Method in class com.vaadin.flow.router.Location
Gets all the path segments of this location.
getSegmentsList(String) - Static method in class com.vaadin.flow.router.internal.PathUtil
Returns an unmodifiable list containing the segments of the specified path.
getSelf() - Method in class com.vaadin.flow.dom.Element
 
getSelf() - Method in class com.vaadin.flow.dom.Node
Gets the narrow typed reference to this object.
getSelf() - Method in class com.vaadin.flow.dom.ShadowRoot
 
getServerSyncId() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the server sync id.
getService() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the Vaadin service.
getService() - Method in class com.vaadin.flow.server.communication.UidlWriter.ResolveContext
Gets the related Vaadin service.
getService() - Method in class com.vaadin.flow.server.SessionDestroyEvent
Gets the Vaadin service from which the even originates.
getService() - Method in class com.vaadin.flow.server.SessionInitEvent
Gets the Vaadin service from which this event originates.
getService() - Method in class com.vaadin.flow.server.SystemMessagesInfo
Returns the service this SystemMessages request comes from.
getService() - Method in interface com.vaadin.flow.server.VaadinRequest
Gets the vaadin service for the context of this request.
getService() - Method in interface com.vaadin.flow.server.VaadinResponse
Gets the vaadin service for the context of this response.
getService() - Method in class com.vaadin.flow.server.VaadinServlet
Gets the Vaadin service for this servlet.
getService() - Method in class com.vaadin.flow.server.VaadinServletRequest
 
getService() - Method in class com.vaadin.flow.server.VaadinServletResponse
 
getService() - Method in class com.vaadin.flow.server.VaadinSession
 
getServiceInitListeners() - Method in class com.vaadin.flow.di.DefaultInstantiator
 
getServiceInitListeners() - Method in interface com.vaadin.flow.di.Instantiator
Gets all service init listeners to use.
getServiceLoaderListeners(ClassLoader) - Static method in class com.vaadin.flow.di.DefaultInstantiator
Helper for finding service init listeners using ServiceLoader.
getServiceName() - Method in class com.vaadin.flow.server.VaadinService
Gets a unique name for this service.
getServiceName() - Method in class com.vaadin.flow.server.VaadinServletService
 
getServiceTypes() - Method in class com.vaadin.flow.server.startup.LookupServletContainerInitializer
Gets the service types that are used to set services into the Lookup based on found subtypes by the ServletContainerInitializer.
getServiceUrl(VaadinRequest) - Static method in class com.vaadin.flow.internal.BootstrapHandlerHelper
Gets the service URL as a URL relative to the request URI.
getServiceUrl(VaadinRequest) - Static method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
Gets the service URL as a URL relative to the request URI.
getServiceUrl(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
Returns the service url needed for initialising the UI.
getServiceWorkerPath() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the path to the service worker.
getServlet() - Method in class com.vaadin.flow.server.VaadinServletService
Retrieves a reference to the servlet associated with this service.
getServletConfig() - Method in class com.vaadin.flow.server.VaadinServlet
 
getServletContext() - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer.FakeServletConfig
 
getServletName() - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer.FakeServletConfig
 
getServletPathRelative(String, HttpServletRequest) - Static method in class com.vaadin.flow.internal.UrlUtil
Returns the given absolute path as a path relative to the servlet path.
getServletRegistration(ServletConfig) - Static method in class com.vaadin.flow.internal.BootstrapHandlerHelper
Returns a ServletRegistration for the given ServletConfig, if available.
getSession() - Method in class com.vaadin.flow.component.internal.AbstractAttachDetachEvent
Gets the session the component is attached to.
getSession() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the VaadinSession to which the related UI is attached.
getSession() - Method in class com.vaadin.flow.component.UI
Gets the VaadinSession to which this UI is attached.
getSession() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the Vaadin session.
getSession() - Method in class com.vaadin.flow.server.SessionDestroyEvent
Gets the Vaadin service session that is no longer used.
getSession() - Method in class com.vaadin.flow.server.SessionInitEvent
Gets the Vaadin service session that has been initialized.
getSession() - Method in class com.vaadin.flow.server.VaadinSession
Gets the underlying session to which this service session is currently associated.
getSessionAttributeName() - Method in class com.vaadin.flow.server.VaadinService
Returns the name used for storing the VaadinSession in the underlying HTTP session.
getSessionExpiredCaption() - Method in class com.vaadin.flow.server.SystemMessages
Gets the caption to show in a "session expired" notification.
getSessionExpiredMessage() - Method in class com.vaadin.flow.server.SystemMessages
Gets the message to show in a "session expired" notification.
getSessionExpiredURL() - Method in class com.vaadin.flow.server.SystemMessages
Gets the URL the user will be redirected to after dismissing a session expired message.
getSessionLock(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Gets the lock instance used to lock the VaadinSession associated with the given wrapped session.
getSessionRegistry(VaadinSession) - Static method in class com.vaadin.flow.server.SessionRouteRegistry
Get the session registry for VaadinSession.
getSetterMethods(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Return all the setter methods from the given type.
getShadowDomElements() - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Get a copy of the elements that should be added to the shadow dom hosting the embedded web component.
getShadowRoot() - Method in class com.vaadin.flow.dom.Element
Gets the shadow root of the element, if any.
getShadowRoot() - Method in class com.vaadin.flow.internal.nodefeature.ShadowRootData
 
getShadowRoot(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets shadow root for the node if it has been attached.
getShadowRoot(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getShadowRoot(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getShadowRoot(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getShell() - Method in class com.vaadin.flow.server.AppShellRegistry
Returns the AppShellConfigurator class in the application.
getShortName() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the application short name.
getSize(String) - Static method in enum class com.vaadin.flow.component.Unit
Gives size component as float of the css string representing a size.
getSizes() - Method in class com.vaadin.flow.server.PwaIcon
Gets the value of the sizes attribute.
getSource() - Method in class com.vaadin.flow.component.ComponentEvent
 
getSource() - Method in class com.vaadin.flow.component.HeartbeatEvent
 
getSource() - Method in class com.vaadin.flow.component.page.BrowserWindowResizeEvent
 
getSource() - Method in class com.vaadin.flow.component.page.History.HistoryStateChangeEvent
 
getSource() - Method in class com.vaadin.flow.component.ShortcutEvent
Component which listened for the shortcut.
getSource() - Method in class com.vaadin.flow.dom.DomEvent
Returns the element on which the listener has been attached.
getSource() - Method in class com.vaadin.flow.dom.ElementAttachEvent
 
getSource() - Method in class com.vaadin.flow.dom.ElementDetachEvent
 
getSource() - Method in class com.vaadin.flow.dom.PropertyChangeEvent
 
getSource() - Method in class com.vaadin.flow.router.AfterNavigationEvent
 
getSource() - Method in class com.vaadin.flow.router.BeforeEvent
 
getSource() - Method in class com.vaadin.flow.router.LocationChangeEvent
 
getSource() - Method in class com.vaadin.flow.router.NavigationEvent
 
getSource() - Method in class com.vaadin.flow.router.RoutesChangedEvent
 
getSource() - Method in class com.vaadin.flow.server.ServiceDestroyEvent
 
getSource() - Method in class com.vaadin.flow.server.ServiceInitEvent
 
getSource() - Method in class com.vaadin.flow.server.SessionDestroyEvent
 
getSource() - Method in class com.vaadin.flow.server.SessionInitEvent
 
getSource() - Method in class com.vaadin.flow.server.UIInitEvent
 
getSpringCsrfToken(VaadinRequest) - Static method in class com.vaadin.flow.internal.springcsrf.SpringCsrfTokenUtil
 
getSpringCsrfToken(ServletRequest) - Static method in class com.vaadin.flow.internal.springcsrf.SpringCsrfTokenUtil
 
getStart() - Method in class com.vaadin.flow.internal.Range
Returns the inclusive start point of this range.
getStartUrl() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the start url of the PWA application.
getState() - Method in class com.vaadin.flow.component.page.History.HistoryStateChangeEvent
Gets the history state value as JSON.
getState() - Method in class com.vaadin.flow.router.NavigationEvent
Gets navigation state.
getState() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Returns the state of this connection.
getState() - Method in class com.vaadin.flow.server.VaadinSession
Returns the lifecycle state of this session.
getStateNode() - Method in class com.vaadin.flow.internal.StateTree.BeforeClientResponseEntry
 
getStateNodeId() - Method in interface com.vaadin.flow.internal.nodefeature.ReturnChannelRegistration
Gets the id of the state node to which the return channel belongs.
getStateProvider() - Method in class com.vaadin.flow.dom.Node
Gets the state provider for this element.
getStateProvider() - Method in class com.vaadin.flow.dom.ShadowRoot
 
getStateTree() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the state tree of the related UI.
getStaticResource(String) - Method in class com.vaadin.flow.server.StaticFileServer
Returns a URL to the static Web resource at the given URI or null if no file found.
getStaticResource(String) - Method in class com.vaadin.flow.server.VaadinService
Returns a URL to the static resource at the given URI or null if no file found.
getStaticResource(String) - Method in class com.vaadin.flow.server.VaadinServletService
 
getStatsHash(JsonObject) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
getStatusCode() - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets the HTTP status code that will be returned for the client if this location change is an initial rendering request.
getStreamVariable() - Method in class com.vaadin.flow.server.StreamReceiver
Get the StreamVariable for this stream receiver.
getStringProperty(String, String) - Method in interface com.vaadin.flow.server.AbstractConfiguration
Gets a configured property as a string.
getStringProperty(String, String) - Method in class com.vaadin.flow.server.AbstractPropertyConfiguration
 
getStyle() - Method in interface com.vaadin.flow.component.HasStyle
Gets the style instance for managing inline styles for the element of this component.
getStyle() - Method in class com.vaadin.flow.dom.Element
Gets the style instance for managing element inline styles.
getStyle() - Method in class com.vaadin.flow.internal.nodefeature.ElementStylePropertyMap
Returns a style instance for managing element inline styles.
getStyle(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Returns a style instance for managing element inline styles.
getStyle(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getStyle(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getStyle(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getStyleSheetAnnotations(Class<? extends Component>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Finds all StyleSheet annotations on the given Component class, its super classes and implemented interfaces.
getStylesheetLinks(VaadinContext, String) - Static method in class com.vaadin.flow.server.BootstrapHandler
Gives a links for referencing the custom theme stylesheet files (typically styles.css or document.css), which are served in express build mode by static file server directly from frontend/themes folder.
getStylesheetTags(VaadinContext, String) - Static method in class com.vaadin.flow.server.BootstrapHandler
Gives link tags for referencing the custom theme stylesheet files (typically styles.css or document.css), which are served in express build mode by static file server directly from frontend/themes folder.
getSubLocation() - Method in class com.vaadin.flow.router.Location
Creates a new location without the first path segment.
getSubTypesOf(Class<T>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
 
getSubTypesOf(Class<T>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
 
getSubTypesOf(Class<T>) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
Gets all subtypes in hierarchy of a given type.
getSubTypesOf(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
Gets all subtypes in hierarchy of a given type, using FQN string.
getSymbol() - Method in enum class com.vaadin.flow.component.Unit
 
getSynchronizationRegistration() - Method in class com.vaadin.flow.component.AbstractSinglePropertyField
Returns the registration of the DOM event listener that synchronizes the property value.
getSynchronizedProperties() - Method in class com.vaadin.flow.component.internal.ComponentMetaData
Gets the properties that are marked to be synchronized and corresponding events.
getSynchronizedProperties(Class<? extends Component>) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets the synchronized property infos of the properties that are defined declaratively for the given class with their RPC update mode.
getSynchronizedPropertyEvents(Class<? extends Component>) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets the name of the synchronized property event defined declaratively for the given class.
getSyncId() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Gets the sync id last seen by the client.
getSystemMessages(SystemMessagesInfo) - Method in class com.vaadin.flow.server.DefaultSystemMessagesProvider
 
getSystemMessages(SystemMessagesInfo) - Method in interface com.vaadin.flow.server.SystemMessagesProvider
Gets the system messages to use in the given context.
getSystemMessages(Locale, VaadinRequest) - Method in class com.vaadin.flow.server.VaadinService
Gets the system message to use for a specific locale.
getSystemMessagesProvider() - Method in class com.vaadin.flow.server.VaadinService
Gets the system messages provider currently defined for this service.
getSystemProperty(String) - Method in class com.vaadin.flow.server.AbstractPropertyConfiguration
Gets an system property value.
getSystemProperty(String) - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
Gets an system property value.
getTabIndex() - Method in interface com.vaadin.flow.component.Focusable
Gets the tabindex in the component.
getTag() - Method in interface com.vaadin.flow.component.webcomponent.WebComponentConfiguration
Retrieves the tag name configured by the web component exporter.
getTag() - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI.WebComponentConnectEvent
Gets the tag of the element to connect.
getTag() - Method in class com.vaadin.flow.component.WebComponentExporter
The tag associated with the exported component.
getTag() - Method in class com.vaadin.flow.dom.Element
Gets the tag name for the element.
getTag() - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Gets the tag name of the element.
getTag(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the tag name for the given node.
getTag(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getTag(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getTag(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getTagById() - Method in class com.vaadin.flow.component.template.internal.IdCollector
Gets a map from field ids to their component tags.
getTarget() - Method in class com.vaadin.flow.router.internal.RouteTarget
Get the component route target.
getTarget(String) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the target class matching the given url.
getTargetRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the route template String for the given navigation target class.
getTargetRoutes() - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get all registered target routes for this configuration mapping the main template.
getTargetRoutes() - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Override so that the getters use the correct target routes map for data.
getTargetURI(AbstractStreamResource) - Method in class com.vaadin.flow.server.StreamResourceRegistry
Returns the URI path to the given resource in the context of this registry (relevant in portlet context).
getTargetUrl(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getTargetUrl(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the url path String for the given navigation target class.
getTargetUrl(Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Get the url string for given navigation target.
getTargetUrl(Class<? extends Component>) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getTargetUrl(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getTargetUrl(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the url path String for the given navigation target class and parameters.
getTargetUrl(Class<? extends Component>, RouteParameters) - Method in interface com.vaadin.flow.server.RouteRegistry
Get the url string for given navigation target.
getTargetUrl(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getTemplate() - Method in class com.vaadin.flow.router.RouteBaseData
Get the full route template of Route.
getTemplate() - Method in class com.vaadin.flow.router.RouteParameterData
Gets the parameter template string.
getTemplate(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getTemplate(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the route template String for the given navigation target class.
getTemplate(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Gets the route template for the given target.
getTemplate(Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Get the main template for given navigation target.
getTemplate(Class<? extends Component>) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getTemplate(Class<? extends Component>, Set<RouteParameterFormatOption>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the route template String for the given navigation target class and using the specified parameters format.
getTemplate(String, Class<? extends Component>) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Gets the template for the given url base by appending the parameter according to the given navigationTarget if it's implementing HasUrlParameter
getTemplateItem(Component, JsonObject, Type) - Method in interface com.vaadin.flow.component.template.internal.DeprecatedPolymerPublishedEventHandler
Deprecated.
Get the template model object and type.
getText() - Method in interface com.vaadin.flow.component.HasText
Gets the text content of this component.
getText() - Method in class com.vaadin.flow.component.Text
Gets the text of the component.
getText() - Method in class com.vaadin.flow.dom.Element
Gets the text content of this element.
getText() - Method in class com.vaadin.flow.internal.nodefeature.TextNodeMap
Gets the text of this node.
getTextContent(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the text content.
getTextContent(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getTextContent(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
 
getTextContent(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getTextRecursively() - Method in class com.vaadin.flow.dom.Element
Gets the text content of this element tree.
getTheme() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get the AbstractTheme instance used in the application.
getTheme() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get the AbstractTheme instance used in the application.
getTheme() - Method in class com.vaadin.flow.theme.ThemeDefinition
Gets the theme class.
getThemeAnnotation(VaadinContext) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
Gets the theme annotation for the project.
getThemeColor() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the theme color of the application.
getThemeDefinition() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
Get the ThemeDefinition of the application.
getThemeDefinition() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
Get the ThemeDefinition of the application.
getThemeFilePath(String, String) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
 
getThemeFolder(File, String) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
Finds the folder for the given theme.
getThemefor() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
The themefor getter.
getThemeIdPrefix() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
getThemeJson(String, AbstractConfiguration) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
 
getThemeJson(String, File) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
 
getThemeList() - Method in class com.vaadin.flow.dom.Element
Gets the set of the theme names applied to the corresponding element in theme attribute.
getThemeName() - Method in interface com.vaadin.flow.component.HasTheme
Gets the theme names for this component.
getThemeName(VaadinContext) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
Gets the custom theme name if the custom theme is used in the project.
getThemeNames() - Method in interface com.vaadin.flow.component.HasTheme
Gets the set of theme names used for this element.
getThemeResourceFromPrecompiledProductionBundle(String) - Static method in class com.vaadin.flow.server.frontend.ThemeUtils
Gets the URL of the theme resource located in the pre-compiled production bundle JAR or in the external packaged theme JAR.
getThemeUrl() - Method in interface com.vaadin.flow.theme.AbstractTheme
The url for the components themed version implementation.
getThirdDelay() - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Returns the delay before the loading indicator goes into the "third" state.
getThirdDelay() - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
getThrowable() - Method in class com.vaadin.flow.server.ErrorEvent
Gets the contained throwable, the cause of the error.
getTimeZoneId() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Returns the TimeZone Id (like "Europe/Helsinki") provided by the browser (if the browser supports this feature).
getTimezoneOffset() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Returns the browser-reported TimeZone offset in milliseconds from GMT.
getTitle() - Method in class com.vaadin.experimental.Feature
 
getTitle() - Method in class com.vaadin.flow.component.HtmlComponent
Gets the title of this component.
getTitle() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the page title recorded with Page.setTitle(String).
getToken() - Method in class com.vaadin.flow.internal.springcsrf.SpringCsrfToken
 
getTokenFile() - Method in class com.vaadin.flow.server.frontend.Options
 
getTokenFileContent(Function<String, String>) - Method in class com.vaadin.flow.server.startup.AbstractConfigurationFactory
Gets the content of the token file with given locationProvider.
getTokenFileData() - Method in class com.vaadin.flow.server.frontend.Options
 
getTokenFileFromClassloader(VaadinContext) - Method in class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory
Gets token file from the classpath using the provided context.
getTopParentLayout(VaadinContext, Class<?>, String) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Get the top most parent layout for navigation target according to the Route or RouteAlias annotation.
getTranslation(Object, Object...) - Method in class com.vaadin.flow.component.Component
Get the translation for the component locale.
getTranslation(Object, Locale, Object...) - Method in class com.vaadin.flow.component.Component
getTranslation(Object, Locale, Object...) - Method in interface com.vaadin.flow.i18n.I18NProvider
Get the translation for key with given locale.
getTranslation(String, Object...) - Method in class com.vaadin.flow.component.Component
Get the translation for the component locale.
getTranslation(String, Locale, Object...) - Method in class com.vaadin.flow.component.Component
getTranslation(String, Locale, Object...) - Method in interface com.vaadin.flow.i18n.I18NProvider
Get the translation for key with given locale.
getTranslation(Locale, Object, Object...) - Method in class com.vaadin.flow.component.Component
Get the translation for key with given locale.
getTranslation(Locale, String, Object...) - Method in class com.vaadin.flow.component.Component
Get the translation for key with given locale.
getTransport() - Method in interface com.vaadin.flow.component.PushConfiguration
Returns the primary transport type for push.
getTransport() - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
getTrigger() - Method in class com.vaadin.flow.component.page.History.HistoryStateChangeEvent
Gets the type of user action that triggered this history change.
getTrigger() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the type of user action that triggered this location change.
getTrigger() - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets the type of user action that triggered this location change.
getTrigger() - Method in class com.vaadin.flow.router.NavigationEvent
Gets the type of user action that triggered this navigation event.
getType() - Method in class com.vaadin.flow.dom.DomEvent
Gets the type of the event.
getType() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
getType() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
 
getType() - Method in class com.vaadin.flow.server.PwaIcon
Gets the value of the type attribute.
getType() - Method in class com.vaadin.flow.server.webcomponent.PropertyData
Getter for the property value class type.
getType() - Method in class com.vaadin.flow.shared.ui.Dependency
Gets the type of the dependency.
getType(String) - Static method in class com.vaadin.flow.router.RouteParameterRegex
Gets the type of the parameter for the given regex.
getUi() - Method in class com.vaadin.flow.server.AppShellSettings
Get the target UI instance.
getUI() - Method in class com.vaadin.flow.component.Component
Gets the UI this component is attached to.
getUI() - Method in class com.vaadin.flow.component.internal.AbstractAttachDetachEvent
Gets the UI the component is attached to.
getUI() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the UI that this instance belongs to.
getUI() - Method in class com.vaadin.flow.component.page.History
Gets the UI that this instance belongs to.
getUI() - Method in class com.vaadin.flow.component.UI
 
getUI() - Method in class com.vaadin.flow.i18n.LocaleChangeEvent
Returns the UI where the locale changed in.
getUI() - Method in class com.vaadin.flow.internal.ExecutionContext
Gets the UI associated with the execution.
getUI() - Method in class com.vaadin.flow.internal.StateTree
Gets the UI that this tree belongs to.
getUI() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the UI this navigation takes place inside.
getUI() - Method in class com.vaadin.flow.router.LocationChangeEvent
Gets the UI in which the view is shown.
getUI() - Method in class com.vaadin.flow.router.NavigationEvent
Gets the UI in which the navigation occurs.
getUI() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the UI.
getUI() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
 
getUI() - Method in class com.vaadin.flow.server.communication.IndexHtmlResponse
Gets the UI that will be displayed on the generated HTML page.
getUI() - Method in class com.vaadin.flow.server.UIInitEvent
Get the initialized UI for this initialization event.
getUIById(int) - Method in class com.vaadin.flow.server.VaadinSession
Returns a UI with the given id.
getUIClass(VaadinRequest) - Static method in class com.vaadin.flow.server.BootstrapHandler
Returns the UI class mapped for servlet that handles the given request.
getUIClassName() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Gets UI class configuration option value.
getUIClassName() - Method in class com.vaadin.flow.server.AbstractDeploymentConfiguration
 
getUIId() - Method in class com.vaadin.flow.component.UI
Gets the id of the UI, used to identify this UI within its application when processing requests.
getUIs() - Method in class com.vaadin.flow.server.VaadinSession
Gets all the UIs of this session.
getUnit(String) - Static method in enum class com.vaadin.flow.component.Unit
Gives size unit of the css string representing a size.
getUnitFromSymbol(String) - Static method in enum class com.vaadin.flow.component.Unit
Convert unit string symbol to Unit.
getUnixPath(Path) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Get path as a String in Unix form.
getUnixRelativePath(Path, Path) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Get relative path from a source path to a target path in Unix form.
getUnknownForward() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the unknown forward.
getUnknownReroute() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the unknown reroute.
getUpdateMode() - Method in class com.vaadin.flow.component.internal.ComponentMetaData.SynchronizedPropertyInfo
 
getUpdateMode(Method) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Returns method's RPC communication mode from the client side to the server side when the element is disabled.
getUpdateMode(Method) - Method in class com.vaadin.flow.internal.nodefeature.ClientCallableHandlers
 
getUpdateMode(Method) - Method in class com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers
Deprecated.
 
getUri() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Get the proxy uri.
getURI(AbstractStreamResource) - Static method in class com.vaadin.flow.server.StreamResourceRegistry
Gets the URI for the given resource.
getUriResolver() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the URI resolver to use for bootstrap resources.
getUrl() - Method in class com.vaadin.flow.shared.ui.Dependency
Gets the untranslated URL for the dependency.
getUrl(Class<? extends C>, List<T>) - Method in class com.vaadin.flow.router.RouteConfiguration
Get the url string for given navigation target with the parameters in the url.
getUrl(Class<? extends C>, T) - Method in class com.vaadin.flow.router.RouteConfiguration
Get the url string for given navigation target with the parameter in the url.
getUrl(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Get the registered url string for given navigation target.
getUrl(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.RouteConfiguration
Gets the url which navigates to given navigationTarget using given parameters.
getUrl(String, List<T>) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Gets the final url by appending the given parameters.
getUrlBase(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Return the url base without any route parameters.
getUrlBase(String) - Static method in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Gets the url base without the parameter for the given template and navigation target implementing * HasUrlParameter.
getUrlParameters() - Method in class com.vaadin.flow.router.NavigationState
Gets the list of strings that correspond to the raw string url parameters.
getUserPrincipal() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns a java.security.Principal object containing the name of the current authenticated user.
getVaadinContext() - Method in interface com.vaadin.flow.server.VaadinConfig
Get the VaadinContext for this configuration.
getVaadinContext() - Method in class com.vaadin.flow.server.VaadinServletConfig
 
getVaadinHomeDirectory() - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Gets vaadin home directory (".vaadin" folder in the user home dir).
getVaadinRequest() - Method in class com.vaadin.flow.server.communication.IndexHtmlResponse
Get the request which triggers the Index HTML response.
getVaadinResponse() - Method in class com.vaadin.flow.server.communication.IndexHtmlResponse
Get the Vaadin response object including all the headers which will be sent to browser.
getVaadinVersion() - Static method in class com.vaadin.flow.server.Platform
Returns the platform version string, e.g., "23.0.0".
getValidAnnotations() - Static method in class com.vaadin.flow.server.startup.VaadinAppShellInitializer
Return the list of annotations handled by this class.
getValidSupers() - Static method in class com.vaadin.flow.server.startup.VaadinAppShellInitializer
Return the list of super classes handled by this class.
getValue() - Method in class com.vaadin.flow.component.AbstractCompositeField
 
getValue() - Method in class com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent
 
getValue() - Method in class com.vaadin.flow.component.AbstractField
 
getValue() - Method in interface com.vaadin.flow.component.HasValue
Returns the current value of this object.
getValue() - Method in interface com.vaadin.flow.component.HasValue.ValueChangeEvent
Returns the new value that triggered this value change event.
getValue() - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
Delegate method for HasValue.getValue().
getValue() - Method in class com.vaadin.flow.dom.PropertyChangeEvent
Returns the new value that triggered this value change event.
getValue() - Method in class com.vaadin.flow.internal.change.MapPutChange
Gets the new value.
getValue() - Method in class com.vaadin.flow.internal.nodefeature.BasicTypeValue
Gets the value of a basic type.
getValue() - Method in class com.vaadin.flow.internal.nodefeature.NodeValue
Gets the value of this feature.
getValue() - Method in class com.vaadin.flow.router.RouteParam
Gets the value of the parameter.
getValue() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
The value getter.
getVariant() - Method in class com.vaadin.flow.theme.ThemeDefinition
Gets the variant of the theme.
getVersion() - Method in class com.vaadin.flow.internal.UsageStatistics.UsageEntry
Gets the version string.
getVersion(String, List<String>) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
 
getWebappResourcesDirectory() - Method in class com.vaadin.flow.server.frontend.Options
Get the output directory for webpack output.
getWebComponentDisconnect() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns the number of seconds that a WebComponent will wait for a reconnect before removing the server-side component from memory.
getWebComponentDisconnect() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
getWebComponentDisconnect() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
getWebComponentElementId() - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI.WebComponentConnectEvent
Gets the id of the web component.
getWebComponentHtmlContent(VaadinService) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Gets the content of the frontend/web-component.html file which is served by vite in dev-mode and read from classpath in production mode.
getWebComponentUserAssignedId() - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI.WebComponentConnectEvent
Gets the user-assigned id of the web component.
getWebpackNodeEnvironment() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Returns flags required to pass to Node for Webpack to function.
getWhiteSpace() - Method in interface com.vaadin.flow.component.HasText
Gets the "white-space" style value.
getWidth() - Method in interface com.vaadin.flow.component.HasSize
Gets the width defined for the component.
getWidth() - Method in class com.vaadin.flow.component.page.BrowserWindowResizeEvent
Gets the new browser window width.
getWidth() - Method in class com.vaadin.flow.server.PwaIcon
Gets width of an icon.
getWidthUnit() - Method in interface com.vaadin.flow.component.HasSize
Gets the width unit of the component, if defined.
getWildcard(String) - Method in class com.vaadin.flow.router.RouteParameters
Gets a list representing the wildcard value of a parameter, where each element in the list is a path segment.
getWindowInnerHeight() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Gets the inner height of the browser window window.innerHeight in pixels.
getWindowInnerWidth() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Gets the inner width of the browser window window.innerWidth in pixels.
getWindowName() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Returns a unique browser window identifier.
getWrappedSession() - Method in interface com.vaadin.flow.server.VaadinRequest
Gets the session associated with this request, creating a new if there is no session.
getWrappedSession() - Method in class com.vaadin.flow.server.VaadinServletRequest
 
getWrappedSession(boolean) - Method in interface com.vaadin.flow.server.VaadinRequest
Gets the session associated with this request, optionally creating a new if there is no session.
getWrappedSession(boolean) - Method in class com.vaadin.flow.server.VaadinServletRequest
 
getWriter() - Method in class com.vaadin.flow.server.StreamResource
Returns the stream resource writer.
getWriter() - Method in interface com.vaadin.flow.server.VaadinResponse
Returns a PrintWriter object that can send character text to the client.
GLOBAL - Static variable in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
GLOBAL_PNPM_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Constant for setting the pinned supported version of pnpm to be used by default (see FrontendTools.DEFAULT_PNPM_VERSION).
go(int) - Method in class com.vaadin.flow.component.page.History
Navigates a number of steps forward or backward in the history.
GO_BACK - Static variable in interface com.vaadin.flow.component.Key
The Back button.
GO_HOME - Static variable in interface com.vaadin.flow.component.Key
The Home button, which takes the user to the phone's main screen (usually an application launcher).
GONE - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known.
GREEN - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 
GRID - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
GROUP_FIRST - Static variable in interface com.vaadin.flow.component.Key
Switches to the first character group on an ISO/IEC 9995 keyboard.
GROUP_LAST - Static variable in interface com.vaadin.flow.component.Key
Switches to the last character group on an ISO/IEC 9995 keyboard.
GROUP_NEXT - Static variable in interface com.vaadin.flow.component.Key
Switches to the next character group on an ISO/IEC 9995 keyboard.
GROUP_PREVIOUS - Static variable in interface com.vaadin.flow.component.Key
Switches to the previous character group on an ISO/IEC 9995 keyboard.
guess() - Static method in class com.vaadin.flow.server.frontend.installer.Platform
Create a Platform and figure out OS and Architecture.
GUIDE - Static variable in interface com.vaadin.flow.component.Key
Toggles the display of the program or content guide.
GUIDE_NEXT_DAY - Static variable in interface com.vaadin.flow.component.Key
If the guide is currently displayed, this button tells the guide to display the next day's content.
GUIDE_PREVIOUS_DAY - Static variable in interface com.vaadin.flow.component.Key
If the guide is currently displayed, this button tells the guide to display the previous day's content.
GwtIncompatible - Annotation Interface in com.vaadin.flow.shared
Marks a type, method, constructor of field to be ignored by the GWT compiler.

H

H1 - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <h1>.
H2 - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <h2>.
H3 - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <h3>.
H4 - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <h4>.
H5 - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <h5>.
H6 - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <g6>.
handle(UI, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
 
handle(UI, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.NavigationRpcHandler
 
handle(UI, JsonObject) - Method in interface com.vaadin.flow.server.communication.rpc.RpcInvocationHandler
Handles RPC data invocationJson using ui as a context.
handle(NavigationEvent) - Method in class com.vaadin.flow.component.internal.JavaScriptNavigationStateRenderer
 
handle(NavigationEvent) - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
 
handle(NavigationEvent) - Method in class com.vaadin.flow.router.internal.ErrorStateRenderer
 
handle(NavigationEvent) - Method in class com.vaadin.flow.router.internal.InternalRedirectHandler
 
handle(NavigationEvent) - Method in interface com.vaadin.flow.router.NavigationHandler
Handles the navigation event.
handleContextOrServletRootWithoutSlash(HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.server.VaadinServlet
Invoked for every request to this servlet to potentially send a redirect to avoid problems with requests to the context root with no trailing slash.
handleError(Exception) - Method in interface com.vaadin.flow.server.ErrorHandlingCommand
Handles exceptions thrown during the execution of a FutureAccess.
handleError(Exception) - Method in class com.vaadin.flow.server.FutureAccess
Handles exceptions thrown during the execution of this task.
handleEvent(DomEvent) - Method in interface com.vaadin.flow.dom.DomEventListener
Invoked when a DOM event has been fired.
handleFileUploadValidationAndData(VaadinSession, InputStream, StreamReceiver, String, String, long, StateNode) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
Validate that stream target is in a valid state for receiving data and send stream to receiver.
handleInitializedRegistry() - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Handles an attempt to initialize already initialized route registry.
handleNode(StateNode, JsonObject) - Method in class com.vaadin.flow.server.communication.ReturnChannelHandler
 
handleNode(StateNode, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
Handle the RPC data invocationJson using target node as a context.
handleNode(StateNode, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.AttachExistingElementRpcHandler
 
handleNode(StateNode, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.AttachTemplateChildRpcHandler
 
handleNode(StateNode, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.EventRpcHandler
 
handleNode(StateNode, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.MapSyncRpcHandler
 
handleNode(StateNode, JsonObject) - Method in class com.vaadin.flow.server.communication.rpc.PublishedServerEventHandlerRpcHandler
 
handleNonRouterLayout(Class<?>) - Method in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
Handles the clazz which is not a top level route and not a router layout.
handleNonRouterLayout(Class<?>) - Method in class com.vaadin.flow.server.startup.WebComponentExporterAwareValidator
 
handleRequest(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.VaadinService
Handles the incoming request and writes the response into the response object.
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.FaviconHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.PushRequestHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.PwaHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.SessionRequestHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.StreamRequestHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in interface com.vaadin.flow.server.RequestHandler
Called when a request needs to be handled.
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.SynchronizedRequestHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.UnsupportedBrowserHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse, StreamReceiver, String, String) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
Handle reception of incoming stream from the client.
handleRequest(VaadinSession, VaadinRequest, VaadinResponse, StreamResource) - Method in class com.vaadin.flow.server.communication.StreamResourceHandler
Handle sending for a stream resource request.
HandlerHelper - Class in com.vaadin.flow.server
Contains helper methods for VaadinServlet and generally for handling VaadinRequests.
HandlerHelper.RequestType - Enum Class in com.vaadin.flow.server
Framework internal enum for tracking the type of a request.
handleRpc(UI, Reader, VaadinRequest) - Method in class com.vaadin.flow.server.communication.ServerRpcHandler
Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.
handleSessionExpired(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.HeartbeatHandler
 
handleSessionExpired(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.PushRequestHandler
 
handleSessionExpired(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.UidlRequestHandler
 
handleSessionExpired(VaadinRequest, VaadinResponse) - Method in interface com.vaadin.flow.server.SessionExpiredHandler
Called when the a session expiration has occurred and a notification needs to be sent to the user.
handleSessionExpired(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.VaadinService
Called when the session has expired and the request handling is therefore aborted.
handleTriggeredBeforeEvent(NavigationEvent, BeforeEvent) - Method in class com.vaadin.flow.component.internal.JavaScriptNavigationStateRenderer
 
handleTriggeredBeforeEvent(NavigationEvent, BeforeEvent) - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
Handle a BeforeEvent after if has been triggered to an observer.
handleWebComponentResyncRequest(BootstrapHandler.BootstrapContext, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
Handles WebComponents resynchronization request
HANGUL_MODE - Static variable in interface com.vaadin.flow.component.Key
The Hangul (Korean character set) mode key, which toggles between Hangul and English entry modes.
HANJA_MODE - Static variable in interface com.vaadin.flow.component.Key
Selects the Hanja mode, for converting Hangul characters to the more specific Hanja characters.
HANKAKU - Static variable in interface com.vaadin.flow.component.Key
The Hankaku (half-width characters) key.
has(String) - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
has(String) - Method in class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
has(String) - Method in interface com.vaadin.flow.dom.Style
Checks if the given style property has been set.
has(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Checks whether an attribute with the given name has been set.
hasAccess(Class<?>) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Checks if the user defined by the current active servlet request (using HttpServletRequest.getUserPrincipal() and HttpServletRequest.isUserInRole(String) has access to the given class.
hasAccess(Class<?>, HttpServletRequest) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Checks if the user defined by the request (using HttpServletRequest.getUserPrincipal() and HttpServletRequest.isUserInRole(String) has access to the given class.
hasAccess(Class<?>, Principal, Function<String, Boolean>) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Checks if the user defined by the given Principal and role checker has access to the given class.
hasAccess(Method) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Checks if the user defined by the current active servlet request (using HttpServletRequest.getUserPrincipal() and HttpServletRequest.isUserInRole(String) has access to the given method.
hasAccess(Method, HttpServletRequest) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Checks if the user defined by the request (using HttpServletRequest.getUserPrincipal() and HttpServletRequest.isUserInRole(String) has access to the given method.
hasAccess(Method, Principal, Function<String, Boolean>) - Method in class com.vaadin.flow.server.auth.AccessAnnotationChecker
Checks if the user defined by the given Principal and role checker has access to the given method.
hasAnnotation(AnnotatedElement, String) - Static method in class com.vaadin.flow.internal.ReflectTools
Checks whether the element has annotation whose FQN is annotationFqn.
hasAnnotationWithSimpleName(AnnotatedElement, String) - Static method in class com.vaadin.flow.internal.ReflectTools
Checks whether the element has annotation whose simple name is simpleName.
HasAriaLabel - Interface in com.vaadin.flow.component
A generic interface for components and other user interface objects that may have an aria-label and an aria-labelledby DOM attributes to set the accessible name of the component.
hasAttribute(Element) - Method in class com.vaadin.flow.dom.impl.ClassAttributeHandler
 
hasAttribute(Element) - Method in class com.vaadin.flow.dom.impl.CustomAttribute
Checks what Element.hasAttribute(String) should return for this attribute.
hasAttribute(Element) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
hasAttribute(StateNode, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Checks if the given attribute has been set.
hasAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
hasAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
hasAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
hasAttribute(String) - Method in class com.vaadin.flow.dom.Element
Checks if the given attribute has been set.
hasBeforeClientResponseEntries() - Method in class com.vaadin.flow.internal.StateNode
Checks whether there are pending executions for this node.
hasChannels() - Method in class com.vaadin.flow.internal.nodefeature.ReturnChannelMap
Return if map contains any registered channels.
hasClassName(String) - Method in interface com.vaadin.flow.component.HasStyle
Checks if the component has the given class name.
HasComponents - Interface in com.vaadin.flow.component
A component to which the user can add and remove child components.
hasConfigurations() - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Checks whether the registry contains any web component configurations.
hasCustomMessage() - Method in class com.vaadin.flow.router.ErrorParameter
Check if we have a custom message for the exception.
hasDirtyNodes() - Method in class com.vaadin.flow.internal.StateTree
Checks if there are nodes that have been marked as dirty since the last time StateTree.collectDirtyNodes() was invoked.
HasDynamicTitle - Interface in com.vaadin.flow.router
Allows to resolve navigation target title dynamically at runtime.
HasElement - Interface in com.vaadin.flow.component
Marker interface for any class which is based on an Element.
HasEnabled - Interface in com.vaadin.flow.component
A generic interface for components and other user interface objects that may be enabled or disabled.
hasErrorParameter() - Method in class com.vaadin.flow.router.BeforeEvent
Check if we have an error parameter set for this navigation event.
HasErrorParameter<T extends Exception> - Interface in com.vaadin.flow.router
Defines a view that handles the exceptions for the set Exception type T.
hasEventListener(Component, Class<? extends T>) - Static method in class com.vaadin.flow.component.ComponentUtil
Check if the component has at least one registered listener of the given event type.
hasExternalForwardUrl() - Method in class com.vaadin.flow.router.BeforeEvent
Check if we have a forward for an external URL.
hasFeature(Class<? extends NodeFeature>) - Method in class com.vaadin.flow.internal.StateNode
Checks whether this node contains a feature.
hasForwardTarget() - Method in class com.vaadin.flow.router.BeforeEvent
Check if we have a forward target.
HASH_PATTERN - Static variable in class com.vaadin.flow.server.communication.UidlRequestHandler
 
hashAndBundleModulesEqual(JsonObject, JsonObject, Map<String, String>) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
Verify that package hash versions are equal and that all project npmPackages are in bundle.
hasHandler(String) - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Checks whether the handler is registered in this feature.
hashCode() - Method in class com.vaadin.experimental.Feature
 
hashCode() - Method in class com.vaadin.flow.component.internal.ComponentTracker.Location
 
hashCode() - Method in class com.vaadin.flow.dom.Node
 
hashCode() - Method in class com.vaadin.flow.internal.Range
 
hashCode() - Method in class com.vaadin.flow.router.QueryParameters
 
hashCode() - Method in class com.vaadin.flow.router.RouteAliasData
 
hashCode() - Method in class com.vaadin.flow.router.RouteBaseData
 
hashCode() - Method in class com.vaadin.flow.router.RouteData
 
hashCode() - Method in class com.vaadin.flow.router.RouteParameters
 
hashCode() - Method in class com.vaadin.flow.server.frontend.FrontendVersion
 
hashCode() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
hashCode() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
 
hashCode() - Method in class com.vaadin.flow.server.webcomponent.PropertyConfigurationImpl
 
hashCode() - Method in class com.vaadin.flow.server.webcomponent.PropertyData
 
hashCode() - Method in class com.vaadin.flow.shared.ui.Dependency
 
hashCode() - Method in class com.vaadin.flow.shared.util.UniqueSerializable
 
HasHelper - Interface in com.vaadin.flow.component
Mixin interface for field components that have helper text as property and slots for inserting components.
hasJarBundle(String, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
Check if jar bundle exists on given path.
HasLabel - Interface in com.vaadin.flow.component
A component that supports label definition.
hasLastHandledLocation() - Method in class com.vaadin.flow.component.internal.UIInternals
Check if we have already started navigation to some location on this roundtrip.
hasListener(Class<? extends ComponentEvent>) - Method in class com.vaadin.flow.component.Component
Checks if there is at least one listener registered for the given event type for this component.
hasListener(Class<? extends ComponentEvent>) - Method in class com.vaadin.flow.component.ComponentEventBus
Checks if there is at least one listener registered for the given event type.
hasLock() - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
hasLock() - Method in class com.vaadin.flow.server.VaadinSession
Checks if the current thread has exclusive access to this VaadinSession.
hasLock(VaadinService, WrappedSession) - Static method in class com.vaadin.flow.server.VaadinSession
Checks if the current thread has exclusive access to the given WrappedSession.
hasLogBinding() - Method in class com.vaadin.flow.router.InternalServerError
Returns true if there is a logging binding available for SLF4J.
hasMandatoryParameter(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
hasMandatoryParameter(Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Check if the given navigationTarget requires parameters.
hasModalComponent() - Method in class com.vaadin.flow.component.internal.UIInternals
Check if we have a modal component defined for the UI.
hasModalComponent() - Method in class com.vaadin.flow.component.UI
Check if UI has a defined modal component.
hasNavigationTargets() - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Check if there are registered navigation targets in the registry.
hasNewConstants() - Method in class com.vaadin.flow.internal.ConstantPool
Checks if any new constants have been added to this constant pool since the last time ConstantPool.dumpConstants() was called.
hasNode(StateNode) - Method in interface com.vaadin.flow.internal.NodeOwner
Check if given node is registered to this node owner.
hasNode(StateNode) - Method in class com.vaadin.flow.internal.NullOwner
 
hasNode(StateNode) - Method in class com.vaadin.flow.internal.StateTree
 
HasOrderedComponents - Interface in com.vaadin.flow.component
A component which the children components are ordered, so the index of each child matters for the layout.
hasProperty(StateNode, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Checks if the given property has been set.
hasProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
hasProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
hasProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
hasProperty(String) - Method in interface com.vaadin.flow.component.webcomponent.WebComponentConfiguration
Check if the configuration has a property identified by the propertyName.
hasProperty(String) - Method in class com.vaadin.flow.dom.Element
Checks whether this element has a property with the given name.
hasProperty(String) - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Checks whether there is a property of the given name.
hasProperty(String) - Method in class com.vaadin.flow.server.webcomponent.WebComponentBinding
Does the component binding have a property identified by given name.
hasRerouteTarget() - Method in class com.vaadin.flow.router.BeforeEvent
Check if we have a reroute target.
hasRoute(String) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
See if configuration contains a registered route for given path.
hasRoute(String, List<String>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Check if configuration holds a route for given path with possible path segments.
hasRouteTarget(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Check it the given route target has been registered to the configuration.
HasSize - Interface in com.vaadin.flow.component
Any component implementing this interface supports setting the size of the component using HasSize.setWidth(String) and HasSize.setHeight(String).
HasStyle - Interface in com.vaadin.flow.component
Represents Component which has class attribute and inline styles.
hasTarget() - Method in class com.vaadin.flow.router.internal.NavigationRouteTarget
Gets whether this search result instance contains a navigation target.
hasTemplate(String) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
See if configuration contains a registered route for given template.
HasText - Interface in com.vaadin.flow.component
A component that supports text content.
HasText.WhiteSpace - Enum Class in com.vaadin.flow.component
Represents "white-space" style values.
HasTheme - Interface in com.vaadin.flow.component
Represents Component which has theme attribute.
hasThemeName(String) - Method in interface com.vaadin.flow.component.HasTheme
Checks if the component has the given theme name.
hasUnknownForward() - Method in class com.vaadin.flow.router.BeforeEvent
Gets if forward route is unknown.
hasUnknownReroute() - Method in class com.vaadin.flow.router.BeforeEvent
Gets if reroute route is unknown.
HasUrlParameter<T> - Interface in com.vaadin.flow.router
Defines route parameters for navigation targets for use in routing.
HasUrlParameterFormat - Class in com.vaadin.flow.router.internal
Utility methods to transform urls and parameters from/into the HasUrlParameter format into/from the template format.
HasValidation - Interface in com.vaadin.flow.component
A component that supports input validation.
hasValidValue() - Method in class com.vaadin.flow.component.AbstractSinglePropertyField
Checks whether the element property has a value that can be converted to the model type.
HasValue<E extends HasValue.ValueChangeEvent<V>,V> - Interface in com.vaadin.flow.component
A generic interface for field components and other user interface objects that have a user-editable value.
HasValue.ValueChangeEvent<V> - Interface in com.vaadin.flow.component
An event fired when the value of a HasValue changes.
HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>> - Interface in com.vaadin.flow.component
A listener for value change events.
HasValueAndElement<E extends HasValue.ValueChangeEvent<V>,V> - Interface in com.vaadin.flow.component
A component that has a value.
HEAD - Enum constant in enum class com.vaadin.flow.component.page.TargetElement
 
HEADER - Enum constant in enum class com.vaadin.flow.server.PwaIcon.Domain
 
HEADER - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <header>.
HEADSET_HOOK - Static variable in interface com.vaadin.flow.component.Key
The Headset Hook key.
heartbeat(HeartbeatEvent) - Method in interface com.vaadin.flow.component.HeartbeatListener
Notifies about a heartbeat received for UI.
HEARTBEAT - Enum constant in enum class com.vaadin.flow.server.HandlerHelper.RequestType
Heartbeat requests.
HeartbeatEvent - Class in com.vaadin.flow.component
Event created for an application heartbeat from the client.
HeartbeatEvent(UI, long) - Constructor for class com.vaadin.flow.component.HeartbeatEvent
Constructs a heartbeat Event.
HeartbeatHandler - Class in com.vaadin.flow.server.communication
Handles heartbeat requests.
HeartbeatHandler() - Constructor for class com.vaadin.flow.server.communication.HeartbeatHandler
 
HeartbeatListener - Interface in com.vaadin.flow.component
Listener for listening to the heartbeat of the application.
height() - Element in annotation interface com.vaadin.flow.component.page.BodySize
Definition for body height.
HELP - Static variable in interface com.vaadin.flow.component.Key
The Help key.
HIBERNATE - Static variable in interface com.vaadin.flow.component.Key
The Hibernate key.
HIDDEN - Enum constant in enum class com.vaadin.flow.dom.Style.Overflow
 
HIDDEN - Enum constant in enum class com.vaadin.flow.dom.Style.Visibility
 
highlight(T, boolean) - Method in interface com.vaadin.flow.router.HighlightAction
Performs the highlight action on the target.
HighlightAction<T> - Interface in com.vaadin.flow.router
An action to be performed to set the highlight state of the target.
HighlightActions - Class in com.vaadin.flow.router
A set of predefined HighlightActions.
HighlightCondition<T> - Interface in com.vaadin.flow.router
A condition to meet to determine the highlight state of the target.
HighlightConditions - Class in com.vaadin.flow.router
A set of predefined HighlightConditions.
HIRAGANA - Static variable in interface com.vaadin.flow.component.Key
The Hiragana key.
HIRAGANA_KATAKANA - Static variable in interface com.vaadin.flow.component.Key
Toggles between the Hiragana and Katakana writing systems.
History - Class in com.vaadin.flow.component.page
Represents window.history in the browser.
History(UI) - Constructor for class com.vaadin.flow.component.page.History
Creates a history API endpoint for the given UI.
HISTORY - Enum constant in enum class com.vaadin.flow.router.NavigationTrigger
Navigation was triggered by the user going forward or back in the browser's history.
History.HistoryStateChangeEvent - Class in com.vaadin.flow.component.page
Event fired when the history state has changed.
History.HistoryStateChangeHandler - Interface in com.vaadin.flow.component.page
Handles location change events.
HistoryStateChangeEvent(History, JsonValue, Location, NavigationTrigger) - Constructor for class com.vaadin.flow.component.page.History.HistoryStateChangeEvent
Creates a new event.
HOME - Static variable in interface com.vaadin.flow.component.Key
The Home or key.
host - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Proxy host.
HOTSWAP_AGENT - Enum constant in enum class com.vaadin.flow.internal.BrowserLiveReload.Backend
 
HR - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <hr>.
Html - Class in com.vaadin.flow.component
A component which encapsulates a given HTML fragment with a single root element.
Html(InputStream) - Constructor for class com.vaadin.flow.component.Html
Creates an instance based on the HTML fragment read from the stream.
Html(String) - Constructor for class com.vaadin.flow.component.Html
Creates an instance based on the given HTML fragment.
HtmlComponent - Class in com.vaadin.flow.component
Base class for a Component that represents a single built-in HTML element.
HtmlComponent() - Constructor for class com.vaadin.flow.component.HtmlComponent
Creates a component with the element type based on the Tag annotation of the sub class.
HtmlComponent(String) - Constructor for class com.vaadin.flow.component.HtmlComponent
Creates a component with a new element with the given tag name.
HtmlContainer - Class in com.vaadin.flow.component
Base class for a Component that represents a single built-in HTML element that can contain child components or text.
HtmlContainer() - Constructor for class com.vaadin.flow.component.HtmlContainer
Creates an empty component with the element determined by the Tag annotation of a sub class.
HtmlContainer(Component...) - Constructor for class com.vaadin.flow.component.HtmlContainer
Creates a component with the given child components.
HtmlContainer(String) - Constructor for class com.vaadin.flow.component.HtmlContainer
Creates a new empty component with a new element with the given tag name.
HtmlContainer(String, Component...) - Constructor for class com.vaadin.flow.component.HtmlContainer
Creates a new component with the given contents and a new element with the given tag name.
HtmlUtils - Class in com.vaadin.flow.internal
Helpers for HTML related aspects.
HTTP_VERSION_NOT_SUPPORTED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (505) indicating that the server does not support or refuses to support the HTTP protocol version that was used in the request message.
HTTPS_PROTOCOLS - Static variable in class com.vaadin.flow.server.frontend.installer.DefaultFileDownloader
 
HttpStatusCode - Enum Class in com.vaadin.flow.server
HTTP status codes as defined in RFC 2068.
HYPER - Static variable in interface com.vaadin.flow.component.Key
The Hyper key.

I

I18N_PROVIDER - Static variable in class com.vaadin.flow.server.InitParameters
I18N provider property.
I18NProvider - Interface in com.vaadin.flow.i18n
I18N provider interface for internationalization usage.
iconPath() - Element in annotation interface com.vaadin.flow.server.PWA
Path to the application icon file.
id - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Id of proxy.
id() - Element in annotation interface com.vaadin.flow.component.dependency.CssImport
The 'id' of the new 'dom-module' created.
Id - Annotation Interface in com.vaadin.flow.component.template
Defines the id of a component or an element to map to inside a lit template.
ID - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
Key for id property.
IdCollector - Class in com.vaadin.flow.component.template.internal
Collects information of @Id mapped fields in a template class.
IdCollector(Class<?>, String, Element) - Constructor for class com.vaadin.flow.component.template.internal.IdCollector
Creates a collector the the given template.
identity() - Static method in interface com.vaadin.flow.function.SerializableFunction
Returns a function that always returns its input argument.
identity() - Static method in interface com.vaadin.flow.function.ValueProvider
Returns a value provider that always returns its input argument.
IdMapper - Class in com.vaadin.flow.component.template.internal
Creates or maps Element instances to fields mapped using @Id.
IdMapper(Component) - Constructor for class com.vaadin.flow.component.template.internal.IdMapper
Creates a mapper for the given template.
IFRAME - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <iframe>.
IMG - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <img>.
ImmutableClassList - Class in com.vaadin.flow.dom.impl
Immutable class list implementation.
ImmutableClassList(Collection<String>) - Constructor for class com.vaadin.flow.dom.impl.ImmutableClassList
Creates a new immutable class list with the given values.
ImmutableEmptyStyle - Class in com.vaadin.flow.dom.impl
A style implementation which is empty and immutable.
ImmutableEmptyStyle() - Constructor for class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
importedFileExists(String) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
IMPORTS_D_TS_NAME - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The TypeScript definitions for the FrontendUtils.IMPORTS_NAME file.
IMPORTS_NAME - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Name of the file that contains application imports, javascript, theme and style annotations.
IN_MEMORY_CHILD - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
JsonObject in-memory type value for VirtualChildrenList.
INCH - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing inches.
include() - Element in annotation interface com.vaadin.flow.component.dependency.CssImport
The 'id' of a module to include in the generated 'custom-style'.
includeInitialUidl(VaadinRequest) - Method in interface com.vaadin.flow.server.BootstrapInitialPredicate
Return whether the bootstrap handler has to include initial UIDL in the response.
incrementServerId() - Method in class com.vaadin.flow.component.internal.UIInternals
Increments the server sync id.
INDEX_HTML - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the index.html in client side.
INDEX_JS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the index.js in client side.
INDEX_TS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the index.ts in client side.
INDEX_TSX - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the index.tsx in client side.
IndexHtmlRequestHandler - Class in com.vaadin.flow.server.communication
This class is responsible for serving the index.html according to the template provided in the frontend folder.
IndexHtmlRequestHandler() - Constructor for class com.vaadin.flow.server.communication.IndexHtmlRequestHandler
 
IndexHtmlRequestListener - Interface in com.vaadin.flow.server.communication
This event listener is notified when the Single Page Application's HTML page is about to be generated and sent to the client.
IndexHtmlResponse - Class in com.vaadin.flow.server.communication
This represents the state of a Index HTML response being generated.
IndexHtmlResponse(VaadinRequest, VaadinResponse, Document) - Constructor for class com.vaadin.flow.server.communication.IndexHtmlResponse
Create a response object for client side bootstrapping.
IndexHtmlResponse(VaadinRequest, VaadinResponse, Document, UI) - Constructor for class com.vaadin.flow.server.communication.IndexHtmlResponse
Create a response object for client side bootstrapping with UI.
indexOf(Component) - Method in interface com.vaadin.flow.component.HasOrderedComponents
Returns the index of the given component.
indexOf(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
indexOf(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
indexOf(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 
indexOf(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Gets the position of a value in the list.
indexOfChild(Element) - Method in class com.vaadin.flow.dom.Node
Returns the index of the specified child in the children list, or -1 if this list does not contain the child.
INERT_DATA - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
Id for InertData.
InertData - Class in com.vaadin.flow.internal.nodefeature
Server-side feature defining whether a node is inert, and if it should ignore inheriting inert state from parent.
InertData(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.InertData
Creates a new feature for the given node.
INFO - Static variable in interface com.vaadin.flow.component.Key
Toggles the display of information about the currently selected content, program, or media.
informLocaleChangeObservers(UI) - Static method in class com.vaadin.flow.router.EventUtil
Inform components connected to the given ui that implement LocaleChangeObserver about locale change.
informLocaleChangeObservers(UI, List<HasElement>) - Static method in class com.vaadin.flow.router.EventUtil
Inform components implementing LocaleChangeObserver about locale change.
INHERIT - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
Inherits this property from its parent element.
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.BoxSizing
 
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.Clear
 
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.FloatCss
 
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.Overflow
 
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.TextAlign
 
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.Visibility
 
INHERIT - Enum constant in enum class com.vaadin.flow.dom.Style.WhiteSpace
 
init() - Method in class com.vaadin.flow.server.VaadinService
Initializes this service.
init(VaadinRequest) - Method in class com.vaadin.flow.component.UI
Initializes this UI.
init(ServletConfig) - Method in class com.vaadin.flow.server.VaadinServlet
Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
init(ServletContext) - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
Initializes Atmosphere for use with Vaadin servlets found in the given context.
init(Set<Class<?>>, VaadinContext) - Static method in class com.vaadin.flow.server.startup.VaadinAppShellInitializer
Initializes the AppShellRegistry for the application.
INIT - Enum constant in enum class com.vaadin.flow.server.HandlerHelper.RequestType
INIT requests.
initAtmosphereForVaadinServlet(ServletRegistration, ServletContext) - Static method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
Initializes Atmosphere for use with the given Vaadin servlet
initContent() - Method in class com.vaadin.flow.component.Composite
Called when the content of this composite is requested for the first time.
initDevModeHandler(Set<Class<?>>, VaadinContext) - Method in interface com.vaadin.flow.internal.DevModeHandlerManager
Starts up a new DevModeHandler.
INITIAL - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
Sets this property to its default value.
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.BoxSizing
 
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.Clear
 
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.FloatCss
 
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.Overflow
 
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.TextAlign
 
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.Visibility
 
INITIAL - Enum constant in enum class com.vaadin.flow.dom.Style.WhiteSpace
 
initialize(VaadinContext) - Method in interface com.vaadin.flow.internal.VaadinContextInitializer
Initializes the Vaadin context.
initialize(VaadinContext, Map<Class<?>, Collection<Class<?>>>, VaadinApplicationInitializationBootstrap) - Method in interface com.vaadin.flow.di.AbstractLookupInitializer
Creates a new Lookup instance, initializes it and passes it to the provided bootstrap.
initialize(VaadinContext, Map<Class<?>, Collection<Class<?>>>, VaadinApplicationInitializationBootstrap) - Method in class com.vaadin.flow.di.LookupInitializer
 
initialize(Set<Class<?>>, VaadinContext) - Method in class com.vaadin.flow.server.startup.AnnotationValidator
 
initialize(Set<Class<?>>, VaadinContext) - Method in class com.vaadin.flow.server.startup.ErrorNavigationTargetInitializer
 
initialize(Set<Class<?>>, VaadinContext) - Method in class com.vaadin.flow.server.startup.RouteRegistryInitializer
 
initialize(Set<Class<?>>, VaadinContext) - Method in class com.vaadin.flow.server.startup.VaadinAppShellInitializer
 
initialize(Set<Class<?>>, VaadinContext) - Method in interface com.vaadin.flow.server.startup.VaadinContextStartupInitializer
Applies this initializer to the given context
initialize(Set<Class<?>>, VaadinContext) - Method in class com.vaadin.flow.server.startup.WebComponentConfigurationRegistryInitializer
 
initialize(Set<Class<?>>, VaadinContext) - Method in class com.vaadin.flow.server.startup.WebComponentExporterAwareValidator
 
initializeUI(UI, Location) - Method in class com.vaadin.flow.router.Router
Enables navigation for a new UI instance.
initializeUIWithRouter(BootstrapHandler.BootstrapContext, UI) - Method in class com.vaadin.flow.server.BootstrapHandler
 
initializeUIWithRouter(BootstrapHandler.BootstrapContext, UI) - Method in class com.vaadin.flow.server.communication.IndexHtmlRequestHandler
 
initializeUIWithRouter(BootstrapHandler.BootstrapContext, UI) - Method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
 
InitParameters - Class in com.vaadin.flow.server
Constants for all servlet init parameters.
InitParameters() - Constructor for class com.vaadin.flow.server.InitParameters
 
INJECT_BY_ID - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
JsonObject @id type value for VirtualChildrenList.
InjectableFieldConsumer - Interface in com.vaadin.flow.component.template.internal
Three argument consumer.
Inline - Annotation Interface in com.vaadin.flow.component.page
Defines files to inline into the initial page.
INLINE - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
INLINE - Enum constant in enum class com.vaadin.flow.shared.ui.LoadMode
Forced the dependency to be inlined in the body of the html page, removing the requirement to have additional roundtrips to fetch the script.
INLINE_BLOCK - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
INLINE_FLEX - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
INLINE_GRID - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
INLINE_TABLE - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
Inline.Container - Annotation Interface in com.vaadin.flow.component.page
Internal annotation to enable use of multiple Inline annotations.
Inline.Position - Enum Class in com.vaadin.flow.component.page
Inline position enum.
Inline.Wrapping - Enum Class in com.vaadin.flow.component.page
File content wrapping enum.
inlineImports(File, File) - Static method in class com.vaadin.flow.server.frontend.CssBundler
 
InlineTargets - Class in com.vaadin.flow.server
Data holder class for collected Inline annotations to be added to the initial page.
InlineTargets() - Constructor for class com.vaadin.flow.server.InlineTargets
 
inMemoryCollection() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
INPUT - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <input>.
InputEvent - Class in com.vaadin.flow.component
Event fired when the component has received any type of input (e.g.
InputEvent(Component, boolean) - Constructor for class com.vaadin.flow.component.InputEvent
Creates a new input event.
InputNotifier - Interface in com.vaadin.flow.component
Mixin interface for components that support adding input listeners to the their root elements.
InputStreamFactory - Interface in com.vaadin.flow.server
Creates input stream instances that provides the actual data of a StreamResource.
INSERT - Static variable in interface com.vaadin.flow.component.Key
The Insert key, Ins.
insertChild(int, Element...) - Method in class com.vaadin.flow.dom.Node
Inserts the given child element(s) at the given position.
insertChild(int, Collection<Element>) - Method in class com.vaadin.flow.dom.Node
Inserts the given child element(s) at the given position.
insertChild(StateNode, int, Element) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Inserts the given child at the given position.
insertChild(StateNode, int, Element) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
insertChild(StateNode, int, Element) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
inspectHierarchy(Element, Collection<Element>, Predicate<Element>) - Static method in class com.vaadin.flow.router.EventUtil
Collect all children for given node as a Element stream.
install() - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
Install node and npm.
INSTALL_NODE_LOCALLY - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
 
INSTALL_PATH - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
 
InstallationException - Exception in com.vaadin.flow.server.frontend.installer
Exception indicating a failure during installation of node and npm.
InstallationException(String) - Constructor for exception com.vaadin.flow.server.frontend.installer.InstallationException
Exception with message.
InstallationException(String, Throwable) - Constructor for exception com.vaadin.flow.server.frontend.installer.InstallationException
Exceptioon with message and cause.
installNode(String, URI) - Method in class com.vaadin.flow.server.frontend.FrontendTools
Install node and npm.
INSTANT_REPLAY - Static variable in interface com.vaadin.flow.component.Key
Tells the device to perform an instant replay (typically some form of jumping back a short amount of time then playing it again, possibly but not usually in slow motion).
instantiate(Class<T>, Class<?>) - Method in class com.vaadin.flow.di.LookupInitializer
Instantiates service implementation type with the given serviceClass .
Instantiator - Interface in com.vaadin.flow.di
Delegate for discovering, creating and managing instances of various types used by Flow.
InstantiatorFactory - Interface in com.vaadin.flow.di
A factory for an Instantiator.
INTEGER - Static variable in class com.vaadin.flow.router.RouteParameterRegex
Integer type regex.
INTERMEDIATE - Enum constant in enum class com.vaadin.flow.dom.DebouncePhase
Debounce phase for events that are periodically sent to the server while events are being fired in rapid succession.
INTERNAL - Enum constant in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
 
INTERNAL_SERVER_ERROR - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request.
INTERNAL_VAADIN_SERVLET_VITE_DEV_MODE_FRONTEND_PATH - Static variable in class com.vaadin.flow.server.VaadinServlet
 
internalErrorCaption - Variable in class com.vaadin.flow.server.SystemMessages
 
internalErrorMessage - Variable in class com.vaadin.flow.server.SystemMessages
 
internalErrorNotificationEnabled - Variable in class com.vaadin.flow.server.SystemMessages
 
internalErrorURL - Variable in class com.vaadin.flow.server.SystemMessages
 
InternalRedirectHandler - Class in com.vaadin.flow.router.internal
Handles navigation by redirecting the user to some location in the application.
InternalRedirectHandler(Location) - Constructor for class com.vaadin.flow.router.internal.InternalRedirectHandler
Creates a new redirect handler for the provided location.
InternalServerError - Class in com.vaadin.flow.router
This is a basic default error view shown on exceptions during navigation.
InternalServerError() - Constructor for class com.vaadin.flow.router.InternalServerError
 
intersects(Range) - Method in class com.vaadin.flow.internal.Range
Checks whether this range and another range are at least partially covering the same values.
INTL_BACKSLASH - Static variable in interface com.vaadin.flow.component.Key
Located between the left Shift and Z keys.Labelled \| on a UK keyboard.
INTL_RO - Static variable in interface com.vaadin.flow.component.Key
Located between the / and right Shift keys.Labelled \ろ ( ro ) on a Japanese keyboard.
INTL_YEN - Static variable in interface com.vaadin.flow.component.Key
Located between the = and Backspace keys.Labelled ¥ ( yen ) on a Japanese keyboard.
INVALID_ATMOSPHERE_VERSION_WARNING - Static variable in class com.vaadin.flow.server.VaadinService
 
InvalidApplicationConfigurationException - Exception in com.vaadin.flow.server
Exception indicating that the application's routes have been configured incorrectly.
InvalidApplicationConfigurationException(String) - Constructor for exception com.vaadin.flow.server.InvalidApplicationConfigurationException
Constructs a new invalid route configuration runtime exception with the specified detail message.
invalidate() - Method in class com.vaadin.flow.server.WrappedHttpSession
 
invalidate() - Method in interface com.vaadin.flow.server.WrappedSession
Invalidates this session then unbinds any objects bound to it.
InvalidCustomElementNameException - Exception in com.vaadin.flow.server
Exception indicating that the custom-element name is invalid.
InvalidCustomElementNameException(String) - Constructor for exception com.vaadin.flow.server.InvalidCustomElementNameException
Constructs a new invalid custom element name runtime exception with the specified detail message.
InvalidI18NConfigurationException - Exception in com.vaadin.flow.server
Exception indicating that the application's I18N localization has been configured incorrectly.
InvalidI18NConfigurationException(String) - Constructor for exception com.vaadin.flow.server.InvalidI18NConfigurationException
Constructs a new invalid I18N localization configuration runtime exception with the specified detail message.
InvalidI18NConfigurationException(String, Throwable) - Constructor for exception com.vaadin.flow.server.InvalidI18NConfigurationException
Constructs a new invalid I18N localization configuration runtime exception with the specified detail message.
InvalidLocationException - Exception in com.vaadin.flow.router
Thrown to indicate that a Location instance is invalid.
InvalidLocationException(String) - Constructor for exception com.vaadin.flow.router.InvalidLocationException
Creates a new exception with the specified detail message.
InvalidLocationException(String, Throwable) - Constructor for exception com.vaadin.flow.router.InvalidLocationException
Constructs a new runtime exception with the specified detail message and cause.
InvalidRouteConfigurationException - Exception in com.vaadin.flow.server
Exception indicating that the application's routes have been configured incorrectly.
InvalidRouteConfigurationException(String) - Constructor for exception com.vaadin.flow.server.InvalidRouteConfigurationException
Constructs a new invalid route configuration runtime exception with the specified detail message.
InvalidRouteLayoutConfigurationException - Exception in com.vaadin.flow.server
Exception indicating that Route layouts configuration has problems.
InvalidRouteLayoutConfigurationException(String) - Constructor for exception com.vaadin.flow.server.InvalidRouteLayoutConfigurationException
Constructs a new invalid Route parent layout configuration runtime exception with the specified detail message.
InvalidUIDLSecurityKeyException() - Constructor for exception com.vaadin.flow.server.communication.ServerRpcHandler.InvalidUIDLSecurityKeyException
Default constructor for the exception.
invoke(JsonArray) - Method in interface com.vaadin.flow.internal.nodefeature.ReturnChannelRegistration
Invokes the channel handler with the give arguments.
IOS - Enum constant in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
 
isAltKey() - Method in class com.vaadin.flow.component.ClickEvent
Checks whether the alt key was was down when the event was fired.
isAndroid() - Method in class com.vaadin.flow.server.WebBrowser
Tests if the browser is run on Android.
isAndroid() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run on Android.
isAnnotatedParameter(Class<?>, Class<? extends Annotation>) - Static method in class com.vaadin.flow.router.ParameterDeserializer
Check if the parameter value is annotated as OptionalParameter.
isAnonymousEndpoint(HttpServletRequest) - Method in interface com.vaadin.flow.internal.hilla.EndpointRequestUtil
Checks if the given request goes to an anonymous (public) endpoint.
isApplicable(JsonValue, Class<?>) - Method in class com.vaadin.flow.server.communication.rpc.DefaultRpcDecoder
 
isApplicable(JsonValue, Class<?>) - Method in interface com.vaadin.flow.server.communication.rpc.RpcDecoder
Returns true if the decoder is applicable for the given value and the required type.
isApplicable(JsonValue, Class<?>) - Method in class com.vaadin.flow.server.communication.rpc.StringToEnumDecoder
 
isApplicable(JsonValue, Class<?>) - Method in class com.vaadin.flow.server.communication.rpc.StringToNumberDecoder
 
isApplyDefaultTheme() - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Returns whether the default theming is applied for the loading indicator, making it visible for users.
isApplyDefaultTheme() - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
isAtmosphereAvailable() - Static method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
Checks if Atmosphere is available on the classpath.
isAtmosphereAvailable() - Method in class com.vaadin.flow.server.VaadinService
Checks whether Atmosphere is available for use.
isAttached() - Method in class com.vaadin.flow.component.Component
Checks whether this component is currently attached to a UI.
isAttached() - Method in class com.vaadin.flow.internal.StateNode
Checks whether this node is attached to a state tree.
isAutoUpdate() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Check if automatic updates are enabled.
isBrotli() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Checks whether precompressed Brotli files should be used if available.
isBrowserDefaultAllowed() - Method in class com.vaadin.flow.component.ShortcutRegistration
Checks if the default key behaviour in the browser is allowed by the shortcut.
isBubbles() - Method in class com.vaadin.flow.component.webcomponent.EventOptions
Can the event bubbles up through the DOM or not.
isBundleBuild() - Method in class com.vaadin.flow.server.frontend.Options
Check if a bundle build should run.
isCacheEnabled() - Method in class com.vaadin.flow.server.communication.WebComponentProvider
Whether bootstrap HTML fragment are cached based on component tag.
isCancelable() - Method in class com.vaadin.flow.component.webcomponent.EventOptions
Is the event is cancelable.
isCanceled() - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
Checks whether this invocation has been canceled.
isCheckedException(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Checks if the given exception class represents a checked exception.
isChrome() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Chrome.
isChrome() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is Chrome.
isChromeOS() - Method in class com.vaadin.flow.server.WebBrowser
Tests if the browser is run on ChromeOS (e.g.
isChromeOS() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run on Chrome OS (e.g.
isCiBuild() - Method in class com.vaadin.flow.server.frontend.Options
 
isCleanNpmFiles() - Method in class com.vaadin.flow.server.frontend.Options
 
isClientSideInitialized() - Method in class com.vaadin.flow.internal.ExecutionContext
Gets whether the client side is being initialized as part of the server response.
isCloseIdleSessions() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns whether a Vaadin session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time.
isCloseIdleSessions() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns whether a Vaadin session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time.
isCloseIdleSessions() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isClosing() - Method in class com.vaadin.flow.component.UI
Returns whether this UI is marked as closed and is to be detached.
isComposed() - Method in class com.vaadin.flow.component.webcomponent.EventOptions
Can the event bubble across the boundary between the shadow DOM and the regular DOM.
isComposing() - Method in class com.vaadin.flow.component.internal.KeyboardEvent
Checks whether the key event occurred as part of a composition session.
isCompositeContent(Composite<?>, Component) - Static method in class com.vaadin.flow.component.ComponentUtil
Checks if the given component is inside a Composite chain, i.e.
isConnected() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
 
isConnected() - Method in interface com.vaadin.flow.server.communication.PushConnection
Returns whether this connection is currently open.
isCookiesDisabledNotificationEnabled() - Method in class com.vaadin.flow.server.SystemMessages
Checks if "cookies disabled" notifications should be shown to the end user.
isCopyTemplates() - Method in class com.vaadin.flow.server.frontend.Options
 
isCreateMissingPackageJson() - Method in class com.vaadin.flow.server.frontend.Options
 
isCsrfTokenValid(UI, String) - Static method in class com.vaadin.flow.server.VaadinService
Verifies that the given CSRF token (synchronizer token pattern) is valid for the given UI.
isCtrlKey() - Method in class com.vaadin.flow.component.ClickEvent
Checks whether the ctrl key was was down when the event was fired.
isCustomElement(Element) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks whether the given element is a custom element or not.
isCustomElementName(String) - Static method in class com.vaadin.flow.internal.CustomElementNameValidator
Validate that given name is a valid Custom Element name.
isDevBundleBuild() - Method in class com.vaadin.flow.server.frontend.Options
Check if a dev mode bundle build should run.
isDevModeLiveReloadEnabled() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Checks if dev mode live reload is enabled or not.
isDevModeLiveReloadEnabled() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isDevModeSessionSerializationEnabled() - Method in interface com.vaadin.flow.server.startup.ApplicationConfiguration
Checks if development mode session serialization is enabled or not.
isDevModeSessionSerializationEnabled() - Method in class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl
 
isDevToolsEnabled() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Checks if dev tools are enabled or not.
isDevToolsEnabled() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isDirty() - Method in class com.vaadin.flow.component.internal.UIInternals
Checks if there are changes waiting to be sent to the client side.
isDirty() - Method in class com.vaadin.flow.internal.StateTree
Checks if there are changes waiting to be sent to the client side.
isDisposed() - Method in class com.vaadin.flow.server.communication.streaming.StreamingStartEventImpl
Get if stream resource should be unregistered.
isDomEventConstructor(Constructor<?>) - Static method in class com.vaadin.flow.component.ComponentEventBusUtil
Checks if the given constructor can be used when firing a ComponentEvent based on a DomEvent.
isDSTInEffect() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Returns whether daylight saving time (DST) is currently in effect in the region of the browser or not.
isEager() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
 
isEager() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
 
isEagerServerLoad() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Get if the bootstrap page should include the initial UIDL fragment.
isEdge() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Edge.
isEdge() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is Edge.
isEmpty() - Method in class com.vaadin.flow.component.AbstractCompositeField
 
isEmpty() - Method in class com.vaadin.flow.component.AbstractField
 
isEmpty() - Method in interface com.vaadin.flow.component.HasValue
Returns whether this HasValue is considered to be empty.
isEmpty() - Method in class com.vaadin.flow.component.internal.ComponentMetaData.DependencyInfo
 
isEmpty() - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
isEmpty() - Method in class com.vaadin.flow.internal.change.ListAddChange
Returns whether this add operation still contains any new items.
isEmpty() - Method in class com.vaadin.flow.internal.Range
Checks whether the range has no elements between the start and end.
isEmpty() - Method in class com.vaadin.flow.server.Attributes
Returns true if there are no attributes.
isEmpty() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
Check if no proxies have been defined.
isEnabled() - Method in class com.vaadin.experimental.Feature
 
isEnabled() - Method in interface com.vaadin.flow.component.HasEnabled
Returns whether the object is enabled or disabled.
isEnabled() - Method in class com.vaadin.flow.dom.Element
Get the enabled state of the element.
isEnabled() - Method in class com.vaadin.flow.internal.StateNode
Returns enabled state respecting ascendants state.
isEnabled() - Method in class com.vaadin.flow.server.PwaConfiguration
Is PWA enabled.
isEnabled() - Method in enum class com.vaadin.flow.shared.communication.PushMode
Checks whether the push mode is using push functionality
isEnabled(Feature) - Method in class com.vaadin.experimental.FeatureFlags
Checks if the given feature is enabled.
isEnabled(String) - Method in class com.vaadin.experimental.FeatureFlags
Checks if the given feature is enabled.
isEnabledSelf() - Method in class com.vaadin.flow.internal.StateNode
Returns the enabled state only for this node.
isEnableImportsUpdate() - Method in class com.vaadin.flow.server.frontend.Options
 
isEnablePackagesUpdate() - Method in class com.vaadin.flow.server.frontend.Options
 
isEnablePnpm() - Method in class com.vaadin.flow.server.frontend.Options
 
isEnableWebpackConfigUpdate() - Method in class com.vaadin.flow.server.frontend.Options
 
isEndpointRequest(HttpServletRequest) - Method in interface com.vaadin.flow.internal.hilla.EndpointRequestUtil
Checks if the request is for an endpoint.
isEqualTo(FrontendVersion) - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Check if this and the given version are equal to each other.
isEventPropagationAllowed() - Method in class com.vaadin.flow.component.ShortcutRegistration
Checks if the shortcut allows keydown event (associated with the shortcut) propagation in the browser.
isExperimental(String) - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
 
isExternal(String) - Static method in class com.vaadin.flow.internal.UrlUtil
checks if the given url is an external URL (e.g.
isFirefox() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Firefox.
isFirefox() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is Firefox.
isForceAlternativeNode() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Check if alternative node usage should be forced.
isForceProductionBuild() - Method in class com.vaadin.flow.server.frontend.Options
 
isForwardTo() - Method in class com.vaadin.flow.router.NavigationEvent
isFrameworkInternalRequest(VaadinRequest) - Static method in class com.vaadin.flow.server.BootstrapHandler
Checks whether the request is an internal request.
isFrameworkInternalRequest(String, HttpServletRequest) - Static method in class com.vaadin.flow.server.HandlerHelper
Checks whether the request is an internal request.
isFreePort(int) - Static method in class com.vaadin.flow.internal.NetworkUtil
Checks if the given port is free.
isFromClient() - Method in class com.vaadin.flow.component.ComponentEvent
Checks if this event originated from the client side.
isFromClient() - Method in interface com.vaadin.flow.component.HasValue.ValueChangeEvent
Checks if this event originated from the client side.
isFrontendHotdeploy() - Method in class com.vaadin.flow.server.frontend.Options
Checks if running with a dev server (when not in production mode).
isGecko() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is using the Gecko engine.
isGenerateEmbeddableWebComponents() - Method in class com.vaadin.flow.server.frontend.Options
 
isGetter(Method) - Static method in class com.vaadin.flow.internal.ReflectTools
Checks whether the given method is a valid getter according to JavaBeans Specification.
isGetterName(String, boolean) - Static method in class com.vaadin.flow.internal.ReflectTools
Checks whether the given method name is a valid getter name according to the JavaBeans Specification.
isGlobalPnpm() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Returns whether globally installed pnpm is used or the default one (see FrontendTools.DEFAULT_PNPM_VERSION).
isGlobalPnpm() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isHillaAvailable() - Static method in interface com.vaadin.flow.internal.hilla.EndpointRequestUtil
Checks if Hilla is available.
isIE() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Internet Explorer.
isIE() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is Internet Explorer.
isIgnoreParentInert() - Method in class com.vaadin.flow.internal.nodefeature.InertData
Gets whether the inertness setting of ancestor nodes should be ignored.
isIgnoreVersionChecks() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Check if version checks should be ignored.
isInactive() - Method in class com.vaadin.flow.internal.StateNode
Checks whether the node is active.
isInert() - Method in class com.vaadin.flow.internal.nodefeature.InertData
Returns whether this node is explicitly inert and if not, then checks parents for the same.
isInert() - Method in class com.vaadin.flow.internal.StateNode
Returns whether or not this state node is inert and it should not receive any updates from the client side.
isInertSelf() - Method in class com.vaadin.flow.internal.nodefeature.InertData
Gets whether the node itself has been set to be inert (regardless of its ancestors' inert setting).
isInitialAttach() - Method in class com.vaadin.flow.component.AttachEvent
Checks whether this is the first time the component has been attached.
isInitTheme() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Should custom theme be initialized.
isInstantiableService(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Check if a class can be instantiated via its default constructor via reflection.
isInternalErrorNotificationEnabled() - Method in class com.vaadin.flow.server.SystemMessages
Checks if "internal error" notifications should be shown to the end user.
isInterrupted() - Method in interface com.vaadin.flow.server.StreamVariable
If this method returns true while the content is being streamed the handler is told to stop receiving the current upload.
isInvalid() - Method in interface com.vaadin.flow.component.HasValidation
Returns true if component input is invalid, false otherwise.
isIOS() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Check if the browser is run on IOS.
isIPad() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Check if the browser is run on IPad.
isIPhone() - Method in class com.vaadin.flow.server.WebBrowser
Tests if the browser is run on IPhone.
isIPhone() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run on iPhone.
isLinux() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Check if platform is linux.
isLinux() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Linux.
isLinux() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run on Linux.
isLiveReload(AtmosphereResource) - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Returns whether the passed connection is a browser live-reload connection.
isMac() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Check if platform is mac.
isMacOSX() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Mac OS X.
isMacOSX() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run on Mac OSX.
isMapped(String) - Method in class com.vaadin.flow.component.template.internal.IdMapper
Checks if the given id has been mapped.
isMetaKey() - Method in class com.vaadin.flow.component.ClickEvent
Checks whether the meta key was was down when the event was fired.
isModifier(Key) - Static method in interface com.vaadin.flow.component.Key
Returns whether the specified key is a modifier or not.
isMultipartUpload(VaadinRequest) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
 
isNavigationSupported() - Method in class com.vaadin.flow.component.UI
Returns true if this UI instance supports navigation.
isNavigationSupported() - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI
 
isNew() - Method in class com.vaadin.flow.server.WrappedHttpSession
 
isNew() - Method in interface com.vaadin.flow.server.WrappedSession
Returns true if the client does not yet know about the session or if the client chooses not to join the session.
isNewerThan(FrontendVersion) - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Check if this version is newer than given version.
isNodeAutoUpdate() - Method in class com.vaadin.flow.server.frontend.Options
 
isNodeValues() - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Checks whether this list contains node values.
isNodeValues() - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
isNonProxyHost(String) - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Check if given host is excluded for proxy.
isNotObjectMethod(Method) - Static method in class com.vaadin.flow.internal.ReflectTools
Returns whether the given method is NOT declared in Object .
isOfflineEnabled() - Method in class com.vaadin.flow.server.PwaConfiguration
Is offline enabled.
isOfflinePathEnabled() - Method in class com.vaadin.flow.server.PwaConfiguration
Is static offline HTML used for offline mode.
isOlderThan(FrontendVersion) - Method in class com.vaadin.flow.server.frontend.FrontendVersion
Check if this version is older than given version.
isOpera() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Opera.
isOpera() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is Opera.
isOtherSessionLocked(VaadinSession) - Static method in class com.vaadin.flow.server.VaadinService
Checks whether there might be some VaadinSession other than the provided one for which the current thread holds a lock.
isOwnProperty(String) - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
Checks whether the given property is the property explicitly set in this deployment configuration (not in it's parent config).
isPathAdded(String) - Method in class com.vaadin.flow.router.RoutesChangedEvent
Determines if a route url was added for this change.
isPathAvailable(String) - Method in class com.vaadin.flow.router.RouteConfiguration
Check if the given path is available.
isPathRemoved(String) - Method in class com.vaadin.flow.router.RoutesChangedEvent
Determines if a route url was removed for this change.
isPathUnsafe(String) - Static method in class com.vaadin.flow.server.HandlerHelper
Checks if the given URL path contains the directory change instruction (dot-dot), taking into account possible double encoding in hexadecimal format, which can be injected maliciously.
isPnpmEnabled() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Returns whether pnpm is enabled or not.
isPnpmEnabled() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isPostponed() - Method in class com.vaadin.flow.router.BeforeLeaveEvent
Checks whether this event was postponed.
isPreCompiledProductionBundle() - Static method in class com.vaadin.flow.server.frontend.BundleUtils
Returns whether the application uses pre-compiled production bundle or a custom bundle.
isPresto() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is using the Presto engine.
isProbablyTemporaryFile(File) - Static method in class com.vaadin.flow.server.frontend.FileIOUtils
Checks if the given file is likely a temporary file created by an editor.
isProduction() - Method in enum class com.vaadin.flow.server.Mode
 
isProductionMode() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Returns whether Vaadin is in production mode.
isProductionMode() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Checks if the application is running in production mode.
isProductionMode() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns whether Vaadin is in production mode.
isProductionMode() - Method in class com.vaadin.flow.server.frontend.Options
Gets the production mode.
isProductionMode() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isProductionMode() - Method in class com.vaadin.flow.server.startup.DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl
 
isReadOnly() - Method in interface com.vaadin.flow.component.HasValue
Returns whether this HasValue is in read-only mode or not.
isReadOnly() - Method in interface com.vaadin.flow.component.HasValueAndElement
 
isReadOnly() - Method in class com.vaadin.flow.server.webcomponent.PropertyData
Checks if the property is a read-only value.
isRefreshEvent() - Method in class com.vaadin.flow.router.AfterNavigationEvent
Check if event is for a refresh of a preserveOnRefresh view.
isRefreshEvent() - Method in class com.vaadin.flow.router.BeforeEnterEvent
Check if event is for a refresh of a preserveOnRefresh view.
isRepeat() - Method in class com.vaadin.flow.component.internal.KeyboardEvent
Checks whether the key has been pressed in a sustained manner.
isReportedFeature(Class<? extends NodeFeature>) - Method in class com.vaadin.flow.internal.StateNode
Returns whether the featureType should be reported to the client even if it doesn't contain any data.
isRequestForHtml(VaadinRequest) - Method in class com.vaadin.flow.server.BootstrapHandler
Checks if the request is potentially a request for an HTML page.
isRequestTiming() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns whether the server provides timing info to the client.
isRequestTiming() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns whether the server provides timing info to the client.
isRequestTiming() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isRequestType(VaadinRequest, HandlerHelper.RequestType) - Static method in class com.vaadin.flow.server.HandlerHelper
Returns whether the given request is of the given type.
isRequiredIndicatorVisible() - Method in interface com.vaadin.flow.component.HasValue
Checks whether the required indicator is visible.
isRequiredIndicatorVisible() - Method in interface com.vaadin.flow.component.HasValueAndElement
 
isRequireHomeNodeExec() - Method in class com.vaadin.flow.server.frontend.Options
 
isRequiresServerRestart() - Method in class com.vaadin.experimental.Feature
 
isResourceAvailable(String) - Method in class com.vaadin.flow.server.VaadinService
Checks if a resource is available at the given Vaadin URI.
isResynchronize() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Checks if this is a request to resynchronize the client side.
isRouteAdded(Class<? extends Component>) - Method in class com.vaadin.flow.router.RoutesChangedEvent
Determines if a given route navigation target was added for this change.
isRouteRegistered(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Check if the route is available as a registered target.
isRouteRemoved(Class<? extends Component>) - Method in class com.vaadin.flow.router.RoutesChangedEvent
Determines if a given route navigation target was removed for this change.
isRunNpmInstall() - Method in class com.vaadin.flow.server.frontend.Options
 
isSafari() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Safari.
isSafari() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is Safari.
isScript(Element) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks whether the given element is a script or not.
isSecure() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Check if the proxy is secure.
isSecure() - Method in interface com.vaadin.flow.server.VaadinRequest
Checks whether the request was made using a secure channel, e.g.
isSecureConnection() - Method in class com.vaadin.flow.server.WebBrowser
Checks if the connection was established using HTTPS.
isSendUrlsAsParameters() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns whether the sending of URL's as GET and POST parameters in requests with content-type application/x-www-form-urlencoded is enabled or not.
isSendUrlsAsParameters() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns whether the sending of URL's as GET and POST parameters in requests with content-type application/x-www-form-urlencoded is enabled or not.
isSendUrlsAsParameters() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isSentToBrowser() - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
 
isSentToBrowser() - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Checks whether the JavaScript execution has already been sent to the browser.
isSessionExpiredNotificationEnabled() - Method in class com.vaadin.flow.server.SystemMessages
Checks if "session expired" notifications should be shown to the end user.
isSetter(Method) - Static method in class com.vaadin.flow.internal.ReflectTools
Checks whether the given method is a valid setter according to the JavaBeans Specification.
isSetterName(String) - Static method in class com.vaadin.flow.internal.ReflectTools
Checks whether the given method name is a valid setter name according to the JavaBeans Specification.
isShadowRoot(StateNode) - Static method in class com.vaadin.flow.dom.ShadowRoot
Checks whether the given node is a shadow root node.
isShell(Class<?>) - Method in class com.vaadin.flow.di.LookupInitializer.AppShellPredicateImpl
 
isShell(Class<?>) - Method in interface com.vaadin.flow.server.startup.AppShellPredicate
Checks whether the class is an AppShellConfigurator class inside the web application.
isShiftKey() - Method in class com.vaadin.flow.component.ClickEvent
Checks whether the shift key was was down when the event was fired.
isShortcutActive() - Method in class com.vaadin.flow.component.ShortcutRegistration
Is the shortcut active on the current UI.
isSkipDevBundle() - Method in class com.vaadin.flow.server.frontend.Options
Is dev bundle build skipped or not.
isStaticAttribute(String, String) - Method in class com.vaadin.flow.component.template.internal.AbstractInjectableElementInitializer
Checks whether the attribute declaration is an attribute with a static value ( so it can be set on the serve side).
isStatsExternal() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Get if the stats.json file should be retrieved from an external service or through the classpath.
isSubscribed() - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
Checks if there are any subscribers for the return value of this expression.
isSubsetOf(Range) - Method in class com.vaadin.flow.internal.Range
Checks whether this range is a subset of another range.
isSyncIdCheckEnabled() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns whether sync id checking is enabled.
isSyncIdCheckEnabled() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns whether sync id checking is enabled.
isSyncIdCheckEnabled() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isTemplateMapped() - Method in class com.vaadin.flow.component.Component
Gets whether this component was attached as part of a template (by being mapped by an Id annotation), or if it was created directly.
isTemplateModelValue(Component, JsonValue, Class<?>) - Method in interface com.vaadin.flow.component.template.internal.DeprecatedPolymerPublishedEventHandler
Deprecated.
Validate that the given Component instance is a PolymerTemplate and that the value can be converted.
isTextNode() - Method in class com.vaadin.flow.dom.Element
Checks whether this element represents a text node.
isTextNode(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Checks if the state node represents a text node.
isTextNode(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
isTextNode(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
isTextNode(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
isTooOldToFunctionProperly() - Method in class com.vaadin.flow.shared.BrowserDetails
Checks if the browser is so old that it simply won't work.
isTouchDevice() - Method in class com.vaadin.flow.component.page.ExtendedClientDetails
Checks if the browser supports touch events.
isTrident() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is using the Trident engine.
isTrueish(Object) - Static method in class com.vaadin.flow.internal.JavaScriptSemantics
Gets the boolean value of the provided value: null is false.
isUIActive(UI) - Method in class com.vaadin.flow.server.VaadinService
Returns whether the given UI is active (the client-side actively communicates with the server) or whether it can be removed from the session and eventually collected.
isUsageStatisticsEnabled() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Returns whether development time usage statistics collection is enabled or not.
isUsageStatisticsEnabled() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
isUseByteCodeScanner() - Method in class com.vaadin.flow.server.frontend.Options
 
isUseGlobalPnpm() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Check if global pnpm should be used.
isUseGlobalPnpm() - Method in class com.vaadin.flow.server.frontend.Options
 
isUserInRole(String) - Method in interface com.vaadin.flow.server.VaadinRequest
Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
isUserOriginated() - Method in class com.vaadin.flow.dom.PropertyChangeEvent
Returns whether this event was triggered by user interaction, on the client side, or programmatically, on the server side.
isVaadinServlet(ServletRegistration, ServletContext) - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
Tries to determine if the given servlet registration refers to a Vaadin servlet.
isVaadinStaticFileRequest(VaadinRequest) - Static method in class com.vaadin.flow.server.BootstrapHandler
Checks whether the request is a request for /VAADIN/*.
isValidAttributeName(String) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks if the given attribute name is valid.
isValidStatusCode(int) - Static method in enum class com.vaadin.flow.server.HttpStatusCode
Checks if the given status code is valid.
isValidStylePropertyName(String) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks if the given style property name is valid.
isValidStylePropertyValue(String) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks if the given style property value is valid.
isValidTagName(String) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks if the given tag name is valid.
isValidUrl(VaadinRequest) - Method in interface com.vaadin.flow.server.BootstrapUrlPredicate
Return whether the bootstrap handler should render the page.
isValidValueType(Serializable) - Static method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Checks if the given value is of a supported type.
isVirtualChild() - Method in class com.vaadin.flow.dom.Node
Gets whether this element is a virtual child of its parent.
isVisible() - Method in class com.vaadin.flow.component.Component
Gets the component visibility value.
isVisible() - Method in class com.vaadin.flow.dom.Element
Gets the element visibility value.
isVisible() - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Get element visibility.
isVisible() - Method in class com.vaadin.flow.internal.StateNode
Checks (recursively towards the parent node) whether the node is effectively visible.
isVisible(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the node visibility.
isVisible(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
isVisible(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
isVisible(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
isWebKit() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is using the WebKit engine.
isWindows() - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Check if the current os is Windows.
isWindows() - Method in class com.vaadin.flow.server.frontend.installer.Platform
Check if platform is windows.
isWindows() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Windows.
isWindows() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run on Windows.
isWindowsPhone() - Method in class com.vaadin.flow.server.WebBrowser
Tests whether the user is using Windows Phone.
isWindowsPhone() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run on Windows Phone.
isXsrfProtectionEnabled() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Returns whether cross-site request forgery protection is enabled.
isXsrfProtectionEnabled() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns whether cross-site request forgery protection is enabled.
isXsrfProtectionEnabled() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
ItemLabelGenerator<T> - Interface in com.vaadin.flow.component
ItemLabelGenerator can be used to customize the string shown to the user for an item.
iterator() - Method in class com.vaadin.flow.dom.impl.ImmutableClassList
 
iterator() - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
iterator() - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Gets an iterator returning all items in this list.
iterator() - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
iterator() - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 

J

JAR_RESOURCES_FOLDER - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The folder inside the 'generated' folder where frontend resources from jars are copied.
JAR_RESOURCES_IMPORT - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The location where javascript files present in jar resources are copied and can be imported from.
JAR_RESOURCES_IMPORT_FRONTEND_RELATIVE - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The location where javascript files present in jar resources are copied and can be imported from, relative to the frontend folder.
JarContentsManager - Class in com.vaadin.flow.server.frontend
Shared code for managing contents of jar files.
JarContentsManager() - Constructor for class com.vaadin.flow.server.frontend.JarContentsManager
 
JAVA_RESOURCE_FOLDER_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
JavaScript - Annotation Interface in com.vaadin.flow.component.dependency
Defines JavaScript dependencies on a Component class.
JAVASCRIPT - Enum constant in enum class com.vaadin.flow.component.page.Inline.Wrapping
 
JAVASCRIPT - Enum constant in enum class com.vaadin.flow.shared.ui.Dependency.Type
 
JavaScript.Container - Annotation Interface in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple JavaScript annotations.
JavaScriptBootstrapContext(VaadinRequest, VaadinResponse, UI, Function<VaadinRequest, String>) - Constructor for class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler.JavaScriptBootstrapContext
Creates a new context instance using the given parameters.
JavaScriptBootstrapHandler - Class in com.vaadin.flow.server.communication
Processes a 'start' request type from the client to initialize server session and UI.
JavaScriptBootstrapHandler() - Constructor for class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
Creates a new bootstrap handler with default page builder.
JavaScriptBootstrapHandler.JavaScriptBootstrapContext - Class in com.vaadin.flow.server.communication
Custom BootstrapContext for JavaScriptBootstrapHandler.
JavaScriptException(String) - Constructor for exception com.vaadin.flow.component.page.PendingJavaScriptResult.JavaScriptException
Creates a new JavaScript exception with the given message.
JavaScriptInvocation(String, Serializable...) - Constructor for class com.vaadin.flow.component.internal.UIInternals.JavaScriptInvocation
Creates a new invocation.
JavaScriptNavigationStateRenderer - Class in com.vaadin.flow.component.internal
Handle navigation events in relation to the client side bootstrap UI.
JavaScriptNavigationStateRenderer(NavigationState) - Constructor for class com.vaadin.flow.component.internal.JavaScriptNavigationStateRenderer
Constructs a new NavigationStateRenderer that handles the given navigation state.
JavaScriptSemantics - Class in com.vaadin.flow.internal
Helpers for replicating JavaScript semantics in Java.
join() - Method in class com.vaadin.flow.component.internal.DeadlockDetectingCompletableFuture
 
join(String[], String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Joins the words in the input array together into a single string by inserting the separator string between each word.
JREBEL - Enum constant in enum class com.vaadin.flow.internal.BrowserLiveReload.Backend
 
JS_MODULE - Enum constant in enum class com.vaadin.flow.shared.ui.Dependency.Type
 
JS_MODULES - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
A key in a Json object for js modules data.
JsModule - Annotation Interface in com.vaadin.flow.component.dependency
Annotation for defining JavaScript Module dependencies on a Component class.
JsModule.Container - Annotation Interface in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple JsModule annotations.
JSON_CONTENT_TYPE - Static variable in class com.vaadin.flow.shared.JsonConstants
The content type for JSON requests/responses.
JsonCodec - Class in com.vaadin.flow.internal
Utility for encoding objects to and from JSON.
JsonConstants - Class in com.vaadin.flow.shared
A utility class providing constants for JSON related features.
JsonConstants() - Constructor for class com.vaadin.flow.shared.JsonConstants
 
jsonEquals(JsonValue, JsonValue) - Static method in class com.vaadin.flow.internal.JsonUtils
Compares two json values for deep equality.
JsonSerializable - Interface in com.vaadin.flow.component
Base interface for classes that are serializable to and from JsonObject.
JsonSerializer - Class in com.vaadin.flow.internal
General-purpose serializer of Java objects to JsonValue and deserializer of JsonValue to Java objects.
JsonUtils - Class in com.vaadin.flow.internal
Helpers for using elemental.json.
JSR356WebsocketInitializer - Class in com.vaadin.flow.server.communication
Initializer class for JSR 356 websockets.
JSR356WebsocketInitializer() - Constructor for class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
 
JSR356WebsocketInitializer.FakeServletConfig - Class in com.vaadin.flow.server.communication
"ServletConfig" which only provides information from a ServletRegistration and its ServletContext.
JUNJA_MODE - Static variable in interface com.vaadin.flow.component.Key
Selects the Junja mode, in which Korean is represented using single-byte Latin characters.
JUSTIFY - Enum constant in enum class com.vaadin.flow.dom.Style.TextAlign
 

K

KANA_MODE - Static variable in interface com.vaadin.flow.component.Key
The Kana Mode (Kana Lock) key.
KANJI_MODE - Static variable in interface com.vaadin.flow.component.Key
The Kanji Mode key.
KATAKANA - Static variable in interface com.vaadin.flow.component.Key
The Katakana key.
Key - Interface in com.vaadin.flow.component
An interface to represent keyboard keys.
KEY_A - Static variable in interface com.vaadin.flow.component.Key
a on a US keyboard.Labelled q on an AZERTY (e.g., French) keyboard.
KEY_B - Static variable in interface com.vaadin.flow.component.Key
b on a US keyboard.
KEY_C - Static variable in interface com.vaadin.flow.component.Key
c on a US keyboard.
KEY_CONTENTS - Static variable in class com.vaadin.flow.shared.ui.Dependency
 
KEY_D - Static variable in interface com.vaadin.flow.component.Key
d on a US keyboard.
KEY_E - Static variable in interface com.vaadin.flow.component.Key
e on a US keyboard.
KEY_F - Static variable in interface com.vaadin.flow.component.Key
f on a US keyboard.
KEY_G - Static variable in interface com.vaadin.flow.component.Key
g on a US keyboard.
KEY_H - Static variable in interface com.vaadin.flow.component.Key
h on a US keyboard.
KEY_I - Static variable in interface com.vaadin.flow.component.Key
i on a US keyboard.
KEY_J - Static variable in interface com.vaadin.flow.component.Key
j on a US keyboard.
KEY_K - Static variable in interface com.vaadin.flow.component.Key
k on a US keyboard.
KEY_L - Static variable in interface com.vaadin.flow.component.Key
l on a US keyboard.
KEY_LOAD_MODE - Static variable in class com.vaadin.flow.shared.ui.Dependency
 
KEY_M - Static variable in interface com.vaadin.flow.component.Key
m on a US keyboard.
KEY_N - Static variable in interface com.vaadin.flow.component.Key
n on a US keyboard.
KEY_O - Static variable in interface com.vaadin.flow.component.Key
o on a US keyboard.
KEY_P - Static variable in interface com.vaadin.flow.component.Key
p on a US keyboard.
KEY_Q - Static variable in interface com.vaadin.flow.component.Key
q on a US keyboard.Labelled a on an AZERTY (e.g., French) keyboard.
KEY_R - Static variable in interface com.vaadin.flow.component.Key
r on a US keyboard.
KEY_S - Static variable in interface com.vaadin.flow.component.Key
s on a US keyboard.
KEY_T - Static variable in interface com.vaadin.flow.component.Key
t on a US keyboard.
KEY_TYPE - Static variable in class com.vaadin.flow.shared.ui.Dependency
 
KEY_U - Static variable in interface com.vaadin.flow.component.Key
u on a US keyboard.
KEY_URL - Static variable in class com.vaadin.flow.shared.ui.Dependency
 
KEY_V - Static variable in interface com.vaadin.flow.component.Key
v on a US keyboard.
KEY_W - Static variable in interface com.vaadin.flow.component.Key
w on a US keyboard.Labelled z on an AZERTY (e.g., French) keyboard.
KEY_X - Static variable in interface com.vaadin.flow.component.Key
x on a US keyboard.
KEY_Y - Static variable in interface com.vaadin.flow.component.Key
y on a US keyboard.Labelled z on a QWERTZ (e.g., German) keyboard.
KEY_Z - Static variable in interface com.vaadin.flow.component.Key
z on a US keyboard.Labelled w on an AZERTY (e.g., French) keyboard, and y on a QWERTZ (e.g., German) keyboard.
KEY11 - Static variable in interface com.vaadin.flow.component.Key
The 11 key found on certain media numeric keypads.
KEY12 - Static variable in interface com.vaadin.flow.component.Key
The 12 key found on certain media numeric keypads.
KeyboardEvent - Class in com.vaadin.flow.component.internal
Abstract class for keyboard events.
KeyboardEvent(Component, boolean, String, String, int, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.internal.KeyboardEvent
Creates a new keyboard event.
KeyboardEvent(Component, String) - Constructor for class com.vaadin.flow.component.internal.KeyboardEvent
Creates a new server-side keyboard event with no additional information.
KeyboardEvent(Component, String, String) - Constructor for class com.vaadin.flow.component.internal.KeyboardEvent
Creates a new server-side keyboard event with no additional information.
KeyDownEvent - Class in com.vaadin.flow.component
The event when a key is pressed.
KeyDownEvent(Component, boolean, String, String, int, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.KeyDownEvent
Creates a new keyboard event.
KeyDownEvent(Component, String) - Constructor for class com.vaadin.flow.component.KeyDownEvent
Creates a new server-side keyboard event with no additional information.
KeyDownEvent(Component, String, String) - Constructor for class com.vaadin.flow.component.KeyDownEvent
Creates a new server-side keyboard event with no additional information.
KeyEventListener<E extends KeyboardEvent> - Class in com.vaadin.flow.component
A conditional event listener for KeyboardEvents.
KeyEventListener(ComponentEventListener<E>, Key, KeyModifier...) - Constructor for class com.vaadin.flow.component.KeyEventListener
Create a listener which will delegate to listener only if key is the target key.
KeyLocation - Enum Class in com.vaadin.flow.component
Possible keyboard key locations.
KeyModifier - Enum Class in com.vaadin.flow.component
Modifier keys.
KeyNotifier - Interface in com.vaadin.flow.component
Mixin interface for components that support adding key event listeners to the their root elements.
KeyPressEvent - Class in com.vaadin.flow.component
The event when a key is pressed.
KeyPressEvent(Component, boolean, String, String, int, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.KeyPressEvent
Creates a new keyboard event.
KeyPressEvent(Component, String) - Constructor for class com.vaadin.flow.component.KeyPressEvent
Creates a new server-side keyboard event with no additional information.
KeyPressEvent(Component, String, String) - Constructor for class com.vaadin.flow.component.KeyPressEvent
Creates a new server-side keyboard event with no additional information.
keySet() - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Gets the defined keys.
KeyUpEvent - Class in com.vaadin.flow.component
The event when a key is released.
KeyUpEvent(Component, boolean, String, String, int, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.KeyUpEvent
Creates a new keyboard event.
KeyUpEvent(Component, String) - Constructor for class com.vaadin.flow.component.KeyUpEvent
Creates a new server-side keyboard event with no additional information.
KeyUpEvent(Component, String, String) - Constructor for class com.vaadin.flow.component.KeyUpEvent
Creates a new server-side keyboard event with no additional information.

L

LABEL - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <label>.
LABEL_PROPERTY_NAME - Static variable in class com.vaadin.flow.dom.ElementConstants
The label property.
LANG_1 - Static variable in interface com.vaadin.flow.component.Key
Korean: HangulMode 한/영 ( han/yeong ) Japanese (Mac keyboard): かな ( kana )
LANG_2 - Static variable in interface com.vaadin.flow.component.Key
Korean: Hanja 한자 ( hanja ) Japanese (Mac keyboard): 英数 ( eisu )
LANG_3 - Static variable in interface com.vaadin.flow.component.Key
Japanese (word-processing keyboard): Katakana
LANG_4 - Static variable in interface com.vaadin.flow.component.Key
Japanese (word-processing keyboard): Hiragana
LANG_5 - Static variable in interface com.vaadin.flow.component.Key
Japanese (word-processing keyboard): Zenkaku/Hankaku
LAST_NUMBER_REDIAL - Static variable in interface com.vaadin.flow.component.Key
The Redial button, which redials the last-called number.
LAUNCH_APP_1 - Static variable in interface com.vaadin.flow.component.Key
Sometimes labelled My Computer on the keyboard
LAUNCH_APP_2 - Static variable in interface com.vaadin.flow.component.Key
Sometimes labelled Calculator on the keyboard
LAUNCH_APPLICATION1 - Static variable in interface com.vaadin.flow.component.Key
The first generic application launcher button.
LAUNCH_APPLICATION10 - Static variable in interface com.vaadin.flow.component.Key
The 10th generic application launcher button.
LAUNCH_APPLICATION11 - Static variable in interface com.vaadin.flow.component.Key
The 11th generic application launcher button.
LAUNCH_APPLICATION12 - Static variable in interface com.vaadin.flow.component.Key
The 12th generic application launcher button.
LAUNCH_APPLICATION13 - Static variable in interface com.vaadin.flow.component.Key
The 13th generic application launcher button.
LAUNCH_APPLICATION14 - Static variable in interface com.vaadin.flow.component.Key
The 14th generic application launcher button.
LAUNCH_APPLICATION15 - Static variable in interface com.vaadin.flow.component.Key
The 15th generic application launcher button.
LAUNCH_APPLICATION16 - Static variable in interface com.vaadin.flow.component.Key
The 16th generic application launcher button.
LAUNCH_APPLICATION2 - Static variable in interface com.vaadin.flow.component.Key
The second generic application launcher button.
LAUNCH_APPLICATION3 - Static variable in interface com.vaadin.flow.component.Key
The third generic application launcher button.
LAUNCH_APPLICATION4 - Static variable in interface com.vaadin.flow.component.Key
The fourth generic application launcher button.
LAUNCH_APPLICATION5 - Static variable in interface com.vaadin.flow.component.Key
The fifth generic application launcher button.
LAUNCH_APPLICATION6 - Static variable in interface com.vaadin.flow.component.Key
The sixth generic application launcher button.
LAUNCH_APPLICATION7 - Static variable in interface com.vaadin.flow.component.Key
The seventh generic application launcher button.
LAUNCH_APPLICATION8 - Static variable in interface com.vaadin.flow.component.Key
The eighth generic application launcher button.
LAUNCH_APPLICATION9 - Static variable in interface com.vaadin.flow.component.Key
The ninth generic application launcher button.
LAUNCH_CALCULATOR - Static variable in interface com.vaadin.flow.component.Key
The Calculator key.
LAUNCH_CALENDAR - Static variable in interface com.vaadin.flow.component.Key
The Calendar key.
LAUNCH_CONTACTS - Static variable in interface com.vaadin.flow.component.Key
The Contacts key.
LAUNCH_MAIL - Static variable in interface com.vaadin.flow.component.Key
The Mail key.
LAUNCH_MEDIA_PLAYER - Static variable in interface com.vaadin.flow.component.Key
The Media Player key.
LAUNCH_MUSIC_PLAYER - Static variable in interface com.vaadin.flow.component.Key
The Music Player key.
LAUNCH_MY_COMPUTER - Static variable in interface com.vaadin.flow.component.Key
The My Computer key on Windows keyboards.
LAUNCH_PHONE - Static variable in interface com.vaadin.flow.component.Key
The Phone key, to open the phone dialer application if one is present.
LAUNCH_SCREEN_SAVER - Static variable in interface com.vaadin.flow.component.Key
The Screen Saver key.
LAUNCH_SPREADSHEET - Static variable in interface com.vaadin.flow.component.Key
The Spreadsheet key.
LAUNCH_WEB_BROWSER - Static variable in interface com.vaadin.flow.component.Key
The Web Browser key.
LAUNCH_WEB_CAM - Static variable in interface com.vaadin.flow.component.Key
The WebCam key.
LAUNCH_WORD_PROCESSOR - Static variable in interface com.vaadin.flow.component.Key
The Word Processor key.
launchBrowserInDevelopmentMode(String) - Method in interface com.vaadin.flow.internal.DevModeHandlerManager
Opens the given application URL in a browser if the application is running in development mode.
layout() - Element in annotation interface com.vaadin.flow.router.Route
Sets the parent component for the route target component.
layout() - Element in annotation interface com.vaadin.flow.router.RouteAlias
Sets the parent component for the route target component.
LAZY - Enum constant in enum class com.vaadin.flow.shared.ui.LoadMode
Allows the dependency being loaded independent of the initial page load.
LEADING - Enum constant in enum class com.vaadin.flow.dom.DebouncePhase
Debounce phase that happens immediately when the event is first triggered.
leaveNavigation(String, String) - Method in class com.vaadin.flow.component.UI
Check that the view can be leave.
LEFT - Enum constant in enum class com.vaadin.flow.component.KeyLocation
Left key location.
LEFT - Enum constant in enum class com.vaadin.flow.dom.Style.Clear
 
LEFT - Enum constant in enum class com.vaadin.flow.dom.Style.FloatCss
 
LEFT - Enum constant in enum class com.vaadin.flow.dom.Style.TextAlign
 
LEFT_TO_RIGHT - Enum constant in enum class com.vaadin.flow.component.Direction
 
length() - Method in class com.vaadin.flow.internal.Range
The number of integers contained in the range.
LENGTH_REQUIRED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (411) indicating that the request cannot be handled without a defined Content-Length.
LI - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <li>.
lineNumber() - Method in class com.vaadin.flow.component.internal.ComponentTracker.Location
 
LINK - Static variable in interface com.vaadin.flow.component.Key
Opens content linked to the current program, if available and possible.
LINUX - Enum constant in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
 
LIST_ITEM - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
LIST_PROGRAM - Static variable in interface com.vaadin.flow.component.Key
Lists the current program.
ListAddChange<T extends Serializable> - Class in com.vaadin.flow.internal.change
Change describing an add operation in a list node feature.
ListAddChange(NodeList<T>, boolean, int, List<? extends T>) - Constructor for class com.vaadin.flow.internal.change.ListAddChange
Creates a new list add change.
ListClearChange<T extends Serializable> - Class in com.vaadin.flow.internal.change
Change describing a clear operation in a list node feature.
ListClearChange(NodeList<T>) - Constructor for class com.vaadin.flow.internal.change.ListClearChange
Creates a new list clear change.
ListenerPriority - Annotation Interface in com.vaadin.flow.router
This annotation sets the priority of execution on BeforeEnterListeners, BeforeLeaveListeners and AfterNavigationListeners.
listenOn(Component...) - Method in class com.vaadin.flow.component.ShortcutRegistration
Fluently define the Component onto which the shortcut's listener is bound.
listenProgress() - Method in interface com.vaadin.flow.server.StreamVariable
Whether the StreamVariable.onProgress(StreamingProgressEvent) method should be called during the upload.
ListRemoveChange<T extends Serializable> - Class in com.vaadin.flow.internal.change
Change describing a remove operation in a list node feature.
ListRemoveChange(NodeList<T>, int, T) - Constructor for class com.vaadin.flow.internal.change.ListRemoveChange
Creates a new list remove change.
listToJson(List<?>) - Static method in class com.vaadin.flow.internal.JsonUtils
Converts the given list to JSON.
LIVE_CONTENT - Static variable in interface com.vaadin.flow.component.Key
Toggles a display listing currently available live content or programs.
LIVE_RELOAD_PORT_ATTR - Static variable in class com.vaadin.flow.server.communication.IndexHtmlRequestHandler
 
loadBundleImports() - Static method in class com.vaadin.flow.server.frontend.BundleUtils
Loads stats.json from the classpath (from the production bundle) and returns the "bundleImports" part of it.
loadClass(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
 
loadClass(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
 
loadClass(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
Load a class in the classloader.
LoadDependenciesOnStartup - Annotation Interface in com.vaadin.flow.server
Defines routes to load eagerly.
LOADING_INDICATOR_CONFIGURATION - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
LoadingIndicatorConfiguration - Interface in com.vaadin.flow.component.page
Provides method for configuring the loading indicator.
LoadingIndicatorConfigurationMap - Class in com.vaadin.flow.internal.nodefeature
Map for storing configuration for the loading indicator.
LoadingIndicatorConfigurationMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
Creates a new map for the given node.
loadInstantiators() - Method in class com.vaadin.flow.server.VaadinService
Loads and initializes instantiators.
loadMode() - Element in annotation interface com.vaadin.flow.component.dependency.JavaScript
Determines the dependency load mode.
loadMode() - Element in annotation interface com.vaadin.flow.component.dependency.StyleSheet
Determines the dependency load mode.
LoadMode - Enum Class in com.vaadin.flow.shared.ui
Determines a way that dependency is loaded.
loadProperties() - Method in class com.vaadin.experimental.FeatureFlags
Read the feature flag properties files and updates the enable property of each feature object.
loadSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Called when the VaadinSession should be loaded from the underlying HTTP session.
LOCAL_FRONTEND_RESOURCES_PATH - Static variable in class com.vaadin.flow.server.Constants
Default path for local frontend resources packaged for jar add-ons.
localeChange(LocaleChangeEvent) - Method in interface com.vaadin.flow.i18n.LocaleChangeObserver
Notifies when the UI locale is changed.
LocaleChangeEvent - Class in com.vaadin.flow.i18n
Event object with data related to locale change.
LocaleChangeEvent(UI, Locale) - Constructor for class com.vaadin.flow.i18n.LocaleChangeEvent
Locale change event constructor.
LocaleChangeObserver - Interface in com.vaadin.flow.i18n
Any com.vaadin.ui.Component implementing this interface will be informed when the UI locale is changed and on attach.
LocaleUtil - Class in com.vaadin.flow.internal
Utility class for locale handling.
Location - Class in com.vaadin.flow.router
Represents a relative URL made up of path segments and query parameters, but lacking e.g.
Location(String) - Constructor for class com.vaadin.flow.router.Location
Creates a new Location object for given location string.
Location(String, QueryParameters) - Constructor for class com.vaadin.flow.router.Location
Creates a new Location object for given location string and query parameters.
Location(String, String, String, int) - Constructor for class com.vaadin.flow.component.internal.ComponentTracker.Location
 
Location(List<String>) - Constructor for class com.vaadin.flow.router.Location
Creates a new location based on a list of path segments.
Location(List<String>, QueryParameters) - Constructor for class com.vaadin.flow.router.Location
Creates a new location based on a list of path segments and query parameters.
LocationChangeEvent - Class in com.vaadin.flow.router
Event created when the location changes by any of the reasons defined at NavigationTrigger.
LocationChangeEvent(Router, UI, NavigationTrigger, Location, List<HasElement>) - Constructor for class com.vaadin.flow.router.LocationChangeEvent
Creates a new location change event.
locationPrefix() - Static method in class com.vaadin.flow.router.HighlightConditions
Highlight if the navigation path starts with the target RouterLink path.
locationPrefix(String) - Static method in class com.vaadin.flow.router.HighlightConditions
Highlight if the navigation path starts with prefix.
LocationUtil - Class in com.vaadin.flow.router
Utility class exposing reusable utility methods for location.
lock() - Method in class com.vaadin.flow.server.VaadinSession
Locks this session to protect its data from concurrent access.
LOCK - Static variable in interface com.vaadin.flow.component.Key
Locks or unlocks the currently selected content or program.
lockSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Locks the given session for this service instance.
LOG_OFF - Static variable in interface com.vaadin.flow.component.Key
The LogOff key.
logAppStartupToConsole(ServletContext, boolean) - Static method in class com.vaadin.flow.server.startup.ServletDeployer
Prints to sysout a notification to the user that the application has been deployed.
logChangedFiles(List<String>, String) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
 
LONG - Static variable in class com.vaadin.flow.router.RouteParameterRegex
Long type regex.
LONG_POLLING - Enum constant in enum class com.vaadin.flow.shared.ui.Transport
HTTP long polling.
LongPollingCacheFilter - Class in com.vaadin.flow.server.communication
A PerRequestBroadcastFilter implementation that handles AtmospherePushConnection.PushMessages to ensure that a message is preserved in the BroadcasterCache until the client has received it.
LongPollingCacheFilter() - Constructor for class com.vaadin.flow.server.communication.LongPollingCacheFilter
 
lookup(Class<T>) - Method in interface com.vaadin.flow.di.Lookup
Lookup for a service of the given type.
lookup(Class<T>) - Method in class com.vaadin.flow.di.LookupInitializer.LookupImpl
 
Lookup - Interface in com.vaadin.flow.di
Provides a way to discover services used by Flow (SPI).
lookupAll(Class<T>) - Method in interface com.vaadin.flow.di.Lookup
Lookup for all services by the provided serviceClass.
lookupAll(Class<T>) - Method in class com.vaadin.flow.di.LookupInitializer.LookupImpl
 
LookupImpl(Map<Class<?>, Collection<Class<?>>>, BiFunction<Class<?>, Class<?>, Object>) - Constructor for class com.vaadin.flow.di.LookupInitializer.LookupImpl
Creates a new instance of Lookup with services found in the application classpath.
LookupInitializer - Class in com.vaadin.flow.di
Default implementation of AbstractLookupInitializer.
LookupInitializer() - Constructor for class com.vaadin.flow.di.LookupInitializer
 
LookupInitializer.AppShellPredicateImpl - Class in com.vaadin.flow.di
Default implementation of AppShellPredicate.
LookupInitializer.LookupImpl - Class in com.vaadin.flow.di
Default implementation of Lookup.
LookupInitializer.ResourceProviderImpl - Class in com.vaadin.flow.di
Default implementation of ResourceProvider.
LookupServletContainerInitializer - Class in com.vaadin.flow.server.startup
Standard servlet initializer for collecting all SPI implementations.
LookupServletContainerInitializer() - Constructor for class com.vaadin.flow.server.startup.LookupServletContainerInitializer
 
LUMO - Static variable in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
 

M

MACOSX - Enum constant in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
 
MAIL_FORWARD - Static variable in interface com.vaadin.flow.component.Key
Opens the user interface to forward a message.
MAIL_REPLY - Static variable in interface com.vaadin.flow.component.Key
Opens the user interface to reply to a message.
MAIL_SEND - Static variable in interface com.vaadin.flow.component.Key
Sends the current message.
MAIN - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <main>.
MANIFEST - Enum constant in enum class com.vaadin.flow.server.PwaIcon.Domain
 
manifestPath() - Element in annotation interface com.vaadin.flow.server.PWA
Path to the manifest file.
MANNER_MODE - Static variable in interface com.vaadin.flow.component.Key
A button which cycles among the notification modes: silent, vibrate, ring, and so forth.
MANUAL - Enum constant in enum class com.vaadin.flow.shared.communication.PushMode
Push is enabled.
MAP_STATE_NODE_EVENT_DATA - Static variable in class com.vaadin.flow.shared.JsonConstants
Token used as an event data expression or prefix to an event data expression to represent that the state node ID should be fetched for the element, or its closest parent, that corresponds to event.target or the element returned by the evaluated expression.
mapComponentOrElement(Field, String, String, Consumer<Element>) - Method in class com.vaadin.flow.component.template.internal.IdMapper
Maps an element or component to the given field.
mapEventTargetElement() - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Marks that the DOM event should map the event.target to the closest corresponding Element on the server side, to be returned by DomEvent.getEventTarget().
MapPutChange - Class in com.vaadin.flow.internal.change
Change describing a changed value in a map feature.
MapPutChange(NodeFeature, String, Object) - Constructor for class com.vaadin.flow.internal.change.MapPutChange
Creates a new put change.
MapRemoveChange - Class in com.vaadin.flow.internal.change
Change describing a value removed from a map.
MapRemoveChange(NodeMap, String) - Constructor for class com.vaadin.flow.internal.change.MapRemoveChange
Creates a new remove change.
MapSyncRpcHandler - Class in com.vaadin.flow.server.communication.rpc
Model map synchronization RPC handler.
MapSyncRpcHandler() - Constructor for class com.vaadin.flow.server.communication.rpc.MapSyncRpcHandler
 
mapToJson(Map<String, ?>) - Static method in class com.vaadin.flow.internal.JsonUtils
Converts the given map to JSON.
markAsDirty() - Method in class com.vaadin.flow.internal.StateNode
Marks this node as dirty.
markAsDirty(StateNode) - Method in interface com.vaadin.flow.internal.NodeOwner
Marks a node owned by this instance as dirty.
markAsDirty(StateNode) - Method in class com.vaadin.flow.internal.NullOwner
 
markAsDirty(StateNode) - Method in class com.vaadin.flow.internal.StateTree
 
markAsUsed(String, String) - Static method in class com.vaadin.flow.internal.UsageStatistics
Registers a new entry with the given feature name and version string if no previous entry has been registered for the same name.
matches(Key, KeyModifier...) - Method in class com.vaadin.flow.component.ShortcutEvent
Checks if the event matches the given Key and (optional) KeyModifiers.
matches(String) - Method in interface com.vaadin.flow.component.Key
Checks if key is a printable representation for this instance.
mayUpdateFromClient(String, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
 
mayUpdateFromClient(String, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Checks whether the client is allowed to store the given value with the given key.
MEDIA_APPS - Static variable in interface com.vaadin.flow.component.Key
Presents a list of media applications, such as photo viewers, audio and video players, and games.
MEDIA_AUDIO_TRACK - Static variable in interface com.vaadin.flow.component.Key
The Audio Track key.
MEDIA_FAST_FORWARD - Static variable in interface com.vaadin.flow.component.Key
Starts, continues, or increases the speed of fast forwarding the media.
MEDIA_LAST - Static variable in interface com.vaadin.flow.component.Key
Jumps back to the last-viewed content, program, or other media.
MEDIA_PAUSE - Static variable in interface com.vaadin.flow.component.Key
Pauses the currently playing media.
MEDIA_PLAY - Static variable in interface com.vaadin.flow.component.Key
Starts or continues playing media at normal speed, if not already doing so.
MEDIA_PLAY_PAUSE - Static variable in interface com.vaadin.flow.component.Key
Toggles between playing and pausing the current media.
MEDIA_RECORD - Static variable in interface com.vaadin.flow.component.Key
Starts or resumes recording media.
MEDIA_REWIND - Static variable in interface com.vaadin.flow.component.Key
Starts, continues, or increases the speed of rewinding the media.
MEDIA_SELECT - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
MEDIA_SKIP_BACKWARD - Static variable in interface com.vaadin.flow.component.Key
Skips backward to the previous content or program.
MEDIA_SKIP_FORWARD - Static variable in interface com.vaadin.flow.component.Key
Skips forward to the next content or program.
MEDIA_STEP_BACKWARD - Static variable in interface com.vaadin.flow.component.Key
Steps backward to the previous content or program.
MEDIA_STEP_FORWARD - Static variable in interface com.vaadin.flow.component.Key
Steps forward to the next content or program.
MEDIA_STOP - Static variable in interface com.vaadin.flow.component.Key
Stops the current media activity (such as playing, recording, pausing, forwarding, or rewinding).
MEDIA_TOP_MENU - Static variable in interface com.vaadin.flow.component.Key
Top Menu button; opens the media's main menu, such as on a DVD or Blu-Ray disc.
MEDIA_TRACK_NEXT - Static variable in interface com.vaadin.flow.component.Key
Seeks to the next media or program track.
MEDIA_TRACK_PREVIOUS - Static variable in interface com.vaadin.flow.component.Key
Seeks to the previous media or program track.
merge(Map<T, List<String>>) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
MESSAGE_DELIMITER - Static variable in class com.vaadin.flow.shared.communication.PushConstants
The character used to mark message boundaries when messages may be split into multiple fragments.
MessageDigestUtil - Class in com.vaadin.flow.internal
Utility class for common MessageDigest operations.
Meta - Annotation Interface in com.vaadin.flow.component.page
Defines a meta tag with customized name and content that will be added to the HTML of the host page of a UI class.
META - Enum constant in enum class com.vaadin.flow.component.KeyModifier
KeyModifier for "Meta" key.
META - Static variable in interface com.vaadin.flow.component.Key
The Meta key.
META_ASYNC - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used when the message is sent asynchronously via push channel.
META_INF - Static variable in class com.vaadin.flow.server.Constants
The path used in the vaadin servlet for handling static resources.
META_LEFT - Static variable in interface com.vaadin.flow.component.Key
The Windows, , Command or other OS symbol key.
META_RIGHT - Static variable in interface com.vaadin.flow.component.Key
The Windows, , Command or other OS symbol key.
META_SESSION_EXPIRED - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used when informing the client side that the session has expired.
Meta.Container - Annotation Interface in com.vaadin.flow.component.page
Internal annotation to enable use of multiple Meta annotations.
MetadataWriter - Class in com.vaadin.flow.server.communication
Serializes miscellaneous metadata to JSON.
MetadataWriter() - Constructor for class com.vaadin.flow.server.communication.MetadataWriter
 
METHOD_NOT_ALLOWED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (405) indicating that the method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
methodName() - Method in class com.vaadin.flow.component.internal.ComponentTracker.Location
 
MICROPHONE_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles the microphone on and off.
MICROPHONE_VOLUME_DOWN - Static variable in interface com.vaadin.flow.component.Key
Decreases the microphone's input volume.
MICROPHONE_VOLUME_MUTE - Static variable in interface com.vaadin.flow.component.Key
Mutes the microphone input.
MICROPHONE_VOLUME_UP - Static variable in interface com.vaadin.flow.component.Key
Increases the microphone's input volume.
MIDDLE_ROUTER_LAYOUT - Static variable in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
 
MINUS - Static variable in interface com.vaadin.flow.component.Key
-_ on a US keyboard.
MM - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing millimeters.
Mode - Enum Class in com.vaadin.flow.server
The mode the application is running in.
MODE_CHANGE - Static variable in interface com.vaadin.flow.component.Key
The Mode Change key.
ModelList - Class in com.vaadin.flow.internal.nodefeature
List for model values used in data binding in templates.
ModelList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ModelList
Creates an instance of this node feature.
MODIFIER - Enum constant in enum class com.vaadin.flow.router.RouteParameterFormatOption
Parameter modifier, i.e.
modifyIndexHtml(Document, VaadinRequest) - Method in class com.vaadin.flow.server.AppShellRegistry
Modifies the `index.html` document based on the AppShellConfigurator annotations or AppShellConfigurator.configurePage(AppShellSettings) method.
modifyIndexHtmlResponse(IndexHtmlResponse) - Method in interface com.vaadin.flow.server.communication.IndexHtmlRequestListener
The method allows to modify the Index HTML response before it is sent to browser.
modifyIndexHtmlResponse(IndexHtmlResponse) - Method in class com.vaadin.flow.server.VaadinService
modifyPath(String, String) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
Create a new address for a resource which is calculated based on the request base path (servlet path) and the original path for the Vaadin resource.
modifyPushConfiguration(PushConfiguration) - Method in class com.vaadin.flow.server.AppShellRegistry
Modifies PushConfiguration instance based on the Push annotation on AppShellConfigurator.
mostPermissive(DisabledUpdateMode, DisabledUpdateMode) - Static method in enum class com.vaadin.flow.dom.DisabledUpdateMode
Gets the most permissive out of two update modes.
MOVED_PERMANENTLY - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests.
MOVED_TEMPORARILY - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource.
moveElementsFrom(UI) - Method in class com.vaadin.flow.component.internal.UIInternals
Move all the children of the other UI to this current UI.
moveToNewUI(UI, UI) - Method in interface com.vaadin.flow.component.internal.UIInternalUpdater
Move all the children from the old UI to the new UI.
MULTIPLE_CHOICES - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location.
MULTIPLY - Static variable in interface com.vaadin.flow.component.Key
The numeric keypad's multiplication key, *.

N

name() - Element in annotation interface com.vaadin.flow.component.page.Meta
Gets the custom tag name.
name() - Element in annotation interface com.vaadin.flow.server.PWA
Name of the application.
NAME - Enum constant in enum class com.vaadin.flow.router.RouteParameterFormatOption
The name of the parameter.
NAMING_CONVENTION - Static variable in annotation interface com.vaadin.flow.router.Route
 
NAV - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <nav>.
navigate(UI, Location, NavigationTrigger) - Method in class com.vaadin.flow.router.Router
Navigates the given UI to the given location.
navigate(UI, Location, NavigationTrigger, JsonValue) - Method in class com.vaadin.flow.router.Router
Navigates the given UI to the given location.
navigate(Class<? extends C>, RouteParameters, QueryParameters) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target with the specified parameters.
navigate(Class<? extends C>, T) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target with the specified parameter.
navigate(Class<? extends C>, T) - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI
 
navigate(Class<? extends C>, T, QueryParameters) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target with the specified parameter.
navigate(Class<? extends T>, QueryParameters) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target and query parameters.
navigate(Class<T>) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target.
navigate(Class<T>) - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI
 
navigate(Class<T>, RouteParam...) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target with the specified parameters.
navigate(Class<T>, RouteParameters) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target with the specified parameters.
navigate(String) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given location.
navigate(String) - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI
 
navigate(String, QueryParameters) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given location and query parameters.
navigate(String, QueryParameters) - Method in class com.vaadin.flow.component.webcomponent.WebComponentUI
 
NAVIGATE_IN - Static variable in interface com.vaadin.flow.component.Key
Navigates into a submenu or option.
NAVIGATE_NEXT - Static variable in interface com.vaadin.flow.component.Key
Navigates to the next item.
NAVIGATE_OUT - Static variable in interface com.vaadin.flow.component.Key
Navigates out of the current screen or menu.
NAVIGATE_PREVIOUS - Static variable in interface com.vaadin.flow.component.Key
Navigates to the previous item.
navigateToClient(String) - Method in class com.vaadin.flow.component.UI
 
NavigationEvent - Class in com.vaadin.flow.router
Event object with data related to navigation.
NavigationEvent(Router, Location, UI, NavigationTrigger) - Constructor for class com.vaadin.flow.router.NavigationEvent
Creates a new navigation event.
NavigationEvent(Router, Location, UI, NavigationTrigger, JsonValue, boolean) - Constructor for class com.vaadin.flow.router.NavigationEvent
Creates a new navigation event.
NavigationHandler - Interface in com.vaadin.flow.router
Handles navigation to a location e.g.
NavigationRouteTarget - Class in com.vaadin.flow.router.internal
Contains the information resulted from searching a route target using a navigation url as input.
NavigationRouteTarget(String, RouteTarget, Map<String, String>) - Constructor for class com.vaadin.flow.router.internal.NavigationRouteTarget
 
NavigationRpcHandler - Class in com.vaadin.flow.server.communication.rpc
RPC handler for Navigation.
NavigationRpcHandler() - Constructor for class com.vaadin.flow.server.communication.rpc.NavigationRpcHandler
 
NavigationState - Class in com.vaadin.flow.router
Contains all relevant information related to a valid navigation.
NavigationState(Router) - Constructor for class com.vaadin.flow.router.NavigationState
Creates a new instance of the class using the router.
NavigationStateBuilder - Class in com.vaadin.flow.router
A builder class for constructing new NavigationState instances.
NavigationStateBuilder(Router) - Constructor for class com.vaadin.flow.router.NavigationStateBuilder
Constructs a new NavigationStateBuilder.
NavigationStateRenderer - Class in com.vaadin.flow.router.internal
Handles navigation events by rendering a contained NavigationState in the target UI.
NavigationStateRenderer(NavigationState) - Constructor for class com.vaadin.flow.router.internal.NavigationStateRenderer
Constructs a new NavigationStateRenderer that handles the given navigation state.
NavigationTargetFilter - Interface in com.vaadin.flow.server.startup
A filter that can prevent specific navigation targets from being registered.
NavigationTrigger - Enum Class in com.vaadin.flow.router
The type of user action that triggered navigation.
NEAREST - Enum constant in enum class com.vaadin.flow.component.ScrollOptions.Alignment
 
NEEDS_BUNDLE_BUILD_FILE - Static variable in class com.vaadin.flow.server.Constants
Name of the temporary file storing internal flag showing that Flow needs to re-build the production bundle or not.
needsBuild(Options, FrontendDependenciesScanner, ClassFinder, Mode) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
Checks if an application needs a new frontend bundle.
needsBundleBuild(File) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
Checks if a new production bundle is needed by restoring re-bundle checker result flag from a temporal file.
negate() - Method in interface com.vaadin.flow.function.SerializablePredicate
 
NetworkUtil - Class in com.vaadin.flow.internal
Utility class for network related methods.
never() - Static method in class com.vaadin.flow.router.HighlightConditions
Never highlight.
NEW - Static variable in interface com.vaadin.flow.component.Key
Creates a new document or message.
NEXT_CANDIDATE - Static variable in interface com.vaadin.flow.component.Key
The Next Candidate function key.
NEXT_FAVORITE_CHANNEL - Static variable in interface com.vaadin.flow.component.Key
Cycles to the next channel in the favorites list.
NEXT_USER_PROFILE - Static variable in interface com.vaadin.flow.component.Key
Cycles to the next saved user profile, if this feature is supported and multiple profiles exist.
NO_CONTENT - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (204) indicating that the request succeeded but that there was no new information to return.
NO_NAVIGATION - Static variable in class com.vaadin.flow.component.webcomponent.WebComponentUI
 
Node<N extends Node<N>> - Class in com.vaadin.flow.dom
Represents a node in the DOM.
Node(StateNode, ElementStateProvider) - Constructor for class com.vaadin.flow.dom.Node
Private constructor for initializing with an existing node and state provider.
NODE_AUTO_UPDATE - Static variable in class com.vaadin.flow.server.InitParameters
Configuration parameter name for requiring node executable installed in home directory.
NODE_DOWNLOAD_ROOT - Static variable in class com.vaadin.flow.server.InitParameters
 
NODE_MODULES - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Location for the installed node packages.
NODE_MODULES - Static variable in class com.vaadin.flow.server.frontend.TaskCleanFrontendFiles
 
NODE_TYPE - Static variable in class com.vaadin.flow.internal.JsonCodec
Type id for a complex type array containing an Element.
NODE_VERSION - Static variable in class com.vaadin.flow.server.InitParameters
 
NodeAttachChange - Class in com.vaadin.flow.internal.change
Change describing that a node has been attached.
NodeAttachChange(StateNode) - Constructor for class com.vaadin.flow.internal.change.NodeAttachChange
Creates a new attach change.
NodeChange - Class in com.vaadin.flow.internal.change
Base class describing a change to a state node.
NodeChange(StateNode) - Constructor for class com.vaadin.flow.internal.change.NodeChange
Creates a new change for the given node.
NodeDetachChange - Class in com.vaadin.flow.internal.change
Change describing that a node has been detached.
NodeDetachChange(StateNode) - Constructor for class com.vaadin.flow.internal.change.NodeDetachChange
Creates a new detach change.
NodeFeature - Class in com.vaadin.flow.internal.nodefeature
A node feature represents a group of related values and functionality in a state node.
NodeFeature(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.NodeFeature
Creates a new feature for the given node.
NodeFeatureChange - Class in com.vaadin.flow.internal.change
Base class for all node changes related to a feature.
NodeFeatureChange(NodeFeature) - Constructor for class com.vaadin.flow.internal.change.NodeFeatureChange
Creates a new change for the given feature.
NodeFeatureRegistry - Class in com.vaadin.flow.internal.nodefeature
A registry of node features that are available based on type.
NodeFeatures - Class in com.vaadin.flow.internal.nodefeature
Registry of node feature id numbers and map keys shared between server and client.
NodeInstaller - Class in com.vaadin.flow.server.frontend.installer
Node installation class.
NodeInstaller(File, Platform, ArchiveExtractor, FileDownloader) - Constructor for class com.vaadin.flow.server.frontend.installer.NodeInstaller
Initialize a new NodeInstaller.
NodeInstaller(File, Platform, List<ProxyConfig.Proxy>) - Constructor for class com.vaadin.flow.server.frontend.installer.NodeInstaller
Create NoodeInstaller with default extractor and downloader.
NodeInstaller(File, List<ProxyConfig.Proxy>) - Constructor for class com.vaadin.flow.server.frontend.installer.NodeInstaller
Create NodeInstaller with default extractor and downloader and guess platform.
NodeList<T extends Serializable> - Class in com.vaadin.flow.internal.nodefeature
A state node feature that structures data as a list.
NodeList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.NodeList
Creates a new list for the given node.
NodeList.SetView<T extends Serializable> - Class in com.vaadin.flow.internal.nodefeature
Provides access to a NodeList as a Set.
NodeMap - Class in com.vaadin.flow.internal.nodefeature
A state node feature that structures data as a map.
NodeMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.NodeMap
Creates a new map feature for the given node.
NodeOwner - Interface in com.vaadin.flow.internal
Abstract root of a state node tree.
NodeProperties - Class in com.vaadin.flow.internal.nodefeature
Various node properties' ids.
NodeTasks - Class in com.vaadin.flow.server.frontend
An executor that it's run when the servlet context is initialised in dev-mode or when flow-maven-plugin goals are run.
NodeTasks(Options) - Constructor for class com.vaadin.flow.server.frontend.NodeTasks
Initialize tasks with the given options.
NodeUpdater - Class in com.vaadin.flow.server.frontend
Base abstract class for frontend updaters that needs to be run when in dev-mode or from the flow maven plugin.
NodeUpdater(ClassFinder, FrontendDependenciesScanner, Options) - Constructor for class com.vaadin.flow.server.frontend.NodeUpdater
Constructor.
NodeValue<T extends Serializable> - Class in com.vaadin.flow.internal.nodefeature
A node feature that carries a single value.
NodeValue(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.NodeValue
Creates a new feature for the given node.
NodeVisitor - Interface in com.vaadin.flow.dom
Element API node visitor interface.
NodeVisitor.ElementType - Enum Class in com.vaadin.flow.dom
The type of the element.
NoInputStreamException - Exception in com.vaadin.flow.server
Exception for when there is no InputStream available.
NoInputStreamException() - Constructor for exception com.vaadin.flow.server.NoInputStreamException
 
NON_AUTHORITATIVE_INFORMATION - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (203) indicating that the meta information presented by the client did not originate from the server.
NON_CONVERT - Static variable in interface com.vaadin.flow.component.Key
The NonConvert ("Don't convert") key.
NON_PARENT - Static variable in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
 
NON_PARENT_ALIAS - Static variable in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
 
NON_ROUTER_LAYOUT - Static variable in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
 
none() - Static method in class com.vaadin.flow.router.HighlightActions
An action which does nothing, regardless of the highlight state.
NONE - Enum constant in enum class com.vaadin.flow.component.page.Inline.Wrapping
 
NONE - Enum constant in enum class com.vaadin.flow.dom.Style.Clear
 
NONE - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
NONE - Enum constant in enum class com.vaadin.flow.dom.Style.FloatCss
 
NONE - Static variable in interface com.vaadin.flow.component.Key
This value is reserved for corner cases of no key value present in event e.g.
nonProxyHosts - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Excluded hosts string delimited by '|'.
NoOutputStreamException - Exception in com.vaadin.flow.server
Exception for when there is no OutputStream available.
NoOutputStreamException() - Constructor for exception com.vaadin.flow.server.NoOutputStreamException
 
NORMAL - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
Sequences of white space are collapsed.
NORMAL - Enum constant in enum class com.vaadin.flow.dom.Style.WhiteSpace
 
NOT_ACCEPTABLE - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (406) indicating that the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
NOT_FOUND - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (404) indicating that the requested resource is not available.
NOT_IMPLEMENTED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request.
NOT_MODIFIED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.
NOT_PRODUCTION_MODE_INFO - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
NotFoundException - Exception in com.vaadin.flow.router
Exception indicating that something went wrong while resolving navigation routes.
NotFoundException() - Constructor for exception com.vaadin.flow.router.NotFoundException
Default constructor.
NotFoundException(String) - Constructor for exception com.vaadin.flow.router.NotFoundException
Navigation exception thrown when routing fails due to a faulty navigation target string.
NoTheme - Annotation Interface in com.vaadin.flow.theme
A marker annotation to avoid applying any default theme to the application.
NOTIFICATION - Static variable in interface com.vaadin.flow.component.Key
The Notification key.
notifyNavigationTarget(Component, NavigationEvent, BeforeEnterEvent, LocationChangeEvent) - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
Notify the navigation target about the status of the navigation.
notifyNavigationTarget(Component, NavigationEvent, BeforeEnterEvent, LocationChangeEvent) - Method in class com.vaadin.flow.router.internal.ErrorStateRenderer
 
notifyNavigationTarget(Component, NavigationEvent, BeforeEnterEvent, LocationChangeEvent) - Method in class com.vaadin.flow.router.internal.NavigationStateRenderer
 
NotSupported - Annotation Interface in com.vaadin.flow.component
Methods annotated with NotSupported are mapped to the original webcomponent implementation, but not supported at Java level.
NOWRAP - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
Collapses white space as for normal, but suppresses line breaks (text wrapping) within the source.
NOWRAP - Enum constant in enum class com.vaadin.flow.dom.Style.WhiteSpace
 
NPM_BIN_PATH - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
 
NPM_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
NpmPackage - Annotation Interface in com.vaadin.flow.component.dependency
Annotation for defining an npm package dependency on a Component class which includes one or more JS modules.
NpmPackage.Container - Annotation Interface in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple NpmPackage annotations.
NullOwner - Class in com.vaadin.flow.internal
A stateless singleton node owner that is used for nodes that have not yet been attached to a state tree.
NUM_LOCK - Static variable in interface com.vaadin.flow.component.Key
The NumLock (Number Lock) key.
numbersEqual(JsonValue, JsonValue) - Static method in class com.vaadin.flow.internal.JsonUtils
 
numberStream(JsonArray) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a double stream from a JSON array of numbers.
NUMPAD - Enum constant in enum class com.vaadin.flow.component.KeyLocation
Numeric pad key location.
NUMPAD_0 - Static variable in interface com.vaadin.flow.component.Key
0 Ins on a keyboard 0 on a phone or remote control
NUMPAD_1 - Static variable in interface com.vaadin.flow.component.Key
1 End on a keyboard 1 or 1 QZ on a phone orremote control
NUMPAD_2 - Static variable in interface com.vaadin.flow.component.Key
2 ↓ on a keyboard 2 ABC on a phone or remote control
NUMPAD_3 - Static variable in interface com.vaadin.flow.component.Key
3 PgDn on a keyboard 3 DEF on a phone or remote control
NUMPAD_4 - Static variable in interface com.vaadin.flow.component.Key
4 ← on a keyboard 4 GHI on a phone or remote control
NUMPAD_5 - Static variable in interface com.vaadin.flow.component.Key
5 on a keyboard 5 JKL on a phone or remote control
NUMPAD_6 - Static variable in interface com.vaadin.flow.component.Key
6 → on a keyboard 6 MNO on a phone or remote control
NUMPAD_7 - Static variable in interface com.vaadin.flow.component.Key
7 Home on a keyboard 7 PQRS or 7 PRS on a phoneor remote control
NUMPAD_8 - Static variable in interface com.vaadin.flow.component.Key
8 ↑ on a keyboard 8 TUV on a phone or remote control
NUMPAD_9 - Static variable in interface com.vaadin.flow.component.Key
9 PgUp on a keyboard 9 WXYZ or 9 WXY on a phoneor remote control
NUMPAD_ADD - Static variable in interface com.vaadin.flow.component.Key
+
NUMPAD_BACKSPACE - Static variable in interface com.vaadin.flow.component.Key
Found on the Microsoft Natural Keyboard.
NUMPAD_CLEAR - Static variable in interface com.vaadin.flow.component.Key
C or AC (All Clear).
NUMPAD_CLEAR_ENTRY - Static variable in interface com.vaadin.flow.component.Key
CE (Clear Entry)
NUMPAD_COMMA - Static variable in interface com.vaadin.flow.component.Key
, (thousands separator).
NUMPAD_DECIMAL - Static variable in interface com.vaadin.flow.component.Key
.
NUMPAD_DIVIDE - Static variable in interface com.vaadin.flow.component.Key
/
NUMPAD_ENTER - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
NUMPAD_EQUAL - Static variable in interface com.vaadin.flow.component.Key
=
NUMPAD_HASH - Static variable in interface com.vaadin.flow.component.Key
# on a phone or remote control device.
NUMPAD_MEMORY_ADD - Static variable in interface com.vaadin.flow.component.Key
M+ Add current entry to the value stored in memory.
NUMPAD_MEMORY_CLEAR - Static variable in interface com.vaadin.flow.component.Key
MC Clear the value stored in memory.
NUMPAD_MEMORY_RECALL - Static variable in interface com.vaadin.flow.component.Key
MR Replace the current entry with the value stored in memory.
NUMPAD_MEMORY_STORE - Static variable in interface com.vaadin.flow.component.Key
MS Replace the value stored in memory with the current entry.
NUMPAD_MEMORY_SUBTRACT - Static variable in interface com.vaadin.flow.component.Key
M- Subtract current entry from the value stored in memory.
NUMPAD_MULTIPLY - Static variable in interface com.vaadin.flow.component.Key
* on a keyboard.
NUMPAD_PAREN_LEFT - Static variable in interface com.vaadin.flow.component.Key
( Found on the Microsoft Natural Keyboard.
NUMPAD_PAREN_RIGHT - Static variable in interface com.vaadin.flow.component.Key
) Found on the Microsoft Natural Keyboard.
NUMPAD_STAR - Static variable in interface com.vaadin.flow.component.Key
* on a phone or remote control device.This key is typically found below the 7 key and to the left of the 0 key.
NUMPAD_SUBTRACT - Static variable in interface com.vaadin.flow.component.Key
-

O

OBJECT - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <object>.
objectStream(JsonArray) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a stream from a JSON array of objects.
of(int) - Static method in enum class com.vaadin.flow.component.KeyLocation
Returns the KeyLocation for location.
of(String) - Static method in enum class com.vaadin.flow.component.KeyModifier
Returns the KeyModifier for key.
of(String, String) - Static method in class com.vaadin.flow.router.QueryParameters
Creates parameters from given key-value pair.
of(String, String...) - Static method in interface com.vaadin.flow.component.Key
Returns a Key instance for a printable representation of the key.
of(T, Class<? super T>...) - Static method in interface com.vaadin.flow.di.Lookup
Creates a lookup which contains (only) the provided service as instance of given serviceTypes.
offline() - Element in annotation interface com.vaadin.flow.server.PWA
Whether the application should be available offline.
offlinePath() - Element in annotation interface com.vaadin.flow.server.PWA
Path to the static offline html file.
offlineResources() - Element in annotation interface com.vaadin.flow.server.PWA
Offline resources to be cached using the service worker.
offsetBy(int) - Method in class com.vaadin.flow.internal.Range
Get a range that is based on this one, but offset by a number.
OK - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (200) indicating the request succeeded normally.
OL - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <ol>.
ON_DEMAND - Static variable in interface com.vaadin.flow.component.Key
Opens the user interface for selecting on demand content or programs to watch.
onAttach() - Method in class com.vaadin.flow.internal.StateNode
Called when this node has been attached to a state tree.
onAttach(boolean) - Method in class com.vaadin.flow.internal.nodefeature.ComponentMapping
 
onAttach(boolean) - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Called when the state node has been attached to the state tree.
onAttach(AttachEvent) - Method in class com.vaadin.flow.component.Component
Called when the component is attached to a UI.
onAttach(AttachEvent) - Method in class com.vaadin.flow.component.UI
Called after the UI is added to the session.
onAttach(ElementAttachEvent) - Method in interface com.vaadin.flow.dom.ElementAttachListener
Invoked when an element is attached to the UI.
once(Command) - Static method in interface com.vaadin.flow.shared.Registration
Creates a registration that will run a command only once.
onChange(SerializableBiConsumer<C, P>) - Method in interface com.vaadin.flow.component.webcomponent.PropertyConfiguration
Sets a Property change handler.
onChange(SerializableBiConsumer<C, P>) - Method in class com.vaadin.flow.server.webcomponent.PropertyConfigurationImpl
 
onComponentAttach(Component, boolean) - Static method in class com.vaadin.flow.component.ComponentUtil
Handles triggering the onAttach method and firing the AttachEvent for the given component when it has been attached to a UI.
onComponentDetach(Component) - Static method in class com.vaadin.flow.component.ComponentUtil
Handles triggering the onDetach method and firing the DetachEvent for the given component right before it is detached from a UI.
onComponentEvent(E) - Method in class com.vaadin.flow.component.KeyEventListener
 
onComponentEvent(T) - Method in interface com.vaadin.flow.component.ComponentEventListener
Invoked when a component event has been fired.
onConnect(AtmosphereResource) - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Sets the web socket connection resource when it's established.
onDetach() - Method in class com.vaadin.flow.internal.nodefeature.ComponentMapping
 
onDetach() - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Called when the state node has been detached from the state tree.
onDetach() - Method in class com.vaadin.flow.internal.nodefeature.NodeList
 
onDetach(DetachEvent) - Method in class com.vaadin.flow.component.Component
Called when the component is detached from a UI.
onDetach(DetachEvent) - Method in class com.vaadin.flow.component.UI
Called before the UI is removed from the session.
onDetach(ElementDetachEvent) - Method in interface com.vaadin.flow.dom.ElementDetachListener
Invoked when an element is detached from the UI.
onDisconnect(AtmosphereResource) - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Removes the web socket connection resource, not null.
ONE_IMPL_REQUIRED - Static variable in class com.vaadin.flow.di.LookupInitializer
 
onEnabledStateChanged(boolean) - Method in class com.vaadin.flow.component.Component
Handle component enable state when the enabled state changes.
onError(Node<?>, String, Element) - Method in interface com.vaadin.flow.dom.ChildElementConsumer
This callback method is called when the requested client element cannot be found in the provided parent by the tag name after the previousSibling.
OneTimeInitializerPredicate - Interface in com.vaadin.flow.di
The presence of the service implementing this interface with OneTimeInitializerPredicate.runOnce() returning true means that ServletContainerInitializers are executed only once and the implementation doesn't have to care about cleaning up data collected based on previous call.
onHistoryStateChange(History.HistoryStateChangeEvent) - Method in interface com.vaadin.flow.component.page.History.HistoryStateChangeHandler
Invoked when a history state change event is fired.
ONLY_WHEN_ENABLED - Enum constant in enum class com.vaadin.flow.dom.DisabledUpdateMode
If used then updates from the client side are allowed only if element is enabled.
onMessage(AtmosphereResource, String) - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Called when any message is received through the connection.
onProgress(StreamVariable.StreamingProgressEvent) - Method in interface com.vaadin.flow.server.StreamVariable
This method is called if StreamVariable.listenProgress() returns true when the streaming starts.
onRequest(AtmosphereResource) - Method in class com.vaadin.flow.server.communication.PushAtmosphereHandler
 
onShortcut(ShortcutEvent) - Method in interface com.vaadin.flow.component.ShortcutEventListener
Invoked when shortcut has been used.
onStartup(Set<Class<?>>, ServletContext) - Method in interface com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer
Overridden to use different classloaders if needed.
onStateChange(AtmosphereResourceEvent) - Method in class com.vaadin.flow.server.communication.PushAtmosphereHandler
 
onUnregister(SerializableRunnable) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Adds a handler that will be run when this registration is removed.
open(String) - Method in class com.vaadin.flow.component.page.Page
Opens the given url in a new tab.
open(String, String) - Method in class com.vaadin.flow.component.page.Page
Opens the given URL in a window with the given name.
OPEN - Enum constant in enum class com.vaadin.flow.server.VaadinSessionState
The session is active and accepting client requests.
OPEN - Static variable in interface com.vaadin.flow.component.Key
Opens an existing document or message.
OPTION - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <option>.
optionalAttributeWithDefault(String, String) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for an optional attribute of the component's root element with a non-null default value.
optionalAttributeWithDefault(String, String, boolean) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for an optional attribute of the component's root element with a non-null default value.
OptionalParameter - Annotation Interface in com.vaadin.flow.router
Marks a Navigation url parameter as optional.
options - Variable in class com.vaadin.flow.server.frontend.NodeUpdater
 
Options - Class in com.vaadin.flow.server.frontend
Build a NodeExecutor instance.
Options(Lookup, File) - Constructor for class com.vaadin.flow.server.frontend.Options
Creates a new instance.
or(Predicate<? super T>) - Method in interface com.vaadin.flow.function.SerializablePredicate
 

P

P - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <p>.
PACKAGE_JSON - Static variable in class com.vaadin.flow.server.Constants
Name of the npm main file.
PACKAGE_LOCK_JSON - Static variable in class com.vaadin.flow.server.Constants
Name of the npm version locking ile.
PACKAGE_LOCK_YAML - Static variable in class com.vaadin.flow.server.Constants
Name of the pnpm version locking ile.
Page - Class in com.vaadin.flow.component.page
Represents the web page open in the browser, containing the UI it is connected to.
Page(UI) - Constructor for class com.vaadin.flow.component.page.Page
Creates a page instance for the given UI.
PAGE_DOWN - Static variable in interface com.vaadin.flow.component.Key
The Page Down (or PgDn) key.
PAGE_LOAD - Enum constant in enum class com.vaadin.flow.router.NavigationTrigger
Navigation was triggered by the user opening the application or reloading in the browser.
PAGE_UP - Static variable in interface com.vaadin.flow.component.Key
The Page Up (or PgUp) key.
Page.ExtendedClientDetailsReceiver - Interface in com.vaadin.flow.component.page
Callback for receiving extended client-side details.
PageTitle - Annotation Interface in com.vaadin.flow.router
Defines the HTML page title for a navigation target.
Pair<U extends Serializable,V extends Serializable> - Class in com.vaadin.flow.internal
Generic class representing an immutable pair of values.
Pair(U, V) - Constructor for class com.vaadin.flow.internal.Pair
Creates a new pair.
PAIRING - Static variable in interface com.vaadin.flow.component.Key
Starts the process of pairing the remote with a device to be controlled.
PARAM - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <param>.
PARAM_FRONTEND_DIR - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
A parameter for overriding the FrontendUtils.DEFAULT_FRONTEND_DIR folder.
PARAM_IGNORE_VERSION_CHECKS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
Set to true to ignore node/npm tool version checks.
PARAM_TOKEN_FILE - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
A parameter informing about the location of the FrontendUtils.TOKEN_FILE.
PARAMETER - Static variable in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Reserved parameter placeholder used when setup internally route path pattern with the parameter design for backward compatibility with HasUrlParameter.
PARAMETER_NAME - Static variable in class com.vaadin.flow.router.internal.HasUrlParameterFormat
Reserved parameter name used when setup internally route path pattern with the parameter design for backward compatibility with HasUrlParameter.
ParameterDeserializer - Class in com.vaadin.flow.router
Parameter deserialization utility.
PARAMETERS_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
ParentLayout - Annotation Interface in com.vaadin.flow.router
Defines the parent layout for components in routing hierarchy.
parseFrontendVersion(String) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Parse the version number of node/npm from version output string.
parsePathToSegments(String) - Static method in class com.vaadin.flow.router.LocationUtil
parsePathToSegments(String, boolean) - Static method in class com.vaadin.flow.router.LocationUtil
Parses the given path to parts split by the path separator.
parseQueryParameters(String) - Static method in class com.vaadin.flow.router.LocationUtil
Parses query parameters from the given location.
ParserData - Class in com.vaadin.flow.component.template.internal
Immutable parser data which may be stored in cache.
ParserData(Map<Field, String>, Map<String, String>, Map<String, Map<String, String>>) - Constructor for class com.vaadin.flow.component.template.internal.ParserData
Constructs an immutable data object with the given information.
parseStyles(String) - Static method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
Parses the given style string and populates the given style object with the found styles.
PARTIAL_CONTENT - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (206) indicating that the server has fulfilled the partial GET request for the resource.
partitionWith(Range) - Method in class com.vaadin.flow.internal.Range
Overlay this range with another one, and partition the ranges according to how they position relative to each other.
password - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Password for proxy.
PASTE - Static variable in interface com.vaadin.flow.component.Key
Paste from the clipboard.
PathUtil - Class in com.vaadin.flow.router.internal
Utility class which contains various methods for parsing a route url into segments.
PathUtil() - Constructor for class com.vaadin.flow.router.internal.PathUtil
 
PAUSE - Static variable in interface com.vaadin.flow.component.Key
The Pause key.
PAYLOAD - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
PAYMENT_REQUIRED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (402) reserved for future use.
PendingJavaScriptInvocation - Class in com.vaadin.flow.component.internal
A pending JavaScript result that can be sent to the client.
PendingJavaScriptInvocation(StateNode, UIInternals.JavaScriptInvocation) - Constructor for class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
Creates a new pending invocation for the given owner node and invocation.
PendingJavaScriptResult - Interface in com.vaadin.flow.component.page
A pending result from a JavaScript snippet sent to the browser for evaluation.
PendingJavaScriptResult.JavaScriptException - Exception in com.vaadin.flow.component.page
Exception used when a CompletableFuture returned from PendingJavaScriptResult is completed exceptionally because of a client-side error.
PERCENTAGE - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing in percentage of the containing element defined by terminal.
PERIOD - Static variable in interface com.vaadin.flow.component.Key
.> on a US keyboard.
phases() - Element in annotation interface com.vaadin.flow.component.DebounceSettings
Gets an array of debounce phases for which the event should be sent to the server.
PICAS - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing picas (12 points).
PINP_DOWN - Static variable in interface com.vaadin.flow.component.Key
A button to move the picture-in-picture view downward.
PINP_MOVE - Static variable in interface com.vaadin.flow.component.Key
A button to control moving the picture-in-picture view.
PINP_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles display of the picture-in-picture view on and off.
PINP_UP - Static variable in interface com.vaadin.flow.component.Key
A button to move the picture-in-picture view upward.
pinPlatformDependency(JsonObject, JsonObject, String) - Static method in class com.vaadin.flow.server.frontend.TaskUpdatePackages
 
PIXELS - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing pixels.
Platform - Class in com.vaadin.flow.server.frontend.installer
Platform contains information about system architecture and OS.
Platform - Class in com.vaadin.flow.server
Provides information about the current version of Vaadin Platform.
Platform() - Constructor for class com.vaadin.flow.server.Platform
 
Platform(Platform.OS, Platform.Architecture) - Constructor for class com.vaadin.flow.server.frontend.installer.Platform
Construct a new Platform.
Platform(String, Platform.OS, Platform.Architecture, String) - Constructor for class com.vaadin.flow.server.frontend.installer.Platform
 
PLAY - Static variable in interface com.vaadin.flow.component.Key
The Play key.
PLAY_SPEED_DOWN - Static variable in interface com.vaadin.flow.component.Key
Decreases the media playback rate.
PLAY_SPEED_RESET - Static variable in interface com.vaadin.flow.component.Key
Returns the media playback rate to normal.
PLAY_SPEED_UP - Static variable in interface com.vaadin.flow.component.Key
Increases the media playback rate.
POINTS - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing points (1/72nd of an inch).
POLL_CONFIGURATION - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
POLL_INTERVAL_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PollConfigurationMap
 
PollConfigurationMap - Class in com.vaadin.flow.internal.nodefeature
A node map for storing configuration for polling.
PollConfigurationMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.PollConfigurationMap
Creates a new map for the given node.
PollEvent - Class in com.vaadin.flow.component
An event that is fired whenever a client polls the server for asynchronous UI updates.
PollEvent(UI, boolean) - Constructor for class com.vaadin.flow.component.PollEvent
Creates a new event using the given source and indicator whether the event originated from the client side or the server side.
PollNotifier - Interface in com.vaadin.flow.component
The interface for adding and removing PollEvent listeners.
POLYFILLS_DEFAULT_VALUE - Static variable in class com.vaadin.flow.server.Constants
 
POLYMER_EVENT_LISTENERS - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
POLYMER_SERVER_EVENT_HANDLERS - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
PolymerEventListenerMap - Class in com.vaadin.flow.internal.nodefeature
Map of PolymerTemplate events with server-side listeners.
PolymerEventListenerMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.PolymerEventListenerMap
Creates a new map feature for the given node.
PolymerServerEventHandlers - Class in com.vaadin.flow.internal.nodefeature
Deprecated.
Polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.
PolymerServerEventHandlers(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers
Deprecated.
Creates a new meta information list for the given state node.
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.EmptyChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.ListAddChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.ListClearChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.ListRemoveChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.MapPutChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.MapRemoveChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.NodeAttachChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.NodeChange
Overridden by subclasses to populate a JSON object when serializing.
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.NodeDetachChange
 
populateJson(JsonObject, ConstantPool) - Method in class com.vaadin.flow.internal.change.NodeFeatureChange
 
populateTokenFileData(JsonObject) - Method in class com.vaadin.flow.server.frontend.Options
Fill token file data into the provided object.
port - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Proxy port.
position() - Element in annotation interface com.vaadin.flow.component.page.Inline
Inline position of element.
postConfigure() - Method in class com.vaadin.flow.component.WebComponentExporter
postpone() - Method in class com.vaadin.flow.router.BeforeLeaveEvent
Initiates the postponement of the current navigation transition, allowing a listener to e.g.
Postpone - Class in com.vaadin.flow.router.internal
Container class for containing left over listeners on postponed navigation.
POWER - Static variable in interface com.vaadin.flow.component.Key
The Power button or key, to toggle power on and off.
POWER_OFF - Static variable in interface com.vaadin.flow.component.Key
The PowerOff or PowerDown key.
PRE - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
Sequences of white space are preserved.
PRE - Enum constant in enum class com.vaadin.flow.dom.Style.WhiteSpace
 
PRE - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <pre>.
PRE_LINE - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
Sequences of white space are collapsed.
PRE_LINE - Enum constant in enum class com.vaadin.flow.dom.Style.WhiteSpace
 
PRE_WRAP - Enum constant in enum class com.vaadin.flow.component.HasText.WhiteSpace
Sequences of white space are preserved.
PRE_WRAP - Enum constant in enum class com.vaadin.flow.dom.Style.WhiteSpace
 
PRECONDITION_FAILED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (412) indicating that the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.
preConfigure() - Method in class com.vaadin.flow.component.WebComponentExporter
prefixIfRelative(String, String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Prepend the given url with the prefix if it is not absolute and doesn't have a protocol.
prepareConnection(String, String) - Method in interface com.vaadin.flow.internal.DevModeHandler
Prepare a HTTP connection against the dev server.
prepareForResync() - Method in class com.vaadin.flow.internal.StateNode
Prepares the tree below this node for resynchronization by detaching all descendants, setting their internal state to not yet attached, and calling the attach listeners.
prepareForResync() - Method in class com.vaadin.flow.internal.StateTree
Prepares the tree for resynchronization, meaning that the client will receive the same changes as when the component tree was initially attached, so that it can build the DOM tree from scratch.
PREPEND - Enum constant in enum class com.vaadin.flow.component.page.Inline.Position
 
PreserveOnRefresh - Annotation Interface in com.vaadin.flow.router
Indicates that a previous view instance should be-reused when reloading a location in the same browser window/tab.
PREVIOUS_CANDIDATE - Static variable in interface com.vaadin.flow.component.Key
The Previous Candidate key.
PRINT - Static variable in interface com.vaadin.flow.component.Key
Prints the current document or message.
PRINT_SCREEN - Static variable in interface com.vaadin.flow.component.Key
The PrintScreen or PrtScr key.
PRIORITY_COMPARATOR - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatureRegistry
Comparator for finding the priority order between node feature types.
proceed() - Method in class com.vaadin.flow.router.BeforeLeaveEvent.ContinueNavigationAction
Resumes the page transition associated with the postponed event.
process(Set<Class<?>>, ServletContext) - Method in interface com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer
Implement this method instead of ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext) to handle classes accessible by different classloaders.
process(Set<Class<?>>, ServletContext) - Method in class com.vaadin.flow.server.startup.LookupServletContainerInitializer
 
process(Set<Class<?>>, ServletContext) - Method in interface com.vaadin.flow.server.startup.VaadinServletContextStartupInitializer
 
PROCESS - Static variable in interface com.vaadin.flow.component.Key
The Process key.
PROD_BUNDLE_JAR_PATH - Static variable in class com.vaadin.flow.server.Constants
The path part where production bundle is located inside the jar.
PROD_BUNDLE_NAME - Static variable in class com.vaadin.flow.server.Constants
The name of the default production bundle.
producePutChange(String, boolean, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
 
producePutChange(String, boolean, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Checks whether a MapPutChange should be produced.
PRODUCTION_CUSTOM - Enum constant in enum class com.vaadin.flow.server.Mode
 
PRODUCTION_PRECOMPILED_BUNDLE - Enum constant in enum class com.vaadin.flow.server.Mode
 
PROGRAMMATIC - Enum constant in enum class com.vaadin.flow.router.NavigationTrigger
Navigation was triggered programmatically via forward/reroute action.
PROJECT_BASEDIR - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 
PROJECT_FRONTEND_GENERATED_DIR_TOKEN - Static variable in class com.vaadin.flow.server.Constants
 
PROPERTIES_FILENAME - Static variable in class com.vaadin.experimental.FeatureFlags
 
property() - Element in annotation interface com.vaadin.flow.component.Synchronize
The name of the property to synchronize.
propertyChange(PropertyChangeEvent) - Method in interface com.vaadin.flow.dom.PropertyChangeListener
Invoked when this listener receives a property change event from an event source to which it has been added.
PropertyChangeDeniedException - Exception in com.vaadin.flow.internal.nodefeature
The exception is thrown when a property change from client is disallowed on the server side.
PropertyChangeDeniedException(String) - Constructor for exception com.vaadin.flow.internal.nodefeature.PropertyChangeDeniedException
 
PropertyChangeEvent - Class in com.vaadin.flow.dom
An event fired when the value of a property changes.
PropertyChangeEvent(Element, String, Serializable, boolean) - Constructor for class com.vaadin.flow.dom.PropertyChangeEvent
Creates a new PropertyChangeEvent event containing the current property value of the given element.
PropertyChangeListener - Interface in com.vaadin.flow.dom
A listener for property change events.
PropertyConfiguration<C extends Component,P extends Serializable> - Interface in com.vaadin.flow.component.webcomponent
Offers a fluent API for configuring the properties of embedded web components produced by WebComponentExporter.
PropertyConfigurationImpl<C extends Component,P extends Serializable> - Class in com.vaadin.flow.server.webcomponent
For internal use only.
PropertyConfigurationImpl(Class<C>, String, Class<P>, P) - Constructor for class com.vaadin.flow.server.webcomponent.PropertyConfigurationImpl
Constructs a new PropertyConfigurationImpl tied to the exported Component type given by componentType.
PropertyData<P extends Serializable> - Class in com.vaadin.flow.server.webcomponent
Value object containing information of a web component's property field.
PropertyData(String, Class<P>, boolean, P) - Constructor for class com.vaadin.flow.server.webcomponent.PropertyData
Constructs a new PropertyData instance tied to the type of the property's value given by type.
PropertyDeploymentConfiguration - Class in com.vaadin.flow.server
The property handling implementation of DeploymentConfiguration based on a base class for resolving system properties and a set of init parameters.
PropertyDeploymentConfiguration(ApplicationConfiguration, Class<?>, Properties) - Constructor for class com.vaadin.flow.server.PropertyDeploymentConfiguration
Create a new property deployment configuration instance.
PropertyDescriptor<S,G> - Interface in com.vaadin.flow.component
Describes a component property that has its value stored in some form in the component's element, typically an element property or attribute.
PropertyDescriptors - Class in com.vaadin.flow.component
Factory methods for creating PropertyDescriptor instances.
propertyIdToHumanFriendly(Object) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Converts a property id to a human friendly format.
propertyWithDefault(String, Boolean) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for a property of the component's root element with a non-null default value.
propertyWithDefault(String, Double) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for a property of the component's root element with a non-null default value.
propertyWithDefault(String, Integer) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for a property of the component's root element with a non-null default value.
propertyWithDefault(String, String) - Static method in class com.vaadin.flow.component.PropertyDescriptors
Creates a descriptor for a property of the component's root element with a non-null default value.
PROPS - Static variable in interface com.vaadin.flow.component.Key
The Props (Properties) key.
protocol - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Protocol used for proxy.
PROVIDED_VERSION - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
 
Proxy(String, String, String) - Constructor for class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Construct a Proxy object out of a proxy url.
Proxy(String, String, String, int, String, String, String) - Constructor for class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Construct a Proxy object.
PROXY_AUTHENTICATION_REQUIRED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (407) indicating that the client MUST first authenticate itself with the proxy.
ProxyConfig - Class in com.vaadin.flow.server.frontend.installer
Proxy configuration used for downloads and executions.
ProxyConfig(List<ProxyConfig.Proxy>) - Constructor for class com.vaadin.flow.server.frontend.installer.ProxyConfig
Create a new proxy configuration with given proxies.
ProxyConfig.Proxy - Class in com.vaadin.flow.server.frontend.installer
Class for holding proxy information.
PublishedServerEventHandlerRpcHandler - Class in com.vaadin.flow.server.communication.rpc
RPC handler for events triggered through element.$server or simply $server in template event handlers.
PublishedServerEventHandlerRpcHandler() - Constructor for class com.vaadin.flow.server.communication.rpc.PublishedServerEventHandlerRpcHandler
 
push() - Method in class com.vaadin.flow.component.UI
Pushes the pending changes and client RPC invocations of this UI to the client-side.
push() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
 
push() - Method in interface com.vaadin.flow.server.communication.PushConnection
Pushes pending state changes and client RPC calls to the client.
push(boolean) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Pushes pending state changes and client RPC calls to the client.
Push - Annotation Interface in com.vaadin.flow.component.page
Configures automatic server push.
PUSH - Enum constant in enum class com.vaadin.flow.server.HandlerHelper.RequestType
Push requests (any transport).
PUSH_ID_PARAMETER - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Name of the parameter used to transmit the push connection identifier.
PUSH_MAPPING - Static variable in class com.vaadin.flow.server.Constants
The path used in the vaadin servlet for handling push.
PUSH_PENDING - Enum constant in enum class com.vaadin.flow.server.communication.AtmospherePushConnection.State
Not connected.
PUSH_SERVLET_MAPPING_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
PUSH_STATE_HASH - Static variable in class com.vaadin.flow.server.communication.UidlRequestHandler
 
PUSH_STATE_LOCATION - Static variable in class com.vaadin.flow.server.communication.UidlRequestHandler
 
PushAtmosphereHandler - Class in com.vaadin.flow.server.communication
Handles Atmosphere requests and forwards them to logical methods in PushHandler.
PushAtmosphereHandler() - Constructor for class com.vaadin.flow.server.communication.PushAtmosphereHandler
 
PushConfiguration - Interface in com.vaadin.flow.component
Provides method for configuring the push channel.
PushConfigurationMap - Class in com.vaadin.flow.internal.nodefeature
Map for storing the push configuration for a UI.
PushConfigurationMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
Creates a new map for the given node.
PushConfigurationMap.PushConfigurationParametersMap - Class in com.vaadin.flow.internal.nodefeature
Map for storing push parameters.
PushConfigurationParametersMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.PushConfigurationMap.PushConfigurationParametersMap
Creates a new map for the given node.
PushConnection - Interface in com.vaadin.flow.server.communication
Represents a bidirectional ("push") connection between a single UI and its client-side.
PushConnectionFactory - Interface in com.vaadin.flow.server.communication
Factory that produces instances of PushConnection.
PushConstants - Class in com.vaadin.flow.shared.communication
Shared constants used by push.
PushConstants() - Constructor for class com.vaadin.flow.shared.communication.PushConstants
 
PushHandler - Class in com.vaadin.flow.server.communication
Handles incoming push connections and messages and dispatches them to the correct UI/ AtmospherePushConnection.
PushHandler(VaadinServletService) - Constructor for class com.vaadin.flow.server.communication.PushHandler
Creates an instance connected to the given service.
pushHistoryState(NavigationEvent) - Method in class com.vaadin.flow.component.internal.JavaScriptNavigationStateRenderer
 
pushHistoryState(NavigationEvent) - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
 
PushMode - Enum Class in com.vaadin.flow.shared.communication
The mode of bidirectional ("push") communication that is in use.
PUSHMODE_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
PushRequestHandler - Class in com.vaadin.flow.server.communication
Handles requests to open a push (bidirectional) communication channel between the client and the server.
PushRequestHandler(VaadinServletService) - Constructor for class com.vaadin.flow.server.communication.PushRequestHandler
Creates an instance connected to the given service.
pushState(JsonValue, Location) - Method in class com.vaadin.flow.component.page.History
Invokes history.pushState in the browser with the given parameters.
pushState(JsonValue, String) - Method in class com.vaadin.flow.component.page.History
Invokes history.pushState in the browser with the given parameters.
put(String, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Stores a value with the given key, replacing any value previously stored with the same key.
put(String, Serializable, boolean) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
 
put(String, Serializable, boolean) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Stores a value with the given key, replacing any value previously stored with the same key.
PWA - Annotation Interface in com.vaadin.flow.server
Defines application PWA properties.
PwaConfiguration - Class in com.vaadin.flow.server
Holds the configuration from the PWA annotation.
PwaConfiguration() - Constructor for class com.vaadin.flow.server.PwaConfiguration
Creates the configuration using default PWA parameters.
PwaConfiguration(boolean, String, String, String, String, String, String, String, String, String, String, String[], boolean) - Constructor for class com.vaadin.flow.server.PwaConfiguration
Constructs a configuration from individual values.
PwaConfiguration(PWA) - Constructor for class com.vaadin.flow.server.PwaConfiguration
Constructs the configuration using the PWA annotation.
PwaHandler - Class in com.vaadin.flow.server.communication
Handles serving of PWA resources.
PwaHandler(SerializableSupplier<PwaRegistry>) - Constructor for class com.vaadin.flow.server.communication.PwaHandler
Creates PwaHandler from PwaRegistry getter.
PwaIcon - Class in com.vaadin.flow.server
Implementation of icons used in PWA resources.
PwaIcon.Domain - Enum Class in com.vaadin.flow.server
Place where icon belongs to (header or manifest.webmanifest).
PwaRegistry - Class in com.vaadin.flow.server
Registry for PWA data.
PwaRegistry(PWA, ServletContext) - Constructor for class com.vaadin.flow.server.PwaRegistry
Creates a new PwaRegistry instance.

Q

QueryParameters - Class in com.vaadin.flow.router
Holds query parameters information.
QueryParameters(Map<String, List<String>>) - Constructor for class com.vaadin.flow.router.QueryParameters
Creates query parameters from parameter map.
QUOTE - Static variable in interface com.vaadin.flow.component.Key
'" on a US keyboard.

R

RANDOM_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles random media (also known as "shuffle mode") on and off.
Range - Class in com.vaadin.flow.internal
An immutable representation of a range, marked by start and end points.
RC_LOW_BATTERY - Static variable in interface com.vaadin.flow.component.Key
A code sent when the remote control's battery is low.
readFromHttpSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Performs the actual read of the VaadinSession from the underlying HTTP session after sanity checks have been performed.
readJson(JsonObject) - Method in interface com.vaadin.flow.component.JsonSerializable
Sets the JSON object data into the Java object.
README - Static variable in class com.vaadin.flow.server.frontend.TaskRunDevBundleBuild
 
README_NOT_CREATED - Static variable in class com.vaadin.flow.server.frontend.TaskRunDevBundleBuild
 
readOnly() - Method in interface com.vaadin.flow.component.webcomponent.PropertyConfiguration
Mark the property as read-only.
readOnly() - Method in class com.vaadin.flow.server.webcomponent.PropertyConfigurationImpl
 
readResolve() - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
readResolve() - Method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
 
readResolve() - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
readResource(String) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
readToObject(JsonObject, Class<T>) - Static method in class com.vaadin.flow.internal.JsonUtils
Converts JsonObject into Java object of given type.
receiveDetails(ExtendedClientDetails) - Method in interface com.vaadin.flow.component.page.Page.ExtendedClientDetailsReceiver
Invoked when the client-side details are available.
receiveMessage(Reader) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Reads and buffers a (possibly partial) message.
reconnect() - Method in class com.vaadin.flow.component.webcomponent.WebComponentWrapper
Cancel cleanup for a disconnected component.
RECONNECT_ATTEMPTS_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
RECONNECT_ATTEMPTS_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
RECONNECT_DIALOG_CONFIGURATION - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
RECONNECT_INTERVAL_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
RECONNECT_INTERVAL_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
ReconnectDialogConfiguration - Interface in com.vaadin.flow.component
Provides methods for configuring the reconnect dialog.
ReconnectDialogConfigurationMap - Class in com.vaadin.flow.internal.nodefeature
Map for storing the reconnect dialog configuration for a UI.
ReconnectDialogConfigurationMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
Creates a new map for the given node.
RECORD_SPEED_NEXT - Static variable in interface com.vaadin.flow.component.Key
Cycles among the available media recording speeds.
RED - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 
REDO - Static variable in interface com.vaadin.flow.component.Key
Redo the last action.
ReflectionCache<C,T> - Class in com.vaadin.flow.internal
A thread-safe cache for the result of doing some reflection lookup based on a class.
ReflectionCache(SerializableFunction<Class<C>, T>) - Constructor for class com.vaadin.flow.internal.ReflectionCache
Creates a new reflection cache with the given value provider.
ReflectTools - Class in com.vaadin.flow.internal
An util class with helpers for reflection operations.
ReflectTools() - Constructor for class com.vaadin.flow.internal.ReflectTools
 
REFRESH - Enum constant in enum class com.vaadin.flow.router.NavigationTrigger
Navigation is for a reload event on a preserveOnRefresh route.
refreshLocation(ComponentTracker.Location, int) - Static method in class com.vaadin.flow.component.internal.ComponentTracker
Refreshes location of all components that had create or attach location below given reference component by given offset value.
refreshTransients(WrappedSession, VaadinService) - Method in class com.vaadin.flow.server.VaadinSession
Refreshes the transient fields of the session to ensure they are up to date.
REGEX - Enum constant in enum class com.vaadin.flow.router.RouteParameterFormatOption
Original template regex.
REGEX_NAME - Enum constant in enum class com.vaadin.flow.router.RouteParameterFormatOption
The named template of the parameter, i.e.
register(Node<?>, Element, StateNode, ChildElementConsumer) - Method in class com.vaadin.flow.internal.nodefeature.AttachExistingElementFeature
Registers the data for the child node requested as being attached to an existing element.
register(StateNode) - Method in interface com.vaadin.flow.internal.NodeOwner
Registers a node with this node owner.
register(StateNode) - Method in class com.vaadin.flow.internal.NullOwner
 
register(StateNode) - Method in class com.vaadin.flow.internal.StateTree
 
registerAtStartup() - Element in annotation interface com.vaadin.flow.router.Route
Marks if this Route should be registered during the initial route registration on servlet startup.
registerChannel(SerializableBiConsumer<JsonArray, ReturnChannelRegistration>) - Method in class com.vaadin.flow.internal.nodefeature.ReturnChannelMap
Registers a new channel based on a callback that receives the provided arguments and the channel registration when a message is passed to the channel.
registerChannel(SerializableConsumer<JsonArray>) - Method in class com.vaadin.flow.internal.nodefeature.ReturnChannelMap
Registers a new channel based on a callback that receives the provided arguments when a message is passed to the channel.
registerResource(AbstractStreamResource) - Method in class com.vaadin.flow.server.StreamResourceRegistry
Registers a stream resource in the session and returns registration handler.
Registration - Interface in com.vaadin.flow.shared
A registration object for removing an event listener added to a source.
REGULAR - Enum constant in enum class com.vaadin.flow.dom.NodeVisitor.ElementType
The type of the regular element: the element which has been created via Element API and attached in a regular way.
reinitializeSession(VaadinRequest) - Static method in class com.vaadin.flow.server.VaadinService
Discards the current session and creates a new session with the same contents.
RELATIVE - Enum constant in enum class com.vaadin.flow.dom.Style.Position
 
relIconPath() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the ath to icon with prefix, so request matches.
relManifestPath() - Method in class com.vaadin.flow.server.PwaConfiguration
Path to manifest with prefix, so request matches.
reload() - Method in class com.vaadin.flow.component.page.Page
Reloads the page in the browser.
reload() - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Requests reload via the resource provided via BrowserLiveReload.onConnect(AtmosphereResource) call.
relOfflinePath() - Method in class com.vaadin.flow.server.PwaConfiguration
Path to offline file with prefix, so request matches.
relServiceWorkerPath() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the path to service worker with prefix, so request matches.
REM - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the font-size of the root font.
remove() - Method in class com.vaadin.flow.component.ShortcutRegistration
Removes the ShortcutRegistration
remove() - Method in interface com.vaadin.flow.internal.StateTree.ExecutionRegistration
Removes the associated task from the execution queue.
remove() - Method in interface com.vaadin.flow.shared.Registration
Removes the associated listener from the event source.
remove(int) - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
remove(int) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
remove(int) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Removes the item at the given index.
remove(int) - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
remove(int) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 
remove(Component...) - Method in interface com.vaadin.flow.component.HasComponents
Removes the given child components from this component.
remove(Object) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
remove(Object) - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
remove(String) - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
remove(String) - Method in class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
remove(String) - Method in interface com.vaadin.flow.dom.Style
Removes the given style property if it has been set.
remove(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Removes the named attribute.
remove(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
 
remove(String) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Removes the value stored for the given key.
remove(Collection<Component>) - Method in interface com.vaadin.flow.component.HasComponents
Removes the given child components from this component.
removeAll() - Method in interface com.vaadin.flow.component.HasComponents
Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the Element API.
removeAll(Collection<?>) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
removeAllChildren() - Method in class com.vaadin.flow.dom.Node
Removes all child elements, including elements only present at the client-side.
removeAllChildren(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Removes all child elements.
removeAllChildren(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
removeAllChildren(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
removeAllProperties() - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Removes all properties.
removeAttribute(Element) - Method in class com.vaadin.flow.dom.impl.ClassAttributeHandler
 
removeAttribute(Element) - Method in class com.vaadin.flow.dom.impl.CustomAttribute
Removes the attribute when Element.removeAttribute(String) is called for this attribute.
removeAttribute(Element) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
removeAttribute(StateNode, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Removes the given attribute if it has been set.
removeAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
removeAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
removeAttribute(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
removeAttribute(Class<?>) - Method in interface com.vaadin.flow.server.VaadinContext
Removes an attribute identified by the given type.
removeAttribute(Class<?>) - Method in class com.vaadin.flow.server.VaadinServletContext
 
removeAttribute(String) - Method in class com.vaadin.flow.dom.Element
Removes the given attribute.
removeAttribute(String) - Method in interface com.vaadin.flow.server.VaadinRequest
Removes an attribute from this request.
removeAttribute(String) - Method in class com.vaadin.flow.server.WrappedHttpSession
 
removeAttribute(String) - Method in interface com.vaadin.flow.server.WrappedSession
Removes the object bound with the specified name from this session.
removeChild(int) - Method in class com.vaadin.flow.dom.Node
Removes the child at the given index.
removeChild(Element...) - Method in class com.vaadin.flow.dom.Node
Removes the given child element(s).
removeChild(StateNode, int) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Removes the child at the given position.
removeChild(StateNode, int) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
removeChild(StateNode, int) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
removeChild(StateNode, Element) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Removes the given child.
removeChild(StateNode, Element) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
removeChild(StateNode, Element) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
removeChild(Collection<Element>) - Method in class com.vaadin.flow.dom.Node
Removes the given child element(s).
removeClassName(String) - Method in interface com.vaadin.flow.component.HasStyle
Removes a CSS class name from this component.
removeClassNames(String...) - Method in interface com.vaadin.flow.component.HasStyle
Removes one or more CSS class names from component.
removeComments(String) - Static method in class com.vaadin.flow.internal.StringUtil
Removes comments (block comments and line comments) from the JS code.
removeComments(String, boolean) - Static method in class com.vaadin.flow.internal.StringUtil
Removes comments (block comments and line comments) from the JS code.
removeEntry(String) - Static method in class com.vaadin.flow.internal.UsageStatistics
Remove a entry of the current usage entries.
removeFromHttpSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Performs the actual removal of the VaadinSession from the underlying HTTP session after sanity checks have been performed.
removeFromParent() - Method in class com.vaadin.flow.component.Component
Removes the component from its parent.
removeFromParent() - Method in class com.vaadin.flow.dom.Element
Removes this element from its parent.
removeFromTree() - Method in class com.vaadin.flow.dom.Element
Removes this element from its parent and state tree.
removeFromTree() - Method in class com.vaadin.flow.internal.StateNode
Removes the node from its parent and unlinks the node (and children) from the state tree.
removeHandleTypesSelfReferences(Set<Class<?>>, Object) - Static method in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
Filters the given set and removes classes (interfaces) which are mentioned in a @HandlesTypes annotation on the given object.
removeItem(T) - Method in class com.vaadin.flow.internal.change.ListAddChange
Removes item from the change list.
removeProperty(StateNode, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Removes the given property if it has been set.
removeProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
removeProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
removeProperty(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
removeProperty(String) - Method in class com.vaadin.flow.dom.Element
Removes the given property.
removeProperty(String) - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Removes the given property.
removeRequestHandler(RequestHandler) - Method in class com.vaadin.flow.server.VaadinSession
Removes a request handler from the session.
removeRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
removeRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Remove the target completely from the configuration.
removeRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Remove the given navigation target route registration.
removeRoute(Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Remove the given navigation target route registration.
removeRoute(String) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
removeRoute(String) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Remove route for given template.
removeRoute(String) - Method in class com.vaadin.flow.router.RouteConfiguration
Remove all registrations for given path.
removeRoute(String) - Method in interface com.vaadin.flow.server.RouteRegistry
Remove the registration for given path.
removeRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
removeRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Remove navigation target for given template.
removeRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Remove only the specified navigationTarget from the path and not other targets if they exist for the same path.
removeRoute(String, Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Remove navigationTarget for the path.
removeRouterLayoutContent(HasElement) - Method in interface com.vaadin.flow.router.RouterLayout
Removes content that should no longer be shown in this router layout.
removeSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Called when the VaadinSession should be removed from the underlying HTTP session.
removeThemeName(String) - Method in interface com.vaadin.flow.component.HasTheme
Removes a theme name from this component.
removeThemeNames(String...) - Method in interface com.vaadin.flow.component.HasTheme
Removes one or more theme names from component.
removeUI(UI) - Method in class com.vaadin.flow.server.VaadinSession
Called by the framework to remove an UI instance from the session because it has been closed.
removeVirtualChild(Element...) - Method in class com.vaadin.flow.dom.Node
Removes the given children that have been attached as the virtual children of this element.
removeVirtualChild(Collection<Element>) - Method in class com.vaadin.flow.dom.Node
Removes the given children that have been attached as the virtual children of this element.
replace(Component, Component) - Method in interface com.vaadin.flow.component.HasOrderedComponents
Replaces the component in the container with another one without changing position.
replaceState(JsonValue, Location) - Method in class com.vaadin.flow.component.page.History
Invokes history.replaceState in the browser with the given parameters.
replaceState(JsonValue, String) - Method in class com.vaadin.flow.component.page.History
Invokes history.replaceState in the browser with the given parameters.
REQUEST_ENTITY_TOO_LARGE - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (413) indicating that the server is refusing to process the request because the request entity is larger than the server is willing or able to process.
REQUEST_LOCATION_PARAMETER - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Parameter for the initial router location when JavaScript bootstrapping.
REQUEST_QUERY_PARAMETER - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Parameter for the initial query string when JavaScript bootstrapping.
REQUEST_TIMEOUT - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (408) indicating that the client did not produce a request within the time that the server was prepared to wait.
REQUEST_TYPE_HEARTBEAT - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Request type parameter value indicating a heartbeat request.
REQUEST_TYPE_INIT - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Request type parameter value indicating an init request.
REQUEST_TYPE_PARAMETER - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Get parameter used in framework requests to identify the request type.
REQUEST_TYPE_PUSH - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Request type parameter value indicating a push request.
REQUEST_TYPE_UIDL - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Request type parameter value indicating a UIDL request.
REQUEST_TYPE_WEBCOMPONENT_RESYNC - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Request type parameter value indicating a WebComponent resynchronization request.
REQUEST_URI_TOO_LONG - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (414) indicating that the server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.
requestCanCreateSession(VaadinRequest) - Method in class com.vaadin.flow.server.VaadinService
Checks whether it's valid to create a new service session as a result of the given request.
requestCanCreateSession(VaadinRequest) - Method in class com.vaadin.flow.server.VaadinServletService
 
REQUESTED_RANGE_NOT_SATISFIABLE - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (416) indicating that the server cannot serve the requested byte range.
requestEnd(VaadinRequest, VaadinResponse, VaadinSession) - Method in class com.vaadin.flow.server.VaadinService
Called after the framework has handled a request and the response has been written.
RequestHandler - Interface in com.vaadin.flow.server
Handler for producing a response to HTTP requests.
requestStart(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.VaadinService
Called before the framework starts handling a request.
REQUIRE_HOME_NODE_EXECUTABLE - Static variable in class com.vaadin.flow.server.InitParameters
Configuration parameter name for requiring node executable installed in home directory.
REQUIRED_ATMOSPHERE_RUNTIME_VERSION - Static variable in class com.vaadin.flow.server.Constants
 
requiresLock() - Method in interface com.vaadin.flow.server.InputStreamFactory
If this method returns true (by default) then reading data from input stream (via InputStreamFactory.createInputStream() will be done under session lock and it's safe to access application data within InputStream read methods.
requiresLookup() - Method in interface com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer
Whether this initializer requires lookup or not.
requiresLookup() - Method in class com.vaadin.flow.server.startup.LookupServletContainerInitializer
 
rerouteTo(NavigationHandler) - Method in class com.vaadin.flow.router.LocationChangeEvent
Reroutes the navigation to use the provided navigation handler instead of the currently used handler.
rerouteTo(NavigationHandler, NavigationState) - Method in class com.vaadin.flow.router.BeforeEvent
Reroutes the navigation to use the provided navigation handler instead of the currently used handler.
rerouteTo(NavigationState) - Method in class com.vaadin.flow.router.BeforeEvent
Reroutes the navigation to the given navigation state.
rerouteTo(NavigationState) - Method in class com.vaadin.flow.router.LocationChangeEvent
Reroutes the navigation to show the given component instead of the component that is currently about to be displayed.
rerouteTo(Class<? extends Component>) - Method in class com.vaadin.flow.router.BeforeEvent
Reroutes the navigation to show the given component instead of the component that is currently about to be displayed.
rerouteTo(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.BeforeEvent
Reroutes the navigation to show the given component instead of the component that is currently about to be displayed.
rerouteTo(String) - Method in class com.vaadin.flow.router.BeforeEvent
Reroute to navigation component registered for given location string instead of the component about to be displayed.
rerouteTo(String, List<T>) - Method in class com.vaadin.flow.router.BeforeEvent
Reroute to navigation component registered for given location string with given route parameters instead of the component about to be displayed.
rerouteTo(String, T) - Method in class com.vaadin.flow.router.BeforeEvent
Reroute to navigation component registered for given location string with given route parameter instead of the component about to be displayed.
rerouteToError(Class<? extends Exception>) - Method in class com.vaadin.flow.router.BeforeEvent
Reroute to error target for given exception without custom message.
rerouteToError(Class<? extends Exception>, String) - Method in class com.vaadin.flow.router.BeforeEvent
Reroute to error target for given exception with given custom message.
rerouteToError(Exception, String) - Method in class com.vaadin.flow.router.BeforeEvent
Reroute to error target for given exception with given custom message.
reset() - Method in class com.vaadin.flow.component.template.internal.IdMapper
Resets the mapper to its original state, clearing any registered mappings.
reset() - Method in class com.vaadin.flow.server.AppShellRegistry
Reset the registry configuration so as it's possible to perform a new configuration and validation.
RESET_CONTENT - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.
resetEntries() - Static method in class com.vaadin.flow.internal.UsageStatistics
Reset the usage entries.
resolve(ResolveRequest) - Method in class com.vaadin.flow.router.internal.DefaultRouteResolver
 
resolve(ResolveRequest) - Method in interface com.vaadin.flow.router.RouteResolver
Resolves the given request to a new NavigationState.
resolve(VaadinContext, Class<?>) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Gets the effective route path value of the annotated class.
ResolveContext(VaadinService, WebBrowser) - Constructor for class com.vaadin.flow.server.communication.UidlWriter.ResolveContext
Creates a new context.
resolveFrontendPath(File, String) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Looks up the frontend resource at the given path.
resolveFrontendPath(File, String, File) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Looks up the fronted resource at the given path.
resolveModelList(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Resolves the ModelList that the model path refers to.
resolveModelMap(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Resolves the ElementPropertyMap that the model path refers to.
resolveNavigationTarget(Location) - Method in class com.vaadin.flow.router.Router
Resolve the navigation target for given Location using the router routeResolver.
resolveNavigationTarget(String, Map<String, String[]>) - Method in class com.vaadin.flow.router.Router
Resolve the navigation target for given path and parameter map using the router routeResolver.
resolvePageTitle(BootstrapHandler.BootstrapContext) - Static method in class com.vaadin.flow.server.BootstrapHandler
Resolves the initial page title for the given bootstrap context and cancels any pending JS execution for it.
ResolveRequest - Class in com.vaadin.flow.router.internal
An object used to encapsulate data used in resolving routing requests.
ResolveRequest(Router, Location) - Constructor for class com.vaadin.flow.router.internal.ResolveRequest
Constructs a new ResolveRequest with the given Router and Location.
resolveResource(String) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
resolveResource(String) - Method in class com.vaadin.flow.server.VaadinService
Resolves the given url resource to be useful for VaadinService.getResource(String) and VaadinService.getResourceAsStream(String).
resolveResource(String) - Method in class com.vaadin.flow.server.VaadinServletService
 
resolveRouteNotFoundNavigationTarget() - Method in class com.vaadin.flow.router.Router
Resolve a navigation target with an empty NotFoundException.
resolveVaadinUri(String) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapUriResolver
Translates a Vaadin URI to a URL that can be loaded by the browser.
resolveVaadinUri(String) - Method in class com.vaadin.flow.server.ServiceContextUriResolver
Resolves the given uri to a path which can be used with VaadinService.getResource(String) and VaadinService.getResourceAsStream(String).
resolveVaadinUri(String, String) - Method in class com.vaadin.flow.shared.VaadinUriResolver
Translates a Vaadin URI to a URL that can be loaded by the browser.
ResourceProvider - Interface in com.vaadin.flow.di
Static "classpath" resources provider.
ResourceProviderImpl() - Constructor for class com.vaadin.flow.di.LookupInitializer.ResourceProviderImpl
Creates a new instance.
RESOURCES_FRONTEND_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Location for the frontend resources in jar files.
RESOURCES_JAR_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Location for the resources in jar files.
RESOURCES_THEME_JAR_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Location for the theme resources in jar files.
RESPONSE_PENDING - Enum constant in enum class com.vaadin.flow.server.communication.AtmospherePushConnection.State
Not connected.
ResponseWriter - Class in com.vaadin.flow.internal
The class that handles writing the response data into the response.
ResponseWriter(DeploymentConfiguration) - Constructor for class com.vaadin.flow.internal.ResponseWriter
Create a response writer with the given deployment configuration.
restoreInstances(Map<Class<?>, CurrentInstance>) - Static method in class com.vaadin.flow.internal.CurrentInstance
Restores the given instances to the given values.
restrictTo(Range) - Method in class com.vaadin.flow.internal.Range
Limits this range to be within the bounds of the provided range.
RESUME - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
ResynchronizationRequiredException() - Constructor for exception com.vaadin.flow.server.communication.ServerRpcHandler.ResynchronizationRequiredException
Default constructor for the exception.
RESYNCHRONIZE_ID - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the parameter used for re-synchronizing.
retainAll(Collection<?>) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
retrieveExtendedClientDetails(Page.ExtendedClientDetailsReceiver) - Method in class com.vaadin.flow.component.page.Page
Obtain extended client side details, such as time screen and time zone information, via callback.
RETURN_CHANNEL_MAP - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
RETURN_CHANNEL_TYPE - Static variable in class com.vaadin.flow.internal.JsonCodec
Type id for a complex type array identifying a ReturnChannelRegistration reference.
ReturnChannelHandler - Class in com.vaadin.flow.server.communication
RPC handler for return channel messages.
ReturnChannelHandler() - Constructor for class com.vaadin.flow.server.communication.ReturnChannelHandler
 
ReturnChannelMap - Class in com.vaadin.flow.internal.nodefeature
Server-side node feature that keeps track of the return channels registered for a state node.
ReturnChannelMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ReturnChannelMap
Creates a new return channel map for the given state node.
ReturnChannelRegistration - Interface in com.vaadin.flow.internal.nodefeature
A registration for a return channel.
reuseDevServer() - Method in interface com.vaadin.flow.server.AbstractConfiguration
Get if the dev server should be reused on each reload.
reuseDevServer() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
RF_BYPASS - Static variable in interface com.vaadin.flow.component.Key
Toggles radio frequency (RF) input bypass mode on and off.
rfc5987Encode(String) - Static method in class com.vaadin.flow.internal.EncodeUtil
Encodes the given string to UTF-8 value-chars as defined in RFC5987 for use in e.g.
RIGHT - Enum constant in enum class com.vaadin.flow.component.KeyLocation
Right key location.
RIGHT - Enum constant in enum class com.vaadin.flow.dom.Style.Clear
 
RIGHT - Enum constant in enum class com.vaadin.flow.dom.Style.FloatCss
 
RIGHT - Enum constant in enum class com.vaadin.flow.dom.Style.TextAlign
 
RIGHT_TO_LEFT - Enum constant in enum class com.vaadin.flow.component.Direction
 
ROMAJI - Static variable in interface com.vaadin.flow.component.Key
The Romaji key; selects the Roman character set.
Route - Annotation Interface in com.vaadin.flow.router
Defines the route template suffix for components that function as navigation targets in routing.
ROUTE - Enum constant in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
 
RouteAlias - Annotation Interface in com.vaadin.flow.router
Defines the route alias for components that function as navigation targets in routing.
RouteAlias.Container - Annotation Interface in com.vaadin.flow.router
Internal annotation to enable use of multiple RouteAlias annotations.
RouteAliasData - Class in com.vaadin.flow.router
Route data for an 'alias' route.
RouteAliasData(List<Class<? extends RouterLayout>>, String, List<Class<?>>, Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouteAliasData
AliasData constructor.
RouteAliasData(List<Class<? extends RouterLayout>>, String, Map<String, RouteParameterData>, Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouteAliasData
AliasData constructor.
RouteBaseData<T extends RouteBaseData> - Class in com.vaadin.flow.router
Abstract base class for route and route alias data.
RouteBaseData(List<Class<? extends RouterLayout>>, String, List<Class<?>>, Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouteBaseData
RouteBaseData constructor.
RouteBaseData(List<Class<? extends RouterLayout>>, String, Map<String, RouteParameterData>, Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouteBaseData
RouteBaseData constructor.
RouteConfiguration - Class in com.vaadin.flow.router
Route configuration helper class for adding, removing and reading routes from the different registries.
RouteData - Class in com.vaadin.flow.router
Data collection of information for a specific registered route target.
RouteData(List<Class<? extends RouterLayout>>, String, List<Class<?>>, Class<? extends Component>, List<RouteAliasData>) - Constructor for class com.vaadin.flow.router.RouteData
RouteData constructor.
RouteData(List<Class<? extends RouterLayout>>, String, Map<String, RouteParameterData>, Class<? extends Component>, List<RouteAliasData>) - Constructor for class com.vaadin.flow.router.RouteData
RouteData constructor.
RouteNotFoundError - Class in com.vaadin.flow.router
This is a basic default error view shown on routing exceptions.
RouteNotFoundError() - Constructor for class com.vaadin.flow.router.RouteNotFoundError
 
RouteParam - Class in com.vaadin.flow.router
Route parameter containing the name and the value used mainly when constructing a RouteParameters instance.
RouteParam(String, String) - Constructor for class com.vaadin.flow.router.RouteParam
Creates a new route parameter.
RouteParameterData - Class in com.vaadin.flow.router
Immutable data representing one url parameter.
RouteParameterData(String, String) - Constructor for class com.vaadin.flow.router.RouteParameterData
Creates a parameter data instance.
RouteParameterFormatOption - Enum Class in com.vaadin.flow.router
Define the route parameters format flags.
RouteParameterRegex - Class in com.vaadin.flow.router
Predefined regex used with template parameters.
RouteParameters - Class in com.vaadin.flow.router
Immutable container which stores the route parameters extracted from a navigation url received from the client.
RouteParameters(RouteParam...) - Constructor for class com.vaadin.flow.router.RouteParameters
Creates a RouteParameters container using the given RouteParams.
RouteParameters(String, String) - Constructor for class com.vaadin.flow.router.RouteParameters
Creates a RouteParameters instance using only one parameter.
RouteParameters(Map<String, String>) - Constructor for class com.vaadin.flow.router.RouteParameters
Creates a RouteParameters container using the given map as argument.
RoutePathProvider - Interface in com.vaadin.flow.router
Allows to implement a custom navigation target path generation logic for components annotated with @Route(Route.NAMING_CONVENTION).
RoutePrefix - Annotation Interface in com.vaadin.flow.router
Defines the route prefix that a Parent layout adds to a route when used in the active view chain.
Router - Class in com.vaadin.flow.router
The router takes care of serving content when the user navigates within a site or an application.
Router(RouteRegistry) - Constructor for class com.vaadin.flow.router.Router
Constructs a new router with the given route registry and a DefaultRouteResolver.
ROUTER_LINK - Enum constant in enum class com.vaadin.flow.router.NavigationTrigger
Navigation was triggered by the user following a router link.
ROUTER_LINK_ATTRIBUTE - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Attribute name for marking internal router link anchors.
RouteRegistry - Interface in com.vaadin.flow.server
The RouteRegistry interface class that gives the out facing usage needs for a route registry implementation.
RouteRegistryInitializer - Class in com.vaadin.flow.server.startup
Servlet initializer for collecting all available Routes on startup.
RouteRegistryInitializer() - Constructor for class com.vaadin.flow.server.startup.RouteRegistryInitializer
 
RouteResolver - Interface in com.vaadin.flow.router
Callback interface for resolving ResolveRequests to new NavigationStates.
RouterLayout - Interface in com.vaadin.flow.router
Implementations of this interface represent a parent for a navigation target components via the Route.layout() parameter.
RouterLink - Class in com.vaadin.flow.router
A link that handles navigation internally using Router instead of loading a new page in the browser.
RouterLink() - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new empty router link.
RouterLink(Router, Class<? extends C>, T) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given parameter.
RouterLink(Router, Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target.
RouterLink(Router, Class<? extends Component>, RouteParameters) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given parameters.
RouterLink(Router, String, Class<? extends C>, T) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given text and parameter.
RouterLink(Router, String, Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given text.
RouterLink(Router, String, Class<? extends Component>, RouteParameters) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given text and parameters.
RouterLink(Class<? extends C>, T) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given parameter.
RouterLink(Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target.
RouterLink(Class<? extends Component>, RouteParameters) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given parameters.
RouterLink(String, Class<? extends C>, T) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given text and parameter.
RouterLink(String, Class<? extends Component>) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given text.
RouterLink(String, Class<? extends Component>, RouteParameters) - Constructor for class com.vaadin.flow.router.RouterLink
Creates a new router link for the given navigation target using the given text and parameters.
routesChanged(RoutesChangedEvent) - Method in interface com.vaadin.flow.router.RoutesChangedListener
Invoked when this listener receives a route change event from a RouteRegistry.
RoutesChangedEvent - Class in com.vaadin.flow.router
Result class containing the removed and added routes for the latest configuration.
RoutesChangedEvent(RouteRegistry, List<RouteBaseData<?>>, List<RouteBaseData<?>>) - Constructor for class com.vaadin.flow.router.RoutesChangedEvent
Constructs a prototypical Event.
RoutesChangedListener - Interface in com.vaadin.flow.router
Listener that gets notified when the registered routes for a RouteRegistry are changed in some way.
RouteTarget - Class in com.vaadin.flow.router.internal
Route target stores the target component and parent layouts.
RouteTarget(Class<? extends Component>) - Constructor for class com.vaadin.flow.router.internal.RouteTarget
Create a new Route target holder with the given target registered and empty parent layouts.
RouteTarget(Class<? extends Component>, List<Class<? extends RouterLayout>>) - Constructor for class com.vaadin.flow.router.internal.RouteTarget
Create a new Route target holder with the given target registered.
RouteUtil - Class in com.vaadin.flow.router.internal
Utility class with methods for route handling.
RouteUtil() - Constructor for class com.vaadin.flow.router.internal.RouteUtil
 
RPC_ATTACH_ASSIGNED_ID - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold assigned state node identifier for attach existing element request.
RPC_ATTACH_EXISTING_ELEMENT - Static variable in class com.vaadin.flow.shared.JsonConstants
Type value for attach existing element server callback.
RPC_ATTACH_EXISTING_ELEMENT_BY_ID - Static variable in class com.vaadin.flow.shared.JsonConstants
Type value for attach existing element server callback.
RPC_ATTACH_ID - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold id of the element for attach existing element request.
RPC_ATTACH_INDEX - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold index of server side element for attach existing element request.
RPC_ATTACH_REQUESTED_ID - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold requested state node identifier for attach existing element request.
RPC_ATTACH_TAG_NAME - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold tag name for attach existing element request.
RPC_CHANNEL - Static variable in class com.vaadin.flow.shared.JsonConstants
Key for the channel id in return channel messages.
RPC_CHANNEL_ARGUMENTS - Static variable in class com.vaadin.flow.shared.JsonConstants
Key for the arguments array in return channel messages.
RPC_EVENT_DATA - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the event data in event messages sent from the client.
RPC_EVENT_TYPE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the event type in event messages sent from the client.
RPC_FEATURE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the feature id when synchronizing node values.
RPC_INVOCATIONS - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the parameter used to transmit RPC invocations.
RPC_NAVIGATION_LOCATION - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the location in a navigation message.
RPC_NAVIGATION_ROUTERLINK - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used in navigation messages triggered by a router link.
RPC_NAVIGATION_STATE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the state in a navigation message.
RPC_NODE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the node in messages sent from the client.
RPC_PROMISE_CALLBACK_NAME - Static variable in class com.vaadin.flow.shared.JsonConstants
Name of the $server property that is used to track pending promises.
RPC_PROPERTY - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the name of the synchronized property.
RPC_PROPERTY_VALUE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the value of the synchronized property.
RPC_PUBLISHED_SERVER_EVENT_HANDLER - Static variable in class com.vaadin.flow.shared.JsonConstants
Type value for events sent from the client to an event handler published on the server.
RPC_TEMPLATE_EVENT_ARGS - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the argument values for server side method call.
RPC_TEMPLATE_EVENT_METHOD_NAME - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the server side method name in template event messages sent from the client.
RPC_TEMPLATE_EVENT_PROMISE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used to hold the promise id for a server side method call.
RPC_TYPE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the type in of messages sent from the client.
RPC_TYPE_CHANNEL - Static variable in class com.vaadin.flow.shared.JsonConstants
RPC type value used for return channel messages.
RPC_TYPE_EVENT - Static variable in class com.vaadin.flow.shared.JsonConstants
Type value for events sent from the client.
RPC_TYPE_MAP_SYNC - Static variable in class com.vaadin.flow.shared.JsonConstants
Type value for model map synchronizations sent from the client.
RPC_TYPE_NAVIGATION - Static variable in class com.vaadin.flow.shared.JsonConstants
Type value for navigation events from the client.
RpcDecodeException - Exception in com.vaadin.flow.server.communication.rpc
Thrown if RPC method argument cannot be decoded to the required type.
RpcDecodeException(String) - Constructor for exception com.vaadin.flow.server.communication.rpc.RpcDecodeException
Creates a new instance with the given message.
RpcDecodeException(Throwable) - Constructor for exception com.vaadin.flow.server.communication.rpc.RpcDecodeException
Creates a new instance with the given cause.
RpcDecoder - Interface in com.vaadin.flow.server.communication.rpc
Decoder of RPC method arguments (server-side methods invoked from the client-side).
RpcInvocationHandler - Interface in com.vaadin.flow.server.communication.rpc
RPC invocation handler interface.
RpcRequest(String, VaadinRequest) - Constructor for class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Creates an instance based on the given JSON received through the given request.
run() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
RUN_IN - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
runExecutionsBeforeClientResponse() - Method in class com.vaadin.flow.internal.StateTree
Called internally by the framework before the response is sent to the client.
runOnce() - Method in interface com.vaadin.flow.di.OneTimeInitializerPredicate
Checks whether the ServletContainerInitializers requires reset to the previous state on ServletContainerInitializer.onStartup(java.util.Set, jakarta.servlet.ServletContext) call.
runPendingAccessTasks(VaadinSession) - Method in class com.vaadin.flow.server.VaadinService
Purges the queue of pending access invocations enqueued with VaadinSession.access(Command).
runWhenAttached(SerializableConsumer<UI>) - Method in class com.vaadin.flow.internal.StateNode
Runs the command when the node is attached to a UI.

S

sameLocation() - Static method in class com.vaadin.flow.router.HighlightConditions
Highlight if the navigation path is the same as the target RouterLink.
SAVE - Static variable in interface com.vaadin.flow.component.Key
Saves the current document or message.
SCAN_CHANNELS_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles the channel scan mode on and off; this is a mode which flips through channels automatically until the user stops the scan.
SCREEN_MODE_NEXT - Static variable in interface com.vaadin.flow.component.Key
Cycles through the available screen display modes.
SCRIPT_TEMPLATE_FOR_STYLESHEET_LINK_TAG - Static variable in class com.vaadin.flow.server.BootstrapHandler
 
SCROLL - Enum constant in enum class com.vaadin.flow.dom.Style.Overflow
 
SCROLL_LOCK - Static variable in interface com.vaadin.flow.component.Key
The Scroll Lock key.
scrollIntoView() - Method in class com.vaadin.flow.component.Component
Scrolls the current component into the visible area of the browser window.
scrollIntoView() - Method in class com.vaadin.flow.dom.Element
Executes the similarly named DOM method on the client side.
scrollIntoView(ScrollOptions) - Method in class com.vaadin.flow.component.Component
Scrolls the current component into the visible area of the browser window.
scrollIntoView(ScrollOptions) - Method in class com.vaadin.flow.dom.Element
Executes the similarly named DOM method on the client side.
ScrollOptions - Class in com.vaadin.flow.component
Options for scrollIntoView.
ScrollOptions() - Constructor for class com.vaadin.flow.component.ScrollOptions
Create an instance with the default options.
ScrollOptions(ScrollOptions.Behavior) - Constructor for class com.vaadin.flow.component.ScrollOptions
Create an instance with the given scroll behavior.
ScrollOptions(ScrollOptions.Behavior, ScrollOptions.Alignment, ScrollOptions.Alignment) - Constructor for class com.vaadin.flow.component.ScrollOptions
Create an instance with the given scroll options.
ScrollOptions.Alignment - Enum Class in com.vaadin.flow.component
Alignment for scrollIntoView.
ScrollOptions.Behavior - Enum Class in com.vaadin.flow.component
Scroll behavior for scrollIntoView.
searchByCause(Exception) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
Get the exception handler for given exception or recurse by exception cause until possible exception with handler found.
searchBySuperType(Throwable) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
Search given exception super classes to get exception handler for if any exist.
SECOND_DELAY_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
SECOND_DELAY_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
SECTION - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <section>.
SEE_OTHER - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (303) indicating that the response to the request can be found under a different URI.
SEEN_SERVER_SYNC_ID - Static variable in class com.vaadin.flow.server.communication.LongPollingCacheFilter
 
SELECT - Static variable in interface com.vaadin.flow.component.Key
The Select key.
SELECT - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <select>.
SEMICOLON - Static variable in interface com.vaadin.flow.component.Key
;: on a US keyboard.
sendError(int, String) - Method in interface com.vaadin.flow.server.VaadinResponse
Sends an error response to the client using the specified status code and clears the buffer.
sendMessage(String) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Sends the given message to the current client.
sendUploadResponse(VaadinResponse, boolean) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
Build response for handled download.
SEPARATOR - Static variable in interface com.vaadin.flow.component.Key
The numeric keypad's places separator character (in the United States, this is a comma, but elsewhere it is frequently a period).
SerializableBiConsumer<T,U> - Interface in com.vaadin.flow.function
A BiConsumer that is also Serializable.
SerializableBiFunction<T,U,R> - Interface in com.vaadin.flow.function
A BiFunction that is also Serializable.
SerializableBiPredicate<T,U> - Interface in com.vaadin.flow.function
A BiPredicate that is also Serializable.
SerializableComparator<T> - Interface in com.vaadin.flow.function
A Comparator that is also Serializable.
SerializableConsumer<T> - Interface in com.vaadin.flow.function
A Consumer that is also Serializable.
SerializableEventListener - Interface in com.vaadin.flow.function
Event listener interface that is serializable.
SerializableFunction<T,R> - Interface in com.vaadin.flow.function
A Function that is also Serializable.
SerializableNodeList<T extends Serializable> - Class in com.vaadin.flow.internal.nodefeature
A list which contains Serializable values but not StateNodes.
SerializableNodeList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.SerializableNodeList
Creates a new list for the given node.
SerializablePredicate<T> - Interface in com.vaadin.flow.function
A Predicate that is also Serializable.
SerializableRunnable - Interface in com.vaadin.flow.function
A Runnable that is also Serializable.
SerializableSupplier<T> - Interface in com.vaadin.flow.function
A Supplier that is also Serializable.
SerializableTriConsumer<T,U,V> - Interface in com.vaadin.flow.function
Like SerializableBiConsumer, but with three arguments.
serveDevModeRequest(HttpServletRequest, HttpServletResponse) - Method in interface com.vaadin.flow.internal.DevModeHandler
Serve a file by proxying to the dev server.
SERVER_SYNC_ID - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the parameter used to transmit the sync id.
ServerRpcHandler - Class in com.vaadin.flow.server.communication
Handles a client-to-server message containing serialized RPC invocations.
ServerRpcHandler() - Constructor for class com.vaadin.flow.server.communication.ServerRpcHandler
 
ServerRpcHandler.InvalidUIDLSecurityKeyException - Exception in com.vaadin.flow.server.communication
Exception thrown then the security key sent by the client does not match the expected one.
ServerRpcHandler.ResynchronizationRequiredException - Exception in com.vaadin.flow.server.communication
Exception thrown then the client side resynchronization is required.
ServerRpcHandler.RpcRequest - Class in com.vaadin.flow.server.communication
A data transfer object representing an RPC request sent by the client side.
ServerSideFeature - Class in com.vaadin.flow.internal.nodefeature
Abstract node feature that is only present on the server.
ServerSideFeature(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ServerSideFeature
Creates a new feature for the given node.
serveStaticOrWebJarRequest(HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.server.VaadinServlet
Handles a request by serving a static file from Webpack when in npm-dev-mode, or from a WebJar when in bower-dev-mode or from the file-system when in production.
serveStaticResource(HttpServletRequest, HttpServletResponse) - Method in interface com.vaadin.flow.server.StaticFileHandler
Serves a static resource for the requested path if a resource can be found.
serveStaticResource(HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.server.StaticFileServer
 
service(HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.server.VaadinServlet
Receives standard HTTP requests from the public service method and dispatches them.
SERVICE_UNAVAILABLE - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request.
SERVICE_URL - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The URL which should be used to connect server-side VaadinService.
SERVICE_WORKER_HEADER - Static variable in class com.vaadin.flow.server.BootstrapHandler
 
SERVICE_WORKER_SRC - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The name of the service worker source file for InjectManifest method of the workbox plugin.
SERVICE_WORKER_SRC_JS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The JavaScript version of the service worker file, for checking if a user has a JavaScript version of a custom service worker file already.
ServiceContextUriResolver - Class in com.vaadin.flow.server
A URI resolver which resolves paths for loading through VaadinService resource methods.
ServiceContextUriResolver() - Constructor for class com.vaadin.flow.server.ServiceContextUriResolver
 
serviceDestroy(ServiceDestroyEvent) - Method in interface com.vaadin.flow.server.ServiceDestroyListener
Invoked when a service is destroyed.
ServiceDestroyEvent - Class in com.vaadin.flow.server
Event fired to ServiceDestroyListener when a VaadinService is being destroyed.
ServiceDestroyEvent(VaadinService) - Constructor for class com.vaadin.flow.server.ServiceDestroyEvent
Creates a new event for the given service.
ServiceDestroyListener - Interface in com.vaadin.flow.server
Listener that gets notified when the VaadinService to which it has been registered is destroyed.
ServiceException - Exception in com.vaadin.flow.server
Thrown for problems which occur in the VaadinService layer.
ServiceException(String) - Constructor for exception com.vaadin.flow.server.ServiceException
Creates an exception which contains the given message.
ServiceException(String, Throwable) - Constructor for exception com.vaadin.flow.server.ServiceException
Creates an exception which wraps the given throwable and contains the given message.
ServiceException(Throwable) - Constructor for exception com.vaadin.flow.server.ServiceException
Creates an exception which wraps the given throwable.
serviceInit(ServiceInitEvent) - Method in interface com.vaadin.flow.server.VaadinServiceInitListener
Run when a VaadinService instance is initialized.
ServiceInitEvent - Class in com.vaadin.flow.server
Event fired to VaadinServiceInitListener when a VaadinService is being initialized.
ServiceInitEvent(VaadinService) - Constructor for class com.vaadin.flow.server.ServiceInitEvent
Creates a new service init event for a given VaadinService and the RequestHandler that will be used by the service.
serviceMap - Variable in class com.vaadin.flow.di.LookupInitializer.LookupImpl
 
SERVLET_PARAMETER_BROTLI - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for the parameter that determines whether Brotli compression should be used for static resources in cases when a precompressed file is available.
SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_DEVMODE_ENABLE_DEV_TOOLS - Static variable in class com.vaadin.flow.server.InitParameters
Configuration parameter name for enabling dev tools.
SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD - Static variable in class com.vaadin.flow.server.InitParameters
Configuration parameter name for enabling live reload.
SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE - Static variable in class com.vaadin.flow.server.InitParameters
Boolean parameter for enabling/disabling bytecode scanning in dev mode.
SERVLET_PARAMETER_DEVMODE_STATISTICS - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_DEVMODE_TIMEOUT - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for the time waiting for the frontend build tool to output a success or error pattern.
SERVLET_PARAMETER_DEVMODE_VITE_OPTIONS - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for adding extra options to the vite.
SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_ENABLE_DEV_SERVER - Static variable in class com.vaadin.flow.server.InitParameters
Deprecated.
SERVLET_PARAMETER_ENABLE_PNPM - Static variable in class com.vaadin.flow.server.InitParameters
Configuration parameter name for enabling pnpm.
SERVLET_PARAMETER_GLOBAL_PNPM - Static variable in class com.vaadin.flow.server.InitParameters
Configuration parameter name for using globally installed pnpm or default one.
SERVLET_PARAMETER_HEARTBEAT_INTERVAL - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_INITIAL_UIDL - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_JSBUNDLE - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_POLYFILLS - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_PRODUCTION_MODE - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_PUSH_MODE - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_PUSH_SERVLET_MAPPING - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_REQUEST_TIMING - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_REUSE_DEV_SERVER - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_STATISTICS_JSON - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for the frontend statistics json file to use to determine template contents.
SERVLET_PARAMETER_SYNC_ID_CHECK - Static variable in class com.vaadin.flow.server.InitParameters
 
SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT - Static variable in class com.vaadin.flow.server.InitParameters
 
ServletContextListeners - Class in com.vaadin.flow.server.startup
All ServletContextListeners in Flow merged into one actual listener to be able to control the order they are executed in.
ServletContextListeners() - Constructor for class com.vaadin.flow.server.startup.ServletContextListeners
 
ServletDeployer - Class in com.vaadin.flow.server.startup
Context listener that automatically registers Vaadin servlets.
ServletDeployer() - Constructor for class com.vaadin.flow.server.startup.ServletDeployer
 
servletInitialized() - Method in class com.vaadin.flow.server.VaadinServlet
 
SESSION_STORED_REDIRECT - Static variable in class com.vaadin.flow.server.auth.ViewAccessChecker
 
SESSION_STORED_REDIRECT_ABSOLUTE - Static variable in class com.vaadin.flow.server.auth.ViewAccessChecker
 
sessionDestroy(SessionDestroyEvent) - Method in interface com.vaadin.flow.server.SessionDestroyListener
Called when a Vaadin service session is no longer used.
SessionDestroyEvent - Class in com.vaadin.flow.server
Event fired when a Vaadin service session is no longer in use.
SessionDestroyEvent(VaadinService, VaadinSession) - Constructor for class com.vaadin.flow.server.SessionDestroyEvent
Creates a new event.
SessionDestroyListener - Interface in com.vaadin.flow.server
A listener that gets notified when a Vaadin service session is no longer used.
sessionExpiredCaption - Variable in class com.vaadin.flow.server.SystemMessages
 
SessionExpiredException - Exception in com.vaadin.flow.server
Exception indicating that the session has expired.
SessionExpiredException() - Constructor for exception com.vaadin.flow.server.SessionExpiredException
 
SessionExpiredHandler - Interface in com.vaadin.flow.server
A specialized RequestHandler which is capable of sending session expiration messages to the user.
sessionExpiredMessage - Variable in class com.vaadin.flow.server.SystemMessages
 
sessionExpiredNotificationEnabled - Variable in class com.vaadin.flow.server.SystemMessages
 
sessionExpiredURL - Variable in class com.vaadin.flow.server.SystemMessages
 
sessionInit(SessionInitEvent) - Method in interface com.vaadin.flow.server.SessionInitListener
Invoked when a new Vaadin service session is initialized for that service.
SessionInitEvent - Class in com.vaadin.flow.server
Event gets fired when a new Vaadin service session is initialized for a Vaadin service.
SessionInitEvent(VaadinService, VaadinSession, VaadinRequest) - Constructor for class com.vaadin.flow.server.SessionInitEvent
Creates a new event.
SessionInitListener - Interface in com.vaadin.flow.server
Event listener that can be registered to a VaadinService to get an event when a new Vaadin service session is initialized for that service.
SessionRequestHandler - Class in com.vaadin.flow.server.communication
Handles a request by passing it to each registered RequestHandler in the session in turn until one produces a response.
SessionRequestHandler() - Constructor for class com.vaadin.flow.server.communication.SessionRequestHandler
 
SessionRouteRegistry - Class in com.vaadin.flow.server
SessionRouteRegistry is a mutable route registry that is valid in the scope of VaadinSession.
set(HasElement, S) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Sets the property value for the given component.
set(PropertyDescriptor<T, ?>, T) - Method in class com.vaadin.flow.component.Component
Sets the value of the given component property.
set(PropertyDescriptor<T, ?>, T) - Method in class com.vaadin.flow.component.Text
 
set(Element, S) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Sets the property value for the given element.
set(Class<T>, T) - Static method in class com.vaadin.flow.internal.CurrentInstance
Sets the current instance of the given type.
set(String, boolean) - Method in interface com.vaadin.flow.dom.ClassList
Sets or removes the given class name, based on the set parameter.
set(String, boolean) - Method in interface com.vaadin.flow.dom.ThemeList
Sets or removes the given theme name, based on the set parameter.
set(String, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
set(String, String) - Method in class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
set(String, String) - Method in interface com.vaadin.flow.dom.Style
Sets the given style property to the given value.
set(String, String) - Method in class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Sets the given attribute to the given value.
setActiveDragSourceComponent(Component) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the drag source of an active HTML5 drag event.
setAlternativeDirGetter(SerializableSupplier<String>) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Set the installation directory if no tools are found.
setAnnotatedRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
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.
setApplyDefaultTheme(boolean) - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Sets whether the default theming is applied for the loading indicator.
setApplyDefaultTheme(boolean) - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
setAppShellTitle(String) - Method in class com.vaadin.flow.component.internal.UIInternals
Records the text content of the title tag in the application shell.
setAriaLabel(String) - Method in interface com.vaadin.flow.component.HasAriaLabel
Set the aria-label of the component to the given text.
setAriaLabelledBy(String) - Method in interface com.vaadin.flow.component.HasAriaLabel
Set the aria-labelledby of the component.
setAttribute(Element, String) - Method in class com.vaadin.flow.dom.impl.ClassAttributeHandler
 
setAttribute(Element, String) - Method in class com.vaadin.flow.dom.impl.CustomAttribute
Sets the value when Element.setAttribute(String, String) is called for this attribute.
setAttribute(Element, String) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
setAttribute(StateNode, String, AbstractStreamResource) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Sets the given attribute to the given StreamResource value.
setAttribute(StateNode, String, AbstractStreamResource) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
setAttribute(StateNode, String, AbstractStreamResource) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
setAttribute(StateNode, String, AbstractStreamResource) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
setAttribute(StateNode, String, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Sets the given attribute to the given value.
setAttribute(StateNode, String, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
setAttribute(StateNode, String, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
setAttribute(StateNode, String, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
setAttribute(Class<T>, T) - Method in class com.vaadin.flow.server.Attributes
Stores a value in this set.
setAttribute(Class<T>, T) - Method in interface com.vaadin.flow.server.VaadinContext
Sets the attribute value for the give type, overriding previously existing one.
setAttribute(Class<T>, T) - Method in class com.vaadin.flow.server.VaadinServletContext
 
setAttribute(Class<T>, T) - Method in class com.vaadin.flow.server.VaadinSession
Stores a value in this service session.
setAttribute(Object) - Method in interface com.vaadin.flow.server.VaadinContext
Sets the attribute value, overriding previously existing one.
setAttribute(String, boolean) - Method in class com.vaadin.flow.dom.Element
Sets the given attribute to the given boolean value.
setAttribute(String, AbstractStreamResource) - Method in class com.vaadin.flow.dom.Element
Sets the given attribute to the given StreamResource value.
setAttribute(String, Object) - Method in class com.vaadin.flow.server.Attributes
Stores a value in this set.
setAttribute(String, Object) - Method in interface com.vaadin.flow.server.VaadinRequest
Defines a request attribute.
setAttribute(String, Object) - Method in class com.vaadin.flow.server.VaadinSession
Stores a value in this service session.
setAttribute(String, Object) - Method in class com.vaadin.flow.server.WrappedHttpSession
 
setAttribute(String, Object) - Method in interface com.vaadin.flow.server.WrappedSession
Saves an attribute value in this session.
setAttribute(String, String) - Method in class com.vaadin.flow.dom.Element
Sets the given attribute to the given value.
setAutoUpdate(boolean) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
When set to true the alternative version is updated to the latest default node version as defined for the framework.
setBackend(BrowserLiveReload.Backend) - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Sets the live reload backend technology explicitly.
setBackground(String) - Method in interface com.vaadin.flow.dom.Style
Sets the background property.
setBaseDir(String) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Set the base directory for locating tools.
setBehavior(ScrollOptions.Behavior) - Method in class com.vaadin.flow.component.ScrollOptions
Sets the scroll behavior.
setBlock(ScrollOptions.Alignment) - Method in class com.vaadin.flow.component.ScrollOptions
Sets the vertical alignment.
setBodySize(String, String) - Method in class com.vaadin.flow.server.AppShellSettings
Set the body size.
setBootstrapInitialPredicate(BootstrapInitialPredicate) - Method in class com.vaadin.flow.server.VaadinService
Set the predicate that decides whether to include the initial Uidl fragment in the bootstrap page.
setBootstrapUrlPredicate(BootstrapUrlPredicate) - Method in class com.vaadin.flow.server.VaadinService
Set the predicate that decides whether the request has a valid URL for rendering the bootstrap page.
setBorder(String) - Method in interface com.vaadin.flow.dom.Style
Sets the border property.
setBottom(String) - Method in interface com.vaadin.flow.dom.Style
Sets the bottom property.
setBoxShadow(String) - Method in interface com.vaadin.flow.dom.Style
Sets the box-shadow property.
setBoxSizing(Style.BoxSizing) - Method in interface com.vaadin.flow.dom.Style
Sets the box-sizing property.
setBrowser(WebBrowser) - Method in class com.vaadin.flow.server.VaadinSession
Set the web browser associated with this session.
setBrowserDefaultAllowed(boolean) - Method in class com.vaadin.flow.component.ShortcutRegistration
Set whether the default key behavior is allowed in the browser.
setCacheEnabled(boolean) - Method in class com.vaadin.flow.server.communication.WebComponentProvider
Enable / disable bootstrap HTML fragment caching based on component tag.
setCacheTime(long) - Method in class com.vaadin.flow.server.AbstractStreamResource
Set cache time in millis.
setCacheTime(long) - Method in interface com.vaadin.flow.server.VaadinResponse
Sets cache time in milliseconds, -1 means no cache at all.
setCacheTime(long) - Method in class com.vaadin.flow.server.VaadinServletResponse
 
setChild(int, Element) - Method in class com.vaadin.flow.dom.Node
Replaces the child at the given position with the given child element.
setChildComponentModal(Component, boolean) - Method in class com.vaadin.flow.component.UI
Makes the child component modal or modeless.
setChildModal(Component) - Method in class com.vaadin.flow.component.internal.UIInternals
Makes an existing child component modal.
setChildModeless(Component) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the given child modeless.
setClassLoader(ClassLoader) - Method in class com.vaadin.flow.server.VaadinService
Sets the class loader to use for loading classes loaded by name, e.g.
setClassName(String) - Method in interface com.vaadin.flow.component.HasStyle
Sets the CSS class names of this component.
setClassName(String, boolean) - Method in interface com.vaadin.flow.component.HasStyle
Sets or removes the given class name for this component.
setClear(Style.Clear) - Method in interface com.vaadin.flow.dom.Style
Sets the clear property.
setColor(String) - Method in interface com.vaadin.flow.dom.Style
Sets the color property.
setComponent(Component) - Method in class com.vaadin.flow.internal.nodefeature.ComponentMapping
Assigns the given component to this node.
setComponent(Element, Component) - Static method in class com.vaadin.flow.dom.ElementUtil
Defines a mapping between this element and the given Component.
setComponent(StateNode, Component) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Defines a mapping between the element and the given component.
setConfiguration(DeploymentConfiguration) - Method in class com.vaadin.flow.server.VaadinSession
 
setConfigurations(Set<WebComponentConfiguration<? extends Component>>) - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Registers all available web component configurations to the registry.
setContentLength(int) - Method in interface com.vaadin.flow.server.VaadinResponse
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
setContentType(String) - Method in class com.vaadin.flow.server.StreamResource
Set content type for the resource.
setContentType(String) - Method in interface com.vaadin.flow.server.VaadinResponse
Sets the content type of this response.
setContentTypeResolver(ContentTypeResolver) - Method in class com.vaadin.flow.server.StreamResource
Sets the resolver which is used to lookup the content type of the resource.
setContextRoot(String) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the relative path from the UI (servlet) path to the context root.
setContinueNavigationAction(BeforeLeaveEvent.ContinueNavigationAction) - Method in class com.vaadin.flow.component.internal.UIInternals
Set a BeforeLeaveEvent.ContinueNavigationAction or null to clear existing action.
setCookiesDisabledCaption(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the caption to show in an "cookies disabled" notification.
setCookiesDisabledMessage(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the message to show in a "cookies disabled" notification.
setCookiesDisabledNotificationEnabled(boolean) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets whether a "cookies disabled" notification should be shown to the end user.
setCookiesDisabledURL(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the URL the user will be redirected to after dismissing a "cookies disabled" message.
setCurrent(UI) - Static method in class com.vaadin.flow.component.UI
Sets the thread local for the current UI.
setCurrent(UI) - Static method in class com.vaadin.flow.internal.CurrentInstance
Sets current instances for the UI and all related classes.
setCurrent(VaadinService) - Static method in class com.vaadin.flow.server.VaadinService
Sets the given Vaadin service as the current service.
setCurrent(VaadinSession) - Static method in class com.vaadin.flow.internal.CurrentInstance
Sets current instances for the VaadinSession and all related classes.
setCurrent(VaadinSession) - Static method in class com.vaadin.flow.server.VaadinSession
Sets the thread local for the current session.
setCurrentInstances(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.VaadinService
Sets the this Vaadin service as the current service and also sets the current Vaadin request and Vaadin response.
setCursor(String) - Method in interface com.vaadin.flow.dom.Style
Sets the cursor property.
setData(Component, Class<T>, T) - Static method in class com.vaadin.flow.component.ComponentUtil
Stores an instance of a specific type for the given component.
setData(Component, String, Object) - Static method in class com.vaadin.flow.component.ComponentUtil
Stores a arbitrary value for the given component.
setDataExpressions(Class<? extends ComponentEvent<?>>, LinkedHashMap<String, Class<?>>) - Method in class com.vaadin.flow.component.internal.EventDataCache
Stores the given data expressions for the given event type in the cache.
setDateHeader(String, long) - Method in interface com.vaadin.flow.server.VaadinResponse
Properly formats a timestamp as a date header.
setDefaultClassLoader() - Method in class com.vaadin.flow.server.VaadinService
Tries to acquire default class loader and sets it as a class loader for this VaadinService if found.
setDefaultClassLoader() - Method in class com.vaadin.flow.server.VaadinServletService
 
setDependencyTriggers(List<String>) - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
 
setDevModeHandler(DevModeHandler) - Method in interface com.vaadin.flow.internal.DevModeHandlerManager
Defines the handler to use with this manager.
setDevModePropertiesUsingTokenData(Map<String, String>, JsonObject) - Method in class com.vaadin.flow.server.startup.AbstractConfigurationFactory
Sets to the dev mode properties to the configuration parameters.
setDialogText(String) - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Sets the text to show in the reconnect dialog when trying to re-establish the server connection.
setDialogText(String) - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
setDialogTextGaveUp(String) - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Sets the text to show in the reconnect dialog after giving up trying to reconnect (ReconnectDialogConfiguration.getReconnectAttempts() reached).
setDialogTextGaveUp(String) - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
setDirection(Direction) - Method in class com.vaadin.flow.component.UI
Sets the direction for the UI.
setDisabledUpdateMode(DisabledUpdateMode) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Configure whether this listener will be called even in cases when the element is disabled.
setDisabledUpdateMode(DisabledUpdateMode) - Method in interface com.vaadin.flow.internal.nodefeature.ReturnChannelRegistration
Sets whether this channel will receive updates in case the state node is disabled.
setDisplay(Style.Display) - Method in interface com.vaadin.flow.dom.Style
Sets the display property.
setElement(Component, Element) - Static method in class com.vaadin.flow.component.Component
Initializes the root element of a component.
setEnabled(boolean) - Method in class com.vaadin.experimental.Feature
 
setEnabled(boolean) - Method in interface com.vaadin.flow.component.HasEnabled
Sets the UI object explicitly disabled or enabled.
setEnabled(boolean) - Method in class com.vaadin.flow.dom.Element
Sets the enabled state of the element.
setEnabled(boolean) - Method in class com.vaadin.flow.internal.StateNode
Enables/disables the node.
setEnabled(String, boolean) - Method in class com.vaadin.experimental.FeatureFlags
Enables or disables the given feature.
setErrorHandler(ErrorHandler) - Method in class com.vaadin.flow.server.VaadinSession
Sets the session error handler.
setErrorMessage(String) - Method in interface com.vaadin.flow.component.HasValidation
Sets an error message to the component.
setErrorNavigationTargets(Set<Class<? extends Component>>) - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Set error handler navigation targets.
setErrorParameter(BeforeEnterEvent, ErrorParameter<NotFoundException>) - Method in class com.vaadin.flow.router.RouteNotFoundError
 
setErrorParameter(BeforeEnterEvent, ErrorParameter<Exception>) - Method in class com.vaadin.flow.router.InternalServerError
 
setErrorParameter(BeforeEnterEvent, ErrorParameter<T>) - Method in interface com.vaadin.flow.router.HasErrorParameter
Callback executed before rendering the exception view.
setErrorRoute(Class<? extends Exception>, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Set a error route to the configuration.
setEventConstructor(Class<T>, Constructor<T>) - Method in class com.vaadin.flow.component.internal.EventDataCache
Stores the given DOM event constructor for the given event type in the cache.
setEventPropagationAllowed(boolean) - Method in class com.vaadin.flow.component.ShortcutRegistration
Set whether shortcut's keydown event is allowed to propagate up the DOM tree in the browser.
setExtendedClientDetails(ExtendedClientDetails) - Method in class com.vaadin.flow.component.internal.UIInternals
Updates the extended client details.
setFallbackTransport(Transport) - Method in interface com.vaadin.flow.component.PushConfiguration
Sets the fallback transport type for push.
setFallbackTransport(Transport) - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
setFileCountMax(long) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
 
setFileSizeMax(long) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
 
setFilter(String) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Sets a JavaScript expression that is used for filtering events to this listener.
setFirstDelay(int) - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Sets the delay before the loading indicator is shown.
setFirstDelay(int) - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
setFloat(Style.FloatCss) - Method in interface com.vaadin.flow.dom.Style
Sets the float property.
setFont(String) - Method in interface com.vaadin.flow.dom.Style
Sets the font property.
setForceAlternativeNode(boolean) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Set if the alternative folder should always be used even if a global installation exists.
setFullAppId(String) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the application id tied with this UI.
setHeader(String, String) - Method in class com.vaadin.flow.server.StreamResource
Sets the value of a generic response header.
setHeader(String, String) - Method in interface com.vaadin.flow.server.VaadinResponse
Sets the value of a generic response header.
setHeight(float, Unit) - Method in interface com.vaadin.flow.component.HasSize
Sets the height of the component.
setHeight(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the height of the component.
setHeight(String) - Method in interface com.vaadin.flow.dom.Style
Sets the height property.
setHeightFull() - Method in interface com.vaadin.flow.component.HasSize
Sets the height of the component to "100%".
setHelperComponent(Component) - Method in interface com.vaadin.flow.component.HasHelper
Adds the given component into helper slot of component, replacing any existing helper component.
setHelperText(String) - Method in interface com.vaadin.flow.component.HasHelper
String used for the helper text.
setHighlightAction(HighlightAction<RouterLink>) - Method in class com.vaadin.flow.router.RouterLink
Sets the HighlightAction of this link, which will be performed with the evaluation of this link's HighlightCondition.
setHighlightCondition(HighlightCondition<RouterLink>) - Method in class com.vaadin.flow.router.RouterLink
Sets the HighlightCondition of this link, which determines if the link should be highlighted when a AfterNavigationEvent occurs.
setHistoryStateChangeHandler(History.HistoryStateChangeHandler) - Method in class com.vaadin.flow.component.page.History
Sets a handler that will be notified when the history state has changed.
setHtmlContent(String) - Method in class com.vaadin.flow.component.Html
Sets the content based on the given HTML fragment.
setId(String) - Method in class com.vaadin.flow.component.Component
Sets the id of the root element of this component.
setId(String) - Method in class com.vaadin.flow.component.Text
The method is not supported for the Text class.
setIgnoreParentInert(boolean) - Method in class com.vaadin.flow.internal.nodefeature.InertData
Sets whether or not the node should ignore parent's inert state or not.
setIgnoreParentInert(Element, boolean) - Static method in class com.vaadin.flow.dom.ElementUtil
Sets whether or not the element should inherit or not inherit its parent's inert state.
setIgnoreVersionChecks(boolean) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Set if node and npm versions should be checked or not.
setImage(BufferedImage) - Method in class com.vaadin.flow.server.PwaIcon
Sets the image presenting the icon.
setIndex(int) - Method in class com.vaadin.flow.internal.change.AbstractListChange
Sets the index of this change in the change list.
setInert(Element, boolean) - Static method in class com.vaadin.flow.dom.ElementUtil
Sets whether or not the given element is inert.
setInertSelf(boolean) - Method in class com.vaadin.flow.internal.nodefeature.InertData
Sets whether the node itself is inert.
setInitTheme(boolean) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Set if custom theme should be initialized.
setInline(ScrollOptions.Alignment) - Method in class com.vaadin.flow.component.ScrollOptions
Sets the horizontal alignment.
setInternalErrorCaption(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the caption to show in an "internal error" notification.
setInternalErrorMessage(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the message to show in an "internal error" notification.
setInternalErrorNotificationEnabled(boolean) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets whether an "internal error" notification should be shown to the end user.
setInternalErrorURL(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the URL the user will be redirected to after dismissing an "internal error" message.
setInvalid(boolean) - Method in interface com.vaadin.flow.component.HasValidation
Sets the validity of the component input.
setJavaFieldValue(Object, Field, Object) - Static method in class com.vaadin.flow.internal.ReflectTools
Sets the value of a java field.
setJavaResourceFolder(File) - Method in class com.vaadin.flow.server.frontend.Options
Set the java resources folder to be checked for feature file.
setLabel(String) - Method in interface com.vaadin.flow.component.HasLabel
Set the label of the component to the given text.
setLastHandledNavigation(Location) - Method in class com.vaadin.flow.component.internal.UIInternals
Set the latest navigation location for active navigation.
setLastHeartbeatTimestamp(long) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the last heartbeat request timestamp for the related UI.
setLastProcessedClientToServerId(int, byte[]) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the last processed server message id.
setLastRequestDuration(long) - Method in class com.vaadin.flow.server.VaadinSession
Sets the time spent servicing the last request in the session and updates the total time spent servicing requests in this session.
setLastRequestTimestamp(long) - Method in class com.vaadin.flow.server.VaadinSession
Sets the time when the last UIDL request was serviced in this session.
setLeft(String) - Method in interface com.vaadin.flow.dom.Style
Sets the left property.
setLocale(Locale) - Method in class com.vaadin.flow.component.UI
Sets the locale for this UI.
setLocale(Locale) - Method in class com.vaadin.flow.server.VaadinSession
Sets the default locale for this session.
setLocation(String) - Method in class com.vaadin.flow.component.page.Page
Navigates this page to the given URI.
setLocation(URI) - Method in class com.vaadin.flow.component.page.Page
Navigates this page to the given URI.
setLoginView(Class<? extends Component>) - Method in class com.vaadin.flow.server.auth.ViewAccessChecker
Sets the Flow login view to use.
setLoginView(String) - Method in class com.vaadin.flow.server.auth.ViewAccessChecker
Sets the frontend login view to use.
setLongPollingSuspendTimeout(int) - Method in class com.vaadin.flow.server.communication.PushHandler
Sets the timeout used for suspend calls when using long polling.
setMargin(String) - Method in interface com.vaadin.flow.dom.Style
Sets the margin property.
setMaxHeight(float, Unit) - Method in interface com.vaadin.flow.component.HasSize
Sets the max-height of the component.
setMaxHeight(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the max-height of the component.
setMaxInactiveInterval(int) - Method in class com.vaadin.flow.server.WrappedHttpSession
 
setMaxInactiveInterval(int) - Method in interface com.vaadin.flow.server.WrappedSession
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
setMaxWidth(float, Unit) - Method in interface com.vaadin.flow.component.HasSize
Sets the max-width of the component.
setMaxWidth(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the max-width of the component.
setMinHeight(float, Unit) - Method in interface com.vaadin.flow.component.HasSize
Sets the min-height of the component.
setMinHeight(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the min-height of the component.
setMinWidth(float, Unit) - Method in interface com.vaadin.flow.component.HasSize
Sets the min-width of the component.
setMinWidth(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the min-width of the component.
setModelValue(T, boolean) - Method in class com.vaadin.flow.component.AbstractCompositeField
Updates the model value if the value has actually changed.
setModelValue(T, boolean) - Method in class com.vaadin.flow.component.AbstractField
Updates the model value if the value has actually changed.
setModelValue(T, boolean) - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
Delegate method corresponding to AbstractField.setModelValue(Object, boolean).
setNavigationTarget(Class<? extends Component>) - Method in class com.vaadin.flow.router.NavigationState
Sets the navigation target of this state.
setNoCacheHeaders() - Method in interface com.vaadin.flow.server.VaadinResponse
Sets all conceivable headers that might prevent a response from being stored in any caches.
setNodeAutoUpdate(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether it is fine to automatically update the alternate node installation if installed version is older than the current default.
setNodeDownloadRoot(URI) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Set the root URI for downloading node.
setNodeDownloadRoot(URI) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
Set a custom download root.
setNodeVersion(String) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Set the node version to install when installation is required.
setNodeVersion(String) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
Set the node version to install.
setOpacity(String) - Method in interface com.vaadin.flow.dom.Style
Sets the opacity property.
setOutline(String) - Method in interface com.vaadin.flow.dom.Style
Sets the outline property.
setOverflow(Style.Overflow) - Method in interface com.vaadin.flow.dom.Style
Sets the overflow property.
setPadding(String) - Method in interface com.vaadin.flow.dom.Style
Sets the padding property.
setPageTitle(String) - Method in class com.vaadin.flow.server.AppShellSettings
Set the page title.
setParameter(BeforeEvent, T) - Method in interface com.vaadin.flow.router.HasUrlParameter
Notifies about navigating to the target that implements this interface.
setParameter(String, String) - Method in interface com.vaadin.flow.component.PushConfiguration
Sets the given parameter.
setParameter(String, String) - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
setParent(StateNode) - Method in class com.vaadin.flow.internal.StateNode
Sets the parent node that this node belongs to.
setParentAnnotatedRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Register a navigation target on the specified path.
setPassword(String) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
Set password to use.
setPayload(JsonValue) - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Sets the payload data of the element.
setPollInterval(int) - Method in class com.vaadin.flow.component.UI
Sets the interval with which the UI should poll the server to see if there are any changes.
setPollInterval(int) - Method in class com.vaadin.flow.internal.nodefeature.PollConfigurationMap
Sets the poll interval.
setPosition(Style.Position) - Method in interface com.vaadin.flow.dom.Style
Sets the position property.
setPresentationValue(T) - Method in class com.vaadin.flow.component.AbstractCompositeField
Updates the presentation of this field to display the provided value.
setPresentationValue(T) - Method in class com.vaadin.flow.component.AbstractField
Updates the presentation of this field to display the provided value.
setPresentationValue(T) - Method in class com.vaadin.flow.component.AbstractSinglePropertyField
 
setPropertiesLocation(File) - Method in class com.vaadin.experimental.FeatureFlags
Set by the Maven / Gradle plugin when running through that so the feature flags will be correctly detected.
setProperty(PropertyConfiguration<C, P>, P) - Method in class com.vaadin.flow.component.webcomponent.WebComponent
Sets property value on the client-side to the given value.
setProperty(StateNode, String, Serializable, boolean) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Sets the given property to the given value.
setProperty(StateNode, String, Serializable, boolean) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
setProperty(StateNode, String, Serializable, boolean) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
setProperty(StateNode, String, Serializable, boolean) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
setProperty(String, boolean) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given boolean value.
setProperty(String, double) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given numeric value.
setProperty(String, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Sets a property to the given value.
setProperty(String, Serializable, boolean) - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Sets a property to the given value.
setProperty(String, Serializable, boolean) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
 
setProperty(String, Serializable, boolean) - Method in class com.vaadin.flow.internal.nodefeature.ElementStylePropertyMap
 
setProperty(String, String) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given string value.
setPropertyBean(String, Object) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given bean, converted to a JSON object.
setPropertyJson(String, JsonValue) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given JSON value.
setPropertyList(String, List<T>) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given list of beans or primitive values, converted to a JSON array.
setPropertyMap(String, Map<String, ?>) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given map of beans or primitive values, converted to a JSON object.
setPushConnection(PushConnection) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the internal push connection object used by the related UI.
setPushConnectionFactory(PushConnectionFactory) - Method in interface com.vaadin.flow.component.PushConfiguration
Sets the factory that will be used to create new instances of PushConnection.
setPushConnectionFactory(PushConnectionFactory) - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
setPushHandler(PushHandler) - Method in class com.vaadin.flow.server.communication.PushAtmosphereHandler
 
setPushMode(PushMode) - Method in interface com.vaadin.flow.component.PushConfiguration
Sets the mode of bidirectional ("push") communication that should be used.
setPushMode(PushMode) - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
setPushServletMapping(String) - Method in interface com.vaadin.flow.component.PushConfiguration
Sets the servlet mapping to use for push requests.
setPushServletMapping(String) - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
setPwaConfigurationClass(Class<?>) - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Sets pwa configuration class.
setQueryParameters(QueryParameters) - Method in class com.vaadin.flow.router.RouterLink
Sets the QueryParameters of this link.
setReadOnly(boolean) - Method in interface com.vaadin.flow.component.HasValue
Sets the read-only mode of this HasValue to given mode.
setReadOnly(boolean) - Method in interface com.vaadin.flow.component.HasValueAndElement
 
setReconnectAttempts(int) - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Sets the number of times to try to reconnect to the server before giving up.
setReconnectAttempts(int) - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
setReconnectInterval(int) - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Sets the interval (in milliseconds) between reconnect attempts.
setReconnectInterval(int) - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
setReferences(NavigationHandler, NavigationEvent) - Method in class com.vaadin.flow.router.BeforeLeaveEvent.ContinueNavigationAction
Sets the navigation handler and the navigation event for this action.
setRequestSizeMax(long) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
 
setRequiredIndicatorVisible(boolean) - Method in interface com.vaadin.flow.component.HasValue
Sets the required indicator visible or not.
setRequiredIndicatorVisible(boolean) - Method in interface com.vaadin.flow.component.HasValueAndElement
 
setResolvedPath(String) - Method in class com.vaadin.flow.router.NavigationState
Set the path for the resolved navigation target.
setResource(String, AbstractStreamResource) - Method in class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Sets the given attribute to the given StreamResource value.
setResponseNoCacheHeaders(BiConsumer<String, String>, BiConsumer<String, Long>) - Static method in class com.vaadin.flow.server.HandlerHelper
Sets no cache headers to the specified response.
setRight(String) - Method in interface com.vaadin.flow.dom.Style
Sets the right property.
setRoute(Router, Class<? extends C>, T) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
setRoute(Router, Class<? extends Component>) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
setRoute(Router, Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
setRoute(Class<? extends C>, T) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
setRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
setRoute(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
setRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Set a new RouteTarget for the given template.
setRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Register a navigation target with specified path and with no parent layouts.
setRoute(String, Class<? extends Component>, Class<? extends RouterLayout>...) - Method in class com.vaadin.flow.router.RouteConfiguration
Register a navigation target with specified path and given parent layout chain.
setRoute(String, Class<? extends Component>, List<Class<? extends RouterLayout>>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
setRoute(String, Class<? extends Component>, List<Class<? extends RouterLayout>>) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Set a new RouteTarget for the given template.
setRoute(String, Class<? extends Component>, List<Class<? extends RouterLayout>>) - Method in class com.vaadin.flow.router.RouteConfiguration
Register a navigation target with specified path and given parent layout chain.
setRoute(String, Class<? extends Component>, List<Class<? extends RouterLayout>>) - Method in interface com.vaadin.flow.server.RouteRegistry
Register a navigation target with specified path and given parent layout chain.
setRoute(String, Class<? extends Component>, List<Class<? extends RouterLayout>>) - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
 
setScale(String) - Method in interface com.vaadin.flow.dom.Style
Sets the scale property.
setSecondDelay(int) - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Sets the delay before the loading indicator goes into the "second" state.
setSecondDelay(int) - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
setSession(VaadinSession) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the session to which the related UI is assigned.
setSessionExpiredCaption(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the caption to show in a "session expired" notification.
setSessionExpiredMessage(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the message to show in a "session expired" notification.
setSessionExpiredNotificationEnabled(boolean) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets whether a "session expired" notification should be shown to the end user.
setSessionExpiredURL(String) - Method in class com.vaadin.flow.server.CustomizedSystemMessages
Sets the URL the user will be redirected to after dismissing a "session expired" message.
setShadowDomElements(List<Element>) - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Set the elements that should be added to each shadow dom hosting an embedded web component.
setShadowRoot(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ShadowRootData
 
setShell(Class<? extends AppShellConfigurator>) - Method in class com.vaadin.flow.server.AppShellRegistry
Sets the AppShellConfigurator class in the application.
setShortcutListenOnElement(String, Component) - Static method in class com.vaadin.flow.component.Shortcuts
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.
setSizeFull() - Method in interface com.vaadin.flow.component.HasSize
Sets the width and the height of the component to "100%".
setSizeUndefined() - Method in interface com.vaadin.flow.component.HasSize
Removes the width and the height of the component.
setState(VaadinSessionState) - Method in class com.vaadin.flow.server.VaadinSession
Sets the lifecycle state of this session.
setStatus(int) - Method in interface com.vaadin.flow.server.VaadinResponse
Sets the (http) status code for the response.
setStatusCode(int) - Method in class com.vaadin.flow.router.LocationChangeEvent
Sets the HTTP status code that will be returned for the client if this location change is an initial rendering request.
setSvg(InputStream) - Method in class com.vaadin.flow.component.Svg
Sets the graphics shown in this component.
setSvg(String) - Method in class com.vaadin.flow.component.Svg
Sets the graphics shown in this component.
setSynchronizedEvent(String) - Method in class com.vaadin.flow.component.AbstractSinglePropertyField
Sets the name of the DOM event for which property values are synchronized from the client to the server.
setSystemMessagesProvider(SystemMessagesProvider) - Method in class com.vaadin.flow.server.VaadinService
Sets the system messages provider to use for getting system messages to display to users of this service.
setTabIndex(int) - Method in interface com.vaadin.flow.component.Focusable
Sets the tabindex attribute in the component.
setTag(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Sets the tag name of the element.
setTargetRoute(Class<? extends Component>, String) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Put a new target route for Class-to-path mapping.
setText(String) - Method in interface com.vaadin.flow.component.HasText
Sets the given string as the content of this component.
setText(String) - Method in class com.vaadin.flow.component.Text
Sets the text of the component.
setText(String) - Method in class com.vaadin.flow.dom.Element
Sets the text content of this element, replacing any existing children.
setText(String) - Method in class com.vaadin.flow.internal.nodefeature.TextNodeMap
Sets the text of this node.
setTextAlign(Style.TextAlign) - Method in interface com.vaadin.flow.dom.Style
Sets the text-align property.
setTextContent(StateNode, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Sets the text content.
setTextContent(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
setTextContent(StateNode, String) - Method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
 
setTextContent(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
setTextDecoration(String) - Method in interface com.vaadin.flow.dom.Style
Sets the text-decoration property.
setThemeName(String) - Method in interface com.vaadin.flow.component.HasTheme
Sets the theme names of this component.
setThemeName(String, boolean) - Method in interface com.vaadin.flow.component.HasTheme
Sets or removes the given theme name for this component.
setThirdDelay(int) - Method in interface com.vaadin.flow.component.page.LoadingIndicatorConfiguration
Sets the delay before the loading indicator goes into the "third" state.
setThirdDelay(int) - Method in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
SETTINGS - Static variable in interface com.vaadin.flow.component.Key
Toggles display of the device's settings screen on and off.
setTitle(String) - Method in class com.vaadin.flow.component.HtmlComponent
Sets the title of this component.
setTitle(String) - Method in class com.vaadin.flow.component.internal.UIInternals
Records the page title set with Page.setTitle(String).
setTitle(String) - Method in class com.vaadin.flow.component.page.Page
Sets the page title.
setTop(String) - Method in interface com.vaadin.flow.dom.Style
Sets the top property.
setTransform(String) - Method in interface com.vaadin.flow.dom.Style
Sets the transform property.
setTransition(String) - Method in interface com.vaadin.flow.dom.Style
Sets the transition property.
setTransport(Transport) - Method in interface com.vaadin.flow.component.PushConfiguration
Sets the primary transport type for push.
setTransport(Transport) - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
setTree(StateTree) - Method in class com.vaadin.flow.internal.StateNode
Sets the state tree that this node belongs to.
setupCss(Element, BootstrapHandler.BootstrapContext) - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapPageBuilder
 
setUpdateFromClientFilter(SerializablePredicate<String>) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Sets a filter that will be used by for determining whether a property maybe updated from the client.
setupErrorDialogs(Element) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
setupHiddenElement(Element) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
setupPushConnectionFactory(PushConfiguration, BootstrapHandler.BootstrapContext) - Method in class com.vaadin.flow.server.BootstrapHandler
 
setupPwa(Document, VaadinService) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
setUseGlobalPnpm(boolean) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
Force usage of global pnpm.
setUserName(String) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
Set user name to use.
setValue(Serializable) - Method in class com.vaadin.flow.internal.nodefeature.BasicTypeValue
Sets the value of a basic type.
setValue(T) - Method in class com.vaadin.flow.component.AbstractCompositeField
 
setValue(T) - Method in class com.vaadin.flow.component.AbstractField
 
setValue(T) - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
Delegate method for HasValue.setValue(Object).
setValue(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeValue
Sets the value of this feature.
setValue(V) - Method in interface com.vaadin.flow.component.HasValue
Sets the value of this object.
SetView(NodeList<T>) - Constructor for class com.vaadin.flow.internal.nodefeature.NodeList.SetView
Creates a new view for the given list.
setViewport(String) - Method in class com.vaadin.flow.server.AppShellSettings
Set the viewport value.
setVisibility(Style.Visibility) - Method in interface com.vaadin.flow.dom.Style
Sets the visibility property.
setVisible(boolean) - Method in class com.vaadin.flow.component.Component
Sets the component visibility value.
setVisible(boolean) - Method in class com.vaadin.flow.component.Text
The method is not supported for the Text class.
setVisible(boolean) - Method in class com.vaadin.flow.dom.Element
Sets the element visibility value.
setVisible(boolean) - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Set the visibility of the element.
setVisible(StateNode, boolean) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Sets the node visibility.
setVisible(StateNode, boolean) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
setVisible(StateNode, boolean) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
setVisible(StateNode, boolean) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
setWhiteSpace(HasText.WhiteSpace) - Method in interface com.vaadin.flow.component.HasText
Sets the given value as "white-space" style value.
setWhiteSpace(Style.WhiteSpace) - Method in interface com.vaadin.flow.dom.Style
Sets the white-space property.
setWidth(float, Unit) - Method in interface com.vaadin.flow.component.HasSize
Sets the width of the component.
setWidth(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the width of the component.
setWidth(String) - Method in interface com.vaadin.flow.dom.Style
Sets the width property.
setWidthFull() - Method in interface com.vaadin.flow.component.HasSize
Sets the width of the component to "100%".
setZIndex(Integer) - Method in interface com.vaadin.flow.dom.Style
Sets the z-index property.
SEVERAL_IMPLS - Static variable in class com.vaadin.flow.di.LookupInitializer
 
sha256(String) - Static method in class com.vaadin.flow.internal.MessageDigestUtil
Calculates the SHA-256 hash of the UTF-16 representation of the given string.
sha256(String, Charset) - Static method in class com.vaadin.flow.internal.MessageDigestUtil
Calculates the SHA-256 hash of the given string representation using the supplied charset.
SHADOW_ROOT - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
SHADOW_ROOT_DATA - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
SHADOW_ROOT_HOST - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
ShadowRoot - Class in com.vaadin.flow.dom
Represents a shadow dom root of an element.
ShadowRootData - Class in com.vaadin.flow.internal.nodefeature
Map of basic element information.
ShadowRootData(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ShadowRootData
Creates a new element data map for the given node.
ShadowRootHost - Class in com.vaadin.flow.internal.nodefeature
Marker feature for a StateNode which is a shadow root for some element.
ShadowRootHost(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.ShadowRootHost
Creates a new instance of the feature for the given node.
ShadowRootStateProvider - Class in com.vaadin.flow.dom.impl
Implementation which handles shadow root nodes.
ShadowRootStateProvider() - Constructor for class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
SharedUtil - Class in com.vaadin.flow.shared.util
Misc internal utility methods used by both the server and the client package.
SharedUtil() - Constructor for class com.vaadin.flow.shared.util.SharedUtil
 
SHIFT - Enum constant in enum class com.vaadin.flow.component.KeyModifier
KeyModifier for "Shift" key.
SHIFT - Static variable in interface com.vaadin.flow.component.Key
The Shift key.
SHIFT_LEFT - Static variable in interface com.vaadin.flow.component.Key
Shift or
SHIFT_RIGHT - Static variable in interface com.vaadin.flow.component.Key
Shift or
ShortcutEvent - Class in com.vaadin.flow.component
Event when shortcut is detected.
ShortcutEvent(Component, Component, Key, Set<KeyModifier>) - Constructor for class com.vaadin.flow.component.ShortcutEvent
Creates a new ShortcutEvent.
ShortcutEventListener - Interface in com.vaadin.flow.component
Listener for shortcut events.
ShortcutRegistration - Class in com.vaadin.flow.component
A registration object for both configuring and removing the registered keyboard shortcut.
Shortcuts - Class in com.vaadin.flow.component
Collections of methods for configuring more complex Shortcut interactions.
shortName() - Element in annotation interface com.vaadin.flow.server.PWA
Short name for the application.
shouldBeCached() - Method in class com.vaadin.flow.server.PwaIcon
Should the icon be cached by the Service Worker.
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
Check if it should generate the file or not.
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateBootstrap
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateFeatureFlags
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexHtml
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexTs
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateServiceWorker
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateViteDevMode
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentBootstrap
 
shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentHtml
 
shouldHighlight(T, AfterNavigationEvent) - Method in interface com.vaadin.flow.router.HighlightCondition
Tests if the target should be highlighted based on the navigation event.
shouldPushHistoryState(NavigationEvent) - Method in class com.vaadin.flow.component.internal.JavaScriptNavigationStateRenderer
 
shouldPushHistoryState(NavigationEvent) - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
 
showRouterLayoutContent(HasElement) - Method in interface com.vaadin.flow.router.RouterLayout
Shows the content of the layout which is the router target component annotated with a @Route.
showRouteTarget(Location, Component, List<RouterLayout>) - Method in class com.vaadin.flow.component.internal.UIInternals
Shows a route target in the related UI.
SIDE_NAV_COMPONENT - Static variable in class com.vaadin.experimental.FeatureFlags
 
simple(Map<String, String>) - Static method in class com.vaadin.flow.router.QueryParameters
Creates parameters from simple representation, where each parameter name corresponds to a single value.
SINGLE_CANDIDATE - Static variable in interface com.vaadin.flow.component.Key
The Single Candidate key.
size() - Method in class com.vaadin.flow.dom.impl.ImmutableClassList
 
size() - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
size() - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
size() - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
size() - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
size() - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Gets the number of items in this list.
size() - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 
SKIP_DEV_BUNDLE_REBUILD - Static variable in class com.vaadin.flow.server.InitParameters
Configuration name for disabling dev bundle rebuild.
skipDevBundleBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Set to true to skip dev bundle build in case a dev bundle exists.
SLASH - Static variable in interface com.vaadin.flow.component.Key
/? on a US keyboard.
SLEEP - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
SMOOTH - Enum constant in enum class com.vaadin.flow.component.ScrollOptions.Behavior
 
SOFT1 - Static variable in interface com.vaadin.flow.component.Key
The first general-purpose virtual function key.
SOFT2 - Static variable in interface com.vaadin.flow.component.Key
The second general-purpose virtual function key.
SOFT3 - Static variable in interface com.vaadin.flow.component.Key
The third general-purpose virtual function key.
SOFT4 - Static variable in interface com.vaadin.flow.component.Key
The fourth general-purpose virtual function key.
SPACE - Static variable in interface com.vaadin.flow.component.Key
The space key, Space Bar.
SPAN - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <span>.
SPEECH_CORRECTION_LIST - Static variable in interface com.vaadin.flow.component.Key
Presents a list of possible corrections for a word which was incorrectly identified.
SPEECH_INPUT_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles between dictation mode and command/control mode.
SPELL_CHECK - Static variable in interface com.vaadin.flow.component.Key
Starts spell checking the current document.
SPI - Static variable in class com.vaadin.flow.di.LookupInitializer
 
SPLIT_SCREEN_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles split screen display mode on and off.
splitAt(int) - Method in class com.vaadin.flow.internal.Range
Split the range into two at a certain integer.
splitAtFromStart(int) - Method in class com.vaadin.flow.internal.Range
Split the range into two after a certain number of integers into the range.
splitCamelCase(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Splits a camelCaseString into an array of words with the casing preserved.
SPRING_BOOT_DEFAULT_LIVE_RELOAD_PORT - Static variable in class com.vaadin.flow.server.Constants
Default live reload port as defined in Spring Boot Dev Tools.
SPRING_BOOT_DEVTOOLS - Enum constant in enum class com.vaadin.flow.internal.BrowserLiveReload.Backend
 
SpringCsrfToken - Class in com.vaadin.flow.internal.springcsrf
A pojo for Spring CSRF token.
SpringCsrfToken(String, String, String) - Constructor for class com.vaadin.flow.internal.springcsrf.SpringCsrfToken
 
SpringCsrfTokenUtil - Class in com.vaadin.flow.internal.springcsrf
A util class for helping dealing with Spring CSRF token.
STANDARD - Enum constant in enum class com.vaadin.flow.component.KeyLocation
Standard key location.
STANDBY - Static variable in interface com.vaadin.flow.component.Key
The Standby key; also known as Suspend or Sleep.
START - Enum constant in enum class com.vaadin.flow.component.ScrollOptions.Alignment
 
startPath() - Element in annotation interface com.vaadin.flow.server.PWA
(Root relative) start url, used in web-manifest, property start_url
startsAfter(Range) - Method in class com.vaadin.flow.internal.Range
Checks whether this range starts after the end of another range.
startsBefore(Range) - Method in class com.vaadin.flow.internal.Range
Checks whether this range starts before the start of another range.
StateNode - Class in com.vaadin.flow.internal
A node in the state tree that is synchronized with the client-side.
StateNode(StateNode) - Constructor for class com.vaadin.flow.internal.StateNode
Create a new instance using the same features as provided node declares.
StateNode(Class<? extends NodeFeature>...) - Constructor for class com.vaadin.flow.internal.StateNode
Creates a state node with the given feature types.
StateNode(List<Class<? extends NodeFeature>>, Class<? extends NodeFeature>...) - Constructor for class com.vaadin.flow.internal.StateNode
Creates a state node with the given feature types and required features that are always sent to the client side.
StateNodeNodeList - Class in com.vaadin.flow.internal.nodefeature
A list which contains StateNodes.
StateNodeNodeList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
Creates a new list for the given node.
StateTree - Class in com.vaadin.flow.internal
The state tree that is synchronized with the client-side.
StateTree(UIInternals, Class<? extends NodeFeature>...) - Constructor for class com.vaadin.flow.internal.StateTree
Creates a new state tree with a set of features defined for the root node.
StateTree.BeforeClientResponseEntry - Class in com.vaadin.flow.internal
A task to be executed before the client response, together with an execution sequence number and context object.
StateTree.ExecutionRegistration - Interface in com.vaadin.flow.internal
A registration object for removing a task registered for execution before the client response.
STATIC - Enum constant in enum class com.vaadin.flow.dom.Style.Position
 
StaticFileHandler - Interface in com.vaadin.flow.server
Handler for static files.
StaticFileHandlerFactory - Interface in com.vaadin.flow.server
A factory to create a StaticFileHandler.
StaticFileServer - Class in com.vaadin.flow.server
Handles sending of resources from the WAR root (web content) or META-INF/resources in the case that VaadinServlet is mapped using "/*".
StaticFileServer(VaadinService) - Constructor for class com.vaadin.flow.server.StaticFileServer
Constructs a file server.
STATISTIC_FLOW_BOOTSTRAPHANDLER - Static variable in class com.vaadin.flow.server.Constants
UsageEntry name for UsageStatistics BootstrapHandler.
STATISTIC_ROUTING_CLIENT - Static variable in class com.vaadin.flow.server.Constants
UsageEntry name for UsageStatistics Routing Client.
STATISTIC_ROUTING_HYBRID - Static variable in class com.vaadin.flow.server.Constants
UsageEntry name for UsageStatistics Hybrid.
STATISTIC_ROUTING_SERVER - Static variable in class com.vaadin.flow.server.Constants
UsageEntry name for UsageStatistics Routing Server.
STATISTICS_JSON_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Default path for the frontend statistics json file.
STB_INPUT - Static variable in interface com.vaadin.flow.component.Key
Cycles among input modes on an external set-top box (STB).
STB_POWER - Static variable in interface com.vaadin.flow.component.Key
Toggles on and off an external STB.
STICKY - Enum constant in enum class com.vaadin.flow.dom.Style.Position
 
stop() - Method in interface com.vaadin.flow.internal.DevModeHandler
Stop the dev-server.
stopDevModeHandler() - Method in interface com.vaadin.flow.internal.DevModeHandlerManager
Stops a running DevModeHandler.
storeSession(VaadinSession, WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Called when the VaadinSession should be stored.
stream() - Method in class com.vaadin.flow.internal.Range
Returns the range as a stream of integers.
stream(JsonArray) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a stream from a JSON array.
StreamingEndEventImpl - Class in com.vaadin.flow.server.communication.streaming
StreamingEndEventImpl(String, String, long) - Constructor for class com.vaadin.flow.server.communication.streaming.StreamingEndEventImpl
End event constructor.
StreamingErrorEventImpl - Class in com.vaadin.flow.server.communication.streaming
StreamingErrorEventImpl(String, String, long, long, Exception) - Constructor for class com.vaadin.flow.server.communication.streaming.StreamingErrorEventImpl
Streaming error event constructor.
streamingFailed(StreamVariable.StreamingErrorEvent) - Method in interface com.vaadin.flow.server.StreamVariable
This method is called when the streaming has failed.
streamingFinished(StreamVariable.StreamingEndEvent) - Method in interface com.vaadin.flow.server.StreamVariable
This method is called when the streaming has finished.
StreamingProgressEventImpl - Class in com.vaadin.flow.server.communication.streaming
StreamingProgressEventImpl(String, String, long, long) - Constructor for class com.vaadin.flow.server.communication.streaming.StreamingProgressEventImpl
Streaming progress event constructor.
streamingStarted(StreamVariable.StreamingStartEvent) - Method in interface com.vaadin.flow.server.StreamVariable
This method is called when the streaming starts.
StreamingStartEventImpl - Class in com.vaadin.flow.server.communication.streaming
StreamingStartEventImpl(String, String, long) - Constructor for class com.vaadin.flow.server.communication.streaming.StreamingStartEventImpl
Streaming start event constructor.
StreamReceiver - Class in com.vaadin.flow.server
Represents a receiver for data upload from the client.
StreamReceiver(StateNode, String, StreamVariable) - Constructor for class com.vaadin.flow.server.StreamReceiver
Creates StreamReceiver instance for streamVariable as a data receiver.
StreamReceiverHandler - Class in com.vaadin.flow.server.communication
Handles StreamReceiver instances registered in VaadinSession.
StreamReceiverHandler() - Constructor for class com.vaadin.flow.server.communication.StreamReceiverHandler
 
StreamReceiverHandler.UploadInterruptedException - Exception in com.vaadin.flow.server.communication
An UploadInterruptedException will be thrown by an ongoing upload if StreamVariable.isInterrupted() returns true.
StreamRegistration - Interface in com.vaadin.flow.server
Stream registration result.
StreamRequestHandler - Class in com.vaadin.flow.server.communication
Handles StreamResource and StreamReceiver instances registered in VaadinSession.
StreamRequestHandler() - Constructor for class com.vaadin.flow.server.communication.StreamRequestHandler
Create a new stream request handler with the default StreamReceiverHandler.
StreamRequestHandler(StreamReceiverHandler) - Constructor for class com.vaadin.flow.server.communication.StreamRequestHandler
 
StreamResource - Class in com.vaadin.flow.server
Represents dynamically generated data.
StreamResource(String, InputStreamFactory) - Constructor for class com.vaadin.flow.server.StreamResource
Creates StreamResource instance using mandatory parameters name as a resource file name and input stream factory as a factory for data.
StreamResource(String, StreamResourceWriter) - Constructor for class com.vaadin.flow.server.StreamResource
Creates StreamResource instance using mandatory parameters name as a resource file name and output stream writer as a data producer.
StreamResourceHandler - Class in com.vaadin.flow.server.communication
Handles StreamResource instances registered in VaadinSession.
StreamResourceHandler() - Constructor for class com.vaadin.flow.server.communication.StreamResourceHandler
 
StreamResourceRegistry - Class in com.vaadin.flow.server
Registry for StreamResource instances.
StreamResourceRegistry(VaadinSession) - Constructor for class com.vaadin.flow.server.StreamResourceRegistry
Creates stream resource registry for provided session.
StreamResourceWriter - Interface in com.vaadin.flow.server
Output stream consumer.
streamToString(InputStream) - Static method in class com.vaadin.flow.server.frontend.FrontendUtils
Read a stream and copy the content into a String using system line separators for all 'carriage return' characters.
StreamVariable - Interface in com.vaadin.flow.server
StreamVariable is a special kind of variable whose value is streamed to an OutputStream provided by the StreamVariable.getOutputStream() method.
StreamVariable.StreamingEndEvent - Interface in com.vaadin.flow.server
Event passed to StreamVariable.streamingFinished(StreamingEndEvent) method the contents have been streamed to StreamVariable successfully.
StreamVariable.StreamingErrorEvent - Interface in com.vaadin.flow.server
Event passed to StreamVariable.streamingFailed(StreamingErrorEvent) method when the streaming ended before the end of the input.
StreamVariable.StreamingEvent - Interface in com.vaadin.flow.server
Streaming event interface.
StreamVariable.StreamingProgressEvent - Interface in com.vaadin.flow.server
Event passed to StreamVariable.onProgress(StreamingProgressEvent) method during the streaming progresses.
StreamVariable.StreamingStartEvent - Interface in com.vaadin.flow.server
Event passed to StreamVariable.streamingStarted(StreamingStartEvent) method before the streaming of the content to StreamVariable starts.
stringEqual(JsonValue, JsonValue) - Static method in class com.vaadin.flow.internal.JsonUtils
 
StringToEnumDecoder - Class in com.vaadin.flow.server.communication.rpc
Decodes a JsonValue with JsonType.STRING type to Enum subclass type.
StringToEnumDecoder() - Constructor for class com.vaadin.flow.server.communication.rpc.StringToEnumDecoder
 
StringToNumberDecoder - Class in com.vaadin.flow.server.communication.rpc
Decodes a JsonValue with JsonType.STRING type to Number subclass type.
StringToNumberDecoder() - Constructor for class com.vaadin.flow.server.communication.rpc.StringToNumberDecoder
 
StringUtil - Class in com.vaadin.flow.internal
Utility class for special string handling.
StringUtil() - Constructor for class com.vaadin.flow.internal.StringUtil
 
stripSuffix(String, String) - Static method in class com.vaadin.flow.internal.StringUtil
Strips the given suffix from the given string, if the strings end with the suffix.
STRONG - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <strong>.
Style - Interface in com.vaadin.flow.dom
Provides inline styles for Elements.
STYLE_COLOR - Static variable in class com.vaadin.flow.dom.ElementConstants
The style property for color.
STYLE_HEIGHT - Static variable in class com.vaadin.flow.dom.ElementConstants
The style property for height.
STYLE_MAX_HEIGHT - Static variable in class com.vaadin.flow.dom.ElementConstants
The style property for max-height.
STYLE_MAX_WIDTH - Static variable in class com.vaadin.flow.dom.ElementConstants
The style property for max-width.
STYLE_MIN_HEIGHT - Static variable in class com.vaadin.flow.dom.ElementConstants
The style property for min-height.
STYLE_MIN_WIDTH - Static variable in class com.vaadin.flow.dom.ElementConstants
The style property for min-width.
STYLE_WIDTH - Static variable in class com.vaadin.flow.dom.ElementConstants
The style property for width.
Style.BoxSizing - Enum Class in com.vaadin.flow.dom
 
Style.Clear - Enum Class in com.vaadin.flow.dom
Css values for the clear property.
Style.Display - Enum Class in com.vaadin.flow.dom
 
Style.FloatCss - Enum Class in com.vaadin.flow.dom
Css values for the float property.
Style.Overflow - Enum Class in com.vaadin.flow.dom
 
Style.Position - Enum Class in com.vaadin.flow.dom
Css values for the position property.
Style.TextAlign - Enum Class in com.vaadin.flow.dom
Css values for the text-align property.
Style.Visibility - Enum Class in com.vaadin.flow.dom
Css values for the visibility property.
Style.WhiteSpace - Enum Class in com.vaadin.flow.dom
Css values for the white-space property.
StyleAttributeHandler - Class in com.vaadin.flow.dom.impl
Emulates the style attribute by delegating to Element.getStyle().
StyleAttributeHandler() - Constructor for class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
styleAttributeToProperty(String) - Static method in class com.vaadin.flow.dom.StyleUtil
Converts the given attribute style (dash-separated) into a property style (camelCase).
stylePropertyToAttribute(String) - Static method in class com.vaadin.flow.dom.StyleUtil
Converts the given property style (camelCase) into a attribute style (dash-separated).
StyleSheet - Annotation Interface in com.vaadin.flow.component.dependency
Defines style sheet dependencies on a Component class.
STYLESHEET - Enum constant in enum class com.vaadin.flow.component.page.Inline.Wrapping
 
STYLESHEET - Enum constant in enum class com.vaadin.flow.shared.ui.Dependency.Type
 
StyleSheet.Container - Annotation Interface in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple StyleSheet annotations.
StyleUtil - Class in com.vaadin.flow.dom
Utility methods for Style.
SUBTITLE - Static variable in interface com.vaadin.flow.component.Key
Toggles the display of subtitles on and off if they're available.
SUBTRACT - Static variable in interface com.vaadin.flow.component.Key
The numeric keypad's subtraction key, -.
SUMMARY - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <summary>.
SUPER - Static variable in interface com.vaadin.flow.component.Key
The Super key.
supportedTypes - Static variable in class com.vaadin.flow.router.ParameterDeserializer
supports(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Checks if the element state provider supports the given state node.
supports(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
supports(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
supports(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
 
suspend(AtmosphereResource) - Method in class com.vaadin.flow.server.communication.PushHandler
Suspends the given resource
SUSPEND - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
Svg - Class in com.vaadin.flow.component
A component that displays a given SVG image.
Svg() - Constructor for class com.vaadin.flow.component.Svg
Creates an empty Svg.
Svg(InputStream) - Constructor for class com.vaadin.flow.component.Svg
Creates an instance based on the given SVG input.
Svg(String) - Constructor for class com.vaadin.flow.component.Svg
Creates an instance based on the given SVG string.
SW_RUNTIME_PRECACHE_PATH - Static variable in class com.vaadin.flow.server.communication.PwaHandler
 
SWITCHING_PROTOCOLS - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (101) indicating the server is switching protocols according to Upgrade header.
SYMBOL - Static variable in interface com.vaadin.flow.component.Key
The Symbol modifier key (found on certain virtual keyboards).
SYMBOL_LOCK - Static variable in interface com.vaadin.flow.component.Key
The Symbol Lock key.
sync(String, JsonValue) - Method in class com.vaadin.flow.component.webcomponent.WebComponentWrapper
Synchronize method for client side to send property value updates to the server.
Synchronize - Annotation Interface in com.vaadin.flow.component
Annotates getters for which properties should be synchronized to the server.
SYNCHRONIZE_PROPERTY_TOKEN - Static variable in class com.vaadin.flow.shared.JsonConstants
Token used as an event data expression to represent that properties should be synchronized.
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.BootstrapHandler
 
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.HeartbeatHandler
Handles a heartbeat request for the given session.
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.IndexHtmlRequestHandler
 
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
 
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.UidlRequestHandler
 
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
 
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.WebComponentProvider
 
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.SynchronizedRequestHandler
Identical to SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse) except the VaadinSession is locked before this is called and unlocked after this has completed.
SynchronizedRequestHandler - Class in com.vaadin.flow.server
RequestHandler which takes care of locking and unlocking of the VaadinSession automatically.
SynchronizedRequestHandler() - Constructor for class com.vaadin.flow.server.SynchronizedRequestHandler
 
synchronizeProperty(String) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Marks that the DOM event of this registration should trigger synchronization for the given property.
SYSTEM_PROPERTY_PREFIX - Static variable in class com.vaadin.experimental.FeatureFlags
 
SystemMessages - Class in com.vaadin.flow.server
Contains the system messages used to notify the user about various critical situations that can occur.
SystemMessagesInfo - Class in com.vaadin.flow.server
Provides information available for SystemMessagesProvider when defining what SystemMessages to use.
SystemMessagesInfo(Locale, VaadinRequest, VaadinService) - Constructor for class com.vaadin.flow.server.SystemMessagesInfo
Creates an instance based on the given locale, request and service.
SystemMessagesProvider - Interface in com.vaadin.flow.server
Gives out system messages based on Locale.

T

TAB - Static variable in interface com.vaadin.flow.component.Key
Tab or
TABLE - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_CAPTION - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_CELL - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_COLUMN - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_COLUMN_GROUP - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_FOOTER_GROUP - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_HEADER_GROUP - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_ROW - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
TABLE_ROW_GROUP - Enum constant in enum class com.vaadin.flow.dom.Style.Display
 
Tag - Annotation Interface in com.vaadin.flow.component
Defines the tag to use for the root element for a component created using the default Component constructor.
TAG - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
target() - Element in annotation interface com.vaadin.flow.component.page.Inline
Target element to inline file contents to.
TARGET - Static variable in class com.vaadin.flow.server.Constants
Target folder constant.
TargetElement - Enum Class in com.vaadin.flow.component.page
Page target element enum for inlining during bootstrap creation.
TaskCleanFrontendFiles - Class in com.vaadin.flow.server.frontend
Clean any frontend files generated for creation on a new development or production bundle.
TaskCleanFrontendFiles(File) - Constructor for class com.vaadin.flow.server.frontend.TaskCleanFrontendFiles
Scans the jar files given defined by resourcesToScan.
TaskCopyFrontendFiles - Class in com.vaadin.flow.server.frontend
Copies JavaScript and CSS files from JAR files into a given folder.
TaskCopyLocalFrontendFiles - Class in com.vaadin.flow.server.frontend
Copies JavaScript files from the given local frontend folder.
TaskCopyTemplateFiles - Class in com.vaadin.flow.server.frontend
Copies template files to the target folder so as to be available for parsing at runtime in production mode.
TaskGenerateBootstrap - Class in com.vaadin.flow.server.frontend
A task for generating the bootstrap file FrontendUtils.BOOTSTRAP_FILE_NAME during `package` Maven goal.
TaskGenerateEndpoint - Interface in com.vaadin.flow.server.frontend
Generate the TS files for endpoints, and the Client API file.
TaskGenerateFeatureFlags - Class in com.vaadin.flow.server.frontend
A task for generating the feature flags file FrontendUtils.FEATURE_FLAGS_FILE_NAME during `package` Maven goal.
TaskGenerateIndexHtml - Class in com.vaadin.flow.server.frontend
Generate index.html if it is missing in frontend folder.
TaskGenerateIndexTs - Class in com.vaadin.flow.server.frontend
Generate index.ts if it is missing in frontend folder.
TaskGenerateOpenAPI - Interface in com.vaadin.flow.server.frontend
Generate OpenAPI json file for Vaadin Endpoints.
TaskGeneratePackageJson - Class in com.vaadin.flow.server.frontend
Creates the package.json if missing.
TaskGenerateServiceWorker - Class in com.vaadin.flow.server.frontend
Generate index.html if it is missing in frontend folder.
TaskGenerateTsConfig - Class in com.vaadin.flow.server.frontend
Generate tsconfig.json if it is missing in project folder.
TaskGenerateTsDefinitions - Class in com.vaadin.flow.server.frontend
Generate types.d.ts if it is missing in project folder and tsconfig.json exists in project folder.
TaskGenerateViteDevMode - Class in com.vaadin.flow.server.frontend
Generate vite-devmode.ts if it is missing in frontend/generated folder.
TaskGenerateWebComponentBootstrap - Class in com.vaadin.flow.server.frontend
A task for generating the bootstrap file for exported web components FrontendUtils.WEB_COMPONENT_BOOTSTRAP_FILE_NAME during `package` Maven goal.
TaskGenerateWebComponentHtml - Class in com.vaadin.flow.server.frontend
Generate web-component.html if it is missing in frontend folder.
TaskInstallFrontendBuildPlugins - Class in com.vaadin.flow.server.frontend
Task that installs any Flow webpack plugins into node_modules/@vaadin for use with webpack compilation.
TaskInstallFrontendBuildPlugins(Options) - Constructor for class com.vaadin.flow.server.frontend.TaskInstallFrontendBuildPlugins
Copy Flow webpack plugins into PLUGIN_TARGET under the build directory.
TaskPrepareProdBundle - Class in com.vaadin.flow.server.frontend
Copies production bundle files from pre-compiled bundle JAR into a folder where production bundle is normally located.
TaskPrepareProdBundle(Options) - Constructor for class com.vaadin.flow.server.frontend.TaskPrepareProdBundle
 
TaskRunDevBundleBuild - Class in com.vaadin.flow.server.frontend
Compiles the dev mode bundle if it is out of date.
TaskRunNpmInstall - Class in com.vaadin.flow.server.frontend
Run npm install after dependencies have been updated.
TaskRunNpmInstall.Stats - Class in com.vaadin.flow.server.frontend
Container for npm installation statistics.
TaskUpdateImports - Class in com.vaadin.flow.server.frontend
An updater that it's run when the servlet context is initialised in dev-mode or when flow-maven-plugin goals are run in order to update Flow imports file and "jar-resources" contents by visiting all classes with JsModule and Theme annotations.
TaskUpdateOldIndexTs - Class in com.vaadin.flow.server.frontend
Updated index.ts if it imports Flow from an old location.
TaskUpdatePackages - Class in com.vaadin.flow.server.frontend
Updates package.json by visiting NpmPackage annotations found in the classpath.
TaskUpdateSettingsFile - Class in com.vaadin.flow.server.frontend
Creates a vaadin-dev-server-settings.json file for use with dev server configuration.
TaskUpdateThemeImport - Class in com.vaadin.flow.server.frontend
Task generating the theme definition file 'theme.js' for importing application theme into the generated frontend directory.
TaskUpdateVite - Class in com.vaadin.flow.server.frontend
Updates the Vite configuration files according with current project settings.
TELETEXT - Static variable in interface com.vaadin.flow.component.Key
Toggles display of teletext, if available.
Template - Interface in com.vaadin.flow.internal
Marker interface for (Lit and Polymer) templates.
TEMPLATE_DIRECTORY - Static variable in class com.vaadin.flow.server.Constants
Default resource directory to place template sources in.
TEMPLATE_IN_TEMPLATE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
JsonObject template-in-template type value for VirtualChildrenList.
TEMPLATE_MODELLIST - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
Id for ModelList.
TEMPORARY_REDIRECT - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (307) indicating that the requested resource resides temporarily under a different URI.
testErrorNavigationTarget(Class<?>) - Method in interface com.vaadin.flow.server.startup.NavigationTargetFilter
Tests whether the given error navigation target class should be included.
testNavigationTarget(Class<? extends Component>) - Method in interface com.vaadin.flow.server.startup.NavigationTargetFilter
Tests whether the given navigation target class should be included.
Text - Class in com.vaadin.flow.component
A component which encapsulates the given text in a text node.
Text(String) - Constructor for class com.vaadin.flow.component.Text
Creates an instance using the given text.
TEXT - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
TEXT_NODE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
Id for TextNodeMap.
TEXTAREA - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <textarea>.
TextNodeMap - Class in com.vaadin.flow.internal.nodefeature
Map holding the data of a text node.
TextNodeMap(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.TextNodeMap
Creates a new text node map for the given node.
Theme - Annotation Interface in com.vaadin.flow.theme
Defines the theme to use for the application.
THEME_ATTRIBUTE_NAME - Static variable in class com.vaadin.flow.dom.impl.ThemeListImpl
 
THEME_IMPORTS_D_TS_NAME - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 
THEME_IMPORTS_NAME - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 
themeClass() - Element in annotation interface com.vaadin.flow.theme.Theme
The theme translation handler.
themeColor() - Element in annotation interface com.vaadin.flow.server.PWA
Theme color of the application.
themeConfigurationChanged(Options, JsonObject, FrontendDependenciesScanner, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.ThemeValidationUtil
 
ThemeDefinition - Class in com.vaadin.flow.theme
Holds all the settings needed to properly set a Theme in the application.
ThemeDefinition(Theme) - Constructor for class com.vaadin.flow.theme.ThemeDefinition
Helper constructor that extracts the needed information from a Theme annotation.
ThemeDefinition(Class<? extends AbstractTheme>, String, String) - Constructor for class com.vaadin.flow.theme.ThemeDefinition
Creates a definition with the given them class and variant.
themeFor() - Element in annotation interface com.vaadin.flow.component.dependency.CssImport
The tag name of the themable element that the generated 'dom-module' will target.
ThemeList - Interface in com.vaadin.flow.dom
Representation of the theme names for an Element.
ThemeListImpl - Class in com.vaadin.flow.dom.impl
Default implementation for the ThemeList that stores the theme names of the corresponding element.
ThemeListImpl(Element) - Constructor for class com.vaadin.flow.dom.impl.ThemeListImpl
Creates new theme list for element specified.
ThemeUtils - Class in com.vaadin.flow.server.frontend
Helpers related to theme handling.
ThemeValidationUtil - Class in com.vaadin.flow.server.frontend
Theme handling methods.
ThemeValidationUtil() - Constructor for class com.vaadin.flow.server.frontend.ThemeValidationUtil
 
then(SerializableConsumer<JsonValue>) - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Adds an untyped handler that will be run for a successful execution.
then(SerializableConsumer<JsonValue>, SerializableConsumer<String>) - Method in class com.vaadin.flow.component.internal.PendingJavaScriptInvocation
 
then(SerializableConsumer<JsonValue>, SerializableConsumer<String>) - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Adds an untyped handler that will be run for a successful execution and a handler that will be run for a failed execution.
then(Class<T>, SerializableConsumer<T>) - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Adds a typed handler that will be run for a successful execution.
then(Class<T>, SerializableConsumer<T>, SerializableConsumer<String>) - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Adds a typed handler that will be run for a successful execution and a handler that will be run for a failed execution.
THIRD_DELAY_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
THIRD_DELAY_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap
 
throttle(int) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Configures this listener to not be notified more often than period milliseconds.
timeout() - Element in annotation interface com.vaadin.flow.component.DebounceSettings
Gets the debounce timeout to use.
toArray() - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
toArray(T[]) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
toCompletableFuture() - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Creates an untyped completable future that will be completed with the result of the execution.
toCompletableFuture(Class<T>) - Method in interface com.vaadin.flow.component.page.PendingJavaScriptResult
Creates a typed completable future that will be completed with the result of the execution.
toggleAttribute(String) - Static method in class com.vaadin.flow.router.HighlightActions
An action which toggles the target's attribute based on its highlight state.
toggleClassName(String) - Static method in class com.vaadin.flow.router.HighlightActions
An action which toggles className class on the target based on its highlight state.
toggleTheme(String) - Static method in class com.vaadin.flow.router.HighlightActions
An action which toggles theme on the target based on its highlight state.
toggleTrailingSlash() - Method in class com.vaadin.flow.router.Location
Removes or adds slash to the end of the location path.
toJson() - Method in interface com.vaadin.flow.component.JsonSerializable
Converts this object to its JSON format.
toJson() - Method in class com.vaadin.flow.component.ScrollOptions
Convert to json in a form compatible with element.scrollIntoView.
toJson() - Method in class com.vaadin.flow.shared.ui.Dependency
Converts the object into json representation.
toJson(ConstantPool) - Method in class com.vaadin.flow.internal.change.NodeChange
Serializes this change to JSON.
toJson(Object) - Static method in class com.vaadin.flow.internal.JsonSerializer
Converts a Java bean, JsonSerializable instance, String, wrapper of primitive type or enum to a JsonValue.
toJson(Collection<?>) - Static method in class com.vaadin.flow.internal.JsonSerializer
Converts a collection of object into a JsonArray, converting each item of the collection individually.
toJsoup(Document, Element) - Static method in class com.vaadin.flow.dom.ElementUtil
Converts the given element and its children to a JSoup node with children.
TOKEN_FILE - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File used to enable npm mode.
toObject(Class<T>, JsonValue) - Static method in class com.vaadin.flow.internal.JsonSerializer
Converts a JsonValue to the corresponding Java object.
toObjects(Class<T>, JsonArray) - Static method in class com.vaadin.flow.internal.JsonSerializer
Converts a JsonArray into a collection of Java objects.
toString() - Method in class com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent
 
toString() - Method in enum class com.vaadin.flow.component.HasText.WhiteSpace
 
toString() - Method in class com.vaadin.flow.component.ShortcutRegistration
 
toString() - Method in enum class com.vaadin.flow.component.Unit
 
toString() - Method in class com.vaadin.flow.dom.Element
 
toString() - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
toString() - Method in class com.vaadin.flow.internal.Range
 
toString() - Method in class com.vaadin.flow.router.internal.NavigationRouteTarget
 
toString() - Method in class com.vaadin.flow.router.QueryParameters
 
toString() - Method in class com.vaadin.flow.router.RouteAliasData
 
toString() - Method in class com.vaadin.flow.router.RouteData
 
toString() - Method in class com.vaadin.flow.router.RouteParameters
 
toString() - Method in class com.vaadin.flow.server.AppShellRegistry
 
toString() - Method in class com.vaadin.flow.server.frontend.FrontendVersion
 
toString() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
 
toString() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
 
toString() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
 
toString() - Method in enum class com.vaadin.flow.server.Mode
 
toString() - Method in class com.vaadin.flow.shared.ui.Dependency
 
trackAttach(Component) - Static method in class com.vaadin.flow.component.internal.ComponentTracker
Tracks the location where the component was attached.
trackCreate(Component) - Static method in class com.vaadin.flow.component.internal.ComponentTracker
Tracks the location where the component was created.
TRAILING - Enum constant in enum class com.vaadin.flow.dom.DebouncePhase
Debounce phase that is sent to the server once there have been at least one debounce timeout period since the last event of the same type.
translateUrl(String) - Method in interface com.vaadin.flow.theme.AbstractTheme
Translates the given url using the result of the AbstractTheme.getThemeUrl() theme method.
transport() - Element in annotation interface com.vaadin.flow.component.page.Push
Transport type used for the push for the annotated root navigation target (or custom UI).
Transport - Enum Class in com.vaadin.flow.shared.ui
Transport modes for Push
TRANSPORT_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
trimPath(String) - Static method in class com.vaadin.flow.router.internal.PathUtil
Trim the path by removing any leading and trailing whitespaces and slashes.
trimSegmentsString(String) - Static method in class com.vaadin.flow.router.internal.PathUtil
Trim the path by removing any leading and trailing whitespaces and trailing slashes.
trimTrailingSlashes(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Trims trailing slashes (if any) from a string.
tryLocateTool(String) - Method in class com.vaadin.flow.server.frontend.FrontendToolsLocator
Makes an attempt to locate the tool by its name.
TURBO - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
TV - Static variable in interface com.vaadin.flow.component.Key
Switches into TV viewing mode.
TV_3D_MODE - Static variable in interface com.vaadin.flow.component.Key
Toggles 3D TV mode on and off.
TV_ANTENNA_CABLE - Static variable in interface com.vaadin.flow.component.Key
Toggles between antenna and cable inputs.
TV_AUDIO_DESCRIPTION - Static variable in interface com.vaadin.flow.component.Key
Toggles audio description mode on and off.
TV_AUDIO_DESCRIPTION_MIX_DOWN - Static variable in interface com.vaadin.flow.component.Key
Decreases the audio description's mixing volume; reduces the volume of the audio descriptions relative to the program sound.
TV_AUDIO_DESCRIPTION_MIX_UP - Static variable in interface com.vaadin.flow.component.Key
Increases the audio description's mixing volume; increases the volume of the audio descriptions relative to the program sound.
TV_CONTENTS_MENU - Static variable in interface com.vaadin.flow.component.Key
Displays or hides the media contents available for playback (this may be a channel guide showing the currently airing programs, or a list of media files to play).
TV_DATA_SERVICE - Static variable in interface com.vaadin.flow.component.Key
Displays or hides the TV's data service menu.
TV_INPUT - Static variable in interface com.vaadin.flow.component.Key
Cycles the input mode on an external TV.
TV_INPUT_COMPONENT1 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "Component 1."
TV_INPUT_COMPONENT2 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "Component 2."
TV_INPUT_COMPOSITE1 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "Composite 1."
TV_INPUT_COMPOSITE2 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "Composite 2."
TV_INPUT_HDMI1 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "HDMI 1."
TV_INPUT_HDMI2 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "HDMI 2."
TV_INPUT_HDMI3 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "HDMI 3."
TV_INPUT_HDMI4 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "HDMI 4."
TV_INPUT_VGA1 - Static variable in interface com.vaadin.flow.component.Key
Switches to the input "VGA 1."
TV_MEDIA_CONTEXT - Static variable in interface com.vaadin.flow.component.Key
The Media Context menu key.
TV_NETWORK - Static variable in interface com.vaadin.flow.component.Key
Toggle the TV's network connection on and off.
TV_NUMBER_ENTRY - Static variable in interface com.vaadin.flow.component.Key
Put the TV into number entry mode.
TV_POWER - Static variable in interface com.vaadin.flow.component.Key
The device's power button.
TV_RADIO_SERVICE - Static variable in interface com.vaadin.flow.component.Key
Radio button.
TV_SATELLITE - Static variable in interface com.vaadin.flow.component.Key
Satellite button.
TV_SATELLITE_BS - Static variable in interface com.vaadin.flow.component.Key
Broadcast Satellite button.
TV_SATELLITE_CS - Static variable in interface com.vaadin.flow.component.Key
Communication Satellite button.
TV_SATELLITE_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles among available satellites.
TV_TERRESTRIAL_ANALOG - Static variable in interface com.vaadin.flow.component.Key
Selects analog terrestrial television service (analog cable or antenna reception).
TV_TERRESTRIAL_DIGITAL - Static variable in interface com.vaadin.flow.component.Key
Selects digital terrestrial television service (digital cable or antenna reception).
TV_TIMER - Static variable in interface com.vaadin.flow.component.Key
Timer programming button.
TYPE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
JsonObject type key for VirtualChildrenList.

U

UI - Class in com.vaadin.flow.component
The topmost component in any component hierarchy.
UI() - Constructor for class com.vaadin.flow.component.UI
Creates a new empty UI.
UI(UIInternalUpdater) - Constructor for class com.vaadin.flow.component.UI
Create a new empty UI with a custom UIInternalUpdater implementation.
UI_ID - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the parameter used to transmit the id of UI used in given request.
UI_ID_PARAMETER - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Name of the parameter used to transmit UI ids back and forth.
UI_NAVIGATE - Enum constant in enum class com.vaadin.flow.router.NavigationTrigger
Navigation was triggered via UI.navigate(String, QueryParameters).
UI_PARAMETER - Static variable in class com.vaadin.flow.server.InitParameters
The name of the parameter that is by default used in e.g.
UI_PUSHCONFIGURATION - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
UI_PUSHCONFIGURATION_PARAMETERS - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
UI.ClientViewPlaceholder - Class in com.vaadin.flow.component
Placeholder view when navigating from server-side views to client-side views.
UIDetachedException - Exception in com.vaadin.flow.component
Exception thrown if the UI has been detached when it should not be.
UIDetachedException() - Constructor for exception com.vaadin.flow.component.UIDetachedException
Creates an instance of the exception.
UIDetachedException(String) - Constructor for exception com.vaadin.flow.component.UIDetachedException
Creates an instance of the exception using the given message.
UIDetachedException(String, Throwable) - Constructor for exception com.vaadin.flow.component.UIDetachedException
Creates an instance of the exception using the given message and cause.
UIDetachedException(Throwable) - Constructor for exception com.vaadin.flow.component.UIDetachedException
Creates an instance of the exception using the given cause.
UIDL - Enum constant in enum class com.vaadin.flow.server.HandlerHelper.RequestType
UIDL requests.
UIDL_KEY_EXECUTE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used for data related to Page.executeJs(String, Serializable...) in UIDL messages.
UIDL_PUSH_ID - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The identifier used for Push messages.
UIDL_SECURITY_TOKEN_ID - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The identifier used for the CSRF token.
UidlRequestHandler - Class in com.vaadin.flow.server.communication
Processes a UIDL request from the client.
UidlRequestHandler() - Constructor for class com.vaadin.flow.server.communication.UidlRequestHandler
 
UidlWriter - Class in com.vaadin.flow.server.communication
Serializes pending server-side changes to UI state to JSON.
UidlWriter() - Constructor for class com.vaadin.flow.server.communication.UidlWriter
 
UidlWriter.ResolveContext - Class in com.vaadin.flow.server.communication
Provides context information for the resolve operations.
uiInit(UIInitEvent) - Method in interface com.vaadin.flow.server.UIInitListener
Notifies when UI is initialized .
UIInitEvent - Class in com.vaadin.flow.server
Event fired to UIInitListener when a UI has been initialized.
UIInitEvent(UI, VaadinService) - Constructor for class com.vaadin.flow.server.UIInitEvent
Constructs a prototypical Event.
UIInitListener - Interface in com.vaadin.flow.server
Event listener that can be registered for receiving an event when a UI is initialized.
UIInternals - Class in com.vaadin.flow.component.internal
Holds UI-specific methods and data which are intended for internal use by the framework.
UIInternals(UI) - Constructor for class com.vaadin.flow.component.internal.UIInternals
Creates a new instance for the given UI.
UIInternals(UI, UIInternalUpdater) - Constructor for class com.vaadin.flow.component.internal.UIInternals
Creates a new instance for the given UI.
UIInternals.JavaScriptInvocation - Class in com.vaadin.flow.component.internal
A Page.executeJs(String, Serializable...) invocation that has not yet been sent to the client.
UIInternalUpdater - Interface in com.vaadin.flow.component.internal
The implementation of this interface is responsible for updating the UI with given content.
UL - Static variable in annotation interface com.vaadin.flow.component.Tag
Tag for an <ul>.
UNAUTHORIZED - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (401) indicating that the request requires HTTP authentication.
UNDO - Static variable in interface com.vaadin.flow.component.Key
Undo the last action.
UNIDENTIFIED - Static variable in interface com.vaadin.flow.component.Key
The user agent wasn't able to map the event's virtual keycode to a specific key value.
UniqueSerializable - Class in com.vaadin.flow.shared.util
A base class for generating an unique object that is serializable.
UniqueSerializable() - Constructor for class com.vaadin.flow.shared.util.UniqueSerializable
 
Unit - Enum Class in com.vaadin.flow.component
Enum of supported units in Css sizes.
UNKNOWN - Enum constant in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
 
UnknownFeatureException - Exception in com.vaadin.experimental
Exception thrown for when a FeatureFlag that doesn't exist is checked.
UnknownFeatureException(String) - Constructor for exception com.vaadin.experimental.UnknownFeatureException
Exception constructor.
UnknownTaskException - Exception in com.vaadin.flow.server.frontend
Exception thrown for when a node task that is not in the task list is encountered.
UnknownTaskException(FallibleCommand) - Constructor for exception com.vaadin.flow.server.frontend.UnknownTaskException
Exception constructor.
UnknownVersionException(String, String) - Constructor for exception com.vaadin.flow.server.frontend.FrontendUtils.UnknownVersionException
Constructs an exception telling which tool was being detected and using what command.
UnknownVersionException(String, String, Exception) - Constructor for exception com.vaadin.flow.server.frontend.FrontendUtils.UnknownVersionException
Constructs an exception telling which tool was being detected and using what command, and the exception causing the failure.
UNLOAD_BEACON - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the parameter used for notifying the server that user closed the tab/window or navigated away.
unlock() - Method in class com.vaadin.flow.server.VaadinSession
Unlocks this session.
unlockSession(WrappedSession, Lock) - Method in class com.vaadin.flow.server.VaadinService
Releases the lock for the given session for this service instance.
UNOFFICIAL_NODEJS_DOWNLOAD_ROOT - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
 
unregister() - Method in interface com.vaadin.flow.server.StreamRegistration
Unregister StreamResource.
unregister(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.AttachExistingElementFeature
Unregister the node and clean up all associated data.
unregister(StateNode) - Method in interface com.vaadin.flow.internal.NodeOwner
Unregisters a node from this owner.
unregister(StateNode) - Method in class com.vaadin.flow.internal.NullOwner
 
unregister(StateNode) - Method in class com.vaadin.flow.internal.StateTree
 
unregisterListener() - Method in class com.vaadin.flow.component.ComponentEvent
Unregisters the event listener currently being invoked.
unregisterResource(StreamReceiver) - Method in class com.vaadin.flow.server.StreamResourceRegistry
Unregister a stream receiver resource.
UNSUPPORTED_MEDIA_TYPE - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (415) indicating that the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
UnsupportedBrowserHandler - Class in com.vaadin.flow.server
A RequestHandler that presents an informative page that the browser in use will not work.
UnsupportedBrowserHandler() - Constructor for class com.vaadin.flow.server.UnsupportedBrowserHandler
 
UnsupportedPropertyTypeException - Exception in com.vaadin.flow.server.webcomponent
UnsupportedPropertyTypeException is throw when WebComponentExporter tries to register a property encasing an unsupported value type.
UnsupportedPropertyTypeException(String) - Constructor for exception com.vaadin.flow.server.webcomponent.UnsupportedPropertyTypeException
Constructs a new runtime exception with the specified detail message.
update(Command) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
update(Command) - Method in class com.vaadin.flow.router.RouteConfiguration
Block updates to the registry configuration from other threads until update command has completed.
update(Command) - Method in interface com.vaadin.flow.server.RouteRegistry
Block updates to the registry configuration from other threads until update command has completed.
update(String, String) - Method in interface com.vaadin.flow.internal.BrowserLiveReload
Request an update of the resource with the given path.
updateActiveState() - Method in class com.vaadin.flow.internal.StateNode
Update "active"/"inactive" state of the node.
updateFromClient(String, Serializable) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Receives a value update from the client.
updatePropertiesToComponent() - Method in class com.vaadin.flow.server.webcomponent.WebComponentBinding
Calls the bound change handlers defined via PropertyConfiguration.onChange(SerializableBiConsumer) for each bound property with the current value of the property.
updateProperty(String, JsonValue) - Method in class com.vaadin.flow.server.webcomponent.WebComponentBinding
Updates a property bound to the component.
updateProperty(String, Serializable) - Method in class com.vaadin.flow.server.webcomponent.WebComponentBinding
Updates a property bound to the component.
updateReadOnly(boolean) - Method in class com.vaadin.flow.server.webcomponent.PropertyData
Creates a copy of this with the new readOnly value.
updateRegistry(Set<WebComponentConfiguration<? extends Component>>) - Method in class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Internal method for updating registry.
updateRoot(UI, HasElement, HasElement) - Method in interface com.vaadin.flow.component.internal.UIInternalUpdater
Update root element of the given UI.
updateRouteRegistry(RouteRegistry, Set<Class<?>>, Set<Class<?>>, Set<Class<?>>) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Updates route registry as necessary when classes have been added / modified / deleted.
UploadException - Exception in com.vaadin.flow.server
Upload exception class.
UploadException(Exception) - Constructor for exception com.vaadin.flow.server.UploadException
Exception constructor with exception.
UploadException(String) - Constructor for exception com.vaadin.flow.server.UploadException
Exception constructor with message.
UploadInterruptedException() - Constructor for exception com.vaadin.flow.server.communication.StreamReceiverHandler.UploadInterruptedException
Constructs an instance of UploadInterruptedException.
upperCamelCaseToDashSeparatedLowerCase(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Converts a UpperCamelCase string into dash ("-") separated lowercase.
upperCaseUnderscoreToHumanFriendly(String) - Static method in class com.vaadin.flow.internal.CaseUtil
Converts an UPPER_CASE_STRING to a human friendly format (Upper Case String).
URI_ATTRIBUTE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
The property in Json object which marks the object as special value transmitting URI (not just any string).
URL_PARAMETER_CLOSE_APPLICATION - Static variable in class com.vaadin.flow.server.Constants
A request parameter that can be given in browser to force the Vaadin application to close an existing UI and session.
URL_PARAMETER_RESTART_APPLICATION - Static variable in class com.vaadin.flow.server.Constants
A request parameter that can be given in browser to force the Vaadin application to create a new UI and session instance, thus overriding @PreserveOnRefresh annotation.
URL_PATTERN - Static variable in class com.vaadin.flow.server.communication.UidlRequestHandler
 
UrlUtil - Class in com.vaadin.flow.internal
Internal utility class for URL handling.
UsageStatistics - Class in com.vaadin.flow.internal
Collects entries that should be exported for vaadin-usage-statistics when running in development mode.
UsageStatistics.UsageEntry - Class in com.vaadin.flow.internal
A usage statistics entry.
UsageStatisticsExporter - Class in com.vaadin.flow.internal
A class for exporting UsageStatistics entries.
UsageStatisticsExporter() - Constructor for class com.vaadin.flow.internal.UsageStatisticsExporter
 
USE_PROXY - Enum constant in enum class com.vaadin.flow.server.HttpStatusCode
Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field.
useAuthentication() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
Check if proxy uses authentication.
useByteCodeScanner(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets frontend scanner strategy: byte code scanning strategy is used if byteCodeScanner is true, full classpath scanner strategy is used otherwise (by default).
useGlobalPnpm(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Uses globally installed pnpm tool for frontend packages installation.
username - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
User name for proxy.
Uses - Annotation Interface in com.vaadin.flow.component.dependency
Marks that an annotated component implicitly uses another component.
Uses.Container - Annotation Interface in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple Uses annotations.

V

VAADIN_APP_PACKAGE_HASH - Static variable in class com.vaadin.flow.server.frontend.TaskUpdatePackages
 
VAADIN_BUILD - Static variable in class com.vaadin.flow.server.Constants
The static build resources folder.
VAADIN_BUILD_FILES_PATH - Static variable in class com.vaadin.flow.server.Constants
The prefix used for all internal static files, relative to context root.
VAADIN_CONFIGURATION - Static variable in class com.vaadin.flow.server.Constants
The static configuration resources folder.
VAADIN_CORE_VERSIONS_JSON - Static variable in class com.vaadin.flow.server.Constants
The name of platform core components and tools versions file.
VAADIN_MAPPING - Static variable in class com.vaadin.flow.server.Constants
The path used in the vaadin servlet for handling static resources.
VAADIN_PREFIX - Static variable in class com.vaadin.flow.server.Constants
The prefix used for System property parameters.
VAADIN_PUSH_DEBUG_JS - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the debug version of the javascript containing push support.
VAADIN_PUSH_JS - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The name of the javascript containing push support.
VAADIN_SERVLET_RESOURCES - Static variable in class com.vaadin.flow.server.Constants
The path to meta-inf/VAADIN/ where static resources are put on the servlet.
VAADIN_STATIC_FILES_PATH - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The prefix used for all internal static files, relative to context root.
VAADIN_VERSIONS_JSON - Static variable in class com.vaadin.flow.server.Constants
The name of platform commercial components and tools versions file.
VAADIN_WEBAPP - Static variable in class com.vaadin.flow.server.Constants
The static resources root folder.
VAADIN_WEBAPP_RESOURCES - Static variable in class com.vaadin.flow.server.Constants
The path to webapp/ public resources root.
VaadinApplicationInitializationBootstrap - Interface in com.vaadin.flow.function
Represents Vaadin web application initialization bootstrap.
VaadinAppShellInitializer - Class in com.vaadin.flow.server.startup
Servlet initializer visiting AppShellConfigurator configuration.
VaadinAppShellInitializer() - Constructor for class com.vaadin.flow.server.startup.VaadinAppShellInitializer
 
VaadinConfig - Interface in com.vaadin.flow.server
Configuration in which VaadinService is running.
VaadinContext - Interface in com.vaadin.flow.server
Context in which VaadinService is running.
VaadinContextInitializer - Interface in com.vaadin.flow.internal
Allows to run initialization of VaadinContext which for some reasons may not be done via ServletContextListener.
VaadinContextStartupInitializer - Interface in com.vaadin.flow.server.startup
Applies this initializer to the given VaadinContext.
VaadinInitializerException - Exception in com.vaadin.flow.server.startup
Indicates an issue during Vaadin initialization.
VaadinInitializerException(String) - Constructor for exception com.vaadin.flow.server.startup.VaadinInitializerException
Constructs a new exception with the specified detail message.
VaadinInitializerException(String, Throwable) - Constructor for exception com.vaadin.flow.server.startup.VaadinInitializerException
Constructs a new exception with the specified detail message and cause.
VaadinRequest - Interface in com.vaadin.flow.server
A generic request to the server, wrapping a more specific request type, e.g.
VaadinResponse - Interface in com.vaadin.flow.server
A generic response from the server, wrapping a more specific response type, e.g.
VaadinService - Class in com.vaadin.flow.server
An abstraction of the underlying technology, e.g.
VaadinService() - Constructor for class com.vaadin.flow.server.VaadinService
Creates a service.
VaadinService(DeploymentConfiguration) - Constructor for class com.vaadin.flow.server.VaadinService
Creates a new vaadin service based on a deployment configuration.
VaadinServiceInitListener - Interface in com.vaadin.flow.server
Listener for VaadinService initialization events.
VaadinServlet - Class in com.vaadin.flow.server
The main servlet, which handles all incoming requests to the application.
VaadinServlet() - Constructor for class com.vaadin.flow.server.VaadinServlet
 
VaadinServletConfig - Class in com.vaadin.flow.server
VaadinConfig implementation for Servlets.
VaadinServletConfig(ServletConfig) - Constructor for class com.vaadin.flow.server.VaadinServletConfig
Vaadin servlet configuration wrapper constructor.
VaadinServletContext - Class in com.vaadin.flow.server
VaadinServletContext(ServletContext) - Constructor for class com.vaadin.flow.server.VaadinServletContext
Creates an instance of this context with given ServletContext.
VaadinServletContextStartupInitializer - Interface in com.vaadin.flow.server.startup
Allows a library/runtime to be notified of a web application's startup phase and perform any required programmatic registration of servlets, filters, and listeners in response to it.
VaadinServletRequest - Class in com.vaadin.flow.server
Wrapper for HttpServletRequest.
VaadinServletRequest(HttpServletRequest, VaadinServletService) - Constructor for class com.vaadin.flow.server.VaadinServletRequest
Wraps a http servlet request and associates with a vaadin service.
VaadinServletResponse - Class in com.vaadin.flow.server
Wrapper for HttpServletResponse.
VaadinServletResponse(HttpServletResponse, VaadinServletService) - Constructor for class com.vaadin.flow.server.VaadinServletResponse
Wraps a http servlet response and an associated vaadin service.
VaadinServletService - Class in com.vaadin.flow.server
A service implementation connected to a VaadinServlet.
VaadinServletService() - Constructor for class com.vaadin.flow.server.VaadinServletService
Creates a servlet service.
VaadinServletService(VaadinServlet, DeploymentConfiguration) - Constructor for class com.vaadin.flow.server.VaadinServletService
Creates an instance connected to the given servlet and using the given configuration.
VaadinSession - Class in com.vaadin.flow.server
Contains everything that Vaadin needs to store for a specific user.
VaadinSession(VaadinService) - Constructor for class com.vaadin.flow.server.VaadinSession
Creates a new VaadinSession tied to a VaadinService.
VaadinSessionState - Enum Class in com.vaadin.flow.server
The lifecycle state of a VaadinSession.
VaadinUriResolver - Class in com.vaadin.flow.shared
Utility for translating special Vaadin URIs into URLs usable by the browser.
VaadinUriResolver() - Constructor for class com.vaadin.flow.shared.VaadinUriResolver
 
validate(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
validateClass(Class<?>) - Method in class com.vaadin.flow.server.AppShellRegistry
Checks whether a class have annotations that should only be in AppShellConfigurator classes.
validateClasses(Collection<Class<?>>) - Method in class com.vaadin.flow.server.startup.AbstractAnnotationValidator
Validate the correctness of the annotations returned by the AbstractAnnotationValidator.getAnnotations() method applied to the classSet.
validateNodeAndNpmVersion() - Method in class com.vaadin.flow.server.frontend.FrontendTools
Validate that the found node and npm versions are new enough.
validatePwaClass(VaadinContext, Stream<Class<?>>) - Method in class com.vaadin.flow.server.startup.AbstractRouteRegistryInitializer
Validate PWA annotations of the potential route classes stream, search for properly annotated PWA class and return it, or null if none existing.
validateRouteClasses(VaadinContext, Stream<Class<?>>) - Method in class com.vaadin.flow.server.startup.AbstractRouteRegistryInitializer
Validate the potential route classes stream and return them as a set.
validateStylePropertyName(String) - Static method in class com.vaadin.flow.dom.ElementUtil
Validates the given style property name and throws an exception if the name is invalid.
validateStylePropertyValue(String) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks if the given style property value is valid.
validateWildcardType(Class<?>, Class<?>) - Static method in class com.vaadin.flow.router.ParameterDeserializer
Validate that we can support the given wildcard parameter type.
value() - Element in annotation interface com.vaadin.flow.component.ClientCallable
Controls RPC for the method from the client side to the server side when the element is disabled.
value() - Element in annotation interface com.vaadin.flow.component.dependency.CssImport.Container
Internally used to enable use of multiple CssImport annotations.
value() - Element in annotation interface com.vaadin.flow.component.dependency.CssImport
Location of the file with the CSS content.
value() - Element in annotation interface com.vaadin.flow.component.dependency.JavaScript.Container
Internally used to enable use of multiple JavaScript annotations.
value() - Element in annotation interface com.vaadin.flow.component.dependency.JavaScript
JavaScript file URL to load before using the annotated Component in the browser.
value() - Element in annotation interface com.vaadin.flow.component.dependency.JsModule.Container
Internally used to enable use of multiple JsModule annotations.
value() - Element in annotation interface com.vaadin.flow.component.dependency.JsModule
JavaScript module to load before using the annotated Component in the browser.
value() - Element in annotation interface com.vaadin.flow.component.dependency.NpmPackage.Container
Internally used to enable use of multiple NpmPackage annotations.
value() - Element in annotation interface com.vaadin.flow.component.dependency.NpmPackage
npm package to install before loading any JS modules declared using JsModule.
value() - Element in annotation interface com.vaadin.flow.component.dependency.StyleSheet.Container
Internally used to enable use of multiple StyleSheet annotations.
value() - Element in annotation interface com.vaadin.flow.component.dependency.StyleSheet
Style sheet file URL to load before using the annotated Component in the browser.
value() - Element in annotation interface com.vaadin.flow.component.dependency.Uses.Container
Internally used to enable use of multiple Uses annotations.
value() - Element in annotation interface com.vaadin.flow.component.dependency.Uses
Marks the component class to depend on.
value() - Element in annotation interface com.vaadin.flow.component.DomEvent
The name of the DOM event which should fire the annotated component event.
value() - Element in annotation interface com.vaadin.flow.component.EventData
A JavaScript expression that will be evaluated to collect data when an event is handled.
value() - Element in annotation interface com.vaadin.flow.component.page.Inline.Container
Internally used to enable use of multiple Inline annotations.
value() - Element in annotation interface com.vaadin.flow.component.page.Inline
Classpath file to inline into target element.
value() - Element in annotation interface com.vaadin.flow.component.page.Meta.Container
Internally used to enable use of multiple Meta annotations.
value() - Element in annotation interface com.vaadin.flow.component.page.Push
The PushMode to use for the annotated root navigation target (or custom UI).
value() - Element in annotation interface com.vaadin.flow.component.page.Viewport
Gets the viewport tag content.
value() - Element in annotation interface com.vaadin.flow.component.Synchronize
The DOM event(s) to use for synchronization.
value() - Element in annotation interface com.vaadin.flow.component.Tag
Gets the tag name.
value() - Element in annotation interface com.vaadin.flow.component.template.Id
The id of the element to map to.
value() - Element in annotation interface com.vaadin.flow.router.internal.DependencyTrigger
The classes the should trigger loading of dependencies.
value() - Element in annotation interface com.vaadin.flow.router.ListenerPriority
The priority of the annotated listener, can be any integer.
value() - Element in annotation interface com.vaadin.flow.router.PageTitle
Gets the HTML title that should be used.
value() - Element in annotation interface com.vaadin.flow.router.ParentLayout
Sets the parent component for the route target component.
value() - Element in annotation interface com.vaadin.flow.router.Route
Sets the route template suffix value of the annotated class.
value() - Element in annotation interface com.vaadin.flow.router.RouteAlias.Container
Internally used to enable use of multiple RouteAlias annotations.
value() - Element in annotation interface com.vaadin.flow.router.RouteAlias
Gets the route alias path value of the annotated class.
value() - Element in annotation interface com.vaadin.flow.router.RoutePrefix
Sets the route prefix defined for class.
value() - Element in annotation interface com.vaadin.flow.server.LoadDependenciesOnStartup
The views for which to load dependencies when the application is opened for the first time.
value() - Element in annotation interface com.vaadin.flow.shared.GwtIncompatible
Has no technical meaning, is only used for documentation
value() - Element in annotation interface com.vaadin.flow.theme.Theme
The name of the theme to use.
VALUE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
valueBound(HttpSessionBindingEvent) - Method in class com.vaadin.flow.server.VaadinSession
 
valueChanged(E) - Method in interface com.vaadin.flow.component.HasValue.ValueChangeListener
Invoked when this listener receives a value change event from an event source to which it has been added.
valueEquals(T, T) - Method in class com.vaadin.flow.component.AbstractCompositeField
Compares to value instances to each other to determine whether they are equal.
valueEquals(T, T) - Method in class com.vaadin.flow.component.AbstractField
Compares to value instances to each other to determine whether they are equal.
valueEquals(T, T) - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
Delegate method corresponding to AbstractField.valueEquals(Object, Object).
valueOf(String) - Static method in enum class com.vaadin.flow.component.Direction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.HasText.WhiteSpace
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.KeyLocation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.KeyModifier
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.page.Inline.Position
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.page.Inline.Wrapping
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.page.TargetElement
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.ScrollOptions.Alignment
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.ScrollOptions.Behavior
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.Unit
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.DebouncePhase
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.DisabledUpdateMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.NodeVisitor.ElementType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.BoxSizing
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.Clear
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.Display
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.FloatCss
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.Overflow
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.Position
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.TextAlign
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.Visibility
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.dom.Style.WhiteSpace
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.internal.BrowserLiveReload.Backend
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.router.NavigationTrigger
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.router.RouteParameterFormatOption
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.server.communication.AtmospherePushConnection.State
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.server.HandlerHelper.RequestType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.server.HttpStatusCode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.server.Mode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.server.PwaIcon.Domain
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.server.VaadinSessionState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.shared.communication.PushMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.shared.ui.Dependency.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.shared.ui.LoadMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.shared.ui.Transport
Returns the enum constant of this class with the specified name.
ValueProvider<SOURCE,TARGET> - Interface in com.vaadin.flow.function
A callback interface for providing values from a given source.
values() - Static method in enum class com.vaadin.flow.component.Direction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.HasText.WhiteSpace
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.KeyLocation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.KeyModifier
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.page.Inline.Position
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.page.Inline.Wrapping
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.page.TargetElement
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.ScrollOptions.Alignment
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.ScrollOptions.Behavior
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.Unit
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.DebouncePhase
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.DisabledUpdateMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.NodeVisitor.ElementType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.BoxSizing
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.Clear
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.Display
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.FloatCss
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.Overflow
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.Position
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.TextAlign
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.Visibility
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.dom.Style.WhiteSpace
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.internal.BrowserLiveReload.Backend
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.router.NavigationTrigger
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.router.RouteParameterFormatOption
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.server.communication.AtmospherePushConnection.State
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.server.HandlerHelper.RequestType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.server.HttpStatusCode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.server.Mode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.server.PwaIcon.Domain
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.server.VaadinSessionState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.shared.communication.PushMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.shared.ui.Dependency.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.shared.ui.LoadMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.shared.ui.Transport
Returns an array containing the constants of this enum class, in the order they are declared.
valueUnbound(HttpSessionBindingEvent) - Method in class com.vaadin.flow.server.VaadinSession
 
variant() - Element in annotation interface com.vaadin.flow.theme.Theme
The theme variant, if any.
verifyFolderExists(Map<String, String>, String) - Method in class com.vaadin.flow.server.startup.AbstractConfigurationFactory
Verify that given folder actually exists on the system if we are not in production mode.
verifyNoOtherSessionLocked(VaadinSession) - Static method in class com.vaadin.flow.server.VaadinService
Checks that another VaadinSession instance is not locked.
verifyParameters(Class<?>, List<String>) - Static method in class com.vaadin.flow.router.ParameterDeserializer
Verifies that the list of route parameters is valid for the given navigation target.
verifyRelativePath(String) - Static method in class com.vaadin.flow.router.LocationUtil
Throws InvalidLocationException if the provided path is not parseable as a relative path.
verifyTool(File) - Method in class com.vaadin.flow.server.frontend.FrontendToolsLocator
Verifies that the tool specified works by performing its test launch.
version() - Element in annotation interface com.vaadin.flow.component.dependency.NpmPackage
Defines the npm package version.
Version - Class in com.vaadin.flow.server
Provides information about the current version of Vaadin Flow.
Version() - Constructor for class com.vaadin.flow.server.Version
 
VH - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the viewport's height.
VIDEO_MODE_NEXT - Static variable in interface com.vaadin.flow.component.Key
Cycles through the available video modes.
ViewAccessChecker - Class in com.vaadin.flow.server.auth
Checks access to views using an AccessAnnotationChecker.
ViewAccessChecker() - Constructor for class com.vaadin.flow.server.auth.ViewAccessChecker
Creates an instance.
ViewAccessChecker(boolean) - Constructor for class com.vaadin.flow.server.auth.ViewAccessChecker
Creates an instance and enables access checker depending on the given flag.
ViewAccessChecker(AccessAnnotationChecker) - Constructor for class com.vaadin.flow.server.auth.ViewAccessChecker
Creates an instance using the given checker.
Viewport - Annotation Interface in com.vaadin.flow.component.page
Defines a viewport tag that will be added to the HTML of the host page of a UI class.
VIRTUAL - Enum constant in enum class com.vaadin.flow.dom.NodeVisitor.ElementType
The type of the virtual element: the element which has been created via Element API and attached using Node.appendVirtualChild(Element...).
VIRTUAL_ATTACHED - Enum constant in enum class com.vaadin.flow.dom.NodeVisitor.ElementType
The type of the virtual element: the element which is created automatically by the engine for the existing client side element and attached to it.
VIRTUAL_CHILDREN - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
VirtualChildrenList - Class in com.vaadin.flow.internal.nodefeature
List of nodes describing the virtually connected child elements of an element.
VirtualChildrenList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Creates a new element virtual children list for the given node.
VISIBILITY_BOUND_PROPERTY - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
The property value used on the client side only in addition to NodeProperties.VISIBLE.
VISIBILITY_HIDDEN_PROPERTY - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
The property used on the client side only in addition to NodeProperties.VISIBLE.
VISIBILITY_STYLE_DISPLAY_PROPERTY - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
The property used on the client side only in addition to NodeProperties.VISIBLE.
VISIBLE - Enum constant in enum class com.vaadin.flow.dom.Style.Overflow
 
VISIBLE - Enum constant in enum class com.vaadin.flow.dom.Style.Visibility
 
VISIBLE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
visit(NodeVisitor.ElementType, Element) - Method in interface com.vaadin.flow.dom.NodeVisitor
Visit the element using provided element type.
visit(ShadowRoot) - Method in interface com.vaadin.flow.dom.NodeVisitor
Visit the shadow root.
visit(StateNode, NodeVisitor) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Visit the node applying visitor to it and its descendants based on the return value from the visitor.
visit(StateNode, NodeVisitor) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
visit(StateNode, NodeVisitor) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
visit(StateNode, NodeVisitor) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
visitDescendants(Node<?>, NodeVisitor) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
Apply the visitor for the descendants of the node.
visitNodeTree(Consumer<StateNode>) - Method in class com.vaadin.flow.internal.StateNode
Applies the visitor to this node and all its descendants.
VITE_CONFIG - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The name of the vite configuration file.
VITE_DEVMODE_TS - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of Vite helper used in development mode.
VITE_GENERATED_CONFIG - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
The name of the generated vite configuration file.
VMAX - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the viewport's larger dimension.
VMIN - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the viewport's smaller dimension.
VOICE_DIAL - Static variable in interface com.vaadin.flow.component.Key
The Voice Dial key.
VW - Enum constant in enum class com.vaadin.flow.component.Unit
Unit code representing the viewport's width.

W

WAKE_UP - Static variable in interface com.vaadin.flow.component.Key
The WakeUp key; used to wake the computer from the hibernation or standby modes.
WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
WARNING_PUSH_MODE_NOT_RECOGNIZED - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
WARNING_XSRF_PROTECTION_DISABLED - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
WEB_COMPONENT - Enum constant in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
 
WEB_COMPONENT_BOOTSTRAP_FILE_NAME - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the web component bootstrap file that is generated in frontend FrontendUtils.GENERATED folder.
WEB_COMPONENT_HTML - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
File name of the web-component.html in client side.
WebBrowser - Class in com.vaadin.flow.server
Provides information about the web browser the user is using that is directly available in the request, for instance browser name and version and IP address.
WebComponent<C extends Component> - Class in com.vaadin.flow.component.webcomponent
Acts as a proxy to the web component root onto which the exporter Component is added.
WebComponent(WebComponentBinding, Element) - Constructor for class com.vaadin.flow.component.webcomponent.WebComponent
Constructs a WebComponent.
WEBCOMPONENT_RESYNC - Enum constant in enum class com.vaadin.flow.server.HandlerHelper.RequestType
WebComponent resynchronization requests.
WebComponentBinding<C extends Component> - Class in com.vaadin.flow.server.webcomponent
Represents a single instance of a exported web component instance embedded onto a host page.
WebComponentBinding(C) - Constructor for class com.vaadin.flow.server.webcomponent.WebComponentBinding
Constructs a new WebComponentBinding.
WebComponentBootstrapHandler - Class in com.vaadin.flow.server.communication
Bootstrap handler for WebComponent requests.
WebComponentBootstrapHandler() - Constructor for class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
Creates a new bootstrap handler with default page builder.
WebComponentBootstrapHandler(BootstrapHandler.PageBuilder) - Constructor for class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
Creates a new bootstrap handler, allowing to use custom page builder.
WebComponentConfiguration<C extends Component> - Interface in com.vaadin.flow.component.webcomponent
Result of defining an embeddable web component using WebComponentExporter.
WebComponentConfigurationFactory() - Constructor for class com.vaadin.flow.component.WebComponentExporter.WebComponentConfigurationFactory
 
WebComponentConfigurationRegistry - Class in com.vaadin.flow.server.webcomponent
Registry for storing available web component configuration implementations.
WebComponentConfigurationRegistry() - Constructor for class com.vaadin.flow.server.webcomponent.WebComponentConfigurationRegistry
Protected constructor for internal OSGi extensions.
WebComponentConfigurationRegistryInitializer - Class in com.vaadin.flow.server.startup
Servlet initializer for collecting all classes that extend WebComponentExporter/WebComponentExporterFactory on startup, creates unique WebComponentConfiguration instances, and adds them to WebComponentConfigurationRegistry.
WebComponentConfigurationRegistryInitializer() - Constructor for class com.vaadin.flow.server.startup.WebComponentConfigurationRegistryInitializer
 
WebComponentConnectEvent(UI, boolean, String, String, String, JsonObject) - Constructor for class com.vaadin.flow.component.webcomponent.WebComponentUI.WebComponentConnectEvent
Creates a new web component connection event.
WebComponentExporter<C extends Component> - Class in com.vaadin.flow.component
Exports a Component as a web component.
WebComponentExporter(String) - Constructor for class com.vaadin.flow.component.WebComponentExporter
Creates a new WebComponentExporter instance and configures the tag name of the web component created based on this exporter.
WebComponentExporter.WebComponentConfigurationFactory - Class in com.vaadin.flow.component
Produces WebComponentConfiguration instances from either WebComponentExporter classes or instances.
WebComponentExporterAwareValidator - Class in com.vaadin.flow.server.startup
Checks that specific annotations are not configured wrong.
WebComponentExporterAwareValidator() - Constructor for class com.vaadin.flow.server.startup.WebComponentExporterAwareValidator
 
WebComponentExporterFactory<C extends Component> - Interface in com.vaadin.flow.component
Exports a Component as a web component.
WebComponentExporterFactory.DefaultWebComponentExporterFactory<C extends Component> - Class in com.vaadin.flow.component
Default factory implementation which uses an exporter class to instantiate it using its default constructor.
WebComponentExporterTagExtractor - Class in com.vaadin.flow.server.webcomponent
Retrieves web component tag from a WebComponentExporterFactory object.
WebComponentExporterTagExtractor() - Constructor for class com.vaadin.flow.server.webcomponent.WebComponentExporterTagExtractor
 
WebComponentExporterUtils - Class in com.vaadin.flow.server.webcomponent
Internal utility methods for WebComponentExporter and WebComponentExporterFactory classes.
WebComponentGenerator - Class in com.vaadin.flow.server.webcomponent
Generates a client-side web component from a Java class.
WebComponentModulesWriter - Class in com.vaadin.flow.server.webcomponent
Writes web components generated from WebComponentExporter implementation classes to a target directory.
WebComponentModulesWriter.DirectoryWriter - Class in com.vaadin.flow.server.webcomponent
Enables the usage of given WebComponentModulesWriter class via reflection.
WebComponentProvider - Class in com.vaadin.flow.server.communication
Request handler that supplies the script/html of the web component matching the given tag.
WebComponentProvider() - Constructor for class com.vaadin.flow.server.communication.WebComponentProvider
 
WebComponentUI - Class in com.vaadin.flow.component.webcomponent
Custom UI for use with WebComponents served from the server.
WebComponentUI() - Constructor for class com.vaadin.flow.component.webcomponent.WebComponentUI
 
WebComponentUI.WebComponentConnectEvent - Class in com.vaadin.flow.component.webcomponent
Event used for sending the activation event for an exported web component from the client to the server.
WebComponentWrapper - Class in com.vaadin.flow.component.webcomponent
Wrapper component for a web component that exposes ClientCallable methods that the client-side components expect to be available.
WebComponentWrapper(Element, WebComponentBinding<?>) - Constructor for class com.vaadin.flow.component.webcomponent.WebComponentWrapper
Wrapper class for the server side WebComponent.
WebComponentWrapper(Element, WebComponentBinding<?>, List<Element>) - Constructor for class com.vaadin.flow.component.webcomponent.WebComponentWrapper
Wrapper class for the server side WebComponent.
WEBSOCKET - Enum constant in enum class com.vaadin.flow.shared.ui.Transport
Websocket.
WEBSOCKET_BUFFER_SIZE - Static variable in class com.vaadin.flow.shared.communication.PushConstants
The size, in bytes, of the receiving buffer used by some servers.
WEBSOCKET_FRAGMENT_SIZE - Static variable in class com.vaadin.flow.shared.communication.PushConstants
The maximum size, in characters, of a websocket message fragment.
WEBSOCKET_XHR - Enum constant in enum class com.vaadin.flow.shared.ui.Transport
Websocket for server to client, XHR for client to server.
whenFrontendMappingAvailable(Runnable) - Static method in class com.vaadin.flow.server.VaadinServlet
Runs the given runnable when frontend mapping is available.
width() - Element in annotation interface com.vaadin.flow.component.page.BodySize
Definition for body width.
WildcardParameter - Annotation Interface in com.vaadin.flow.router
Marks a Navigation url parameter as a wildcard allowing 0-N parameter parts to be bound for this url parameter.
WINDOWS - Enum constant in enum class com.vaadin.flow.shared.BrowserDetails.OperatingSystem
 
WINK - Static variable in interface com.vaadin.flow.component.Key
Causes the device to identify itself in some fashion, such as by flashing a light, briefly changing the brightness of indicator lights, or emitting a tone.
withAlt() - Method in class com.vaadin.flow.component.ShortcutRegistration
Fluently adds KeyModifier.ALT to the shortcut's modifiers.
withBuildDirectory(String) - Method in class com.vaadin.flow.server.frontend.Options
Use the specified directory name (inside the project folder) for the build output.
withBundleBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Whether to run bundle build.
withCiBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Enables ci build.
withCopyTemplates(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether copy templates to META-INF/VAADIN/config/templates.
withCtrl() - Method in class com.vaadin.flow.component.ShortcutRegistration
Fluently adds KeyModifier.CONTROL to the shortcut's modifiers.
withEmbeddableWebComponents(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether to collect and package WebComponentExporter dependencies.
withEnablePnpm(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Enables pnpm tool.
withFeatureFlags(FeatureFlags) - Method in class com.vaadin.flow.server.frontend.Options
 
withForceProductionBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Setting this to true will force a build of the production build even if there is a default production bundle that could be used.
withFrontendDirectory(File) - Method in class com.vaadin.flow.server.frontend.Options
Sets the directory containing the project's frontend files
withFrontendGeneratedFolder(File) - Method in class com.vaadin.flow.server.frontend.Options
Set the folder where frontend files should be generated.
withFrontendHotdeploy(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Whether to run with a dev server (when not in production mode).
withHomeNodeExecRequired(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Requires node executable to be installed in vaadin home folder.
withJarFrontendResourcesFolder(File) - Method in class com.vaadin.flow.server.frontend.Options
Sets the appropriate npm package folder for copying flow resources in jars.
withLeaveObservers(Deque<BeforeLeaveHandler>) - Static method in class com.vaadin.flow.router.internal.Postpone
Set any remaining BeforeLeaveHandlers to be continued from.
withLength(int, int) - Static method in class com.vaadin.flow.internal.Range
Creates a range from a start point, with a given length.
withMeta() - Method in class com.vaadin.flow.component.ShortcutRegistration
Fluently adds KeyModifier.META to the shortcut's modifiers.
withModifiers(KeyModifier...) - Method in class com.vaadin.flow.component.ShortcutRegistration
Configures KeyModifiers for the shortcut.
withNavigationObservers(Deque<BeforeEnterHandler>) - Static method in class com.vaadin.flow.router.internal.Postpone
Set any remaining BeforeEnterHandlers to be continued from.
withNodeDownloadRoot(URI) - Method in class com.vaadin.flow.server.frontend.Options
Sets the download node.js URL.
withNodeVersion(String) - Method in class com.vaadin.flow.server.frontend.Options
Sets the node.js version to be used when node.js is installed automatically by Vaadin, for example "v16.0.0".
withOnly(int) - Static method in class com.vaadin.flow.internal.Range
Creates a range object representing a single integer.
withPath(String) - Method in class com.vaadin.flow.router.NavigationStateBuilder
Assign the path that was used for determining the navigation target.
withPostinstallPackages(List<String>) - Method in class com.vaadin.flow.server.frontend.Options
Sets the additional npm packages to run postinstall for.
withProductionMode(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets the production mode.
withRunNpmInstall(boolean) - Method in class com.vaadin.flow.server.frontend.Options
Sets whether run npm install after updating dependencies.
withShift() - Method in class com.vaadin.flow.component.ShortcutRegistration
Fluently adds KeyModifier.SHIFT to the shortcut's modifiers.
withTarget(RouteTarget, RouteParameters) - Method in class com.vaadin.flow.router.NavigationStateBuilder
Assigns the given route target with the given route parameters to the navigation state being built.
withTarget(Class<? extends Component>) - Method in class com.vaadin.flow.router.NavigationStateBuilder
Assigns the given navigation target to the navigation state being built.
withTarget(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.router.NavigationStateBuilder
Assigns the given navigation target with the given url parameter to the navigation state being built.
withTokenFile(File) - Method in class com.vaadin.flow.server.frontend.Options
Sets the token file (flow-build-info.json) path.
withWebpack(File, File) - Method in class com.vaadin.flow.server.frontend.Options
Sets the webpack related properties.
WrappedHttpSession - Class in com.vaadin.flow.server
Wrapper for HttpSession.
WrappedHttpSession(HttpSession) - Constructor for class com.vaadin.flow.server.WrappedHttpSession
Creates a new wrapped http session.
WrappedSession - Interface in com.vaadin.flow.server
A generic session, wrapping a more specific session implementation, e.g.
wrapperElement - Variable in class com.vaadin.flow.component.UI
 
wrapping() - Element in annotation interface com.vaadin.flow.component.page.Inline
The element type to inline as.
write(OutputStream) - Method in class com.vaadin.flow.server.PwaIcon
Writes the icon image to output stream.
writeBootstrapPage(String, VaadinResponse, Element, String) - Method in class com.vaadin.flow.server.communication.WebComponentBootstrapHandler
Copies the Elements found in the given head elements into the head of the embedding website using JavaScript.
writeCacheHeaders(String, HttpServletResponse) - Method in class com.vaadin.flow.server.StaticFileServer
Writes cache headers for the file into the response.
writeErrorCodeIfRequestLocationIsInvalid(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.BootstrapHandler
Checks whether the request is for a valid location, and if not, writes the error code for the response.
writeIfChanged(File, String) - Static method in class com.vaadin.flow.server.frontend.FileIOUtils
Writes the given content into the given file unless the file already contains that content.
writeIfChanged(File, List<String>) - Static method in class com.vaadin.flow.server.frontend.FileIOUtils
Writes the given content into the given file unless the file already contains that content.
writeModificationTimestamp(URL, HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.server.StaticFileServer
Writes the modification timestamp info for the file into the response.
writeOutput(Map<File, List<String>>) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
 
writeResponseContents(String, URL, HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.internal.ResponseWriter
Writes the contents and content type (if available) of the given resourceUrl to the response.
writeStringResponse(VaadinResponse, String, String) - Method in class com.vaadin.flow.server.VaadinService
Writes the given string as a response using the given content type.
writeToHttpSession(WrappedSession, VaadinSession) - Method in class com.vaadin.flow.server.VaadinService
Performs the actual write of the VaadinSession to the underlying HTTP session after sanity checks have been performed.
writeUncachedStringResponse(VaadinResponse, String, String) - Method in class com.vaadin.flow.server.VaadinService
Writes the given string as a response with headers to prevent caching and using the given content type.

Y

YELLOW - Static variable in class com.vaadin.flow.server.frontend.FrontendUtils
 

Z

ZENKAKU - Static variable in interface com.vaadin.flow.component.Key
The Zenkaku (full width) characters key.
ZENKAKU_HANAKU - Static variable in interface com.vaadin.flow.component.Key
The Zenkaku/Hankaku (full width/half width) toggle key.
ZOOM_IN - Static variable in interface com.vaadin.flow.component.Key
The ZoomIn key.
ZOOM_OUT - Static variable in interface com.vaadin.flow.component.Key
The ZoomOut key.
ZOOM_TOGGLE - Static variable in interface com.vaadin.flow.component.Key
Toggles between full-screen and scaled content display, or otherwise change the magnification level.
A B C D E F G H I J K L M N O P Q R S T U V W Y Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form