Skip navigation links
$ A B C D E F G H I J K L M N O P Q R S T U V W Z 

$

$modelType() - Method in interface com.vaadin.flow.templatemodel.TemplateModelProxyHandler.ModelProxy
Gets the model type definition for this type.
$modelType(BeanModelType<?>) - Method in interface com.vaadin.flow.templatemodel.TemplateModelProxyHandler.ModelProxy
Sets the model type for this instance.
$stateNode() - Method in interface com.vaadin.flow.templatemodel.TemplateModelProxyHandler.ModelProxy
Gets the state node that this instance is backed by.
$stateNode(StateNode) - Method in interface com.vaadin.flow.templatemodel.TemplateModelProxyHandler.ModelProxy
Sets the state node that this instance is backed by.

A

A - Static variable in annotation type 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.
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.
AbstractBasicModelType<T> - Class in com.vaadin.flow.templatemodel
Common abstract class with generic functionality for basic mode type.
AbstractBasicModelType(Class<T>) - Constructor for class com.vaadin.flow.templatemodel.AbstractBasicModelType
 
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.
AbstractDeploymentConfiguration - Class in com.vaadin.flow.server
An abstract base class for DeploymentConfiguration implementations.
AbstractDeploymentConfiguration() - Constructor for class com.vaadin.flow.server.AbstractDeploymentConfiguration
 
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(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(Element, T) - Constructor for class com.vaadin.flow.component.AbstractField
Creates a new field with the given element instance.
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.
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.
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
 
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>, 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.
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.
AbstractStreamResource - Class in com.vaadin.flow.server
Abstract stream resource class.
AbstractStreamResource() - Constructor for class com.vaadin.flow.server.AbstractStreamResource
 
AbstractTemplate<M> - Class in com.vaadin.flow.component.polymertemplate
 
AbstractTemplate() - Constructor for class com.vaadin.flow.component.polymertemplate.AbstractTemplate
 
AbstractTemplate(StateNode) - Constructor for class com.vaadin.flow.component.polymertemplate.AbstractTemplate
 
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 - Static variable in interface com.vaadin.flow.component.Key
The Accept, Commit, or OK key or button.
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(T, U, V) - Method in interface com.vaadin.flow.function.SerializableTriConsumer
Performs the action.
accept(OutputStream, VaadinSession) - Method in interface com.vaadin.flow.server.StreamResourceWriter
Handles stream (writes data to it) using session as a context.
ACCEPT_ALL - Static variable in class com.vaadin.flow.templatemodel.PropertyFilter
An unwrapped filter that accepts all property names.
accepts(Type) - Method in class com.vaadin.flow.templatemodel.AbstractBasicModelType
 
accepts(Type) - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
accepts(Type) - Method in class com.vaadin.flow.templatemodel.ConvertedModelType
 
accepts(Type) - Method in class com.vaadin.flow.templatemodel.ListModelType
 
accepts(Type) - Method in interface com.vaadin.flow.templatemodel.ModelType
Checks whether this type can accept application values of the given type.
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.
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.
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.
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(Component...) - Method in interface com.vaadin.flow.component.HasComponents
Adds the given components as children of this component.
add(String) - Method in interface com.vaadin.flow.component.HasComponents
Add the given text as children of this component.
add(Dependency) - Method in class com.vaadin.flow.component.internal.DependencyList
Adds the given dependency to be loaded by the client side.
ADD - Static variable in interface com.vaadin.flow.component.Key
The numeric keypad's addition key, +.
add(Component...) - Method in class com.vaadin.flow.component.UI
Adds the given components to the UI.
add(String) - Method in class com.vaadin.flow.dom.impl.ImmutableClassList
 
add(String) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
add(int, StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
add(String, DomEventListener) - Method in class com.vaadin.flow.internal.nodefeature.ElementListenerMap
Add eventData for an event type.
add(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
add(int, StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
add(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Adds an item to the end 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(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
add(String, String[]) - Method in class com.vaadin.flow.internal.nodefeature.PolymerEventListenerMap
Adds a listener for a event created from a template method.
add(int, T) - Method in class com.vaadin.flow.internal.nodefeature.SerializableNodeList
 
add(int, StateNode) - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
add(String, DisabledUpdateMode) - Method in class com.vaadin.flow.internal.nodefeature.SynchronizedPropertiesList
Add the property to the synchronized properties 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, 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) - 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, T) - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
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 String>) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
addAll(Collection<? extends StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
 
addAll(Collection<? extends T>) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Adds all provided items to the end of the list.
addAll(Collection<? extends StateNode>) - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
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.
addBootstrapListener(BootstrapListener) - Method in class com.vaadin.flow.server.ServiceInitEvent
Adds a new bootstrap listener that will be used by this service.
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, JavaScript or HtmlImport 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.
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.
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.
addEventListener(String, DomEventListener) - Method in class com.vaadin.flow.dom.Element
Adds an event listener for the given event type.
addEventListener(String, DomEventListener, String...) - Method in class com.vaadin.flow.dom.Element
Deprecated.
Instead, use the returned registration instance for adding event data expressions
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
 
addFavIcon(String, String, String) - Method in class com.vaadin.flow.server.InitialPageSettings
Append a fav icon link to initial page head.
addFavIcon(InitialPageSettings.Position, String, String, String) - Method in class com.vaadin.flow.server.InitialPageSettings
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.
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.
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.
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
 
addHtmlImport(String) - Method in class com.vaadin.flow.component.page.Page
Adds the given HTML import to the page and ensures that it is loaded successfully.
addHtmlImport(String, LoadMode) - Method in class com.vaadin.flow.component.page.Page
Adds the given HTML import to the page and ensures that it is loaded successfully.
addingBundle(Bundle, BundleEvent) - Method in class com.vaadin.flow.server.osgi.VaadinBundleTracker
 
addInlineDependency(Inline, VaadinRequest) - Method in class com.vaadin.flow.server.InlineTargets
Inline contents from classpath file to head of initial page.
addInlineFromFile(String, InitialPageSettings.WrapMode) - Method in class com.vaadin.flow.server.InitialPageSettings
Inline contents from classpath file to append to head of initial page.
addInlineFromFile(InitialPageSettings.Position, String, InitialPageSettings.WrapMode) - Method in class com.vaadin.flow.server.InitialPageSettings
Inline contents from classpath file to head of initial page.
addInlineWithContents(String, InitialPageSettings.WrapMode) - Method in class com.vaadin.flow.server.InitialPageSettings
Add content to append to head of initial page.
addInlineWithContents(InitialPageSettings.Position, String, InitialPageSettings.WrapMode) - Method in class com.vaadin.flow.server.InitialPageSettings
Add content to head of initial page.
addInputListener(ComponentEventListener<InputEvent>) - Method in interface com.vaadin.flow.component.InputNotifier
Adds an input listener to this component.
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(UIInternals.JavaScriptInvocation) - Method in class com.vaadin.flow.component.internal.UIInternals
Adds a JavaScript invocation to be sent to the client.
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.
addLink(String) - Method in class com.vaadin.flow.server.InitialPageSettings
Add a link to be appended to initial page head.
addLink(InitialPageSettings.Position, String) - Method in class com.vaadin.flow.server.InitialPageSettings
Add a link to initial page head.
addLink(String, Map<String, String>) - Method in class com.vaadin.flow.server.InitialPageSettings
Append a link to initial page head.
addLink(InitialPageSettings.Position, String, Map<String, String>) - Method in class com.vaadin.flow.server.InitialPageSettings
Add a link to initial page head.
addLink(String, String) - Method in class com.vaadin.flow.server.InitialPageSettings
Append a link to initial page head.
addLink(InitialPageSettings.Position, String, String) - Method in class com.vaadin.flow.server.InitialPageSettings
Add a link to initial page head.
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.
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.
addMetaTag(String, String) - Method in class com.vaadin.flow.server.InitialPageSettings
Add a meta tag to be appended to initial page head.
addMetaTag(InitialPageSettings.Position, String, String) - Method in class com.vaadin.flow.server.InitialPageSettings
Add a meta tag to initial page head.
addPollListener(ComponentEventListener<PollEvent>) - Method in interface com.vaadin.flow.component.PollNotifier
Add a poll listener.
addPropertyChangeListener(String, PropertyChangeListener) - Method in class com.vaadin.flow.dom.Element
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.
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.internal.nodefeature.ElementPropertyMap
Adds a property change listener.
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.
addRoute(Class<? extends Component>) - Method in class com.vaadin.flow.server.startup.RouteTarget
Add a new route navigation target.
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.
addScannedClasses(Map<Long, Collection<Class<?>>>) - Method in class com.vaadin.flow.server.osgi.OSGiAccess
Adds scanned classes in active bundles.
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, Command, Key, KeyModifier...) - Static method in class com.vaadin.flow.component.Shortcuts
Invoke a Command when the shortcut is invoked.
addShortcutListener(Component, ShortcutEventListener, Key, KeyModifier...) - Method in class com.vaadin.flow.component.Shortcuts
Invoke a ShortcutEventListener when the shortcut is 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.
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.
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.
addSynchronizedProperty(String) - Method in class com.vaadin.flow.dom.Element
addSynchronizedProperty(String, DisabledUpdateMode) - Method in class com.vaadin.flow.dom.Element
addSynchronizedProperty(StateNode, String, DisabledUpdateMode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Makes the property synchronized from the client side to the server.
addSynchronizedProperty(StateNode, String, DisabledUpdateMode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
addSynchronizedProperty(StateNode, String, DisabledUpdateMode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
addSynchronizedProperty(StateNode, String, DisabledUpdateMode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
addSynchronizedPropertyEvent(String) - Method in class com.vaadin.flow.dom.Element
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.
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<S, T>>) - Method in class com.vaadin.flow.component.AbstractCompositeField
 
addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<C, T>>) - Method in class com.vaadin.flow.component.AbstractField
 
addValueChangeListener(HasValue.ValueChangeListener<? super E>) - Method in interface com.vaadin.flow.component.HasValue
Adds a value change listener.
addValueChangeListener(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<C, T>>) - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
afterNavigation(AfterNavigationEvent) - Method in interface com.vaadin.flow.router.internal.AfterNavigationHandler
Method called after navigation has been executed.
afterNavigation(AfterNavigationEvent) - Method in class com.vaadin.flow.router.RouterLink
 
AfterNavigationEvent - Class in com.vaadin.flow.router
Event created before navigation happens.
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 interface that handles AfterNavigationEvent.
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 com.vaadin.ui.Component implementing this interface will be informed when they have been attached to the UI and 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.
allowBrowserDefault() - Method in class com.vaadin.flow.component.ShortcutRegistration
Allows the default keyboard event handling when the shortcut is invoked.
AllowClientUpdates - Annotation Type in com.vaadin.flow.templatemodel
Defines the access control setting for a model property.
AllowClientUpdates.Container - Annotation Type in com.vaadin.flow.templatemodel
Internal annotation to enable use of multiple AllowClientUpdates annotations.
allowEventPropagation() - Method in class com.vaadin.flow.component.ShortcutRegistration
Allow the event to propagate upwards in the DOM tree, when the shortcut is invoked.
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.
ALPHANUMERIC - Static variable in interface com.vaadin.flow.component.Key
The Alphanumeric key.
ALT - Static variable in interface com.vaadin.flow.component.Key
The Alt (Alternative) 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_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
 
and(Predicate<? super T>) - Method in interface com.vaadin.flow.function.SerializablePredicate
 
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
 
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.
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(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) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
Appends an item supplied with payload type 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.
appendChild(Element...) - Method in class com.vaadin.flow.dom.Node
Adds the given children as the last children of this 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(Element...) - Method in class com.vaadin.flow.dom.Node
Appends the given children as the virtual children of the element.
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() - Constructor for class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Creates a new uninitialized route registry.
applicationToModel(Object, PropertyFilter) - Method in class com.vaadin.flow.templatemodel.BasicComplexModelType
 
applicationToModel(Object, PropertyFilter) - Method in class com.vaadin.flow.templatemodel.BasicModelType
 
applicationToModel(Object, PropertyFilter) - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
applicationToModel(Object, PropertyFilter) - Method in interface com.vaadin.flow.templatemodel.ComplexModelType
 
applicationToModel(Object, PropertyFilter) - Method in class com.vaadin.flow.templatemodel.ConvertedModelType
 
applicationToModel(Object, PropertyFilter) - Method in class com.vaadin.flow.templatemodel.ListModelType
 
applicationToModel(Object, PropertyFilter) - Method in interface com.vaadin.flow.templatemodel.ModelType
Creates a model value representation of the provided application value.
apply(T) - Method in interface com.vaadin.flow.component.ItemLabelGenerator
Gets a caption for the item.
apply(SOURCE) - Method in interface com.vaadin.flow.function.ValueProvider
Provides a value from the given source object.
areWebJarsEnabled() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Determines if webJars mechanism is enabled.
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 type 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 type com.vaadin.flow.component.Tag
Tag for an <aside>.
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 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.
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.
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 .
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
BasicComplexModelType<T> - Class in com.vaadin.flow.templatemodel
A model type representing an immutable leaf value (e.g.
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.
BasicModelType - Class in com.vaadin.flow.templatemodel
A model type representing an immutable leaf value, e.g.
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.
BeanModelType<T> - Class in com.vaadin.flow.templatemodel
A model type corresponding to a Java bean type.
BeanModelType(Class<T>, Map<String, BeanModelType.BeanModelTypeProperty>, boolean) - Constructor for class com.vaadin.flow.templatemodel.BeanModelType
Creates a new bean model type from the given class and properties.
BeanModelType(Class<T>, PropertyFilter, boolean) - Constructor for class com.vaadin.flow.templatemodel.BeanModelType
Creates a new bean model type with the bean properties of the provided class that passes the provided property filter.
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
Method called before navigation to attaching Component chain is made.
BeforeEnterEvent - Class in com.vaadin.flow.router
Event created before navigation happens.
BeforeEnterEvent(NavigationEvent, Class<?>) - Constructor for class com.vaadin.flow.router.BeforeEnterEvent
Construct event from a NavigationEvent.
BeforeEnterEvent(Router, NavigationTrigger, Location, Class<?>, UI) - Constructor for class com.vaadin.flow.router.BeforeEnterEvent
Constructs a new BeforeNavigation Event.
BeforeEnterHandler - Interface in com.vaadin.flow.router.internal
The base interface for every interface that handles BeforeEnterEvent.
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 com.vaadin.ui.Component implementing this interface will be informed when they are being attached to the UI.
BeforeEvent - Class in com.vaadin.flow.router
Abstract before event class that has the common functionalities for BeforeLeaveEvent and BeforeEnterEvent.
BeforeEvent(NavigationEvent, Class<?>) - Constructor for class com.vaadin.flow.router.BeforeEvent
Construct event from a NavigationEvent.
BeforeEvent(Router, NavigationTrigger, Location, Class<?>, UI) - Constructor for class com.vaadin.flow.router.BeforeEvent
Constructs a new BeforeNavigation Event.
beforeLeave(BeforeLeaveEvent) - Method in interface com.vaadin.flow.router.internal.BeforeLeaveHandler
Method called before navigation to detaching Component chain is made.
BeforeLeaveEvent - Class in com.vaadin.flow.router
Event created before navigation happens.
BeforeLeaveEvent(NavigationEvent, Class<?>) - Constructor for class com.vaadin.flow.router.BeforeLeaveEvent
Construct event from a NavigationEvent.
BeforeLeaveEvent(Router, NavigationTrigger, Location, Class<?>, UI) - Constructor for class com.vaadin.flow.router.BeforeLeaveEvent
Constructs a new BeforeNavigation Event.
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 interface that handles BeforeLeaveEvent.
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 com.vaadin.ui.Component implementing this interface will be informed when they are being detached from the UI.
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.
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
Class that represents the DOM event "blur".
BodySize - Annotation Type in com.vaadin.flow.component.page
Defines the body size that will be added to the HTML of the host pages.
BootstrapContext(VaadinRequest, VaadinResponse, VaadinSession, UI) - 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
 
BootstrapHandler.BootstrapContext - Class in com.vaadin.flow.server
Provides context information for the bootstrap process.
BootstrapHandler.BootstrapUriResolver - Class in com.vaadin.flow.server
The URI resolver used in the bootstrap process.
BootstrapListener - Interface in com.vaadin.flow.server
This event listener is notified when the bootstrap HTML is about to be generated and sent to the client.
BootstrapPageResponse - Class in com.vaadin.flow.server
This represents the state of a bootstrap page being generated.
BootstrapPageResponse(VaadinRequest, VaadinSession, VaadinResponse, Document, UI, VaadinUriResolver) - Constructor for class com.vaadin.flow.server.BootstrapPageResponse
Create a new bootstrap page response.
BootstrapUriResolver(UI) - Constructor for class com.vaadin.flow.server.BootstrapHandler.BootstrapUriResolver
Creates a new bootstrap resolver based on the given request and session.
BR - Static variable in annotation type 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.
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.
BrowserDetails - Class in com.vaadin.flow.shared
Class that 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 in com.vaadin.flow.shared
An enum for 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.
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.
BundleDependencyFilter - Class in com.vaadin.flow.server.startup
Filter for serving bundles instead of single dependencies basing on the bundling information.
BundleDependencyFilter(WebBrowser, String, Map<String, Set<String>>) - Constructor for class com.vaadin.flow.server.startup.BundleDependencyFilter
Creates a filter with the required information.
BundleFilterFactory - Class in com.vaadin.flow.server.startup
Factory for bundle filters.
BundleFilterFactory() - Constructor for class com.vaadin.flow.server.startup.BundleFilterFactory
 
BUTTON - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <button>.

C

CALL - Static variable in interface com.vaadin.flow.component.Key
The Call key; dials the number which has been entered.
callFunction(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 interface com.vaadin.flow.component.page.Page.ExecutionCanceler
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).
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.HeartbeatHandler
 
canHandleRequest(VaadinRequest) - Method in class com.vaadin.flow.server.communication.UidlRequestHandler
 
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.
cast(Class<C>) - Method in class com.vaadin.flow.templatemodel.BasicComplexModelType
 
cast(Class<C>) - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
cast(Class<C>) - Method in interface com.vaadin.flow.templatemodel.ComplexModelType
Checks that this type uses the provided proxy type and returns this type as a model type with that proxy type.
cast(Class<C>) - Method in class com.vaadin.flow.templatemodel.ListModelType
 
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.
checkForDuplicates(Class<? extends Component>, Collection<Class<? extends RouterLayout>>) - Static method in class com.vaadin.flow.router.internal.RouterUtil
Deprecated.
Checks that the same component type is not used in multiple parts of a route chain.
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.
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.
CHILD_TEMPLATE_KEY - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used for storing child template nodes.
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.
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
 
ClassList - Interface in com.vaadin.flow.dom
Representation of the class names for an Element.
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 - Static variable in interface com.vaadin.flow.component.Key
The Clear key.
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() - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
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, boolean, int, int, int, int, int, int, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.ClickEvent
Creates a new click event.
ClickEvent(Component) - Constructor for class com.vaadin.flow.component.ClickEvent
Creates a new server-side click event with no additional information.
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_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 Type in com.vaadin.flow.component
Publishes the annotated method so it can be invoked from the client side using the notation this.$server.method() in template methods.
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.
ClientResources - Interface in com.vaadin.flow.client
Service which allows to get resources from the client side module.
ClientResourcesUtils - Class in com.vaadin.flow.client
Utilities to load client access resources from the client side module.
ClientUpdateMode - Enum in com.vaadin.flow.templatemodel
A mode for whether a model property may be updated from the client.
CLOSE - Static variable in interface com.vaadin.flow.component.Key
Closes the current document or message.
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.
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_BRACKET - Static variable in class com.vaadin.flow.server.UnsupportedBrowserHandler
 
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).
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.
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.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 as dirty since the last time this method was invoked.
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.
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.flow.client - package com.vaadin.flow.client
 
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.polymertemplate - package com.vaadin.flow.component.polymertemplate
 
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.nodefeature - package com.vaadin.flow.internal.nodefeature
 
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.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.osgi - package com.vaadin.flow.server.osgi
 
com.vaadin.flow.server.startup - package com.vaadin.flow.server.startup
 
com.vaadin.flow.server.webjar - package com.vaadin.flow.server.webjar
 
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.templatemodel - package com.vaadin.flow.templatemodel
 
com.vaadin.flow.theme - package com.vaadin.flow.theme
 
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.
commitJsonResponse(VaadinResponse, String) - Static method in class com.vaadin.flow.server.communication.UidlRequestHandler
Commit the JSON response.
compareTo(T) - Method in class com.vaadin.flow.router.RouteBaseData
 
ComplexModelType<T> - Interface in com.vaadin.flow.templatemodel
A complex model type (represents either a list or a bean).
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.HtmlImportDependency - Class in com.vaadin.flow.component.internal
 
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.
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 - Static variable in interface com.vaadin.flow.component.Key
The Compose key.
compose(Map<String, T>, String) - Method in class com.vaadin.flow.templatemodel.PathLookup
Composes a new path lookup that contains all items of this path lookup and all provided items supplemented with the provided path prefix.
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, boolean, String, String) - Constructor for class com.vaadin.flow.component.CompositionEndEvent
Creates a new composition event.
CompositionEndEvent(Component) - Constructor for class com.vaadin.flow.component.CompositionEndEvent
Creates a new server-side composition event with no additional information.
CompositionEvent - Class in com.vaadin.flow.component.internal
Abstract class for composition events.
CompositionEvent(Component, boolean, String, String) - Constructor for class com.vaadin.flow.component.internal.CompositionEvent
Creates a new composition event.
CompositionEvent(Component) - Constructor for class com.vaadin.flow.component.internal.CompositionEvent
Creates a new server-side composition event with no additional information.
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, boolean, String, String) - Constructor for class com.vaadin.flow.component.CompositionStartEvent
Creates a new composition event.
CompositionStartEvent(Component) - Constructor for class com.vaadin.flow.component.CompositionStartEvent
Creates a new server-side composition event with no additional information.
CompositionUpdateEvent - Class in com.vaadin.flow.component
The event when a composition is updated.
CompositionUpdateEvent(Component, boolean, String, String) - Constructor for class com.vaadin.flow.component.CompositionUpdateEvent
Creates a new composition event.
CompositionUpdateEvent(Component) - Constructor for class com.vaadin.flow.component.CompositionUpdateEvent
Creates a new server-side composition event with no additional information.
configure(ConfigureRoutes) - Method in interface com.vaadin.flow.router.internal.AbstractRouteRegistry.Configuration
Configure the given configurable route holder object.
configure(AbstractRouteRegistry.Configuration) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
Thread-safe update of the RouteConfiguration.
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.
configurePage(InitialPageSettings) - Method in interface com.vaadin.flow.server.PageConfigurator
Configure the initial page 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.
connect(AtmosphereResource) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Associates this AtmospherePushConnection with the given AtmosphereResource representing an established push connection.
connectionLost() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Called when the connection to the client has been lost.
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.
contains(Object) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
contains(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ModelList
Returns true if this list contains the specified node.
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(int) - Method in class com.vaadin.flow.internal.Range
Checks whether an integer is found within this range.
contains(Class<? extends C>) - Method in class com.vaadin.flow.internal.ReflectionCache
Checks whether this cache contains an entry for the given type.
contains(String) - Static method in enum 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
 
containsTarget(Class<? extends Component>) - Method in class com.vaadin.flow.server.startup.RouteTarget
Check if navigation target is present in current target.
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).
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
 
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
 
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.
ConvertedModelType<A,M extends Serializable> - Class in com.vaadin.flow.templatemodel
A ModelType implementation that wraps a model type for performing type conversions on together with a ModelEncoder.
convertPrimitiveType(Class<?>) - Static method in class com.vaadin.flow.internal.ReflectTools
Converts the given primitive type to its boxed version.
convertToApplication(Serializable) - Method in class com.vaadin.flow.templatemodel.AbstractBasicModelType
Converts the given model value to the application type of this model type.
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 - Static variable in interface com.vaadin.flow.component.Key
The Copy key (on certain extended keyboards).
copy(int) - Method in class com.vaadin.flow.internal.change.AbstractListChange
Gets a copy of the change with the same data except index.
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(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(boolean) - Method in class com.vaadin.flow.server.startup.RouteTarget
Create a copy of this RouteTarget.
CR_SEL - Static variable in interface com.vaadin.flow.component.Key
The Cursor Select key, CrSel.
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
 
createArray(JsonValue...) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a new JSON array with the given values.
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 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.
createDeploymentConfiguration(Class<?>, ServletConfig) - Static method in class com.vaadin.flow.server.DeploymentConfigurationFactory
Creates a DeploymentConfiguration instance that is filled with all parameters, specified for the current app.
createDeploymentConfiguration() - Method in class com.vaadin.flow.server.VaadinServlet
Creates a deployment configuration to be used for the creation of a VaadinService.
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.
createEvent(NavigationEvent, List<HasElement>) - Static method in class com.vaadin.flow.router.internal.RouterUtil
Deprecated.
Create a new location change event for given navigation event and chain.
createFilters(VaadinService) - Method in class com.vaadin.flow.server.startup.BundleFilterFactory
Creates bundle filters 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.
createInitialValue(StateNode, String) - Method in class com.vaadin.flow.templatemodel.AbstractBasicModelType
 
createInitialValue(StateNode, String) - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
createInitialValue(StateNode, String) - Method in class com.vaadin.flow.templatemodel.ConvertedModelType
 
createInitialValue(StateNode, String) - Method in class com.vaadin.flow.templatemodel.ListModelType
 
createInitialValue(StateNode, String) - Method in interface com.vaadin.flow.templatemodel.ModelType
Create initial value for the given property and set it for the node.
createInitialValues(StateNode) - Method in class com.vaadin.flow.templatemodel.BeanModelType
Creates initial values for the given node using info from this model type.
createInitParameters(Class<?>, ServletConfig) - Static method in class com.vaadin.flow.server.DeploymentConfigurationFactory
Generate Property containing parameters for with all parameters contained in current application.
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.
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.
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.
createModelProxy(StateNode, BeanModelType<T>) - Static method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler
Creates a proxy object for the given modelType type for the given state node.
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.
createPropertyDeploymentConfiguration(Class<?>, ServletConfig) - Static 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.
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() - 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(VaadinServletService) - Method in class com.vaadin.flow.server.VaadinServlet
Creates a new instance of StaticFileHandler, that is responsible to find and serve static resources.
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.
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.
createUINotFoundJSON() - 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.
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.
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
Class for validating 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).

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 type 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.
debounce(int, DebouncePhase, DebouncePhase...) - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Configures the debouncing phases for which this listener should be triggered.
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.
DebouncePhase - Enum in com.vaadin.flow.dom
Defines phases for an event that is debounced.
DebounceSettings - Annotation Type in com.vaadin.flow.component
Debounce settings for declaratively defined client-side event handlers.
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
 
decode(E) - Method in interface com.vaadin.flow.templatemodel.ModelEncoder
Decodes the given value.
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 type 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_DISPLAY - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_HEARTBEAT_INTERVAL - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
DEFAULT_ICON - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_NAME - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_OFFLINE_PATH - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_PATH - Static variable in class com.vaadin.flow.server.PwaConfiguration
 
DEFAULT_SEND_URLS_AS_PARAMETERS - Static variable in class com.vaadin.flow.server.DefaultDeploymentConfiguration
 
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
 
DefaultClientResources - Class in com.vaadin.flow.client
Default implementation for ClientResources service which returns the client-side resources via the plain Java Class.getResourceAsStream(String) method.
DefaultClientResources() - Constructor for class com.vaadin.flow.client.DefaultClientResources
 
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(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() - Constructor for class com.vaadin.flow.server.DefaultErrorHandler
 
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.
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.
DefaultTemplateParser - Class in com.vaadin.flow.component.polymertemplate
Default template parser implementation.
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 .
Dependency - Class in com.vaadin.flow.shared.ui
Represents an html import, stylesheet or JavaScript to include on the page.
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 in com.vaadin.flow.shared.ui
The type of a dependency.
DependencyFilter - Interface in com.vaadin.flow.server
Filter for dependencies loaded using @StyleSheet, @JavaScript and @HtmlImport.
DependencyFilter.FilterContext - Class in com.vaadin.flow.server
Provides context information for the dependency filter operation.
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.
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
A class that creates DeploymentConfiguration filled with all parameters specified by the framework users.
deserializeParameter(Class<T>, String, String) - Static method in class com.vaadin.flow.router.ParameterDeserializer
Deserializer method for known parameter types.
deserializeUrlParameters(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.
detatchPotentialChild(Object) - Method in class com.vaadin.flow.internal.nodefeature.NodeFeature
Detaches an object if it is a StateNode.
DEVICE_DIMENSIONS - Static variable in annotation type com.vaadin.flow.component.page.Viewport
Sets the viewport at the width and height of the device.
DEVICE_HEIGHT - Static variable in annotation type com.vaadin.flow.component.page.Viewport
Sets the viewport to the height of the device rather than the rendered space.
DIALOG_GRACE_PERIOD_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
DIALOG_GRACE_PERIOD_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
DIALOG_MODAL_DEFAULT - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
DIALOG_MODAL_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
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.
DISABLE_AUTOMATIC_SERVLET_REGISTRATION - Static variable in class com.vaadin.flow.server.Constants
Configuration name for the parameter that determines if Flow should automatically register servlets needed for the application to work.
DISABLE_WEBJARS - Static variable in class com.vaadin.flow.server.Constants
Configuration name for the parameter that determines if Flow should use webJars or not.
disableAutomaticServletRegistration() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Determines if Flow should automatically register servlets.
DisabledUpdateMode - Enum 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.
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 type 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 type com.vaadin.flow.component.Tag
Tag for an <dl>.
doHandleMultipartFileUpload(VaadinSession, VaadinRequest, VaadinResponse, StreamReceiver, StateNode) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
Method used to stream 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
Internal initialization method, should not be overridden.
DOM_EVENT_NAME - Static variable in class com.vaadin.flow.component.PollEvent
 
DomEvent - Annotation Type in com.vaadin.flow.component
Maps a DOM event to a ComponentEvent.
DomEvent - Class in com.vaadin.flow.dom
Server-side representation of a DOM event fired in the browser.
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.
DT - Static variable in annotation type 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 and clears the queue.
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).

E

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
A class representing 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(String, boolean) - Constructor for class com.vaadin.flow.dom.Element
Deprecated.
The autoCreate parameter no longer has any effect. Use Element.Element(String) instead.
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 - Static variable in annotation type 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.templatemodel.PathLookup
Creates an empty path lookup.
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.
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.
Encode - Annotation Type in com.vaadin.flow.templatemodel
Defines a ModelEncoder on a template model property found through Encode.path().
encode(D) - Method in interface com.vaadin.flow.templatemodel.ModelEncoder
Encodes the given value.
Encode.Container - Annotation Type in com.vaadin.flow.templatemodel
Internal annotation to enable use of multiple Encode annotations.
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 - 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.
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.
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
 
ENTER - Static variable in interface com.vaadin.flow.component.Key
The Enter or key.
EQUAL - Static variable in interface com.vaadin.flow.component.Key
=+ on a US keyboard.
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.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.shared.ui.Dependency
 
equals(Object) - Method in class com.vaadin.flow.shared.util.UniqueSerializable
 
equals(Object) - Method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler.InterfaceProxy
 
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_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
Interface for listening to errors in the application.
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.
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.
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 - Static variable in interface com.vaadin.flow.component.Key
The Esc (Escape) or key.
escape(String) - Static method in class com.vaadin.flow.internal.HtmlUtils
Escape a string which may contain html.
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.
eventActionsSupported() - Method in class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
Checks whether this renderer should reroute or postpone navigation based on results from event listeners.
eventActionsSupported() - Method in class com.vaadin.flow.router.internal.ErrorStateRenderer
 
eventActionsSupported() - Method in class com.vaadin.flow.router.internal.NavigationStateRenderer
 
EventData - Annotation Type 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
 
EventHandler - Annotation Type in com.vaadin.flow.component.polymertemplate
Publishes the annotated method so it can be invoked from the client side as template event handlers.
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_SEL - Static variable in interface com.vaadin.flow.component.Key
The ExSel (Extend Selection) key.
Exclude - Annotation Type in com.vaadin.flow.templatemodel
Defines which properties to exclude when importing a bean into a template model.
EXECUTE - Static variable in interface com.vaadin.flow.component.Key
The Execute key.
execute() - Method in interface com.vaadin.flow.server.Command
Runs the given command.
executeJavaScript(String, Serializable...) - Method in class com.vaadin.flow.component.page.Page
Asynchronously runs the given JavaScript expression in the browser.
executeJavaScript(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.
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.
export(JsonObject) - Method in class com.vaadin.flow.internal.ConstantPoolKey
Exports the this key into a JSON object to send to the client.

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.
FakeBrowser - Class in com.vaadin.flow.server.startup
Browser instance targeted for server side resolving of resources.
FakeBrowser() - Constructor for class com.vaadin.flow.server.startup.FakeBrowser
 
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
 
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.
filter(List<Dependency>, DependencyFilter.FilterContext) - Method in interface com.vaadin.flow.server.DependencyFilter
Filters the list of dependencies and returns a (possibly) updated version.
filter(List<Dependency>, DependencyFilter.FilterContext) - Method in class com.vaadin.flow.server.startup.BundleDependencyFilter
 
FilterContext(VaadinService, WebBrowser) - Constructor for class com.vaadin.flow.server.DependencyFilter.FilterContext
Creates a new context for the given session.
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.
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.
findErrorHandler(VaadinSession) - Static method in class com.vaadin.flow.server.ErrorEvent
Method for finding the error handler for the given session.
findLocale(VaadinSession, VaadinRequest) - Static method in class com.vaadin.flow.server.ServletHelper
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.
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).
findThemeForNavigationTarget(UI, Class<?>, String) - Static method in class com.vaadin.flow.theme.ThemeUtil
Find annotated theme for navigationTarget on given path or lumo if available.
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.Component
Dispatches the event to all listeners registered for the event type.
fireEvent(ComponentEvent) - Method in class com.vaadin.flow.component.ComponentEventBus
Dispatches the event to all listeners registered for the event type.
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.
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.
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).
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
Interface with the methods implemented by components 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
Class that represents the DOM event "focus".
FOOTER - Static variable in annotation type 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.
FORCE_LOAD_COOKIE - Static variable in class com.vaadin.flow.server.UnsupportedBrowserHandler
Cookie used to ignore browser checks.
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
 
forIdentifier(String) - Static method in enum 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.
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(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, 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.
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.
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.
FRONTEND_PROTOCOL_PREFIX - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Protocol used for referencing different files based on the browser capability of interpreting ECMAScript 6.
FRONTEND_URL_DEV_DEFAULT - Static variable in class com.vaadin.flow.server.Constants
Default frontend URL prefix for development.
FRONTEND_URL_ES5 - Static variable in class com.vaadin.flow.server.Constants
Configuration name for the frontend URL prefix for ES5.
FRONTEND_URL_ES5 - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Configuration parameter for the build URL of ES5 web components.
FRONTEND_URL_ES5_DEFAULT_VALUE - Static variable in class com.vaadin.flow.server.Constants
Default frontend URL prefix for ES.
FRONTEND_URL_ES6 - Static variable in class com.vaadin.flow.server.Constants
Configuration name for the frontend URL prefix for ES6.
FRONTEND_URL_ES6 - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Configuration parameter for the build URL of ES6 web components.
FRONTEND_URL_ES6_DEFAULT_VALUE - Static variable in class com.vaadin.flow.server.Constants
Default frontend URL prefix for ES6.
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

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
 
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.
get(PropertyDescriptor<?, T>) - Method in class com.vaadin.flow.component.Component
Gets the value of the given component property.
get(HasElement) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Gets the property value for the given component.
get(Element) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Gets the property value for the given element.
get(UI) - Static method in interface com.vaadin.flow.di.Instantiator
Gets the instantiator to use for the given UI.
get(StateNode) - Static method in class com.vaadin.flow.dom.Element
Gets the element 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() - Static method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
Gets the one and only instance.
get(String) - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
get() - Static method in class com.vaadin.flow.dom.impl.BasicTextElementStateProvider
Gets the one and only instance.
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() - Static method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
Gets the one and only instance.
get(StateNode) - Static method in class com.vaadin.flow.dom.ShadowRoot
Gets the shadow root instance mapped to the given state node.
get(String) - Method in interface com.vaadin.flow.dom.Style
Gets the value of the given style property.
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.internal.nodefeature.ElementAttributeMap
Gets the value of an attribute.
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(String) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Gets the value corresponding to the given key.
get(int) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 
get() - Static method in class com.vaadin.flow.internal.NullOwner
Gets the singleton null owner instance.
get(Class<? extends C>) - Method in class com.vaadin.flow.internal.ReflectionCache
Gets a cached value.
get() - Static method in class com.vaadin.flow.server.DefaultSystemMessagesProvider
Gets the instance.
get() - Method in class com.vaadin.flow.server.FutureAccess
 
get(Class<?>) - Static method in class com.vaadin.flow.templatemodel.BasicComplexModelType
Gets the basic model type definition for the given Java class.
get(Class<?>) - Static method in class com.vaadin.flow.templatemodel.BasicModelType
Gets the basic model type definition for the given Java class.
get(Class<T>) - Static method in class com.vaadin.flow.templatemodel.ModelDescriptor
Gets the model descriptor for a model type.
get(int) - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
getActiveChain() - Method in class com.vaadin.flow.router.AfterNavigationEvent
Get the active chain that we have after navigation.
getActiveRouterTargetsChain() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the currently active router target and parent layouts.
getActiveViewLocation() - Method in class com.vaadin.flow.component.internal.UIInternals
Gets the location of the currently shown view.
getAddedBootstrapListeners() - Method in class com.vaadin.flow.server.ServiceInitEvent
Gets a stream of all bootstrap listeners that have been added for the service.
getAddedDependencyFilters() - Method in class com.vaadin.flow.server.ServiceInitEvent
Gets a stream of all dependency filters that have been added for the service.
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.
getAddress() - Method in class com.vaadin.flow.server.WebBrowser
Gets the IP-address of the web browser, if available.
getAfterNavigationEvent() - Method in class com.vaadin.flow.server.InitialPageSettings
Get the after navigation event.
getAllSessions(HttpSession) - Static method in class com.vaadin.flow.server.VaadinSession
Retrieves all VaadinSessions which are stored in the given HTTP session.
getAnnotationFor(Field, Class<T>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Helper to get an annotation for a field.
getAnnotationFor(Class<?>, Class<T>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Helper to get an annotation for a class.
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
 
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.PropertyDeploymentConfiguration
 
getApplicationParameters() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the application parameters specified by the BootstrapHandler.
getApplicationParameters(BootstrapHandler.BootstrapContext) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
getApplicationProperty(String) - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
Gets an application property value.
getApplicationUrl(HttpServletRequest) - Method in class com.vaadin.flow.server.VaadinServlet
Deprecated.
As of 7.0. Will likely change or be removed in a future version
getAppName() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the application name.
getAtmosphereVersion() - Static method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Gets the Atmosphere version in use, as reported by Version.getRawVersion().
getAttribute(String) - Method in class com.vaadin.flow.dom.Element
Gets the value of the given attribute.
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(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(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getAttribute(Element) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
getAttribute(String) - Method in class com.vaadin.flow.server.Attributes
Gets a stored attribute value.
getAttribute(Class<T>) - Method in class com.vaadin.flow.server.Attributes
Gets a stored attribute value.
getAttribute(String) - Method in class com.vaadin.flow.server.osgi.OSGiAccess.OSGiServletContext
 
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(Class<T>) - 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.
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(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
 
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.
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.
getBackgroundColor() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the background color of the application.
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.
getBodyAttributes(String) - Method in interface com.vaadin.flow.theme.AbstractTheme
Gets the attributes that should be set on the <body> element when the Theme variant is applied.
getBooleanProperty(String, boolean) - Method in interface com.vaadin.flow.function.DeploymentConfiguration
getBootstrapListeners(Stream<BootstrapListener>) - Method in interface com.vaadin.flow.di.Instantiator
Processes the available bootstrap listeners.
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.DependencyFilter.FilterContext
Gets the browser info needed for filtering.
getBrowser() - Method in class com.vaadin.flow.server.InitialPageSettings
Get the web browser used for the request used for these settings.
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.
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 com.vaadin.flow.shared.ui.Transport
Returns a Transport by its identifier.
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.ServletHelper
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.
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(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
 
getChild(int) - Method in class com.vaadin.flow.dom.Node
Returns the child element at the given position.
getChildCount() - Method in class com.vaadin.flow.dom.Element
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
 
getChildCount() - Method in class com.vaadin.flow.dom.Node
Gets the number of child elements.
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 class com.vaadin.flow.component.polymertemplate.PolymerTemplate
Gets the child components of this component.
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.
getClassList() - Method in class com.vaadin.flow.dom.Element
Gets the set of CSS class names used for this element.
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
 
getClassList() - Method in class com.vaadin.flow.internal.nodefeature.ElementClassList
Creates a view into this list.
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.
getClickCount() - Method in class com.vaadin.flow.component.ClickEvent
Gets the number of consecutive clicks recently recorded.
getClientToServerId() - Method in class com.vaadin.flow.server.communication.ServerRpcHandler.RpcRequest
Gets the id of the client to server message.
getClientUpdateAllowedProperties(Set<String>) - Method in class com.vaadin.flow.templatemodel.BeanModelType
Gets a map whose keys are all properties (including subproperties) that allowed to be updated from the client-side and values indicate the property getter presence.
getClientUpdateMode(BeanModelType.BeanModelTypeProperty) - Method in class com.vaadin.flow.templatemodel.BeanModelType
Gets the client update mode for a property.
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.
getComponent() - Method in class com.vaadin.flow.dom.Element
Gets the component this element has been mapped to, if any.
getComponent(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the component this element is mapped to.
getComponent() - Method in class com.vaadin.flow.internal.nodefeature.ComponentMapping
Gets the component this node has been mapped to, if any.
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.
getComponentCount() - Method in interface com.vaadin.flow.component.HasOrderedComponents
Gets the number of children components.
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.
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.
getContent() - Method in class com.vaadin.flow.component.Composite
Gets the content of the composite, i.e.
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().
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.
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) - Static method in class com.vaadin.flow.server.ServletHelper
Gets a relative path you can use to refer to the context root.
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.server.communication.ServerRpcHandler.RpcRequest
Gets the CSRF security token (double submit cookie) for this request.
getCsrfToken() - Method in class com.vaadin.flow.server.VaadinSession
Gets the CSRF token (aka double submit cookie) that is used to protect against Cross Site Request Forgery attacks.
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.server.WebBrowser
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
 
getCustomMessage() - Method in class com.vaadin.flow.router.ErrorParameter
Get the set custom message.
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.
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() - Method in class com.vaadin.flow.component.internal.CompositionEvent
Gets the string being composed.
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.
getDecodedType() - Method in interface com.vaadin.flow.templatemodel.ModelEncoder
Get the decoded type of this encoder.
getDependencies(VaadinService, Class<? extends Component>) - Static method in class com.vaadin.flow.component.ComponentUtil
Gets the dependencies for the given class, defined using annotations ( HtmlImport, 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(Stream<DependencyFilter>) - Method in interface com.vaadin.flow.di.Instantiator
Processes the available dependency filters.
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.
getDependencyInfo(VaadinService) - Method in class com.vaadin.flow.component.internal.ComponentMetaData
Gets the dependencies, defined using annotations (HtmlImport, JavaScript, StyleSheet and Uses).
getDependencyList() - Method in class com.vaadin.flow.component.internal.UIInternals
Returns the helper which handles loading of dependencies (css, js).
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.
getDevelopmentFrontendPrefix() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Gets the URL from which frontend resources should be loaded during development, unless explicitly configured to use the production es6 and es5 URLs.
getDialogGracePeriod() - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Gets the timeout (in milliseconds) between noticing a loss of connection and showing the dialog.
getDialogGracePeriod() - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
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(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.
getDisabledUpdateMode(String) - Method in class com.vaadin.flow.internal.nodefeature.SynchronizedPropertiesList
Gets property update mode 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.BootstrapPageResponse
Gets the document node representing the root of the DOM hierarchy that will be used to generate the HTML page.
getDomain() - Method in class com.vaadin.flow.server.PwaIcon
Gets the icon PwaIcon.Domain.
getDSTSavings() - Method in class com.vaadin.flow.server.WebBrowser
Returns the offset in milliseconds between the browser's GMT TimeZone and DST.
getElement() - Method in class com.vaadin.flow.component.Component
Gets the 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.UI
Gets the element for this UI.
getElement(InitialPageSettings.Position) - Method in class com.vaadin.flow.server.InitialPageSettings
Get the list of links to append to head.
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().
getEncodedType() - Method in interface com.vaadin.flow.templatemodel.ModelEncoder
Get the encoded type of this encoder.
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.
getErrorHandler() - Method in class com.vaadin.flow.server.VaadinSession
Gets the session's error handler.
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
 
getErrorNavigationTarget(Exception) - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Get a registered navigation target for given exception.
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.
getEs5() - Static method in class com.vaadin.flow.server.startup.FakeBrowser
Gets the es6 singleton instance.
getEs5FrontendPrefix() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Gets the URL from which frontend resources should be loaded in ES5 compatible browsers.
getEs6() - Static method in class com.vaadin.flow.server.startup.FakeBrowser
Gets the es6 singleton instance.
getEs6FrontendPrefix() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Gets the URL from which frontend resources should be loaded in ES6 compatible browsers.
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.
getEventDataExpressions(Class<? extends ComponentEvent<?>>) - Static method in class com.vaadin.flow.component.ComponentEventBusUtil
Gets a map of event data expression (for Element.addEventListener(String, com.vaadin.flow.dom.DomEventListener, 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
 
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
 
getExistingProperty(String) - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
getExistingSession(VaadinRequest, boolean) - Method in class com.vaadin.flow.server.VaadinService
 
getExpression() - Method in class com.vaadin.flow.component.internal.UIInternals.JavaScriptInvocation
Gets the JavaScript expression to invoke.
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.
getFeatureIfInitialized(Class<T>) - Method in class com.vaadin.flow.internal.StateNode
Gets the feature of the given type if it has been initialized.
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.
getFileName() - Method in interface com.vaadin.flow.server.StreamVariable.StreamingEvent
Get the file name for the stream.
getFilter() - Method in interface com.vaadin.flow.dom.DomListenerRegistration
Gets the currently set filter expression.
getFilterFromIncludeExclude(Method) - Static method in class com.vaadin.flow.templatemodel.TemplateModelUtil
Gets a filter based on any @Include and/or @Exclude annotations present on the given method.
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.
getForwardTarget() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the forward target to use if the user should be forwarded to some other view.
getForwardTargetType() - Method in class com.vaadin.flow.router.BeforeEvent
Get the forward target for forwarding.
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.
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.
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.
getHandlerAnnotation() - Method in class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers
Gets the annotation which is used to mark methods as handlers.
getHandlerAnnotation() - Method in class com.vaadin.flow.internal.nodefeature.ClientCallableHandlers
 
getHandlerAnnotation() - Method in class com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers
 
getHasValue() - Method in class com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent
getHasValue() - Method in interface com.vaadin.flow.component.HasValue.ValueChangeEvent
 
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.
getHeaderNames() - Method in interface com.vaadin.flow.server.VaadinRequest
Returns an enumeration of all the header names this request contains.
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
 
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.
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.
getHtmlImportAnnotations(Class<? extends Component>) - Static method in class com.vaadin.flow.internal.AnnotationReader
Finds all HtmlImport annotations on the given Component class, its super classes and implemented interfaces.
getHtmlImportDependencyCache() - Method in class com.vaadin.flow.server.VaadinService
Gets the HTML import dependency cache that is used by this service.
getHtmlImportUri() - Method in class com.vaadin.flow.component.polymertemplate.TemplateParser.TemplateData
Gets the HtmlImport uri where the template is declared.
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.
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.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(Class<? extends NodeFeature>) - Static method in class com.vaadin.flow.internal.nodefeature.NodeFeatureRegistry
Gets the id of a node feature.
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.WrappedHttpSession
 
getId() - Method in interface com.vaadin.flow.server.WrappedSession
Gets a string with a unique identifier for the session.
getIdentifier() - Method in enum com.vaadin.flow.dom.DebouncePhase
Gets the string that is used to identify this phase.
getIdentifier() - Method in enum com.vaadin.flow.server.ServletHelper.RequestType
Returns the identifier for the request type.
getIdentifier() - Method in enum 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.
getIndex() - Method in class com.vaadin.flow.internal.change.AbstractListChange
Gets the index of the change.
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(InitialPageSettings.Position) - Method in class com.vaadin.flow.server.InitialPageSettings
Get the list of inline objects to append to head.
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.
getInstallPrompt() - Method in class com.vaadin.flow.server.PwaRegistry
Html and js needed for pwa install prompt as a plain string.
getInstance() - Static method in class com.vaadin.flow.component.polymertemplate.DefaultTemplateParser
 
getInstance() - Static method in class com.vaadin.flow.server.osgi.OSGiAccess
Gets the singleton instance.
getInstance(ServletContext) - Static method in class com.vaadin.flow.server.PwaRegistry
Gets the pwa registry for the given servlet context.
getInstance(ServletContext) - Static method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
Gets the route 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.
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.
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().
getItem(String) - Method in class com.vaadin.flow.templatemodel.PathLookup
Gets the item for the provided full path.
getItemType() - Method in class com.vaadin.flow.templatemodel.ListModelType
Gets the item type.
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.
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.
getJavaType() - Method in class com.vaadin.flow.templatemodel.AbstractBasicModelType
 
getJavaType() - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
getJavaType() - Method in class com.vaadin.flow.templatemodel.ConvertedModelType
 
getJavaType() - Method in class com.vaadin.flow.templatemodel.ListModelType
 
getJavaType() - Method in interface com.vaadin.flow.templatemodel.ModelType
Gets the Java Type that this model encapsulates.
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 com.vaadin.flow.component.KeyModifier
Gets the key value.
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.
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.
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.
getListProxy(String, Class<T>) - Method in interface com.vaadin.flow.templatemodel.TemplateModel
Gets a proxy of the given part of the model as a list of beans of the given type.
getLoadingIndicatorConfiguration() - Method in class com.vaadin.flow.component.UI
Retrieves the object used for configuring the loading indicator.
getLoadingIndicatorConfiguration() - Method in class com.vaadin.flow.server.InitialPageSettings
Returns the configuration object for loading indicator.
getLoadMode() - Method in class com.vaadin.flow.component.internal.ComponentMetaData.HtmlImportDependency
 
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 default locale for this session.
getLocale() - Method in class com.vaadin.flow.server.WebBrowser
Gets the locale reported by the browser.
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.
getLocation() - Method in class com.vaadin.flow.component.internal.KeyboardEvent
Gets the KeyLocation of the event.
getLocation() - Method in enum 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.
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.
getLongPollingSuspendTimeout() - Method in class com.vaadin.flow.server.communication.PushHandler
Gets the timeout used for suspend calls when using long polling.
getLumoThemeDefinition() - Static method in class com.vaadin.flow.theme.ThemeUtil
Gets the Lumo theme definition (default theme) if it's available in the classpath.
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() - 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.
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 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() - 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.
getModel() - Method in class com.vaadin.flow.component.polymertemplate.AbstractTemplate
Returns the model of this template.
getModel() - Method in class com.vaadin.flow.component.polymertemplate.PolymerTemplate
 
getModel(StateNode) - Static method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
Gets the model map for the given node.
getModelType() - Method in class com.vaadin.flow.component.polymertemplate.AbstractTemplate
Gets the type of the template model to use with with this template.
getModelType(Type) - Method in class com.vaadin.flow.component.polymertemplate.PolymerTemplate
Get the ModelType for given class.
getModelTypeForProxy(Object) - Static method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler
Gets the model type that a proxy instance is bound to.
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.
getName() - Method in class com.vaadin.flow.internal.UsageStatistics.UsageEntry
Gets the feature name.
getName() - Method in class com.vaadin.flow.server.AbstractStreamResource
Get the resource name.
getName() - Method in class com.vaadin.flow.server.StreamReceiver
 
getName() - Method in class com.vaadin.flow.server.StreamResource
 
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.internal.UIInternals
Get all registered listeners for given navigation handler type.
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.
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 interface com.vaadin.flow.server.RouteRegistry
Gets the optional navigation target class for a given path.
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) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getNavigationTarget(String, List<String>) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getNavigationTarget(String) - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
 
getNavigationTarget(String, List<String>) - Method in class com.vaadin.flow.server.startup.ApplicationRouteRegistry
 
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(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
 
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.
getNodeById(int) - Method in class com.vaadin.flow.internal.StateTree
Finds a node with the given id.
getNodeList() - Method in class com.vaadin.flow.internal.change.AbstractListChange
Gets a changed list.
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.
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.
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.
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, 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.
getOsgiServletContext() - Method in class com.vaadin.flow.server.osgi.OSGiAccess
Gets a servlet context instance which is used to track registries which are storage of scanned classes.
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.ShortcutRegistration
Component which owns the shortcuts key event listener.
getOwner() - Method in class com.vaadin.flow.internal.StateNode
Gets the node owner that this node currently belongs to.
getPage() - Method in class com.vaadin.flow.component.UI
Gets the object representing the page on which this UI exists.
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.
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
 
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() - Method in class com.vaadin.flow.router.RouteBaseData
Get Route url parameters if any.
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(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.
getParent() - Method in class com.vaadin.flow.internal.StateNode
Gets the parent node that this node belongs to.
getParentLayout() - Method in class com.vaadin.flow.router.RouteBaseData
Get the parent layout of Route.
getParentLayouts(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Return the parent layout chain for given navigation target on the target path.
getParentLayouts(Class<?>, String) - Static method in class com.vaadin.flow.router.internal.RouterUtil
Deprecated.
Get parent layouts for navigation target according to the Route or RouteAlias annotation.
getParentLayouts(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.
getParentLayouts() - Method in class com.vaadin.flow.router.RouteBaseData
Return the whole parent layout chain of route target.
getParentLayouts(Class<? extends Component>) - Method in class com.vaadin.flow.server.startup.RouteTarget
Get the parent layout chain defined for the given target.
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
 
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.
getPath() - Method in class com.vaadin.flow.router.Location
Gets the path of this location as a string.
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.
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.
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.
getPrefix() - Method in class com.vaadin.flow.templatemodel.PropertyFilter
Get the full path prefix of this property filter.
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.
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.
getProperty() - Method in class com.vaadin.flow.component.internal.ComponentMetaData.SynchronizedPropertyInfo
 
getProperty(String, 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.dom.Element
Gets the value of the given property as a string.
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(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.internal.nodefeature.AbstractPropertyMap
Gets the value of the given property.
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(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
 
getPropertyNames() - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Gets the property names.
getPropertyNames() - Method in class com.vaadin.flow.templatemodel.BeanModelType
Gets the names of all properties in this bean type.
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 class com.vaadin.flow.templatemodel.BeanModelType
Gets the type of the property with the given name.
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
 
getProxy(String, Class<T>) - Method in interface com.vaadin.flow.templatemodel.TemplateModel
Gets a proxy of the given part of the model as a bean of the given type.
getProxyType() - Method in class com.vaadin.flow.templatemodel.BeanModelType
Gets the Class that proxies of this bean type should extend.
getPushConfiguration() - Method in class com.vaadin.flow.component.UI
Retrieves the object used for configuring the push channel.
getPushConfiguration() - Method in class com.vaadin.flow.server.InitialPageSettings
Returns 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
 
getPushUrl() - Method in interface com.vaadin.flow.component.PushConfiguration
Returns the URL to use for push requests.
getPushURL() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Returns the URL that bidirectional ("push") client-server communication should use.
getPushUrl() - Method in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
getPushURL() - Method in class com.vaadin.flow.server.DefaultDeploymentConfiguration
Returns the URL that bidirectional ("push") client-server communication should use.
getPushURL() - Method in class com.vaadin.flow.server.PropertyDeploymentConfiguration
 
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.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
Turns query parameters into query string that contains all parameter names and their values.
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.server.WebBrowser
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.
getReconnectDialogConfiguration() - Method in class com.vaadin.flow.server.InitialPageSettings
Returns the configuration object for 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
 
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
 
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.
getRemovedRoutes() - Method in class com.vaadin.flow.router.RoutesChangedEvent
Get all routes removed in this change.
getRequest() - Method in class com.vaadin.flow.server.BootstrapHandler.BootstrapContext
Gets the Vaadin/HTTP request.
getRequest() - Method in class com.vaadin.flow.server.BootstrapPageResponse
Gets the request for which the generated bootstrap HTML will be the response.
getRequest() - Method in class com.vaadin.flow.server.InitialPageSettings
Get the initial request for the settings.
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.
getRerouteTarget() - Method in class com.vaadin.flow.router.BeforeEvent
Gets the reroute target 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.
getResolvedPath() - Method in class com.vaadin.flow.router.NavigationState
Get the resolved path details for this navigation state.
getResource(String) - Method in interface com.vaadin.flow.client.ClientResources
Get content of the resource in the client-side module.
getResource(String) - Static method in class com.vaadin.flow.client.ClientResourcesUtils
Get content of the resource in the client-side module.
getResource(String) - Method in class com.vaadin.flow.client.DefaultClientResources
 
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(URI) - Method in class com.vaadin.flow.server.StreamResourceRegistry
Get a registered resource for given URI.
getResource(Class<T>, URI) - Method in class com.vaadin.flow.server.StreamResourceRegistry
Get a registered resource of given type.
getResource(String, WebBrowser, AbstractTheme) - Method in class com.vaadin.flow.server.VaadinService
Returns a URL to the resource at the given Vaadin URI.
getResource(String, WebBrowser, AbstractTheme) - Method in class com.vaadin.flow.server.VaadinServletService
 
getResourceAsStream(String, WebBrowser, AbstractTheme) - Method in class com.vaadin.flow.server.VaadinService
Opens a stream to to the resource at the given Vaadin URI.
getResourceAsStream(String, WebBrowser, AbstractTheme) - Method in class com.vaadin.flow.server.VaadinServletService
 
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.
getResponse() - Method in class com.vaadin.flow.server.BootstrapPageResponse
Gets the HTTP response that serves the bootstrap page.
getRevision() - Static method in class com.vaadin.flow.server.Version
Gets the revision, z in x.y.z.qualifier.
getRootNode() - Method in class com.vaadin.flow.internal.StateTree
Gets the root node of this state tree.
getRootUrl() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the application root url.
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) - 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.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.
getRouteLayouts(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
getRouteLayouts(String, Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Get the layout chain for given navigation target on the targeted path.
getRouteLayouts(String, Class<? extends Component>) - Method in class com.vaadin.flow.server.SessionRouteRegistry
 
getRoutePath(Class<?>, Route) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Get the actual route path including all parent layout RoutePrefix.
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
Gets the router used for navigating in this UI.
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.
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.
getRoutes() - Method in class com.vaadin.flow.router.Router
Deprecated.
getRoutes() - Method in class com.vaadin.flow.server.startup.RouteTarget
Get all registered targets for this routeTarget as a iterable.
getRoutesByParent() - Method in class com.vaadin.flow.router.Router
Deprecated.
No replacement.
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(String) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the RouteTarget stored for the given path.
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.
getRouteTargetType() - Method in class com.vaadin.flow.router.BeforeEvent
Get the route target for rerouting.
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.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.
getScreenHeight() - Method in class com.vaadin.flow.server.WebBrowser
Gets the height of the screen in pixels.
getScreenWidth() - Method in class com.vaadin.flow.server.WebBrowser
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.
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
 
getSegments() - Method in class com.vaadin.flow.router.Location
Gets all the path segments of this location.
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.communication.UidlWriter.ResolveContext
Gets the related Vaadin service.
getService() - Method in class com.vaadin.flow.server.DependencyFilter.FilterContext
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
 
getServiceUrl(BootstrapHandler.BootstrapContext) - Static method in class com.vaadin.flow.server.BootstrapHandler
Gets the service URL as a URL relative to the request URI.
getServiceWorkerJs() - Method in class com.vaadin.flow.server.PwaRegistry
sw.js (service worker javascript) as String.
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.
getServletContext() - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer.FakeServletConfig
 
getServletName() - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer.FakeServletConfig
 
getServletRegistrations() - Method in class com.vaadin.flow.server.osgi.OSGiAccess.OSGiServletContext
 
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.BootstrapPageResponse
Gets the service session to which the rendered view belongs.
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.
getShadowRoot() - Method in class com.vaadin.flow.dom.Element
Gets the shadow root of the element, if any.
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
 
getShadowRoot() - Method in class com.vaadin.flow.internal.nodefeature.ShadowRootData
 
getShortName() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the application short name.
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.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
 
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
 
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.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.component.polymertemplate.AbstractTemplate
Gets the state node for current template.
getStateNode() - Method in class com.vaadin.flow.internal.StateTree.BeforeClientResponseEntry
 
getStateNodeForProxy(Object) - Static method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler
Gets the state node that a proxy is bound to.
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.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
 
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.function.DeploymentConfiguration
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(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
 
getStyle() - Method in class com.vaadin.flow.internal.nodefeature.ElementStylePropertyMap
Returns a style instance for managing element inline styles.
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.
getSubLocation() - Method in class com.vaadin.flow.router.Location
Creates a new location without the first path segment.
getSupportedTypesString() - Static method in interface com.vaadin.flow.templatemodel.ModelType
Gets a string explaining the supported property types in model.
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.
getSynchronizedProperties() - Method in class com.vaadin.flow.component.internal.ComponentMetaData
Gets the properties that are marked to be synchronized and corresponding events.
getSynchronizedProperties() - Method in class com.vaadin.flow.dom.Element
getSynchronizedProperties(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the names of the properties to synchronize from the client side to the server.
getSynchronizedProperties(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getSynchronizedProperties(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getSynchronizedProperties(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getSynchronizedProperties() - Method in class com.vaadin.flow.internal.nodefeature.SynchronizedPropertiesList
Creates a view into this list.
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.
getSynchronizedPropertyEvents() - Method in class com.vaadin.flow.dom.Element
getSynchronizedPropertyEvents(StateNode) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Gets the event types which should trigger synchronization of properties from the client side to the server.
getSynchronizedPropertyEvents(StateNode) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
getSynchronizedPropertyEvents(StateNode) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
getSynchronizedPropertyEvents(StateNode) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
getSynchronizedPropertyEvents() - Method in class com.vaadin.flow.internal.nodefeature.SynchronizedPropertyEventsList
Creates a view into this list.
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.PropertyDeploymentConfiguration
Gets an system property value.
getTabIndex() - Method in interface com.vaadin.flow.component.Focusable
Gets the tabindex in the component.
getTag() - Method in class com.vaadin.flow.dom.Element
Gets the tag name for 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
 
getTag() - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Gets the tag name of the element.
getTarget(List<String>) - Method in class com.vaadin.flow.server.startup.RouteTarget
Get route target for given segments.
getTargetRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfiguredRoutes
Get the route path 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.
getTargetRoutes() - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Override so that the getters use the correct target routes map for data.
getTargetUrl(Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
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
 
getTemplateContent(Class<? extends PolymerTemplate<?>>, String, VaadinService) - Method in class com.vaadin.flow.component.polymertemplate.DefaultTemplateParser
 
getTemplateContent(Class<? extends PolymerTemplate<?>>, String, VaadinService) - Method in interface com.vaadin.flow.component.polymertemplate.TemplateParser
Gets the template data which contains a JSOUP Element representing the template content and the template uri.
getTemplateElement() - Method in class com.vaadin.flow.component.polymertemplate.TemplateParser.TemplateData
Gets the content of the template.
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.BootstrapHandler.BootstrapContext
Gets the ThemeDefinition associated with the pageConfigurationHolder of this context, if any.
getTheme() - Method in class com.vaadin.flow.server.communication.UidlWriter.ResolveContext
Gets the theme used for resolving.
getTheme() - Method in class com.vaadin.flow.theme.ThemeDefinition
Gets the theme class.
getThemeColor() - Method in class com.vaadin.flow.server.PwaConfiguration
Gets the theme color of the application.
getThemedUrl(String, WebBrowser, AbstractTheme) - Method in class com.vaadin.flow.server.VaadinService
Checks if the given URL has a themed version.
getThemedUrl(String, WebBrowser, AbstractTheme) - Method in class com.vaadin.flow.server.VaadinServletService
 
getThemeFor(Class<?>, String) - Method in class com.vaadin.flow.component.UI
Gets the ThemeDefinition associated with the given navigation target, if any.
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.
getThemeNames() - Method in interface com.vaadin.flow.component.HasTheme
Gets the set of theme names used for this element.
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.server.WebBrowser
Returns the TimeZone Id (like "Europe/Helsinki") provided by the browser (if the browser supports this feature).
getTimezoneOffset() - Method in class com.vaadin.flow.server.WebBrowser
Returns the browser-reported TimeZone offset in milliseconds from GMT.
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).
getTopParentLayout(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(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
Get the translation for key with given locale.
getTranslation(String, Locale, Object...) - Method in interface com.vaadin.flow.i18n.I18NProvider
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.
getTwoWayBindingPaths() - Method in class com.vaadin.flow.component.polymertemplate.TemplateInitializer
Gets a set of two way binding paths encountered in the template.
getType() - Method in class com.vaadin.flow.dom.DomEvent
Gets the type of the event.
getType() - Method in class com.vaadin.flow.server.PwaIcon
Gets the value of the type attribute.
getType() - Method in class com.vaadin.flow.shared.ui.Dependency
Gets the type of the dependency.
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.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.BootstrapPageResponse
Gets the UI that will be displayed on the generated bootstrap page.
getUI() - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
 
getUi() - Method in class com.vaadin.flow.server.InitialPageSettings
Get the target UI instance.
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.
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
 
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.
getUriResolver() - Method in class com.vaadin.flow.server.BootstrapPageResponse
Gets the URI resolver utility.
getUris() - Method in class com.vaadin.flow.component.internal.ComponentMetaData.HtmlImportDependency
 
getUrl() - Method in class com.vaadin.flow.router.RouteBaseData
Get the full route url of Route.
getUrl(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Get the registered url string for given navigation target.
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 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 Component>) - Method in class com.vaadin.flow.router.Router
Deprecated.
Url handling is moved to RouteConfiguration.getUrl(Class)
getUrl(Class<? extends C>, T) - Method in class com.vaadin.flow.router.Router
Deprecated.
getUrl(Class<? extends C>, List<T>) - Method in class com.vaadin.flow.router.Router
Deprecated.
getUrl() - Method in class com.vaadin.flow.shared.ui.Dependency
Gets the untranslated URL for the dependency.
getUrlBase(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Return the url base without any url parameters.
getUrlBase(Class<? extends Component>) - Method in class com.vaadin.flow.router.Router
Deprecated.
Url base handling is moved to RouteConfiguration.getUrlBase(Class)
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.
getUsesClass(Class<? extends PolymerTemplate<?>>, String) - Static method in class com.vaadin.flow.component.polymertemplate.TemplateInitializer
Looks for a component class with the given tag name among the classes used by the given polymer template 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.
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.
getViewport() - Method in class com.vaadin.flow.server.InitialPageSettings
Get the currently set viewport setting for this settings object.
getWebJarResourcePath(String) - Method in class com.vaadin.flow.server.webjar.WebJarServer
Gets web jar resource path if it exists.
getWebJarServer() - Method in class com.vaadin.flow.server.VaadinServlet
Gets the web jar server.
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.
getWrappedModelType() - Method in class com.vaadin.flow.templatemodel.ConvertedModelType
Gets the model type describing the data actually stored in the model.
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(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() - Method in class com.vaadin.flow.server.VaadinServletRequest
 
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.
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).
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.
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.

H

H1 - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <h1>.
H2 - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <h2>.
H3 - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <h3>.
H4 - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <h4>.
H5 - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <h5>.
H6 - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <g6>.
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.
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.
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.
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.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
 
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, StreamReceiver, String, String) - Method in class com.vaadin.flow.server.communication.StreamReceiverHandler
Handle reception of incoming stream from the client.
handleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.communication.StreamRequestHandler
 
handleRequest(VaadinSession, VaadinRequest, VaadinResponse, StreamResource) - Method in class com.vaadin.flow.server.communication.StreamResourceHandler
Handle sending for a stream resource request.
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(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.VaadinService
Handles the incoming request and writes the response into the response object.
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.
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.
hasAttribute(String) - Method in class com.vaadin.flow.dom.Element
Checks if the given attribute has been set.
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(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(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
hasAttribute(Element) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
hasBeforeClientResponseEntries() - Method in class com.vaadin.flow.internal.StateNode
Checks whether there are pending executions for this node.
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.
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
Interface for navigation targets to resolve their 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
Interface for defining a view that handles the exceptions for the set Exception type T.
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.
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.flow.dom.Node
 
hashCode() - Method in class com.vaadin.flow.internal.Range
 
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.shared.ui.Dependency
 
hashCode() - Method in class com.vaadin.flow.shared.util.UniqueSerializable
 
hashCode() - Method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler.InterfaceProxy
 
hasInitializers() - Method in class com.vaadin.flow.server.osgi.OSGiAccess
Checks whether the servlet initializers are discovered.
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.
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<T extends Component> - 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(String) - Method in class com.vaadin.flow.dom.Element
Checks whether this element has a property with the given name.
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 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.templatemodel.BeanModelType
Checks whether this bean type has a property with the 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.
HasText - Interface in com.vaadin.flow.component
A component that supports text content.
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.
HasUrlParameter<T> - Interface in com.vaadin.flow.router
Interface for defining url parameters for navigation targets for use in routing.
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.
HEADER - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <header>.
HEADSET_HOOK - Static variable in interface com.vaadin.flow.component.Key
The Headset Hook key.
HeartbeatHandler - Class in com.vaadin.flow.server.communication
Handles heartbeat requests.
HeartbeatHandler() - Constructor for class com.vaadin.flow.server.communication.HeartbeatHandler
 
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.
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.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.
HR - Static variable in annotation type 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.
HtmlDependencyParser - Class in com.vaadin.flow.component.internal
Deprecated.
Due for removal because of additional cache layer
HtmlDependencyParser(String) - Constructor for class com.vaadin.flow.component.internal.HtmlDependencyParser
Deprecated.
Creates a new instance using the given uri as a root.
HtmlImport - Annotation Type in com.vaadin.flow.component.dependency
Annotation for defining HTML dependencies on a Component class.
HtmlImport.Container - Annotation Type in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple HtmlImport annotations.
HtmlImportParser - Class in com.vaadin.flow.component.internal
Helper for finding the HTML imports of a resource.
HtmlUtils - Class in com.vaadin.flow.internal
Helpers for HTML related aspects.
HYPER - Static variable in interface com.vaadin.flow.component.Key
The Hyper key.

I

I18N_PROVIDER - Static variable in class com.vaadin.flow.server.Constants
I18N provider property.
I18NProvider - Interface in com.vaadin.flow.i18n
I18N provider interface for internationalization usage.
Id - Annotation Type in com.vaadin.flow.component.polymertemplate
Defines the id of an element to map to inside a PolymerTemplate.
ID - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
Key for id property.
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.
IFRAME - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <iframe>.
IMG - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <img>.
ImmutableClassList - Class in com.vaadin.flow.dom.impl
A class list implementation which is immutable.
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
 
importBean(String, Object, Predicate<String>) - Method in interface com.vaadin.flow.templatemodel.TemplateModel
Import a bean properties passing the given filter to this template model.
importBeans(ModelList, List<T>, PropertyFilter) - Method in class com.vaadin.flow.templatemodel.ListModelType
Imports beans into a model list based on the properties in the item type of this model type.
importBeans(String, List<?>, Predicate<String>) - Method in interface com.vaadin.flow.templatemodel.TemplateModel
Imports a list of beans to this template model.
importProperties(ElementPropertyMap, Object, PropertyFilter) - Method in class com.vaadin.flow.templatemodel.BeanModelType
Imports properties from a bean into a model map based on the properties in this model type.
IN_MEMORY_CHILD - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
JsonObject in-memory type value for VirtualChildrenList.
Include - Annotation Type in com.vaadin.flow.templatemodel
Defines which properties to include when importing a bean into a template model.
incrementServerId() - Method in class com.vaadin.flow.component.internal.UIInternals
Increments the server sync id.
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(T) - Method in class com.vaadin.flow.internal.nodefeature.NodeList
Gets the position of a value in the list.
indexOf(Object) - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
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.
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.
init(VaadinRequest) - Method in class com.vaadin.flow.component.UI
Initializes this UI.
init(VaadinService) - Method in class com.vaadin.flow.di.DefaultInstantiator
 
init(VaadinService) - Method in interface com.vaadin.flow.di.Instantiator
Initializes this instantiator.
init(ServletContext) - Method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
Initializes Atmosphere for use with Vaadin servlets found in the given context.
init() - Method in class com.vaadin.flow.server.VaadinService
Initializes this service.
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.
initAtmosphereForVaadinServlet(ServletRegistration, ServletContext) - Static method in class com.vaadin.flow.server.communication.JSR356WebsocketInitializer
Initializes Atmosphere for use with the given Vaadin servlet
initChildElements() - Method in class com.vaadin.flow.component.polymertemplate.TemplateInitializer
Initializes child elements.
initContent() - Method in class com.vaadin.flow.component.Composite
Called when the content of this composite is requested for the first time.
initializeUI(UI, VaadinRequest) - Method in class com.vaadin.flow.router.Router
Enables navigation for a new UI instance.
InitialPageSettings - Class in com.vaadin.flow.server
Initial page settings class for modifying the bootstrap page.
InitialPageSettings(VaadinRequest, UI, AfterNavigationEvent, WebBrowser) - Constructor for class com.vaadin.flow.server.InitialPageSettings
Create new initial page settings object.
InitialPageSettings.Position - Enum in com.vaadin.flow.server
Append position enum.
InitialPageSettings.WrapMode - Enum in com.vaadin.flow.server
Content wrapping mode enum.
INJECT_BY_ID - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
JsonObject @id type value for VirtualChildrenList.
Inline - Annotation Type in com.vaadin.flow.component.page
Defines files to inline into the initial page.
Inline.Container - Annotation Type in com.vaadin.flow.component.page
Internal annotation to enable use of multiple Inline annotations.
Inline.Position - Enum in com.vaadin.flow.component.page
Inline position enum.
Inline.Wrapping - Enum in com.vaadin.flow.component.page
File content wrapping enum.
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
 
INPUT - Static variable in annotation type 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(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
 
insertChild(int, Element...) - Method in class com.vaadin.flow.dom.Node
Inserts the given child element(s) at the given position.
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.
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).
Instantiator - Interface in com.vaadin.flow.di
Delegate for discovering, creating and managing instances of various types used by Flow.
intercept(Object, Method, Object[]) - Method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler
Processes a method invocation on a Byte buddy proxy instance and returns the result.
InterfaceProxy() - Constructor for class com.vaadin.flow.templatemodel.TemplateModelProxyHandler.InterfaceProxy
 
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.
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.
InvalidTemplateModelException - Exception in com.vaadin.flow.templatemodel
Exception thrown when encountering an invalid type in a template model.
InvalidTemplateModelException(String, Throwable) - Constructor for exception com.vaadin.flow.templatemodel.InvalidTemplateModelException
Creates a new exception with the given message and cause.
InvalidTemplateModelException(String) - Constructor for exception com.vaadin.flow.templatemodel.InvalidTemplateModelException
Creates a new exception with the given message.
InvalidUIDLSecurityKeyException() - Constructor for exception com.vaadin.flow.server.communication.ServerRpcHandler.InvalidUIDLSecurityKeyException
Default constructor for the exception.
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.
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.internal.StateNode
Checks whether this node is attached to a state tree.
isBasicType(Type) - Static method in class com.vaadin.flow.templatemodel.BasicComplexModelType
Checks whether the type is a basic supported type.
isBean(Type) - Static method in class com.vaadin.flow.templatemodel.BeanModelType
Checks if the given type can be handled as a bean in a model.
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.
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.
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 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 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.
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.
isCsrfTokenValid(VaadinSession, String) - Static method in class com.vaadin.flow.server.VaadinService
Verifies that the given CSRF token (aka double submit cookie) is valid for the given session.
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.
isDialogModal() - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Checks the modality of the dialog.
isDialogModal() - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
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.server.WebBrowser
Returns whether daylight saving time (DST) is currently in effect in the region of the browser or not.
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.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.startup.RouteTarget
Check if this RouteTarget is empty.
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 com.vaadin.flow.shared.communication.PushMode
Checks whether the push mode is using push functionality
isEnabledSelf() - Method in class com.vaadin.flow.internal.StateNode
Returns the enabled state only for this node.
isEs5AdapterNeeded() - Method in class com.vaadin.flow.server.WebBrowser
Checks if the browser needs `custom-elements-es5-adapter.js` to be loaded.
isEs5AdapterNeeded() - Method in class com.vaadin.flow.shared.BrowserDetails
Checks if the browser needs `custom-elements-es5-adapter.js` to be loaded.
isEs6Supported() - Method in class com.vaadin.flow.server.WebBrowser
Checks if the browser supports ECMAScript 6, based on the user agent.
isEs6Supported() - Method in class com.vaadin.flow.shared.BrowserDetails
Checks if the browser supports ECMAScript 6, based on the user agent.
isEventPropagationAllowed() - Method in class com.vaadin.flow.component.ShortcutRegistration
Checks if the shortcut allows keydown event (associated with the shortcut) propagation in the browser.
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.
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.
isGecko() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is using the Gecko engine.
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.
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.
isInactive() - Method in class com.vaadin.flow.internal.StateNode
Checks whether the node is active.
isInitialAttach() - Method in class com.vaadin.flow.component.AttachEvent
Checks whether this is the first time the component has been attached.
isInstallPromptEnabled() - Method in class com.vaadin.flow.server.PwaConfiguration
Is install prompt resources injection enabled.
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.server.WebBrowser
Tests if the browser is run in iOS.
isIOS() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is run in iOS.
isIPad() - Method in class com.vaadin.flow.server.WebBrowser
Tests if the browser is run on IPad.
isIPad() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests 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.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.
isList(Type) - Static method in class com.vaadin.flow.templatemodel.ListModelType
Checks if the given type will be handled as a list of beans in the model.
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.
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.
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.
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
 
isNotObjectMethod(Method) - Static method in class com.vaadin.flow.internal.ReflectTools
Returns whether the given method is NOT declared in Object .
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.
isPathRegistered(String) - Method in class com.vaadin.flow.router.RouteConfiguration
Check if there is a registered target for the given path.
isPostponed() - Method in class com.vaadin.flow.router.BeforeLeaveEvent
Checks whether this event was postponed.
isPresto() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is using the Presto engine.
isProductionMode() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
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.PropertyDeploymentConfiguration
 
isProxy(Object) - Static method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler
Checks if the given object is a proxy created by this class.
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
 
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.
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, ServletHelper.RequestType) - Static method in class com.vaadin.flow.server.ServletHelper
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
 
isResourceAvailable(String, WebBrowser, AbstractTheme) - 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.
isRouteRegistered(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Check if the route is available as a registered target.
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.
isSafariOrIOS() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is Safari or runs on IOS (covering also Chrome on iOS).
isScript(Element) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks whether the given element is a script or not.
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
 
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.
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.
isStaticResourceRequest(HttpServletRequest) - Method in interface com.vaadin.flow.server.StaticFileHandler
Checks if a static resource can be found for the requested path.
isStaticResourceRequest(HttpServletRequest) - Method in class com.vaadin.flow.server.StaticFileServer
 
isSubsetOf(Range) - Method in class com.vaadin.flow.internal.Range
Checks whether this range is a subset of another range.
isSupportedClass(Class<?>) - Method in class com.vaadin.flow.component.polymertemplate.PolymerTemplate
Check if the given Class type is found in the Model.
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 PolymerTemplate (by being mapped by an Id annotation), or if it was created directly.
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.server.WebBrowser
Checks if the browser is so old that it simply won't work with a Vaadin application.
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.server.WebBrowser
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.
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.
isValidAttributeName(String) - Static method in class com.vaadin.flow.dom.ElementUtil
Checks if the given attribute name 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.
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(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
 
isVisible() - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Get element visibility.
isWebKit() - Method in class com.vaadin.flow.shared.BrowserDetails
Tests if the browser is using the WebKit engine.
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.function.DeploymentConfiguration
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

JavaScript - Annotation Type in com.vaadin.flow.component.dependency
Annotation for defining JavaScript dependencies on a Component class.
JavaScript.Container - Annotation Type in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple JavaScript annotations.
JavaScriptInvocation(String, Serializable...) - Constructor for class com.vaadin.flow.component.internal.UIInternals.JavaScriptInvocation
Creates a new invocation.
JavaScriptSemantics - Class in com.vaadin.flow.internal
Helpers for replicating JavaScript semantics in Java.
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.
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
Methods 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.

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.
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.
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.
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 in com.vaadin.flow.component
Enumeration of possible keyboard key locations.
KeyModifier - Enum in com.vaadin.flow.component
Enumeration of 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 type com.vaadin.flow.component.Tag
Tag for an <label>.
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.
length() - Method in class com.vaadin.flow.internal.Range
The number of integers contained in the range.
LI - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <li>.
LINK - Static variable in interface com.vaadin.flow.component.Key
Opens content linked to the current program, if available and possible.
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 Type 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.
ListModelType<T> - Class in com.vaadin.flow.templatemodel
A model type corresponding to a list of bean types.
ListModelType(ComplexModelType<T>) - Constructor for class com.vaadin.flow.templatemodel.ListModelType
Creates a new list model type with the given bean model type.
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.
LIVE_CONTENT - Static variable in interface com.vaadin.flow.component.Key
Toggles a display listing currently available live content or programs.
LOAD_ES5_ADAPTERS - Static variable in class com.vaadin.flow.server.Constants
Configuration name for loading the ES5 adapters.
loadBasicTypes(Function<Class<?>, M>) - Static method in class com.vaadin.flow.templatemodel.AbstractBasicModelType
 
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 - Enum in com.vaadin.flow.shared.ui
Class that determines a way that dependency is loaded.
loadSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Called when the VaadinSession should be loaded from the underlying HTTP session.
localeChange(LocaleChangeEvent) - Method in interface com.vaadin.flow.i18n.LocaleChangeObserver
Method called 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(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.
LOCK - Static variable in interface com.vaadin.flow.component.Key
Locks or unlocks the currently selected content or program.
lock() - Method in class com.vaadin.flow.server.VaadinSession
Locks this session to protect its data from concurrent access.
lockSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Locks the given session for this service instance.
log(String) - Method in class com.vaadin.flow.server.osgi.OSGiAccess.OSGiServletContext
 
LOG_OFF - Static variable in interface com.vaadin.flow.component.Key
The LogOff key.

M

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 type com.vaadin.flow.component.Tag
Tag for an <main>.
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.
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
 
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() - Method in class com.vaadin.flow.internal.StateNode
Marks this node as dirty.
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(String) - Method in interface com.vaadin.flow.component.Key
Checks if key is a printable representation for this instance.
matches(Key, KeyModifier...) - Method in class com.vaadin.flow.component.ShortcutEvent
Checks if the event matches the given Key and (optional) KeyModifiers.
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.
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 - Static variable in interface com.vaadin.flow.component.Key
The Meta key.
Meta - Annotation Type 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.Container - Annotation Type in com.vaadin.flow.component.page
Internal annotation to enable use of multiple Meta annotations.
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.
MetadataWriter - Class in com.vaadin.flow.server.communication
Serializes miscellaneous metadata to JSON.
MetadataWriter() - Constructor for class com.vaadin.flow.server.communication.MetadataWriter
 
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.
MODE_CHANGE - Static variable in interface com.vaadin.flow.component.Key
The Mode Change key.
ModelDescriptor<T extends TemplateModel> - Class in com.vaadin.flow.templatemodel
Describes the model type of a template class.
ModelEncoder<D,E extends Serializable> - Interface in com.vaadin.flow.templatemodel
Interface for implementing type encodings in template models together with the Encode annotation.
ModelItem - Annotation Type in com.vaadin.flow.component.polymertemplate
Allows to receive Model class item from the client side instead of a index of an element in dom-repeat Polymer template section, or string representation.
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.
modelToApplication(Serializable) - Method in class com.vaadin.flow.templatemodel.BasicComplexModelType
 
modelToApplication(Serializable) - Method in class com.vaadin.flow.templatemodel.BasicModelType
 
modelToApplication(Serializable) - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
modelToApplication(Serializable) - Method in class com.vaadin.flow.templatemodel.ConvertedModelType
 
modelToApplication(Serializable) - Method in class com.vaadin.flow.templatemodel.ListModelType
 
modelToApplication(Serializable) - Method in interface com.vaadin.flow.templatemodel.ModelType
Creates a representation of the provided model value that is intended for use in application code.
ModelType - Interface in com.vaadin.flow.templatemodel
A model type that can convert values between a representation suitable for users and a representation suitable for storage in a StateNode.
modifyBootstrapPage(BootstrapPageResponse) - Method in interface com.vaadin.flow.server.BootstrapListener
Lets this listener make changes to the overall HTML document that will be used as the initial HTML page, as well as the HTTP headers in the response serving the initial HTML.
modifyBootstrapPage(BootstrapPageResponse) - Method in class com.vaadin.flow.server.VaadinService
mostPermissive(DisabledUpdateMode, DisabledUpdateMode) - Static method in enum com.vaadin.flow.dom.DisabledUpdateMode
Gets the most permissive out of two update modes.
MULTIPLY - Static variable in interface com.vaadin.flow.component.Key
The numeric keypad's multiplication key, *.

N

NAMING_CONVENTION - Static variable in annotation type com.vaadin.flow.router.Route
 
NAV - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <nav>.
navigate(Class<? extends Component>) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given navigation target.
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(String) - Method in class com.vaadin.flow.component.UI
Updates this UI to show the view corresponding to the given location.
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(UI, Location, NavigationTrigger) - Method in class com.vaadin.flow.router.Router
Navigates the given UI to the given location.
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.
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.
NavigationHandler - Interface in com.vaadin.flow.router
Handles navigation to a location e.g.
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
Class containing 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 in com.vaadin.flow.router
The type of user action that triggered navigation.
negate() - Method in interface com.vaadin.flow.function.SerializablePredicate
 
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.
Node<N extends Node<N>> - Class in com.vaadin.flow.dom
A class representing 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_TYPE - Static variable in class com.vaadin.flow.internal.JsonCodec
Type id for a complex type array containing an Element.
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.
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.
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 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_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.
NoOutputStreamException - Exception in com.vaadin.flow.server
Exception for when there is no OutputStream available.
NoOutputStreamException() - Constructor for exception com.vaadin.flow.server.NoOutputStreamException
 
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 Type in com.vaadin.flow.theme
Defines that the class shouldn't log for missing theme.
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
Notified 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 Type in com.vaadin.flow.component
Methods annotated with NotSupported are mapped to the original webcomponent implementation, but not supported at Java level.
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.
numberStream(JsonArray) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a double stream from a JSON array of numbers.
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

objectStream(JsonArray) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a stream from a JSON array of objects.
of(String, String...) - Static method in interface com.vaadin.flow.component.Key
Returns a Key instance for a printable representation of the key.
of(int) - Static method in enum com.vaadin.flow.component.KeyLocation
Returns the KeyLocation for location.
of(String) - Static method in enum com.vaadin.flow.component.KeyModifier
Returns the KeyModifier for key.
offlinePageCache() - Method in class com.vaadin.flow.server.PwaRegistry
Google Workbox cache resource String of offline page.
offsetBy(int) - Method in class com.vaadin.flow.internal.Range
Get a range that is based on this one, but offset by a number.
OL - Static variable in annotation type 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(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.
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() - Method in class com.vaadin.flow.internal.StateNode
Called when this node has been attached to a state tree.
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(T) - Method in interface com.vaadin.flow.component.ComponentEventListener
Invoked when a component event has been fired.
onComponentEvent(E) - Method in class com.vaadin.flow.component.KeyEventListener
 
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.
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
 
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.
onHistoryStateChange(History.HistoryStateChangeEvent) - Method in interface com.vaadin.flow.component.page.History.HistoryStateChangeHandler
Invoked when a history state change event is fired.
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 class com.vaadin.flow.server.startup.AnnotationValidator
 
onStartup(Set<Class<?>>, ServletContext) - Method in class com.vaadin.flow.server.startup.ErrorNavigationTargetInitializer
 
onStartup(Set<Class<?>>, ServletContext) - Method in class com.vaadin.flow.server.startup.RouteRegistryInitializer
 
onStartup(Set<Class<?>>, ServletContext) - Method in class com.vaadin.flow.server.startup.ServletVerifier
 
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 - Static variable in interface com.vaadin.flow.component.Key
Opens an existing document or message.
OPTION - Static variable in annotation type 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 Type in com.vaadin.flow.router
Annotation to mark a Navigation url parameter as optional.
or(Predicate<? super T>) - Method in interface com.vaadin.flow.function.SerializablePredicate
 
OSGiAccess - Class in com.vaadin.flow.server.osgi
Manages scanned classes inside OSGi container.
OSGiAccess.OSGiServletContext - Class in com.vaadin.flow.server.osgi
This is internal class and is not intended to be used.
OSGiServletContext() - Constructor for class com.vaadin.flow.server.osgi.OSGiAccess.OSGiServletContext
 

P

P - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <p>.
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.ExecutionCanceler - Interface in com.vaadin.flow.component.page
Callback method for canceling executable javascript set with Page.executeJavaScript(String, Serializable...).
PAGE_DOWN - Static variable in interface com.vaadin.flow.component.Key
The Page Down (or PgDn) key.
PAGE_UP - Static variable in interface com.vaadin.flow.component.Key
The Page Up (or PgUp) key.
PageConfigurator - Interface in com.vaadin.flow.server
Interface for configuring the initial page contents.
PageTitle - Annotation Type in com.vaadin.flow.router
Defines the HTML page title for a navigation target.
PAIRING - Static variable in interface com.vaadin.flow.component.Key
Starts the process of pairing the remote with a device to be controlled.
ParameterDeserializer - Class in com.vaadin.flow.router
Parameter deserialization utility.
PARAMETERS_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
ParentLayout - Annotation Type in com.vaadin.flow.router
Defines the parent layout for components in routing hierarchy.
parseImports(String, Function<String, InputStream>, Function<String, String>, Consumer<String>) - Static method in class com.vaadin.flow.component.internal.HtmlImportParser
Parses the contents of the given resource and passes any found HTML imports to the given consumer.
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.
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.
PASTE - Static variable in interface com.vaadin.flow.component.Key
Paste from the clipboard.
PathLookup<T> - Class in com.vaadin.flow.templatemodel
A map for items that are looked up by hierarchical keys made up of period separated strings.
PAUSE - Static variable in interface com.vaadin.flow.component.Key
The Pause key.
PAYLOAD - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
PERIOD - Static variable in interface com.vaadin.flow.component.Key
.> on a US keyboard.
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.
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.
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.
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
Methods which are published as event-handlers on the client side.
PolymerServerEventHandlers(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers
Creates a new meta information list for the given state node.
PolymerTemplate<M extends TemplateModel> - Class in com.vaadin.flow.component.polymertemplate
Component for an HTML element declared as a polymer component.
PolymerTemplate(TemplateParser) - Constructor for class com.vaadin.flow.component.polymertemplate.PolymerTemplate
Creates the component that is responsible for Polymer template functionality using the provided parser.
PolymerTemplate(TemplateParser, VaadinService) - Constructor for class com.vaadin.flow.component.polymertemplate.PolymerTemplate
Creates the component that is responsible for Polymer template functionality using the provided parser.
PolymerTemplate() - Constructor for class com.vaadin.flow.component.polymertemplate.PolymerTemplate
Creates the component that is responsible for Polymer template functionality.
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
 
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 - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <pre>.
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.
preventsDefault() - Method in class com.vaadin.flow.component.ShortcutRegistration
Deprecated.
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 - Static variable in interface com.vaadin.flow.component.Key
The Process key.
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.
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.
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(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.
PropertyFilter - Class in com.vaadin.flow.templatemodel
Property name filter that supports composition for resolving sub properties.
PropertyFilter(Predicate<String>) - Constructor for class com.vaadin.flow.templatemodel.PropertyFilter
Creates a new unwrapped filter from the given predicate.
PropertyFilter(PropertyFilter, String, Predicate<String>) - Constructor for class com.vaadin.flow.templatemodel.PropertyFilter
Creates a new filter by combining a predicate with a filter for an outer scope.
PropertyFilter(PropertyFilter, String) - Constructor for class com.vaadin.flow.templatemodel.PropertyFilter
Creates a new filter by adapting a filter from an outer scope.
propertyIdToHumanFriendly(Object) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Converts a property id to a human friendly format.
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.
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, 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, 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.
PROPS - Static variable in interface com.vaadin.flow.component.Key
The Props (Properties) key.
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 - Annotation Type in com.vaadin.flow.component.page
Configures automatic server push for a root navigation target (or custom UI).
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(boolean) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Pushes pending state changes and client RPC calls to the client.
push() - Method in interface com.vaadin.flow.server.communication.PushConnection
Pushes pending state changes and client RPC calls to the client.
PUSH_ID_PARAMETER - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Name of the parameter used to transmit the push connection identifier.
PUSH_URL_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
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.
PushMode - Enum 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, String) - Method in class com.vaadin.flow.component.page.History
Invokes history.pushState in the browser with the given parameters.
pushState(JsonValue, Location) - Method in class com.vaadin.flow.component.page.History
Invokes history.pushState in the browser with the given parameters.
put(String, Serializable, boolean) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
 
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.NodeMap
Stores a value with the given key, replacing any value previously stored with the same key.
PWA - Annotation Type in com.vaadin.flow.server
Defines application PWA properties.
PwaConfiguration - Class in com.vaadin.flow.server
Class that holds the configuration from the PWA annotation.
PwaConfiguration(PWA, ServletContext) - Constructor for class com.vaadin.flow.server.PwaConfiguration
 
PwaHandler - Class in com.vaadin.flow.server.communication
Handles serving of PWA resources.
PwaHandler(PwaRegistry) - Constructor for class com.vaadin.flow.server.communication.PwaHandler
Creates PwaHandler from PwaRegistry.
PwaIcon - Class in com.vaadin.flow.server
Implementation of icons used in PWA resources.
PwaIcon.Domain - Enum 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.

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.
readResource(String) - Static method in class com.vaadin.flow.server.BootstrapHandler
 
receiveMessage(Reader) - Method in class com.vaadin.flow.server.communication.AtmospherePushConnection
Reads and buffers a (possibly partial) message.
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.
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
 
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.
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
 
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.
reinitializeSession(VaadinRequest) - Static method in class com.vaadin.flow.server.VaadinService
Discards the current session and creates a new session with the same contents.
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.
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.
remove(Component...) - Method in interface com.vaadin.flow.component.HasComponents
Removes the given child components from this component.
remove() - Method in class com.vaadin.flow.component.ShortcutRegistration
Removes the ShortcutRegistration
remove(String) - Method in class com.vaadin.flow.dom.impl.BasicElementStyle
 
remove(String) - Method in class com.vaadin.flow.dom.impl.ImmutableEmptyStyle
 
remove(Object) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
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(int) - Method in class com.vaadin.flow.internal.nodefeature.ElementChildrenList
 
remove(String) - Method in class com.vaadin.flow.internal.nodefeature.ElementPropertyMap
 
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(Object) - Method in class com.vaadin.flow.internal.nodefeature.NodeList.SetView
 
remove(String) - Method in class com.vaadin.flow.internal.nodefeature.NodeMap
Removes the value stored for the given key.
remove(int) - Method in class com.vaadin.flow.internal.nodefeature.StateNodeNodeList
 
remove(int) - Method in class com.vaadin.flow.internal.nodefeature.VirtualChildrenList
 
remove() - Method in interface com.vaadin.flow.internal.StateTree.ExecutionRegistration
Removes the associated task from the execution queue.
remove(Class<? extends Component>) - Method in class com.vaadin.flow.server.startup.RouteTarget
Remove target route from this RouteTarget.
remove() - Method in interface com.vaadin.flow.shared.Registration
Removes the associated listener from the event source.
remove(Object) - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
remove(int) - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
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(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
 
removeAllChildren() - Method in class com.vaadin.flow.dom.Node
Removes all child elements, including elements only present at the client-side.
removeAllProperties() - Method in class com.vaadin.flow.internal.nodefeature.AbstractPropertyMap
Removes all properties.
removeAttribute(String) - Method in class com.vaadin.flow.dom.Element
Removes the given attribute.
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(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(StateNode, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
removeAttribute(Element) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
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(StateNode, int) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Removes the child at the given position.
removeChild(StateNode, Element) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Removes the given child.
removeChild(StateNode, int) - Method in class com.vaadin.flow.dom.impl.AbstractNodeStateProvider
 
removeChild(StateNode, Element) - 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 class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
removeChild(Element...) - Method in class com.vaadin.flow.dom.Node
Removes the given child element(s).
removeChild(int) - Method in class com.vaadin.flow.dom.Node
Removes the child at the given index.
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.
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.dom.Element
Removes this element from its parent.
removeProperty(String) - Method in class com.vaadin.flow.dom.Element
Removes the given property.
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.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(String) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
removeRoute(String, 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 targetRoute completely from the configuration.
removeRoute(String) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Remove route for given path.
removeRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Remove specific navigation target for given route.
removeRoute(Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Remove the given navigation target route registration.
removeRoute(String) - Method in class com.vaadin.flow.router.RouteConfiguration
Remove all registrations for given path.
removeRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.RouteConfiguration
Remove only the specified navigationTarget from the path and not the whole path if other targets exist for path.
removeRoute(Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Remove the given navigation target route registration.
removeRoute(String) - Method in interface com.vaadin.flow.server.RouteRegistry
Remove all registrations for given path.
removeRoute(String, Class<? extends Component>) - Method in interface com.vaadin.flow.server.RouteRegistry
Remove only the specified navigationTarget from the path and not the whole path if other targets exist for path.
removeScannedClasses(Long) - Method in class com.vaadin.flow.server.osgi.OSGiAccess
Removes classes from the bundle identified by the bundleId.
removeSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Called when the VaadinSession should be removed from the underlying HTTP session.
removeSynchronizedProperty(String) - Method in class com.vaadin.flow.dom.Element
removeSynchronizedPropertyEvent(String) - Method in class com.vaadin.flow.dom.Element
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.
RepeatIndex - Annotation Type in com.vaadin.flow.component.polymertemplate
Allows to receive index of an element in dom-repeat Polymer template section.
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, String) - Method in class com.vaadin.flow.component.page.History
Invokes history.replaceState in the browser with the given parameters.
replaceState(JsonValue, Location) - Method in class com.vaadin.flow.component.page.History
Invokes history.replaceState in the browser with the given parameters.
REQUEST_TYPE_HEARTBEAT - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Request type parameter value indicating a heartbeat 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.
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
 
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.
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.
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(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(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, 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.
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(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(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.
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.
resolve(ResolveRequest) - Method in class com.vaadin.flow.router.internal.DefaultRouteResolver
 
resolve(Class<?>, Route) - Static method in class com.vaadin.flow.router.internal.RouteUtil
Gets the effective route path value of the annotated class.
resolve(Class<?>, Route) - Static method in class com.vaadin.flow.router.Router
Deprecated.
resolve(ResolveRequest) - Method in interface com.vaadin.flow.router.RouteResolver
Resolves the given request to a new NavigationState.
resolveBeanAndRun(TemplateModel, String, BiFunction<BeanModelType<?>, ElementPropertyMap, R>) - Static method in class com.vaadin.flow.templatemodel.TemplateModelUtil
Resolves a bean model type and model map based on a model instance and passes those values to the provided callback.
ResolveContext(VaadinService, WebBrowser, AbstractTheme) - Constructor for class com.vaadin.flow.server.communication.UidlWriter.ResolveContext
Creates a new context.
resolveListAndRun(TemplateModel, String, BiFunction<ListModelType<?>, ModelList, R>) - Static method in class com.vaadin.flow.templatemodel.TemplateModelUtil
Resolves a list model type and a model list based on a model instance and passes those to the provided callback.
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(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, WebBrowser) - Method in class com.vaadin.flow.server.VaadinService
resolveResource(String, WebBrowser) - Method in class com.vaadin.flow.server.VaadinServletService
 
resolveType(String) - Method in class com.vaadin.flow.templatemodel.BeanModelType
Finds the model type denoted by the given model path.
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, String) - Method in class com.vaadin.flow.server.ServiceContextUriResolver
resolveVaadinUri(String, String, String) - Method in class com.vaadin.flow.shared.VaadinUriResolver
Translates a Vaadin URI to a URL that can be loaded by the browser.
ResponseWriter - Class in com.vaadin.flow.internal
The class that handles writing the response data into the response.
ResponseWriter() - Constructor for class com.vaadin.flow.internal.ResponseWriter
ResponseWriter(int) - Constructor for class com.vaadin.flow.internal.ResponseWriter
Deprecated.
This constructor is never used internally and might be removed.
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.
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
 
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.
ROMAJI - Static variable in interface com.vaadin.flow.component.Key
The Romaji key; selects the Roman character set.
Route - Annotation Type in com.vaadin.flow.router
Defines the route for components that function as navigation targets in routing.
RouteAlias - Annotation Type in com.vaadin.flow.router
Defines the route alias for components that function as navigation targets in routing.
RouteAlias.Container - Annotation Type 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.
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.
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.
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
 
RoutePrefix - Annotation Type 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_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(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 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 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.
RouterUtil - Class in com.vaadin.flow.router.internal
Deprecated.
This is an internal class for Flow and should not be used outside. This is deprecated since 1.3 and will be removed in later versions of Flow.
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.server.startup
Route target holder that handles getting the correct type of has parameter target.
RouteTarget(Class<? extends Component>) - Constructor for class com.vaadin.flow.server.startup.RouteTarget
Create a new Route target holder with the given target registered.
RouteTarget(Class<? extends Component>, boolean) - Constructor for class com.vaadin.flow.server.startup.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_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_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_TYPE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key holding the type in of messages sent from the client.
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.
runExecutionsBeforeClientResponse() - Method in class com.vaadin.flow.internal.StateTree
Called internally by the framework before the response is sent to the client.
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

safeEscapeForHtml(String) - Static method in class com.vaadin.flow.server.VaadinServlet
Deprecated.
As of 7.0. Will likely change or be removed in a future version
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.
SCROLL_LOCK - Static variable in interface com.vaadin.flow.component.Key
The Scroll Lock key.
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 type com.vaadin.flow.component.Tag
Tag for an <section>.
SELECT - Static variable in interface com.vaadin.flow.component.Key
The Select key.
SELECT - Static variable in annotation type 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.
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.
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.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 or a file from a WebJar.
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.
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(Throwable) - Constructor for exception com.vaadin.flow.server.ServiceException
Creates an exception which wraps the given throwable.
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.
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.
SERVLET_PARAMETER_BROTLI - Static variable in class com.vaadin.flow.server.Constants
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.Constants
 
SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_HEARTBEAT_INTERVAL - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_PRODUCTION_MODE - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_PUSH_MODE - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_PUSH_URL - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_REQUEST_TIMING - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS - Static variable in class com.vaadin.flow.server.Constants
 
SERVLET_PARAMETER_SYNC_ID_CHECK - Static variable in class com.vaadin.flow.server.Constants
 
ServletContainerInitializerExtender - Class in com.vaadin.flow.server.osgi
Bundle activator which starts bundle tracker.
ServletContainerInitializerExtender() - Constructor for class com.vaadin.flow.server.osgi.ServletContainerInitializerExtender
 
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
 
ServletHelper - Class in com.vaadin.flow.server
Contains helper methods for VaadinServlet and generally for handling VaadinRequests.
ServletHelper.RequestType - Enum in com.vaadin.flow.server
Framework internal enum for tracking the type of a request.
servletInitialized() - Method in class com.vaadin.flow.server.VaadinServlet
 
ServletVerifier - Class in com.vaadin.flow.server.startup
Verify the servlet version on container initialization.
ServletVerifier() - Constructor for class com.vaadin.flow.server.startup.ServletVerifier
 
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(PropertyDescriptor<T, ?>, T) - Method in class com.vaadin.flow.component.Component
Sets the value of the given component property.
set(HasElement, S) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Sets the property value for the given component.
set(Element, S) - Method in interface com.vaadin.flow.component.PropertyDescriptor
Sets the property value for the given element.
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, 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, boolean) - Method in interface com.vaadin.flow.dom.ThemeList
Sets or removes the given theme name, based on the set parameter.
set(Class<T>, T) - Static method in class com.vaadin.flow.internal.CurrentInstance
Sets the current instance of the given type.
set(String, String) - Method in class com.vaadin.flow.internal.nodefeature.ElementAttributeMap
Sets the given attribute to the given value.
set(int, T) - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
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.
setAppId(String) - Method in class com.vaadin.flow.component.internal.UIInternals
Sets the application id tied with this UI.
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
 
setAttribute(String, String) - Method in class com.vaadin.flow.dom.Element
Sets the given attribute to the given value.
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(StateNode, String, String) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Sets the given attribute to the given value.
setAttribute(StateNode, String, AbstractStreamResource) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Sets the given attribute to the given StreamResource value.
setAttribute(StateNode, String, String) - Method in class com.vaadin.flow.dom.impl.AbstractTextElementStateProvider
 
setAttribute(StateNode, String, AbstractStreamResource) - 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, AbstractStreamResource) - Method in class com.vaadin.flow.dom.impl.BasicElementStateProvider
 
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(StateNode, String, String) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
setAttribute(StateNode, String, AbstractStreamResource) - Method in class com.vaadin.flow.dom.impl.ShadowRootStateProvider
 
setAttribute(Element, String) - Method in class com.vaadin.flow.dom.impl.StyleAttributeHandler
 
setAttribute(String, Object) - Method in class com.vaadin.flow.server.Attributes
Stores a value in this set.
setAttribute(Class<T>, T) - Method in class com.vaadin.flow.server.Attributes
Stores a value in this set.
setAttribute(String, Object) - Method in class com.vaadin.flow.server.osgi.OSGiAccess.OSGiServletContext
 
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(Class<T>, T) - 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.
setBrowserDefaultAllowed(boolean) - Method in class com.vaadin.flow.component.ShortcutRegistration
Set whether the default key behavior is allowed in the browser.
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.
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.
setComponent(StateNode, Component) - Method in interface com.vaadin.flow.dom.ElementStateProvider
Defines a mapping between the element and the given component.
setComponent(Element, Component) - Static method in class com.vaadin.flow.dom.ElementUtil
Defines a mapping between this element and the given Component.
setComponent(Component) - Method in class com.vaadin.flow.internal.nodefeature.ComponentMapping
Assigns the given component to this node.
setConfiguration(DeploymentConfiguration) - Method in class com.vaadin.flow.server.VaadinSession
 
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(VaadinSession) - Static method in class com.vaadin.flow.internal.CurrentInstance
Sets current instances for the VaadinSession 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.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.
setData(Component, String, Object) - Static method in class com.vaadin.flow.component.ComponentUtil
Stores a arbitrary value for the given component.
setData(Component, Class<T>, T) - Static method in class com.vaadin.flow.component.ComponentUtil
Stores a an instance of a specific type 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 class com.vaadin.flow.server.BootstrapPageResponse
Properly formats a timestamp as a date in a header that will be included in the HTTP response.
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.
setDialogGracePeriod(int) - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Sets the timeout (in milliseconds) between noticing a loss of connection and showing the dialog.
setDialogGracePeriod(int) - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
setDialogModal(boolean) - Method in interface com.vaadin.flow.component.ReconnectDialogConfiguration
Sets the modality of the dialog.
setDialogModal(boolean) - Method in class com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
 
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
 
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.
setElement(Component, Element) - Static method in class com.vaadin.flow.component.Component
Initializes the root element of a component.
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.
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<T>) - Method in interface com.vaadin.flow.router.HasErrorParameter
Method called before rendering the exception view.
setErrorParameter(BeforeEnterEvent, ErrorParameter<Exception>) - Method in class com.vaadin.flow.router.InternalServerError
 
setErrorParameter(BeforeEnterEvent, ErrorParameter<NotFoundException>) - Method in class com.vaadin.flow.router.RouteNotFoundError
 
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.
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
 
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
 
setHeader(String, String) - Method in class com.vaadin.flow.server.BootstrapPageResponse
Sets a header value that will be added to the HTTP response.
setHeader(String, String) - Method in interface com.vaadin.flow.server.VaadinResponse
Sets the value of a generic response header.
setHeight(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the height of the component.
setHeightFull() - Method in interface com.vaadin.flow.component.HasSize
Sets the height of the component to "100%".
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.
setId(String) - Method in class com.vaadin.flow.component.Component
Sets the id of the root element of this component.
setImage(BufferedImage) - Method in class com.vaadin.flow.server.PwaIcon
Sets the image presenting the icon.
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.
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.
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.
setLongPollingSuspendTimeout(int) - Method in class com.vaadin.flow.server.communication.PushHandler
Sets the timeout used for suspend calls when using long polling.
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(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the max-width of the component.
setMinHeight(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the min-height 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.
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
 
setParameter(BeforeEvent, T) - Method in interface com.vaadin.flow.router.HasUrlParameter
Method that is called automatically when navigating to the target that implements this interface.
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.
setParentLayouts(Class<? extends Component>, List<Class<? extends RouterLayout>>) - Method in class com.vaadin.flow.server.startup.RouteTarget
Set the parent layout chain for target component.
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.
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
 
setProperty(String, String) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given string value.
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(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, 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) - 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.ElementStylePropertyMap
 
setPropertyJson(String, JsonValue) - Method in class com.vaadin.flow.dom.Element
Sets the given property to the given JSON value.
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
 
setPushUrl(String) - Method in interface com.vaadin.flow.component.PushConfiguration
Sets the URL to use for push requests.
setPushUrl(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.
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.ServletHelper
Sets no cache headers to the specified response.
setRoute(String, Class<? extends Component>, List<Class<? extends RouterLayout>>) - Method in class com.vaadin.flow.router.internal.AbstractRouteRegistry
 
setRoute(String, Class<? extends Component>) - Method in class com.vaadin.flow.router.internal.ConfigureRoutes
Set a new RouteTarget for the given path.
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>, 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>, Class<? extends RouterLayout>...) - Method in class com.vaadin.flow.router.RouteConfiguration
Register a navigation target with specified path and given parent layout chain.
setRoute(Router, Class<? extends Component>) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
setRoute(Router, Class<? extends C>, T) - Method in class com.vaadin.flow.router.RouterLink
Set the navigation target for this link.
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
 
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
 
setServletContainerInitializers(Collection<Class<? extends ServletContainerInitializer>>) - Method in class com.vaadin.flow.server.osgi.OSGiAccess
Sets the discovered servlet context initializer classes.
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.
setShadowRoot(StateNode) - Method in class com.vaadin.flow.internal.nodefeature.ShadowRootData
 
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.
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.
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
 
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.
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.
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.
setupPushConnectionFactory(PushConfiguration, BootstrapHandler.BootstrapContext) - Method in class com.vaadin.flow.server.BootstrapHandler
 
setUrlParameters(List<String>) - Method in class com.vaadin.flow.router.NavigationState
Set the list of strings that correspond to the raw string url parameters.
setValue(T) - Method in class com.vaadin.flow.component.AbstractCompositeField
 
setValue(T) - Method in class com.vaadin.flow.component.AbstractField
 
setValue(V) - Method in interface com.vaadin.flow.component.HasValue
Sets the value of this object.
setValue(T) - Method in class com.vaadin.flow.component.internal.AbstractFieldSupport
Delegate method for HasValue.setValue(Object).
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.internal.nodefeature.NodeValue
Sets the value of this feature.
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.InitialPageSettings
Set the viewport value.
setVisible(boolean) - Method in class com.vaadin.flow.component.Component
Sets the component visibility value.
setVisible(boolean) - Method in class com.vaadin.flow.dom.Element
Sets the element visibility value.
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
 
setVisible(boolean) - Method in class com.vaadin.flow.internal.nodefeature.ElementData
Set the visibility of the element.
setWidth(String) - Method in interface com.vaadin.flow.component.HasSize
Sets the width of the component.
setWidthFull() - Method in interface com.vaadin.flow.component.HasSize
Sets the width of the component to "100%".
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.
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
A class representing 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 elemement.
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 - 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
 
shouldBeCached() - Method in class com.vaadin.flow.server.PwaIcon
Should the icon be cached by the Service Worker.
shouldHighlight(T, AfterNavigationEvent) - Method in interface com.vaadin.flow.router.HighlightCondition
Tests if the target should be highlighted based on the navigation event.
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, String, Component, List<RouterLayout>) - Method in class com.vaadin.flow.component.internal.UIInternals
Shows a route target in the related UI.
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
 
size() - Method in class com.vaadin.flow.templatemodel.TemplateModelListProxy
 
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.
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 type 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.
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.
STANDBY - Static variable in interface com.vaadin.flow.component.Key
The Standby key; also known as Suspend or Sleep.
start(BundleContext) - Method in class com.vaadin.flow.server.osgi.ServletContainerInitializerExtender
 
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(Class<? extends NodeFeature>...) - Constructor for class com.vaadin.flow.internal.StateNode
Creates a state node with the given feature types.
StateNode(StateNode) - Constructor for class com.vaadin.flow.internal.StateNode
Create a new instance using the same features as provided node declares.
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.
StaticFileHandler - Interface in com.vaadin.flow.server
Handler for static files.
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(VaadinServletService) - Constructor for class com.vaadin.flow.server.StaticFileServer
Constructs a file server.
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.
stop(BundleContext) - Method in class com.vaadin.flow.server.osgi.ServletContainerInitializerExtender
 
stopsPropagation() - Method in class com.vaadin.flow.component.ShortcutRegistration
Deprecated.
storeSession(VaadinSession, WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Called when the VaadinSession should be stored.
stream(JsonArray) - Static method in class com.vaadin.flow.internal.JsonUtils
Creates a stream from a JSON array.
stream() - Method in class com.vaadin.flow.internal.Range
Returns the range as a stream of integers.
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 StreamResource 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
 
StreamResource - Class in com.vaadin.flow.server
Represents dynamically generated 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.
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.
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.
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.
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
 
STRONG - Static variable in annotation type 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.
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 Type in com.vaadin.flow.component.dependency
Annotation for defining style sheet dependencies on a Component class.
StyleSheet.Container - Annotation Type 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, -.
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 - Static variable in interface com.vaadin.flow.component.Key
This value matches DOM's KeyboardEvent's event.code.
suspend(AtmosphereResource) - Method in class com.vaadin.flow.server.communication.PushHandler
Suspends the given resource
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.
Synchronize - Annotation Type 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.
SYNCHRONIZED_PROPERTIES - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
SYNCHRONIZED_PROPERTY_EVENTS - Static variable in class com.vaadin.flow.internal.nodefeature.NodeFeatures
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.UidlRequestHandler
 
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.
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.UnsupportedBrowserHandler
 
SynchronizedPropertiesList - Class in com.vaadin.flow.internal.nodefeature
List of synchronized properties for an element.
SynchronizedPropertiesList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.SynchronizedPropertiesList
Creates a new synchronized properties list for the given node.
SynchronizedPropertyEventsList - Class in com.vaadin.flow.internal.nodefeature
List of synchronized property events for an element.
SynchronizedPropertyEventsList(StateNode) - Constructor for class com.vaadin.flow.internal.nodefeature.SynchronizedPropertyEventsList
Creates a new synchronized property events list for the given node.
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.
synchronizeProperty(String, String) - Method in class com.vaadin.flow.dom.Element
synchronizeProperty(String, String, DisabledUpdateMode) - Method in class com.vaadin.flow.dom.Element
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
Tag - Annotation Type 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
TargetElement - Enum in com.vaadin.flow.component.page
Page target element enum for inlining during bootstrap creation.
TELETEXT - Static variable in interface com.vaadin.flow.component.Key
Toggles display of teletext, if available.
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.
TemplateData(String, Element) - Constructor for class com.vaadin.flow.component.polymertemplate.TemplateParser.TemplateData
 
TemplateInitializer - Class in com.vaadin.flow.component.polymertemplate
Template initialization related logic (parse template, create sub-templates, inject elements by id).
TemplateInitializer(PolymerTemplate<?>, TemplateParser, VaadinService) - Constructor for class com.vaadin.flow.component.polymertemplate.TemplateInitializer
Creates a new initializer instance.
TemplateModel - Interface in com.vaadin.flow.templatemodel
Interface for a template model.
TemplateModelListProxy<T> - Class in com.vaadin.flow.templatemodel
A list implementation which uses a ModelList in a StateNode as the data source.
TemplateModelListProxy(StateNode, ComplexModelType<T>) - Constructor for class com.vaadin.flow.templatemodel.TemplateModelListProxy
Creates a new proxy for the given node and item type.
TemplateModelProxyHandler - Class in com.vaadin.flow.templatemodel
Invocation handler for TemplateModel proxy objects.
TemplateModelProxyHandler.InterfaceProxy - Class in com.vaadin.flow.templatemodel
Base type used for interface proxy types.
TemplateModelProxyHandler.ModelProxy - Interface in com.vaadin.flow.templatemodel
Gives access to the state node of a proxy instance.
TemplateModelUtil - Class in com.vaadin.flow.templatemodel
Utility class for mapping Bean values to TemplateModel values.
TemplateParser - Interface in com.vaadin.flow.component.polymertemplate
Template content parser.
TemplateParser.TemplateData - Class in com.vaadin.flow.component.polymertemplate
Wrapper for the parsing result.
test(String) - Method in class com.vaadin.flow.templatemodel.PropertyFilter
 
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 type 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 Type in com.vaadin.flow.theme
Defines that there is a theme to use and defines the theme handler implementation.
THEME_ATTRIBUTE_NAME - Static variable in class com.vaadin.flow.dom.impl.ThemeListImpl
 
ThemeDefinition - Class in com.vaadin.flow.theme
Holds all the settings needed to properly set a Theme in the application.
ThemeDefinition(Class<? extends AbstractTheme>, String) - Constructor for class com.vaadin.flow.theme.ThemeDefinition
Creates a definition with the given them class and variant.
ThemeDefinition(Theme) - Constructor for class com.vaadin.flow.theme.ThemeDefinition
Helper constructor that extracts the needed information from a Theme annotation.
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.
ThemeUtil - Class in com.vaadin.flow.theme
Utility class for getting default theme and navigation target theme.
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.
toArray() - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
toArray(T[]) - Method in class com.vaadin.flow.dom.impl.ThemeListImpl
 
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(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.
toJson() - Method in class com.vaadin.flow.shared.ui.Dependency
Converts the object into json representation.
toJson() - Method in class com.vaadin.flow.templatemodel.AbstractBasicModelType
 
toJson() - Method in class com.vaadin.flow.templatemodel.BeanModelType
 
toJson() - Method in class com.vaadin.flow.templatemodel.ConvertedModelType
 
toJson() - Method in class com.vaadin.flow.templatemodel.ListModelType
 
toJson() - Method in interface com.vaadin.flow.templatemodel.ModelType
Creates a JSON representation of this model type.
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.
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 class com.vaadin.flow.component.ShortcutRegistration
 
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.RouteAliasData
 
toString() - Method in class com.vaadin.flow.router.RouteData
 
toString() - Method in class com.vaadin.flow.shared.ui.Dependency
 
toString() - Method in class com.vaadin.flow.templatemodel.TemplateModelProxyHandler.InterfaceProxy
 
translateUrl(String) - Method in interface com.vaadin.flow.theme.AbstractTheme
Translates the given url using the result of the AbstractTheme.getThemeUrl() theme method.
Transport - Enum in com.vaadin.flow.shared.ui
Transport modes for Push
TRANSPORT_KEY - Static variable in class com.vaadin.flow.internal.nodefeature.PushConfigurationMap
 
trimTrailingSlashes(String) - Static method in class com.vaadin.flow.shared.util.SharedUtil
Trims trailing slashes (if any) from a string.
tryServeWebJarResource(HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.server.webjar.WebJarServer
Searches for file requested in the webJars.
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_ID_PARAMETER - Static variable in class com.vaadin.flow.shared.ApplicationConstants
Name of the parameter used to transmit UI ids back and forth.
UI_PARAMETER - Static variable in class com.vaadin.flow.server.VaadinSession
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
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, Throwable) - Constructor for exception com.vaadin.flow.component.UIDetachedException
Creates an instance of the exception using the given message and cause.
UIDetachedException(String) - Constructor for exception com.vaadin.flow.component.UIDetachedException
Creates an instance of the exception using the given message.
UIDetachedException(Throwable) - Constructor for exception com.vaadin.flow.component.UIDetachedException
Creates an instance of the exception using the given cause.
UIDL_KEY_EXECUTE - Static variable in class com.vaadin.flow.shared.JsonConstants
Key used for data related to Page.executeJavaScript(String, Serializable...) in UIDL messages.
UIDL_PATH - Static variable in class com.vaadin.flow.server.communication.UidlRequestHandler
 
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
Method called for a initialized UI.
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.JavaScriptInvocation - Class in com.vaadin.flow.component.internal
A Page.executeJavaScript(String, Serializable...) invocation that has not yet been sent to the client.
UL - Static variable in annotation type com.vaadin.flow.component.Tag
Tag for an <ul>.
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
 
unlock() - Method in class com.vaadin.flow.server.VaadinSession
Unlocks this session.
unlockSession(WrappedSession) - Method in class com.vaadin.flow.server.VaadinService
Releases the lock for the given session for this service instance.
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
 
unregister() - Method in interface com.vaadin.flow.server.StreamRegistration
Unregister StreamResource.
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.
UnsupportedBrowserHandler - Class in com.vaadin.flow.server
A RequestHandler that presents an informative page if the browser in use is unsupported.
UnsupportedBrowserHandler() - Constructor for class com.vaadin.flow.server.UnsupportedBrowserHandler
 
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.
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.
updatePageTitle(NavigationEvent, Component) - Static method in class com.vaadin.flow.router.internal.RouterUtil
Deprecated.
Updates the page title according to the currently visible component.
updateRequestDetails(VaadinRequest) - Method in class com.vaadin.flow.server.WebBrowser
For internal use only.
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.
upperCaseUnderscoreToHumanFriendly(String) - Static method in class com.vaadin.flow.internal.CaseUtil
Converts an UPPER_CASE_STRING to a human friendly format (Upper Case String).
URL_PARAMETER_CLOSE_APPLICATION - Static variable in class com.vaadin.flow.server.VaadinService
Deprecated.
As of 7.0.
URL_PARAMETER_RESTART_APPLICATION - Static variable in class com.vaadin.flow.server.VaadinService
Deprecated.
As of 7.0.
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.
USE_ORIGINAL_FRONTEND_RESOURCES - Static variable in class com.vaadin.flow.server.Constants
Configuration name for the parameter that determines if Flow should use bundled fragments or not.
useCompiledFrontendResources() - Method in interface com.vaadin.flow.function.DeploymentConfiguration
Determines if Flow should use compiled or original frontend resources.
Uses - Annotation Type in com.vaadin.flow.component.dependency
Marks that an annotated component implicitly uses another component.
Uses.Container - Annotation Type in com.vaadin.flow.component.dependency
Internal annotation to enable use of multiple Uses annotations.

V

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_STATIC_FILES_PATH - Static variable in class com.vaadin.flow.shared.ApplicationConstants
The prefix used for all internal static files, relative to context root.
VaadinBundleTracker - Class in com.vaadin.flow.server.osgi
Bundle tracker to discover all classes in active bundles.
VaadinBundleTracker(BundleContext) - Constructor for class com.vaadin.flow.server.osgi.VaadinBundleTracker
Creates a new instance of a bundle tracker.
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(DeploymentConfiguration) - Constructor for class com.vaadin.flow.server.VaadinService
Creates a new vaadin service based on a deployment configuration.
VaadinService() - Constructor for class com.vaadin.flow.server.VaadinService
Creates a service.
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
 
VaadinServletConfiguration - Annotation Type in com.vaadin.flow.server
Annotation for configuring subclasses of VaadinServlet.
VaadinServletConfiguration.InitParameterName - Annotation Type in com.vaadin.flow.server
Defines the init parameter name for methods in VaadinServletConfiguration.
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(VaadinServlet, DeploymentConfiguration) - Constructor for class com.vaadin.flow.server.VaadinServletService
Creates an instance connected to the given servlet and using the given configuration.
VaadinServletService() - Constructor for class com.vaadin.flow.server.VaadinServletService
Creates a servlet service.
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 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
 
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.
validatePwaClass(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(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 - 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 com.vaadin.flow.component.KeyLocation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.component.KeyModifier
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.component.page.Inline.Position
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.component.page.Inline.Wrapping
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.component.page.TargetElement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.dom.DebouncePhase
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.dom.DisabledUpdateMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.dom.NodeVisitor.ElementType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.router.NavigationTrigger
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.server.communication.AtmospherePushConnection.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.server.InitialPageSettings.Position
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.server.InitialPageSettings.WrapMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.server.PwaIcon.Domain
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.server.ServletHelper.RequestType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.server.VaadinSessionState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.shared.BrowserDetails.OperatingSystem
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.shared.communication.PushMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.shared.ui.Dependency.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.shared.ui.LoadMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.shared.ui.Transport
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.templatemodel.ClientUpdateMode
Returns the enum constant of this type 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 com.vaadin.flow.component.KeyLocation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.component.KeyModifier
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.component.page.Inline.Position
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.component.page.Inline.Wrapping
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.component.page.TargetElement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.dom.DebouncePhase
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.dom.DisabledUpdateMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.dom.NodeVisitor.ElementType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.router.NavigationTrigger
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.server.communication.AtmospherePushConnection.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.server.InitialPageSettings.Position
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.server.InitialPageSettings.WrapMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.server.PwaIcon.Domain
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.server.ServletHelper.RequestType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.server.VaadinSessionState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.shared.BrowserDetails.OperatingSystem
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.shared.communication.PushMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.shared.ui.Dependency.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.shared.ui.LoadMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.shared.ui.Transport
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.templatemodel.ClientUpdateMode
Returns an array containing the constants of this enum type, in the order they are declared.
valueUnbound(HttpSessionBindingEvent) - Method in class com.vaadin.flow.server.VaadinSession
 
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 url parameters is valid for the given navigation target.
verifyServletVersion() - Static method in class com.vaadin.flow.server.startup.ServletVerifier
Verify that the used servlet version is not too old.
Version - Class in com.vaadin.flow.server
Provides information about the current version of the framework.
Version() - Constructor for class com.vaadin.flow.server.Version
 
VIDEO_MODE_NEXT - Static variable in interface com.vaadin.flow.component.Key
Cycles through the available video modes.
Viewport - Annotation Type 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_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.
VISIBLE - Static variable in class com.vaadin.flow.internal.nodefeature.NodeProperties
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
 
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.
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.
VOICE_DIAL - Static variable in interface com.vaadin.flow.component.Key
The Voice Dial key.

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
 
WebBrowser - Class in com.vaadin.flow.server
Class that provides information about the web browser the user is using.
WebBrowser() - Constructor for class com.vaadin.flow.server.WebBrowser
 
WebJarServer - Class in com.vaadin.flow.server.webjar
Handles requests that may require webJars contents.
WebJarServer(DeploymentConfiguration) - Constructor for class com.vaadin.flow.server.webjar.WebJarServer
Creates a webJar server that is able to search webJars for files and return them.
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.
WIDGETSET_MISMATCH_INFO - Static variable in class com.vaadin.flow.server.communication.ServerRpcHandler
 
WildcardParameter - Annotation Type in com.vaadin.flow.router
Annotation to mark a Navigation url parameter as a wildcard allowing 0-N parameter parts to be bound for this url parameter.
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.
withCtrl() - Method in class com.vaadin.flow.component.ShortcutRegistration
Fluently adds KeyModifier.CONTROL to the shortcut's modifiers.
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.
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.
withShift() - Method in class com.vaadin.flow.component.ShortcutRegistration
Fluently adds KeyModifier.SHIFT to the shortcut's modifiers.
withTarget(Class<? extends Component>, List<String>) - Method in class com.vaadin.flow.router.NavigationStateBuilder
Assigns the given navigation target with the given url parameter 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.
WORKBOX_FOLDER - Static variable in class com.vaadin.flow.server.PwaRegistry
 
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.
write(OutputStream) - Method in class com.vaadin.flow.server.PwaIcon
Writes the icon image to output stream.
writeBrowserTooOldPage(VaadinRequest, VaadinResponse) - Method in class com.vaadin.flow.server.UnsupportedBrowserHandler
Writes a page encouraging the user to upgrade to a more current browser.
writeCacheHeaders(String, HttpServletResponse) - Method in class com.vaadin.flow.server.StaticFileServer
Writes cache headers for the file into the response.
writeModificationTimestamp(URL, HttpServletRequest, HttpServletResponse) - Method in class com.vaadin.flow.server.StaticFileServer
Writes the modification timestamp info for the file into the response.
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.

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 Z 

Copyright © 2000–2019 Vaadin Ltd. All rights reserved.