All Classes
-
All Classes Class Description AbstractAnnotationValidator Validation class that contains common logic to checks that specific annotations are not configured wrong.
AbstractAttachDetachEvent Internal helper for
AttachEvent
andDetachEvent
.AbstractBackEndDataProvider<T,F> Abstract base class for implementing back end data providers.
AbstractBackEndHierarchicalDataProvider<T,F> Abstract base class for implementing
BackEndHierarchicalDataProvider
s.AbstractBasicModelType<T> Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.AbstractBeanPropertyDefinition<T,V> Abstract base class for PropertyDefinition implementations for beans.
AbstractCollaborationManager The common abstract superclass of Collaboration Managers.
AbstractCollaborationManager.ActivationHandler The callback executed when the manager is activated, i.e.
AbstractComponentDataGenerator<T> Abstract class used as base for DataGenerators that need to manage the lifecycle of components, according to what items are requested or destroyed.
AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T> An abstract field class that is backed by a composite component.
AbstractConfiguration Defines a base contract for configuration (e.g.
AbstractConfigurationFactory A configuration factory base logic which reads the token file.
AbstractConfigurationObject Abstract base class for model classes to be serialized to JSON.
AbstractConfigurationObject Base class for all map configuration objects that represent an OL class.
AbstractDataLabels AbstractDataProvider<T,F> Abstract data provider implementation which takes care of refreshing data from the underlying data provider.
AbstractDataView<T> Abstract data view implementation which handles parts that apply for any type of data.
AbstractDeploymentConfiguration An abstract base class for DeploymentConfiguration implementations.
AbstractDevServerRunner Deals with most details of starting a frontend development server or connecting to an existing one.
AbstractField<C extends AbstractField<C,T>,T> An abstract implementation of a field, or a
Component
allowing user input.AbstractField.ComponentValueChangeEvent<C extends Component,V> Value change event fired by components.
AbstractFieldSupport<C extends Component & HasValue<AbstractField.ComponentValueChangeEvent<C,T>,T>,T> Encapsulates all the logic required for a typical field implementation.
AbstractFileBuffer Abstract class for common file receiver buffers.
AbstractGridMultiSelectionModel<T> Abstract implementation of a GridMultiSelectionModel.
AbstractGridSingleSelectionModel<T> Abstract implementation of a GridSingleSelectionModel.
AbstractHierarchicalDataProvider<T,F> Abstract hierarchical data provider implementation which takes care of item refreshes and associated events.
AbstractInjectableElementInitializer Generic initializer logic.
AbstractLazyDataView<T> Abstract lazy data view implementation which handles the interaction with a data communicator.
AbstractListChange<T extends Serializable> Change describing an operation (add/remove) in a
list
node feature.AbstractListDataView<T> Abstract list data view implementation which provides common methods for fetching, filtering and sorting in-memory data to all
ListDataView
subclasses.AbstractLogin Abstract component for the
<vaadin-login-overlay>
and<vaadin-login-form>
components.AbstractLogin.ForgotPasswordEvent `forgot-password` is fired when the user clicks Forgot password button
AbstractLogin.LoginEvent `login` is fired when the user either clicks Submit button or presses an Enter key.
AbstractLookupInitializer SPI for customizing lookup in applications inside Servlet 3.0 containers.
AbstractNavigationStateRenderer Base class for navigation handlers that target a navigation state.
AbstractNodeStateProvider Abstract implementation of the
ElementStateProvider
related to the composition essence of the provider.AbstractNumberField<C extends AbstractNumberField<C,T>,T extends Number> Abstract base class for components based on
vaadin-number-field
element and its subclasses.AbstractPlotOptions AbstractPropertyConfiguration Provides a configuration based on string properties.
AbstractPropertyMap Abstract class to be used as a parent for node maps which supports setting properties in a map.
AbstractRouteRegistry AbstractRouteRegistry with locking support and configuration.
AbstractRouteRegistry.Configuration Configuration interface to use for updating the configuration entity.
AbstractRouteRegistryInitializer Common validation methods for route registry initializer.
AbstractRpcInvocationHandler Abstract invocation handler implementation with common methods.
AbstractSeries Abstract base class for series
AbstractSeriesBeanSerializer Custom bean serializer for
AbstractSeries
that adds the type field.AbstractSeriesEvent Base class for series events.
AbstractSeriesItem Abstract superclass for chart series items
AbstractSeriesItemEvent Base class for series item events.
AbstractServerHandlers<T> Abstract class for collecting Methods which are published as
serverObject.<name>
on the client side.AbstractSinglePropertyField<C extends AbstractField<C,T>,T> Abstract field that is based on a single element property.
AbstractStreamResource Abstract stream resource class.
AbstractStringToNumberConverter<T extends Number> A converter that converts from the number type T to
String
and back.AbstractTaskClientGenerator Abstract class for generating client files.
AbstractTemplate<M extends TemplateModel> Deprecated. Polymer template support is deprecated - we recommend you to useLitTemplate
instead.AbstractTextElementStateProvider Abstract element state provider for text nodes.
AbstractTheme Abstract theme definition class for defining theme variables when in use.
AbstractValidator<T> An abstract base class for typed validators.
AccessAnnotationChecker Checks if a given user has access to a given method.
Accessibility Options for configuring accessibility for the chart.
AccessResponse Response object when access to Collaboration Engine is requested for a user.
Accordion Accordion is a vertically stacked set of expandable panels.
Accordion.OpenedChangeEvent An event fired when an Accordion is opened or closed.
AccordionPanel An accordion panel which could be opened or closed.
ActionDispatcher Allows dispatching actions to be executed in background.
ActivationHandler Defines when to execute the connection callback
AfterNavigationEvent Event created after navigation completed.
AfterNavigationHandler The base interface for every
AfterNavigationEvent
handler.AfterNavigationListener A listener that may be added to the
UI
usingUI.addAfterNavigationListener(AfterNavigationListener)
.AfterNavigationObserver Any attached component implementing this interface will receive an event after all navigation tasks have resolved.
AllFinishedEvent AllFinishedEvent is sent when the upload has processed all the files in its upload queue, regardless of whether all the receptions were successful or not.
AllowClientUpdates Deprecated. This functionality is bound to template model which is not supported for lit template.AllowClientUpdates.Container Internal annotation to enable use of multiple
AllowClientUpdates
annotations.AllowInert Makes a
@ClientCallable
method callable even if the UI is inert.AmbiguousRouteConfigurationException Exception indicating that the application's routes already has the navigation target with the given path.
Anchor Component representing an
<a>
element.AnchorTarget Enum representing
target
attribute values for an<a>
element.AnchorTargetValue Represents
target
attribute values for an<a>
element.AnnotationReader Helper class for reading annotation data.
AnnotationValidator Validation class that is run during servlet container initialization which checks that specific annotations are not configured wrong.
AnonymousAllowed A security annotation, granting anonymous access to the Vaadin endpoint (or its method) it is placed onto.
App AppLayout App Layout is a component for building common application layouts.
AppLayout.AppLayoutI18n The internationalization properties for
AppLayout
AppLayout.Section Sections in the component that can be used as primary.
ApplicationClassLoaderAccess Allows to access the web application classloader.
ApplicationConfiguration Configuration on the application level.
ApplicationConfigurationFactory A factory for
ApplicationConfiguration
.ApplicationConstants A utility class providing static constants.
ApplicationRouteRegistry Registry for holding navigation target components found on servlet initialization.
ApplicationRouteRegistry.ApplicationRouteRegistryWrapper RouteRegistry wrapper class for storing the ApplicationRouteRegistry.
AppShellConfigurator An interface to configure application features and the host page where the Vaadin application is running.
AppShellPredicate Checks whether the provided class is an
AppShellConfigurator
eligible for the web application.AppShellRegistry The registry class for
AppShellConfigurator
annotations.AppShellRegistry.AppShellRegistryWrapper A wrapper class for storing the
AppShellRegistry
instance in the servlet context.AppShellSettings Initial page settings class for modifying the application shell.
ArchiveExtractionException Exception indicating a failure during extraction of an archive file.
AreaOptions ArrayUpdater Array update strategy aware class.
ArrayUpdater.Update Array updater strategy.
Article Component representing a
<article>
element.Aside Component representing a
<aside>
element.Assets Defines the default assets that the Map component provides
Assets.Asset Assets.ImageAsset AtmospherePushConnection A
PushConnection
implementation using the Atmosphere push support that is by default included in Vaadin.AtmospherePushConnection.FragmentedMessage Represents a message that can arrive as multiple fragments.
AtmospherePushConnection.State AttachEvent Event fired after a
Component
is attached to the UI.AttachExistingElementFeature Temporary storage of data required to handle existing element attachment callback from the client side.
AttachExistingElementRpcHandler RPC handler for a client-side response on attach existing element request.
AttachNotifier Mixin interface for components that support adding attach listeners.
AttachTemplateChildRpcHandler RPC handler for a client-side response on attach existing element by id request.
Attributes A collection of style attributes for the
Halo
Attributes The
Attributes
class represents a set of attributes.Autocapitalize Capitalization options for the
autocapitalize
attribute.Autocomplete Values for the
autocomplete
attribute.Avatar Avatar is a graphical representation of an object or entity, for example a person or an organisation.
Avatar.AvatarI18n The internationalization properties for
AvatarGroup
.AvatarGroup Avatar Group is used to group multiple Avatars together.
AvatarGroup.AvatarGroupI18n The internationalization properties for
AvatarGroup
.AvatarGroup.AvatarGroupItem Item to be set as an avatar for the avatar group.
AvatarGroupVariant Set of theme variants applicable for
vaadin-avatar-group
component.AvatarVariant Set of theme variants applicable for
vaadin-avatar
component.Axis AxisDimension Possible axis dimensions with their indexes in client-side
AxisList<T extends Axis> Alternative AxisContainer to allow multiple axes
AxisListSerializer Serializer for
AxisList
AxisRescaledEvent Event for information about rescaling the axis.
AxisStyle The AxisStyle class contains options for customizing the style of an axis
AxisTitle The axis title, showing next to the axis line.
AxisTitleBeanSerializer Serializer for
AxisTitle
.AxisType Enum representing different axis types.
Back Defines the back panel of the frame around 3D charts.
Backend The interface between a cluster backend and Collaboration Engine.
Backend.EventIdNotFoundException This exception is thrown by the {@link EventLog::subscribe()} method if the provided
UUID
does not exist in the log.Backend.EventLog A strictly ordered log of submitted events.
Backend.Snapshot The
Snapshot
class is used to submit and retrieve a snapshot payload using the {@link Backend::replaceSnapshot()} and {@link Backend::loadLatestSnapshot()} methods.BackEndDataProvider<T,F> A data provider that lazy loads items from a back end.
BackendFeatureNotEnabledException Exception thrown if the feature-flag for the
Backend
API is not enabled.BackEndHierarchicalDataProvider<T,F> A data provider that lazy loads items from a back end containing hierarchical data.
Background An object, or array of objects, for backgrounds.
BackgroundShape The shape of the pane background.
BasicComplexModelType<T> Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.BasicElementStateProvider Implementation which stores data for basic elements, i.e.
BasicElementStyle Implementation of
Style
forBasicElementStateProvider
.BasicModelType Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.BasicRenderer<SOURCE,TARGET> Abstract renderer used as the base implementation for renderers that outputs a simple value in the UI, such as
NumberRenderer
andLocalDateRenderer
.BasicTextElementStateProvider Handles storing and retrieval of the state information for a text node using a state node.
BasicTypeValue The feature contains a value of the basic type.
BeanDataGenerator<T> A
DataGenerator
that sends all the fields of the objects in the model to the client, using the field names as property names.BeanModelType<T> Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.BeanPropertySet<T> A
PropertySet
that uses reflection to find bean properties.BeanPropertySet.NestedBeanPropertyDefinition<T,V> Contains properties for a bean type which is nested in another definition.
BeanSerializationDelegate<T> Abstract class for bean serializers.
BeanSerializerDelegator<T> Delegates serialization calls to the given instance of
BeanSerializationDelegate
.BeanUtil Utility class for Java Beans information access.
BeanValidationBinder<BEAN> Binder that uses reflection based on the provided bean type to resolve bean properties.
BeanValidator A
Validator
using the JSR-303 (javax.validation) annotation-based bean validation mechanism.BeforeEnterEvent Event created before navigation happens.
BeforeEnterHandler The base interface for every
BeforeEnterEvent
handler.BeforeEnterListener A listener that may be added to the
UI
usingUI.addBeforeEnterListener(BeforeEnterListener)
.BeforeEnterObserver Any attached component implementing this interface will receive an event before a new navigation state is entered.
BeforeEvent Abstract before event class that has the common functionalities for
BeforeLeaveEvent
andBeforeEnterEvent
.BeforeLeaveEvent Event created before navigation happens.
BeforeLeaveHandler The base interface for every
BeforeLeaveEvent
handler.BeforeLeaveListener A listener that may be added to the
UI
usingUI.addBeforeLeaveListener(BeforeLeaveListener)
.BeforeLeaveObserver Any attached component implementing this interface will receive an event before leaving the current navigation state.
BigDecimalField BigDecimalField is an input field for handling decimal numbers with high precision.
BigDecimalRangeValidator Validator for validating that an
BigDecimal
is inside a given range.BigIntegerRangeValidator Validator for validating that an
BigInteger
is inside a given range.Binder<BEAN> Connects one or more
Field
components to properties of a backing data type such as a bean type.Binder.Binding<BEAN,TARGET> Represents the binding between a field and a data property.
Binder.BindingBuilder<BEAN,TARGET> Creates a binding between a field and a data property.
Binder.BindingBuilderImpl<BEAN,FIELDVALUE,TARGET> An internal implementation of
BindingBuilder
.Binder.BindingImpl<BEAN,FIELDVALUE,TARGET> An internal implementation of
Binding
.BinderCrudEditor<E> A CRUD editor that binds editor fields to bean properties using a
Binder
.BinderValidationErrorHandler Handler for applying effects to
HasValue
components inBinder
based onValidationResult
for the user input.BinderValidationStatus<BEAN> Binder validation status change.
BinderValidationStatusHandler<BEAN> Handler for
BinderValidationStatus
changes.BindingException A subclass of
RuntimeException
which may be thrown insideBinder.Binding
logic to wrap an exception caused byHasValue
, validator, converter, etc.BindingExceptionHandler Handles an
Exception
which may be thrown insideBinder.Binding
logic to be able to identify the originator of the exception (the originalException
instance usually doesn't contain any information whichHasValue
object is the source of the exception).BindingValidationStatus<TARGET> Represents the status of field validation.
BindingValidationStatus.Status Status of the validation.
BindingValidationStatusHandler Handler for
BindingValidationStatus
changes.BlurNotifier<T extends Component> Mixin interface to handle blur events on components.
BlurNotifier.BlurEvent<C extends Component> Represents the DOM event "blur".
Board Vaadin Board allows creating responsive layouts in an easy way.
BodySize Defines the body size that will be added to the HTML of the host pages.
BootstrapException A Vaadin internal runtime exception thrown when the writing of the bootstrap page in
BootstrapHandler
fails for some reason.BootstrapHandler Request handler which handles bootstrapping of the application, i.e.
BootstrapHandler.BootstrapContext Provides context information for the bootstrap process.
BootstrapHandler.BootstrapPageBuilder Builds bootstrap pages.
BootstrapHandler.BootstrapUriResolver The URI resolver used in the bootstrap process.
BootstrapHandler.PageBuilder Interface for objects capable of building the bootstrap page.
BootstrapHandlerHelper Helper methods for use in bootstrapping.
BootstrapInitialPredicate The callback used by bootstrap handlers in order to know when a request needs to pre-render the UI and include the initial UIDL in the page.
BootstrapListener Deprecated. Since 3.0, this API is deprecated in favor ofIndexHtmlRequestListener
when using client-side bootstrappingBootstrapPageResponse Deprecated. Since 3.0, this API is deprecated in favor ofIndexHtmlResponse
when using client-side bootstrappingBootstrapUrlPredicate The callback used by bootstrap handlers in order to know when a request is a valid URL to render the page.
Bottom The bottom of the frame around a 3D chart.
BoxPlotItem A DataSeriesItem implementation suitable for box plot charts.
BoxSizing Enum for the values of the CSS property
box-sizing
.Breaks An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.
BrowserDetails Parses the user agent string from the browser and provides information about the browser.
BrowserDetails.OperatingSystem Detected operating systems.
BrowserLauncher Util for launching a browser instance.
BrowserLiveReload Provides a way to reload browser tabs via web socket connection passed as a
AtmosphereResource
.BrowserLiveReload.Backend Live reload enabling technology detected.
BrowserLiveReloadAccess Deprecated. UseBrowserLiveReloadAccessor
insteadBrowserLiveReloadAccessor Provides API to access to the
BrowserLiveReload
instance by aVaadinService
.BrowserLiveReloadAccessorImpl Default implementation for
BrowserLiveReloadAccessor
that stores the instance in the Vaadin context.BrowserWindowResizeEvent Event that is fired when a browser window containing a uI is resized.
BrowserWindowResizeListener Listener that gets notified when the size of the browser window containing the uI has changed.
BundleLitParser Parse statistics data provided by webpack.
BundleParser Deprecated. UseBundleLitParser
to parse Lit template since polymer template is deprecated, we recommend you to useLitTemplate
instead.Button The Button component allows users to perform actions.
ButtonOptions A collection of options for buttons appearing in the exporting module.
ButtonPosition Positioning options for
DrillUpButton
Buttons Options for the export related buttons, print and export.
ButtonTheme ButtonVariant Set of theme variants applicable for
vaadin-button
component.ByteRangeValidator Validator for validating that an
Byte
is inside a given range.CallbackDataProvider<T,F> Data provider that uses one callback for fetching items from a back end and another callback for counting the number of available items.
CallbackDataProvider.CountCallback<T,F> Callback interface for counting the number of items in a backend based on a query.
CallbackDataProvider.FetchCallback<T,F> Callback interface for fetching a stream of items from a backend based on a query.
CaseUtil Utilities related to various case operations.
CellFocusEvent<T> Event fired when a cell in the Grid is focused.
CellFocusEvent.GridSection An enum representing the different sections of a grid.
Chart Vaadin Charts is a feature-rich interactive charting library for Vaadin.
ChartAddSeriesEvent The ChartAddSeriesEvent class stores data about new series added to an existing chart.
ChartAfterPrintEvent Fired after a chart is printed using the print menu
ChartBeforePrintEvent Fired before a chart is printed using the print menu
ChartClickEvent The ChartClickEvent class stores information on click events anywhere on the area of the chart.
ChartConfiguration ChartDrillupAllEvent ChartDrillupEvent triggered after all the series has been drilled up if chart has multiple drilldown series
ChartDrillupEvent ChartDrillupEvent triggered when the 'Back to previous series' button is clicked
ChartEnum Interface shared by all enum classes of the vaadin charts.
ChartEnumSerializer Serializer for all classes implementing
ChartEnum
ChartLoadEvent Fired after a chart is loaded
ChartModel Options regarding the chart area and plot area as well as general chart options.
ChartOptions The ChartOptions configures a page local global options like localized texts for charts.
ChartOptionsBeanSerializerModifier Modifier that adds special handling for
ChartOptions
andGradientColor
insideChartOptions
ChartRedrawEvent Fired after a chart is redrawn
ChartSelectionEvent The ChartSelectionEvent class stores information on selection events on the chart's area.
ChartSerialization Util class that handles the configuration needed for the model classes to be serialized to JSON.
ChartStyle Styles of chart
ChartType The default series type for the chart.
ChartVariant Set of theme variants applicable for
vaadin-chart
component.Checkbox Checkbox is an input field representing a binary choice.
CheckboxGroup<T> CheckBoxGroup is a multi-selection component where items are displayed as check boxes.
CheckboxGroupDataView<T> Implementation of generic data view for checkbox group.
CheckboxGroupListDataView<T> Data view implementation for Checkbox Group with in-memory list data.
CheckboxGroupVariant Set of theme variants applicable for
vaadin-checkbox-group
component.ChildElementConsumer Callback which allows to handle request to map a client side DOM element to the server
Element
instance.ClassAttributeHandler Emulates the
class
attribute by delegating toElement.getClassList()
.ClassFinder Interface for annotated and subclass class searches.
ClassFinder.CachedClassFinder Implementation that proxy and cache a real
ClassFinder
.ClassFinder.DefaultClassFinder Implementation that searches for annotated classes or subclasses in a list of classes.
ClassList Representation of the class names for an
Element
.ClassLoaderAwareServletContainerInitializer Allows to load the implementation class by one classloader but accepts classes in
ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext)
method loaded by another classloader.ClickableRenderer<SOURCE> Represents a clickable renderer.
ClickableRenderer.ItemClickListener<SOURCE> Listener that receives the clicked item (or tapped item, in touch devices).
ClickEvent ClickEvent<C extends Component> Event fired when a component is clicked.
ClickNotifier<T extends Component> Mixin interface for components that support adding click listeners to the their root elements.
ClientCallable Publishes the annotated method so it can be invoked from the client side using the notation
this.$server.method()
.ClientCallableHandlers Methods which are published as
element.$server.<name>
on the client side.ClientUpdateMode Deprecated. Template model and polymer template support is deprecated - we recommend you to useLitTemplate
instead.ClientValidationUtil A utility class that allows preventing the web component from setting itself to valid as a result of client-side validation.
CollaborationAvatarGroup Extension of the
AvatarGroup
component which integrates with theCollaborationEngine
.CollaborationAvatarGroup.ImageProvider Callback for creating a stream resource with the image for a specific user.
CollaborationBinder<BEAN> Extension of
Binder
for creating collaborative forms withCollaborationEngine
.CollaborationBinder.CollaborationBindingBuilderImpl<BEAN,FIELDVALUE,TARGET> CollaborationBinderUtil Utility methods for
CollaborationBinder
.CollaborationEngine CollaborationEngine is an API for creating collaborative experiences in Vaadin applications.
CollaborationEngineConfiguration Configuration object for
CollaborationEngine
.CollaborationEngineServiceInitListener A
VaadinServiceInitListener
which uses theInstantiator
to find whether an instance ofCollaborationEngineConfiguration
is provided as a bean in the current environment, using that instance if found.CollaborationList A list that is shared between multiple users.
CollaborationMap A map that is shared between multiple users.
CollaborationMessage Message of a
CollaborationMessageList
.CollaborationMessageInput Extension of the
MessageInput
component which integrates with theCollaborationMessageList
.CollaborationMessageList Extension of the
MessageList
component which integrates with theCollaborationEngine
.CollaborationMessageList.MessageConfigurator Configurator callback for messages in a
CollaborationMessageList
.CollaborationMessagePersister Persister of
CollaborationMessage
items, which enables to read and write messages from/to a backend, for example a database.CollaborationMessagePersister.FetchQuery A query to fetch messages from a backend.
CollaborationMessagePersister.PersistRequest A request to persist messages to a backend.
CollaborationMessageSubmitter Submitter of messages.
CollaborationMessageSubmitter.ActivationContext The activation context of a
CollaborationMessageSubmitter
.CollapseEvent<T,C extends Component> Color Interface used for different type of colors used in model and theme
ColorAxis ColumnOptions ColumnPathRenderer<SOURCE> Renderer for columns that doesn't use any template for rendering its contents (only the value from the object model).
ColumnReorderEvent<T> Event fired when the columns in the Grid are reordered.
ColumnResizeEvent<T> Event fired when a Grid column is resized by the user.
ColumnTextAlign Constants for the text alignment of columns.
ComboBox<T> Combo Box allows the user to choose a value from a filterable list of options presented in an overlay.
ComboBox.FetchItemsCallback<T> A callback method for fetching items.
ComboBox.ItemFilter<T> Predicate to check
ComboBox
items against user typed strings.ComboBoxBase<TComponent extends ComboBoxBase<TComponent,TItem,TValue>,TItem,TValue> Provides base functionality for combo box related components, such as
ComboBox
ComboBoxBase.CustomValueSetEvent<TComponent extends ComboBoxBase<TComponent,?,?>> Event that is dispatched from a combo box component, if the component allows setting custom values, and the user has entered a non-empty value that does not match any of the existing items
ComboBoxDataCommunicator<TItem> Customized data communicator that uses a custom key mapper for preserving keys of selected items when using lazy-loading.
ComboBoxDataCommunicator.SelectionPreservingKeyMapper<TItem> Customized key mapper that does not remove key for an item as long as it is selected.
ComboBoxDataView<T> Implementation of generic data view for ComboBox.
ComboBoxLazyDataView<T> Data view implementation for ComboBox with lazy data fetching.
ComboBoxListDataView<T> Data view implementation for ComboBox with in-memory list data.
ComboBoxVariant Set of theme variants applicable for
vaadin-combo-box
component.Command A generic command interface meant to be used for passing lambdas around.
Compare The
YAxis
will show percentage or absolute change depending on whether compare is set toCompare.PERCENT
orCompare.VALUE
ComplexModelType<T> Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.Component A Component is a higher level abstraction of an
Element
or a hierarchy ofElement
s.ComponentConnectionContext A connection context based on the attach state of a set of component instances.
ComponentDataGenerator<T> A
DataGenerator
that manages the creation and passivation of components generated byComponentRenderer
s.ComponentEvent<T extends Component> An event whose source is a
Component
.ComponentEventBus An event bus for
Component
s.ComponentEventBusUtil Static helpers and caching functionality for
ComponentEventBus
.ComponentEventListener<T extends ComponentEvent<?>> Generic listener for component events.
ComponentMapping A server side only node feature for mapping a node to a component.
ComponentMetaData Immutable meta data related to a component class.
ComponentMetaData.DependencyInfo Dependencies defined for a
Component
class.ComponentMetaData.SynchronizedPropertyInfo Synchronized properties defined for a
Component
class.ComponentRenderer<COMPONENT extends Component,SOURCE> Base class for all renderers that support arbitrary
Component
s.ComponentUtil Utility methods for
Component
.Composite<T extends Component> A composite encapsulates a
Component
tree to allow creation of new components by composing existing components.CompositeDataGenerator<T> A
DataGenerator
that aggregates multiple DataGenerators and delegates the data generation to them.CompositionEndEvent The event when a composition is ended.
CompositionEvent Abstract class for composition events.
CompositionNotifier Mixin interface for components that support adding composition listeners to the their root elements.
CompositionStartEvent The event when a composition is started.
CompositionUpdateEvent The event when a composition is updated.
Condition Under which conditions the rule applies.
ConfigurableFilterDataProvider<T,Q,C> A data provider that supports programmatically setting a filter that will be applied to all queries.
ConfigurableFilterDataProviderWrapper<T,Q,C,F> A configurable data provider that wraps another data provider by combining any filter from the component with the configured filter and passing that to the wrapped provider through the query.
Configuration Chart's configuration root object containing all the child objects that are used to configure chart, axes, legend, titles etc.
Configuration Contains the configuration for the map, such as layers, sources, features.
ConfigurationChangeListener Listener interface for events triggered in Configuration.
ConfiguredRoutes Route configuration class that is used as a value object.
ConfigureRoutes Configuration class for editing routes.
ConfirmDialog Confirm Dialog is a modal Dialog used to confirm user actions.
ConfirmDialog.CancelEvent `cancel` is sent when the user clicks Cancel button or presses Escape key.
ConfirmDialog.ConfirmEvent `confirm` is sent when the user clicks Confirm button
ConfirmDialog.RejectEvent `reject` is sent when the user clicks Reject button
ConnectionContext The context in which a topic connection is active.
ConstantPool Keeps track of
ConstantPoolKey
values that have already been sent to the client.ConstantPoolKey Wraps a JSON value that should be stored in the
ConstantPool
shared between the client and the server.Constants Defines constants for OpenLayers types, which are uses by the client-side synchronization mechanism to identify which OL class to construct and synchronize into.
Constants Constants used by the server side framework.
ContentTypeResolver Content type resolver.
ContextButton Options for the export button.
ContextButtonMenuItem ContextMenu Context Menu is a component that you can attach to any component to display a context menu.
ContextMenuBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>> Base functionality for server-side components based on
<vaadin-context-menu>
.ContextMenuBase.OpenedChangeEvent<C extends ContextMenuBase<C,?,?>> ConvertedModelType<A,M extends Serializable> Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.Converter<PRESENTATION,MODEL> Defines conversion between a model and a presentation type.
ConverterFactory Creates
Converter
instances capable to handle conversion between a model and a presentation type.CookieConsent Cookie Consent is a component for showing a cookie consent banner the first time a user visits the application, until the banner is dismissed.
CookieConsent.Position Position of the banner.
Coordinate Represents map coordinates in a specific projection.
Credits Highchart by default puts a credits label in the lower right corner of the chart.
Crosshair Configure a crosshair that follows either the mouse pointer or the hovered point.
CrosshairLabel A label on the axis next to the crosshair.
Crud<E> A component for performing CRUD operations on a data backend (e.g entities from a database).
Crud.CancelEvent<E> Event fired when the user cancels the creation of a new item or modifications to an existing item.
Crud.DeleteEvent<E> Event fired when the user tries to delete an existing item.
Crud.EditEvent<E> Event fired when the user starts to edit an existing item.
Crud.EditMode Determines whether an item presented for editing is to be treated as a new item or an existing item.
Crud.NewEvent<E> Event fired when the user starts to create a new item.
Crud.SaveEvent<E> Event fired when the user tries to save a new item or modifications to an existing item.
CrudEditor<E> Interface representing a crud editor.
CrudEditorPosition Enum with the possible values for the crud's editor position.
CrudFilter The filter type for use with
CrudGrid
.CrudGrid<E> A simple grid implementation for Crud that allows searching and sorting backed by a data provider.
CrudI18n Internationalization object for customizing the component UI texts.
CrudI18n.Confirmations The confirmation dialogs used in the component
CrudI18n.Confirmations.Confirmation Represents texts in the confirmation dialogs
CrudI18n.Confirmations.Confirmation.Button The confirmation options on a dialog
CrudI18nUpdatedEvent Event fired to a crud grid when the internationalization object is changed.
CrudVariant The set of theme variants applicable to the
vaadin-crud
component.CssData A container for CssImport information when scanning the class path.
CssImport Imports a CSS file into the application bundle.
CssImport.Container Internal annotation to enable use of multiple
CssImport
annotations.CurrentInstance Keeps track of various current instances for the current thread.
Cursor You can set the cursor to POINTER("pointer") if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
CustomAttribute Callback for handling attributes with special semantics.
CustomElementNameValidator Validates custom-element name according to definition in Custom element name
CustomField<T> A
HasValue
whose UI content can be constructed by the user, enabling the creation of e.g.CustomFieldVariant The set of theme variants applicable to the
vaadin-custom-field
component.CustomizedSystemMessages Contains the system messages used to notify the user about various critical situations that can occur.
CvdlProducts Utilities for commercial product handling.
DashStyle Dash styles used to render lines.
DataAddedEvent Event triggered when data was added to the series.
DataChangeEvent<T> An event fired when the data of a
DataProvider
changes.DataChangeEvent.DataRefreshEvent<T> An event fired when a single item of a
DataProvider
has been updated.DataCommunicator<T> DataProvider base class.
DataCommunicator.EmptyDataProvider<T1> In-memory data provider with no items.
DataCommunicator.Filter<F> Wraps the component's filter object with the meta information whether this filter changing should trigger the item count change event.
DataGenerator<T> A data generator for
DataCommunicator
.DataGrouping Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.
DataKeyMapper<T> DataKeyMapper to map data objects to key strings.
DataLabels Options for the series data labels, appearing next to each data point.
DataLabelsFunnel DataLabelsRange Extended data labels for range series types.
DataProvider<T,F> A common interface for fetching data from a backend.
DataProviderListener<T> Data change events listener.
DataProviderSeries<T> A series which is based on data from a DataProvider.
DataProviderSeriesBeanSerializer Custom bean serializer for
DataProviderSeries
DataProviderWrapper<T,F,M> Wrapper class for modifying, chaining and replacing filters and sorting in a query.
DataRemovedEvent Event when the data was removed.
DataSeries An array of data points to be displayed in a chart.
DataSeriesItem The DataSeriesItem class represents a single entry in a
DataSeries
.DataSeriesItem3d DataSeriesItem that can hold also Z value.
DataSeriesItemBeanSerializer Custom bean serializer for
DataSeriesItem
DataSeriesItemBullet DataSeriesItem that can hold also target and targetOptions.
DataSeriesItemTimeline DataSeriesItem that can hold also Label and Description values.
DataSeriesItemXrange DataSeriesItem that can hold also x2 and partialFill amount and color.
DataUpdatedEvent Event for updating existing data series.
DataView<T> Base view interface for getting information on current data set of a Component.
DataViewUtils Internal utility class used by data view implementations and components to simplify the filtering and sorting handling, but not limited to it.
DatePicker Date Picker is an input field that allows the user to enter a date by typing or by selecting from a calendar overlay.
DatePicker.DatePickerI18n The internationalization properties for
DatePicker
.DatePicker.InvalidChangeEvent<T extends GeneratedVaadinDatePicker<T,?>> DatePicker.OpenedChangeEvent<T extends GeneratedVaadinDatePicker<T,?>> DatePickerVariant Set of theme variants applicable for
vaadin-date-picker
component.DateRangeValidator Validator for validating that a
LocalDate
is inside a given range.DateSerializer Serializes all
Date
objects as UTC long.DateTimeLabelFormats For a DATETIME axis, the scale will automatically adjust to the appropriate unit.
DateTimePicker Date Time Picker is an input field for selecting both a date and a time.
DateTimePickerVariant Set of theme variants applicable for
vaadin-date-time-picker
component.DateTimeRangeValidator Validator for validating that a
LocalDateTime
is inside a given range.DateToLongConverter DateToSqlDateConverter DeadlockDetectingCompletableFuture<T> A completable future that will throw from blocking operations if the current thread holds the session lock.
DebouncePhase Defines phases for an event that is debounced.
DebounceSettings Debounce settings for declaratively defined client-side event handlers.
DebugWindowConnection BrowserLiveReload
implementation class.DebugWindowMessage A message sent to the debug window.
DefaultApplicationConfigurationFactory Default implementation of
ApplicationConfigurationFactory
.DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl DefaultArchiveExtractor Default implementation for file archive extraction.
DefaultBeanSerializerModifier Logic for altering the bean serialization process.
DefaultBinderValidationErrorHandler Default implementation of
BinderValidationErrorHandler
.DefaultBindingExceptionHandler Default implementation of
BindingExceptionHandler
.DefaultConverterFactory Default implementation of
ConverterFactory
, handling all standard converters defined incom.vaadin.flow.data.converters
package.DefaultDeploymentConfiguration The default implementation of
DeploymentConfiguration
based on a base class for resolving system properties and a set of init parameters.DefaultErrorHandler Marks an HasErrorParameter view as Framework default handler so it can be disregarded if there is a custom view for the same Exception.
DefaultErrorHandler The default implementation of
ErrorHandler
.DefaultFileDownloader Default file downloader implementation.
DefaultInstantiator Default instantiator that is used if no other instantiator has been registered.
DefaultRoutePathProvider Default implementation for
RoutePathProvider
.DefaultRouteResolver Default implementation of the
RouteResolver
interface.DefaultRpcDecoder Decodes the standard basic types from their JSON representation.
DefaultSystemMessagesProvider System messages provider using the built-in default system messages.
Dependency Represents an html import, stylesheet or JavaScript to include on the page.
Dependency.Type The type of a dependency.
DependencyFilter Filter for dependencies loaded using
@StyleSheet
, and *@JavaScript
.DependencyList List for storing dependencies/files (JavaScript, Stylesheets) to be loaded and included on the client side.
DependencyTreeCache<T> A caching tree traverser for collecting and parsing dependencies.
DeploymentConfiguration 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 Creates
DeploymentConfiguration
filled with all parameters specified by the framework users.DeprecatedPolymerPublishedEventHandler Deprecated. Polymer template support is deprecated - we recommend you to useLitTemplate
instead.DeprecatedPolymerTemplate Deprecated. Polymer template support is deprecated - we recommend you to useLitTemplate
instead.DescriptionList Component representing a
<dl>
element.DescriptionList.Description Component representing a
<dd>
element.DescriptionList.Term Component representing a
<dt>
element.DetachEvent Event fired before a
Component
is detached from the UI.DetachNotifier Mixin interface for components that support adding detach listeners.
Details Details is an expandable panel for showing and hiding content from the user to make the UI less crowded.
Details.OpenedChangeEvent DetailsVariant The set of theme variants applicable to the
vaadin-details
component.DevModeHandler DevModeHandlerManager Provides API to access to the
DevModeHandler
instance by aVaadinService
.DevModeHandlerManagerImpl Provides API to access to the
DevModeHandler
instance.DevModeInitializer Initializer for starting node updaters as well as the dev mode server.
DevModeStartupListener Trigger for running dev mode initialization when running in a compatible servlet environment.
DevModeUsageStatistics Singleton for collecting development time usage metrics
DevServerOutputTracker Tracks the output of a dev server and scans for given success and/or failure patterns while copying the dev server output to standard output.
DevServerOutputTracker.Result Encapsulates the result of a find operation.
Dial Options for the dial or arrow pointer of the gauge.
Dialog A Dialog is a small window that can be used to present information and user interface elements in an overlay.
Dialog.DialogCloseActionEvent `vaadin-dialog-close-action` is sent when the user clicks outside the overlay or presses the escape key.
Dialog.DialogFooter Class for adding and removing components to the footer part of a dialog.
Dialog.DialogHeader Class for adding and removing components to the header part of a dialog.
Dialog.DialogResizeEvent `resize` event is sent when the user finishes resizing the overlay.
Dialog.OpenedChangeEvent<T extends GeneratedVaadinDialog<T>> DialogVariant Set of theme variants applicable for
vaadin-dialog
component.Dimension Axial dimension.
Direction Specifies the direction of the text and other content inside of an element.
DisabledUpdateMode Controls RPC communication from the client side to the server side respecting enabled state.
Div Component representing a
<div>
element.DndUtil Internal class for drag and drop related utility methods.
Docker DomEvent Maps a DOM event to a
ComponentEvent
.DomEvent Server-side representation of a DOM event fired in the browser.
DomEventListener Server-side listener for client-side DOM events.
DomListenerRegistration A registration for configuring or removing a DOM event listener added to an element.
DoubleRangeValidator Validator for validating that a
Double
is inside a given range.DragEndEvent<T extends Component> HTML5 drag end event, fired when the user stops dragging a drag source either by dropping on top of a valid drop target or by canceling to drop.
DragSource<T extends Component> Mixin interface that provides basic drag source API for any component.
DragStartEvent<T extends Component> HTML5 drag start event, fired when the user starts dragging a drag source.
DrawerToggle Server-side component for the
<vaadin-drawer-toggle>
element.Drilldown Options for drill down, the concept of inspecting increasingly high resolution data through clicking on chart items like columns or pie slices.
DrilldownCallback Handler interface for chart's drilldown callbacks.
DrilldownCallback.DrilldownDetails DrilldownEvent The DrilldownEvent class stores information on click events in drilldown points
DrillUpButton Options for the drill up button that appears when drilling down on a series.
DrillUpButtonRelativeTo What box to align the button to.
DrillUpButtonTheme A collection of style attributes for the
DrillUpButton
DropEffect Used to specify the drop effect to use on dragenter or dragover events.
DropEvent<T extends Component> Server side drop event.
DropTarget<T extends Component> Mixin interface that provides basic drop target API for any component.
DuplicateNavigationTitleException Exception indicating a conflict between a route target implementing
HasDynamicTitle
while also having aPageTitle
annotation.EditColumnConfigurator<T> Configuration for the editor of an edit column.
Editor<T> An editor in a Grid.
EditorCancelEvent<T> Holds the data for cancel events fired in
Editor
.EditorCancelListener<T> An event listener for a
Grid
editor cancel events.EditorCloseEvent<T> Holds the data for close events fired in
Editor
.EditorCloseListener<T> An event listener for a
Grid
editor close events.EditorEvent<T> Base class for events fired in
Editor
.EditorImpl<T> Implementation of
Editor
interface.EditorOpenEvent<T> Holds the data for open events fired in
Editor
.EditorOpenListener<T> An event listener for a
Grid
editor open events.EditorRenderer<T> Renderer and DataGenerator used by
Grid.Column
to control the state of the editor components.EditorSaveEvent<T> Holds the data for save events fired in
Editor
.EditorSaveListener<T> An event listener for a
Grid
editor save events.EditorType Set of editor types applicable for editor of the
vaadin-grid-edit-column
component.EffectAllowed Used to specify the effect that is allowed for a drag operation.
Element Represents an element in the DOM.
ElementAttachEvent Event fired after an Element has been attached to the UI.
ElementAttachListener Listener for element attach events.
ElementAttributeMap Map for element attribute values.
ElementChildrenList List of nodes describing the child elements of an element.
ElementClassList Handles CSS class names for an element.
ElementConstants Constants for common element attribute, property, style names.
ElementData Map of basic element information.
ElementDetachEvent Event fired after an element has been detached from the UI.
ElementDetachListener Listener for element detach events.
ElementFactory Helpers to create
Element
instances.ElementListenerMap Map of DOM events with server-side listeners.
ElementPropertyMap Map for element property values.
ElementStateProvider Handles storing and retrieval of the state information for an element using a state node.
ElementStylePropertyMap Map for element style values.
ElementUtil Provides utility methods for
Element
.EmailField Email Field is an extension of Text Field that only accepts email addresses as input.
EmailValidator A string validator for e-mail addresses.
Emphasis Component representing a
<em>
element.EmptyChange Empty change for the feature to report its presence for the client (send the feature information even though its data is empty).
Encode Deprecated. Template model and polymer template support is deprecated - we recommend you to useLitTemplate
instead.Encode.Container Internal annotation to enable use of multiple
Encode
annotations.EncodeUtil Utilities related to various encoding schemes.
EndPointData A simple container with the information related to an application end-point, i.e.
EndpointGeneratorTaskFactory A factory for creating Vaadin Endpoint generator tasks.
EndpointRequestUtil A container for utility methods related with Hilla endpoints.
EntryScope The scope of data in a topic.
ErrorEvent An error thrown by the framework and handled by an
ErrorHandler
.ErrorHandler Application errors handler.
ErrorHandlingCommand Defines the interface to handle exceptions thrown during the execution of a FutureAccess.
ErrorLevel Represents the error levels displayed on components.
ErrorMessageProvider Provider interface for generating localizable error messages using
ValueContext
.ErrorNavigationEvent Event object with data related to error navigation.
ErrorNavigationTargetInitializer Servlet initializer for collecting all available error handler navigation targets implementing
HasErrorParameter
on startup.ErrorParameter<T extends Exception> Navigation error parameter class containing thrown exception and possibly a custom message.
ErrorRouteRegistry Interface class for RouteRegistries that can be used to request for error navigation views for Exceptions.
ErrorStateRenderer Handles error navigation rendering in the target UI.
ErrorTargetEntry A pair of a navigation target for handling exceptions and the exception type handled by the navigation target.
EventData Maps data from a DOM event to a
ComponentEvent
.EventDataCache Cache for tracking global information related to
ComponentEvent
types.EventHandler Deprecated. Event handlers are not supported by Lit templates.EventOptions EventOptions
is used to configure the custom event published by an exported web component.EventRpcHandler RPC handler for events.
EventUtil Event handling utilities.
Exclude Deprecated. Template model and polymer template support is deprecated - we recommend you to useLitTemplate
instead.ExecutionContext Context of a callback execution when
UI.beforeClientResponse(com.vaadin.flow.component.Component, com.vaadin.flow.function.SerializableConsumer)
is invoked.ExecutionFailedException Thrown by
FallibleCommand
if it's unable to complete its execution.ExpandEvent<T,C extends Component> ExportFileType Default MIME type for exporting if chart.exportChart() is called without specifying a type option.
Exporting Options for the exporting module.
ExportingMenuItemDefinition ExtendedClientDetails Provides extended information about the web browser, such as screen resolution and time zone.
Extent Defines an area within a map using min/max coordinates.
FailedEvent FailedEvent event is sent when the upload is received, but the reception is interrupted for some reason.
FallbackChunk Fall back chunk info.
FallbackChunk.CssImportData Css data stored in fallback chunk.
FallibleCommand A generic command which may fail.
FaviconHandler Handles the favicon request explicitly and return 404 for it.
Feature Information about a feature available behind a flag.
Feature A geographic feature to be displayed on a map.
FeatureEventDetails Stores information about a
Feature
that is part of an eventFeatureFlagMessage Message with feature flags sent to the debug window.
FeatureFlags Tracks available feature flags and their status.
FeatureFlags.FeatureFlagsWrapper FeatureFlags wrapper class for storing the FeatureFlags object.
FeatureLayer Layer that allows to conveniently display a number of geographic features.
FieldHighlighterInitializer FileBuffer Basic in file receiver implementation.
FileData Class containing file information for upload.
FileFactory File factory interface for generating file to store the uploaded data into.
FileIOUtils FileRejectedEvent Sent when the file selected for upload doesn't meet the constraints specified on
Upload
FileUtil Fill FilterUtils Internal filter related utilities for data provider.
FinishedEvent FinishedEvent is sent when the upload receives a file, regardless of whether the reception was successful or failed.
FlagItem DataSeriesItem that can hold also title and text values.
FlagShape The name of a symbol to use for the border in
ChartType.FLAGS
series.FlexComponent A component which implements Flexbox.
FlexComponent.Alignment Enum with the possible values for the component alignment inside the layout.
FlexComponent.JustifyContentMode Enum with the possible values for the way the extra space inside the layout is distributed among the components.
FlexLayout A layout component that implements Flexbox.
FlexLayout.ContentAlignment Enum with the possible values for the component alignment inside the layout.
FlexLayout.FlexDirection Possible values for the
flex-direction
CSS property, which determines how the elements are placed inside the layout.FlexLayout.FlexWrap Possible values for the
flex-wrap
CSS property, which determines how the elements inside the layout should behave when they don't fit inside the layout.FloatRangeValidator Validator for validating that a
Float
is inside a given range.Focusable<T extends Component> Represents a component that can gain and lose focus.
FocusNotifier<T extends Component> Mixin interface to handle focus events on components.
FocusNotifier.FocusEvent<C extends Component> Represents the DOM event "focus".
FontWeight Font weight used by Style class
Footer Component representing a
<footer>
element.FooterRow One row of
FooterRow.FooterCell
s in a Grid.FooterRow.FooterCell A footer cell in a Grid.
FormLayout Form Layout allows you to build responsive forms with multiple columns and to position input labels on top or to the side of the input.
FormLayout.FormItem Server-side component for the
<vaadin-form-item>
element.FormLayout.ResponsiveStep A class used in describing the responsive layouting behavior of a
FormLayout
.FormLayout.ResponsiveStep.LabelsPosition Enum for describing the position of label components in a
FormLayout.FormItem
.FormManager Manager to handle form values and field highlight state.
Frame Provides the option to draw a frame around the charts by defining a bottom, front and back panel.
FrontendDependencies Represents the class dependency tree of the application.
FrontendDependenciesScanner Frontend dependencies scanner.
FrontendDependenciesScanner.FrontendDependenciesScannerFactory Frontend dependencies scanner factory.
FrontendTools Provides access to frontend tools (Node.js and npm, pnpm) and optionally installs the tools if needed.
FrontendToolsLocator Helps to locate the tools in the system by their names.
FrontendToolsSettings Configuration object for controlling the
FrontendTools
features.FrontendUtils A class for static methods and definitions that might be used in different locations.
FrontendUtils.CommandExecutionException Thrown when the command execution fails.
FrontendUtils.UnknownVersionException Thrown when detecting the version of a tool fails.
FrontendVersion Version object for frontend versions comparison and handling.
FrontendWebComponentGenerator Generates embeddable web component files in npm mode, hiding the complexity caused by using a different class loader.
FunctionCaller FutureAccess Encapsulates a
Command
submitted usingVaadinSession.access(Command)
.GaugeOptions GeneratedVaadinButton<R extends GeneratedVaadinButton<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckbox<R extends GeneratedVaadinCheckbox<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckbox.ChangeEvent<R extends GeneratedVaadinCheckbox<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckbox.CheckedChangeEvent<R extends GeneratedVaadinCheckbox<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckbox.IndeterminateChangeEvent<R extends GeneratedVaadinCheckbox<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckboxGroup<R extends GeneratedVaadinCheckboxGroup<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R extends GeneratedVaadinCheckboxGroup<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinComboBox Deprecated. This class is not used in any API, and will be removed in a future major version.GeneratedVaadinComboBox.CustomValueSetEvent<TComponent extends ComboBoxBase<TComponent,?,?>> Deprecated. UseComboBoxBase.CustomValueSetEvent
instead.GeneratedVaadinComboBox.FilterChangeEvent<R extends ComboBoxBase<R,?,?>> Deprecated. This class is not used in any API, and will be removed in a future major version.GeneratedVaadinComboBox.InvalidChangeEvent<R extends ComboBoxBase<R,?,?>> Deprecated. This class is not used in any API, and will be removed in a future major version.GeneratedVaadinComboBox.OpenedChangeEvent<TComponent extends ComboBoxBase<TComponent,?,?>> Deprecated. This class is not used in any API, and will be removed in a future major version.GeneratedVaadinComboBox.SelectedItemChangeEvent<TComponent extends ComboBoxBase<TComponent,?,?>> Deprecated. This class is not used in any API, and will be removed in a future major version.GeneratedVaadinContextMenu<R extends ContextMenuBase<R,?,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinContextMenu.OpenedChangeEvent<C extends ContextMenuBase<C,?,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinDatePicker<R extends GeneratedVaadinDatePicker<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinDatePicker.ChangeEvent<R extends GeneratedVaadinDatePicker<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinDatePicker.InvalidChangeEvent<R extends GeneratedVaadinDatePicker<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinDatePicker.OpenedChangeEvent<R extends GeneratedVaadinDatePicker<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinDialog<R extends GeneratedVaadinDialog<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinDialog.OpenedChangeEvent<R extends GeneratedVaadinDialog<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinEmailField<R extends GeneratedVaadinEmailField<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinFormItem<R extends GeneratedVaadinFormItem<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinFormLayout<R extends GeneratedVaadinFormLayout<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinNotification<R extends GeneratedVaadinNotification<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinNotification.OpenedChangeEvent<R extends GeneratedVaadinNotification<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinNumberField<R extends GeneratedVaadinNumberField<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinPasswordField<R extends GeneratedVaadinPasswordField<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinProgressBar<R extends GeneratedVaadinProgressBar<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinRadioButton<R extends GeneratedVaadinRadioButton<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinRadioButton.CheckedChangeEvent<R extends GeneratedVaadinRadioButton<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinRadioGroup<R extends GeneratedVaadinRadioGroup<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinRadioGroup.InvalidChangeEvent<R extends GeneratedVaadinRadioGroup<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinRichTextEditor<R extends GeneratedVaadinRichTextEditor<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinRichTextEditor.ChangeEvent<R extends GeneratedVaadinRichTextEditor<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinSelect<R extends GeneratedVaadinSelect<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinSelect.InvalidChangeEvent<R extends GeneratedVaadinSelect<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinSelect.OpenedChangeEvent<R extends GeneratedVaadinSelect<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinSplitLayout<R extends GeneratedVaadinSplitLayout<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinSplitLayout.IronResizeEvent<R extends GeneratedVaadinSplitLayout<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinSplitLayout.SplitterDragendEvent<R extends GeneratedVaadinSplitLayout<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTab<R extends GeneratedVaadinTab<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTabs<R extends GeneratedVaadinTabs<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTextArea<R extends GeneratedVaadinTextArea<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTextArea.ChangeEvent<R extends GeneratedVaadinTextArea<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTextArea.InvalidChangeEvent<R extends GeneratedVaadinTextArea<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTextField<R extends GeneratedVaadinTextField<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTextField.ChangeEvent<R extends GeneratedVaadinTextField<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTextField.InvalidChangeEvent<R extends GeneratedVaadinTextField<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTimePicker<R extends GeneratedVaadinTimePicker<R,T>,T> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinTimePicker.InvalidChangeEvent<R extends GeneratedVaadinTimePicker<R,?>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.FileRejectEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.FilesChangeEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.MaxFilesReachedChangeEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadAbortEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadBeforeEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadErrorEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadProgressEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadRequestEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadResponseEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadRetryEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadStartEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUpload.UploadSuccessEvent<R extends GeneratedVaadinUpload<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUploadFile<R extends GeneratedVaadinUploadFile<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUploadFile.FileAbortEvent<R extends GeneratedVaadinUploadFile<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUploadFile.FileRemoveEvent<R extends GeneratedVaadinUploadFile<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUploadFile.FileRetryEvent<R extends GeneratedVaadinUploadFile<R>> Deprecated. since v23.3, generated classes will be removed in v24.GeneratedVaadinUploadFile.FileStartEvent<R extends GeneratedVaadinUploadFile<R>> Deprecated. since v23.3, generated classes will be removed in v24.Global Global options that don't apply to each chart.
GradientColor Class providing gradient colors
GradientColor.LinearGradient GradientColor.RadialGradient GradientColor.Stop GradientColorStopsSerializer Grid<T> Grid is a component for showing tabular data.
Grid.AbstractGridExtension<T> A helper base class for creating extensions for the Grid component.
Grid.Column<T> Server-side component for the
<vaadin-grid-column>
element.Grid.DataCommunicatorBuilder<T,U extends ArrayUpdater> Builder for
DataCommunicator
object.Grid.MultiSortPriority Multi-sort priority (visually indicated by numbers in column headers) controls how columns are added to the sort order, when a column becomes sorted, or the sort direction of a column is changed.
Grid.NestedNullBehavior behavior when parsing nested properties which may contain
null
values in the property chainGrid.SelectionMode Selection mode representing the built-in selection models in grid.
Grid.UpdateQueue GridArrayUpdater Array update strategy aware class for Grid.
GridArrayUpdater.UpdateQueueData Data object for
TreeGridArrayUpdater
.GridContextMenu<T> Server-side component for
<vaadin-context-menu>
to be used withGrid
.GridContextMenu.GridContextMenuItemClickEvent<T> Event that is fired when a
GridMenuItem
is clicked inside aGridContextMenu
.GridContextMenu.GridContextMenuOpenedEvent<T> GridDataView<T> Implementation of generic data view for grid.
GridDragEndEvent<T> Drag end event of
Grid
rows.GridDragStartEvent<T> Drag start event of
Grid
rows.GridDropEvent<T> Drop event that occurs on the
Grid
or its rows.GridDropLocation Defines drop locations within a Grid row.
GridDropMode Defines the locations within the Grid row where an element can be dropped.
GridLazyDataView<T> Data view implementation for Grid with lazy data fetching.
GridListDataView<T> Data view implementation for Grid with in-memory list data.
GridMenuItem<T> Item component used inside
GridContextMenu
andGridSubMenu
.GridMultiSelectionModel<T> Multiselection model interface for Grid.
GridMultiSelectionModel.SelectAllCheckboxVisibility State for showing the select all checkbox in the grid's default header row for the selection column.
GridNoneSelectionModel<T> Selection model implementation for disabling selection in Grid.
GridPro<E> GridPro.CellEditStartedEvent<E> Event fired when the user starts to edit an existing item.
GridPro.EditColumn<T> Server-side component for the
<vaadin-grid-edit-column>
element.GridPro.ItemPropertyChangedEvent<E> Event fired when the user has edited an existing item.
GridProVariant Set of theme variants applicable for
vaadin-grid-pro
component.GridSelectionColumn Server side implementation for the flow specific grid selection column.
GridSelectionModel<T> The server-side interface that controls Grid's selection state.
GridSingleSelectionModel<T> Single selection model interface for Grid.
GridSortOrder<T> Sorting information for
Grid
.GridSortOrderBuilder<T> Helper classes with fluent API for constructing
GridSortOrder
lists.GridSubMenu<T> API that allows adding content into the sub menus of a
GridContextMenu
to create hierarchical menus.GridVariant Set of theme variants applicable for
vaadin-grid
component.GwtIncompatible Marks a type, method, constructor of field to be ignored by the GWT compiler.
H1 Component representing a
<h1>
element.H2 Component representing a
<h2>
element.H3 Component representing a
<h3>
element.H4 Component representing a
<h4>
element.H5 Component representing a
<h5>
element.H6 Component representing a
<h6>
element.Halo Options for the halo appearing around the hovered point in line-type series as well as outside the hovered slice in pie charts.
HandlerHelper Contains helper methods for
VaadinServlet
and generally for handlingVaadinRequests
.HandlerHelper.RequestType Framework internal enum for tracking the type of a request.
Handles Options for the handles for dragging the zoomed area.
HasAllowedCharPattern Mixin interface for field components that support setting allowed char pattern to prevent user from entering invalid characters when typing or pasting text.
HasAriaLabel A generic interface for components and other user interface objects that may have an aria-label property to set the accessible name of the component.
HasAutocapitalize Mixin interface for fields with
autocapitalize
attribute.HasAutocomplete Mixin interface for fields with
autocomplete
attribute.HasAutocorrect Mixin interface for fields with
autocorrect
attribute.HasAxis<T> HasClearButton Mixin interface for components that support a clear button.
HasClientValidation Mixin interface for subscribing to the client-side `validated` event from a component.
HasClientValidation.ClientValidatedEvent An event fired by the web component whenever it is validated on the client-side.
HasComponents A component to which the user can add and remove child components.
HasDataGenerators<T> Defines the contract of adding and removing multiple
DataGenerator
s to a given object.HasDataProvider<T> A generic interface for listing components that use a data provider for showing data.
HasDataView<T,F,V extends DataView<T>> An interface for components that get items from the generic data provider types
DataProvider
andInMemoryDataProvider
.HasDynamicTitle Allows to resolve navigation target title dynamically at runtime.
HasElement Marker interface for any class which is based on an
Element
.HasEnabled A generic interface for components and other user interface objects that may be enabled or disabled.
HasErrorParameter<T extends Exception> Defines a view that handles the exceptions for the set Exception type T.
HasExpirationTimeout Common interface to be implemented by types holding data associated to a topic, which provides methods to set an expiration timeout on the data which will be cleared after the timeout has passed since the last connection to the topic has been closed.
HasFilterableDataProvider<T,F> A generic interface for listing components that use a filterable data provider for showing data.
HasHelper Mixin interface for field components that have helper text as property and slots for inserting components.
HasHierarchicalDataProvider<T> A generic interface for hierarchical listing components that use a data provider for showing hierarchical data.
HasItem Indicates that an event has an associated item
HasItemComponents<T> Represents a component that can have additional components between the items.
HasItemComponents.ItemComponent<T> Represents a single item component that is used inside a
HasItemComponents
.HasItems<T> Mixin interface for components that displays a collection of items.
HasItemsAndComponents<T> Represents a component that display a collection of items and can have additional components between the items.
HasLabel A component that supports label definition.
HasLazyDataView<T,F,V extends LazyDataView<T>> Interface that defines methods for fetching items lazily from a backend.
HasListDataView<T,V extends ListDataView<T,?>> An interface for components that accept setting items in-memory and returns a
ListDataView
that provides information and allows operations on the items.HasMenuItems A common interface for components that can have
MenuItem
s with click listeners inside them.HasOrderedComponents A component which the children components are ordered, so the index of each child matters for the layout.
HasPrefixAndSuffix Mixin interface for text-field components that have prefix and suffix slots for inserting components.
HasSeries Indicates that an event has an associated series
HasSize Any component implementing this interface supports setting the size of the component using
HasSize.setWidth(String)
andHasSize.setHeight(String)
.HasStyle Represents
Component
which has class attribute and inline styles.HasText A component that supports text content.
HasText.WhiteSpace Represents
"white-space"
style values.HasTheme Represents
Component
which has theme attribute.HasThemeVariant<TVariantEnum extends ThemeVariant> Mixin interface that allows adding and removing typed theme variants to / from a component
HasTooltip Mixin interface for components that have special handling for tooltips on the Web Component level.
HasUrlParameter<T> Defines route parameters for navigation targets for use in routing.
HasUrlParameterFormat Utility methods to transform urls and parameters from/into the
HasUrlParameter
format into/from the template format.HasValidation A component that supports input validation.
HasValidator<V> A generic interface for field components and other user interface objects that have a user-editable value that should be validated.
HasValue<E extends HasValue.ValueChangeEvent<V>,V> A generic interface for field components and other user interface objects that have a user-editable value.
HasValue.ValueChangeEvent<V> An event fired when the value of a
HasValue
changes.HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>> A listener for value change events.
HasValueAndElement<E extends HasValue.ValueChangeEvent<V>,V> A component that has a value.
HasValueChangeMode Denotes that the component is able to change the way its value on the client side is synchronized with the server side.
Header Component representing a
<header>
element.HeaderRow One row of
HeaderRow.HeaderCell
s in a Grid.HeaderRow.HeaderCell A header cell in a Grid.
HeartbeatEvent Event created for an application heartbeat from the client.
HeartbeatHandler Handles heartbeat requests.
HeartbeatListener Listener for listening to the heartbeat of the application.
HeatSeries A specialized series for use with HeatMaps
HierarchicalArrayUpdater Hierarchical array update strategy aware class.
HierarchicalArrayUpdater.HierarchicalUpdate Array updater strategy that is aware of hierarchical changes.
HierarchicalCommunicationController<T> HierarchicalCommunicationController controls all the communication to client.
HierarchicalConfigurableFilterDataProvider<T,Q,C> A hierarchical data provider that supports programmatically setting a filter that will be applied to all queries.
HierarchicalDataCommunicator<T> Data communicator that handles requesting hierarchical data from
HierarchicalDataProvider
and sending it to client side.HierarchicalDataProvider<T,F> A common interface for fetching hierarchical data from a data source, such as an in-memory collection or a backend database.
HierarchicalQuery<T,F> Immutable hierarchical query object used to request data from a backend.
HierarchyColumnComponentRenderer<COMPONENT extends Component,SOURCE> Renders components as hierarchy column for tree grid.
HierarchyMapper<T,F> Mapper for hierarchical data.
HighlightAction<T> An action to be performed to set the highlight state of the target.
HighlightActions A set of predefined
HighlightAction
s.HighlightCondition<T> A condition to meet to determine the highlight state of the target.
HighlightConditions A set of predefined
HighlightCondition
s.HighlightHandler Functional interface that defines how to handle highlight changes for properties in a topic.
HighlightHandler.HighlightContext The context of the highlight.
History Represents
window.history
in the browser.History.HistoryStateChangeEvent Event fired when the history state has changed.
History.HistoryStateChangeHandler Handles location change events.
HorizontalAlign Alignment of the title relative to the axis values and more generically horizontal alignment.
HorizontalLayout Horizontal Layout places components side-by-side in a row.
Hover Options for the hovered series
Hr Component representing a
<hr>
element.Html A component which encapsulates a given HTML fragment with a single root element.
HtmlComponent Base class for a
Component
that represents a single built-in HTML element.HtmlContainer Base class for a
Component
that represents a single built-in HTML element that can contain child components or text.HTMLLabelItem A HTML label that can be positioned anywhere in the chart area.
HTMLLabels HTML labels that can be positioned anywhere in the chart area.
HtmlObject Component representing a
<object>
element.HtmlUtils Helpers for HTML related aspects.
HttpStatusCode HTTP status codes as defined in RFC 2068.
I18NProvider I18N provider interface for internationalization usage.
Icon Component for displaying an icon from the Vaadin Icons collection.
Icon An icon or image that can be used to visually represent a
Feature
, by using it as the feature'sStyle.setImage(ImageStyle)
Icon.Anchor Icon.AnchorOrigin Icon.ImageSize Icon.Options IconFactory Factory for icons.
IconRenderer<ITEM> A renderer that renders each item as a text following by an icon using provided icon generator and label generator.
Id Deprecated. Use com.vaadin.flow.component.template.Id instead.Id Defines the id of a component or an element to map to inside a lit template.
IdCollector Deprecated. UseIdCollector
instead.IdCollector Collects information of
@Id
mapped fields in a template class.IdentifierProvider<T> A callback interface that is used to provide the identifier of an item.
IdentifierProviderChangeEvent<T,C extends Component> Event notifying the component that its identifier provider has been changed through a data view.
IdMapper Deprecated. UseIdMapper
instead.Polymer template support is deprecated - we recommend you to useLitTemplate
instead.IdMapper Creates or maps Element instances to fields mapped using
@Id
.IFrame Component representing a
<iframe>
element.IFrame.ImportanceType Importance types.
IFrame.SandboxType Sandbox types.
IllegalAttributeException Thrown to indicate that an element had an illegal or inappropriate attribute.
Image Component representing a
<img>
element.ImageLayer Layer for server-rendered images that are available in arbitrary extents and resolutions.
ImageSource Abstract base class for all sources providing a single image
ImageSource.Options ImageStyle Abstract base class for drawing image-based features
ImageStyle.Options ImageWMSSource Source for WMS servers providing single, untiled images
ImageWMSSource.Options ImmutableClassList Immutable class list implementation.
ImmutableEmptyStyle A style implementation which is empty and immutable.
Inactive Include Deprecated. Template model and polymer template support is deprecated - we recommend you to useLitTemplate
instead.IndexHtmlRequestHandler This class is responsible for serving the
index.html
according to the template provided in the frontend folder.IndexHtmlRequestListener This event listener is notified when the Single Page Application's HTML page is about to be generated and sent to the client.
IndexHtmlResponse This represents the state of a Index HTML response being generated.
InertData Server-side feature defining whether a node is inert, and if it should ignore inheriting inert state from parent.
InitialPageSettings Deprecated. since 3.0 useAppShellSettings
InitialPageSettings.Position Append position enum.
InitialPageSettings.WrapMode Content wrapping mode enum.
InitParameters Constants for all servlet init parameters.
InjectableFieldConsumer Three argument consumer.
InjectableLitElementInitializer Initialize a lit template element with data.
InjectablePolymerElementInitializer Deprecated. InjectableLitElementInitializer
should be used for Lit templates since polymer support is deprecated, we recommend you to useLitTemplate
instead.Inline Defines files to inline into the initial page.
Inline.Container Internal annotation to enable use of multiple
Inline
annotations.Inline.Position Inline position enum.
Inline.Wrapping File content wrapping enum.
InlineTargets Data holder class for collected
Inline
annotations to be added to the initial page.InMemoryDataProvider<T> A mixin interface for in-memory data providers.
InMemoryDataProviderHelpers Helper methods for implementing
InMemoryDataProvider
s.Input Component representing an
<input>
element.InputEvent Event fired when the component has received any type of input (e.g.
InputNotifier Mixin interface for components that support adding input listeners to the their root elements.
InputStreamFactory Creates input stream instances that provides the actual data of a
StreamResource
.InstallationException Exception indicating a failure during installation of node and npm.
Instantiator Delegate for discovering, creating and managing instances of various types used by Flow.
InstantiatorFactory A factory for an
Instantiator
.InstantSerializer Serializes all
Instant
objects as UTC long.IntegerField IntegerField is an extension of Text Field that only accepts integer numbers.
IntegerRangeValidator Validator for validating that an
Integer
is inside a given range.InternalRedirectHandler Handles navigation by redirecting the user to some location in the application.
InternalServerError This is a basic default error view shown on exceptions during navigation.
IntervalUnit Irregular time unit used to define point interval unit.
InvalidApplicationConfigurationException Exception indicating that the application's routes have been configured incorrectly.
InvalidCustomElementNameException Exception indicating that the custom-element name is invalid.
InvalidI18NConfigurationException Exception indicating that the application's I18N localization has been configured incorrectly.
InvalidLocationException Thrown to indicate that a
Location
instance is invalid.InvalidRouteConfigurationException Exception indicating that the application's routes have been configured incorrectly.
InvalidRouteLayoutConfigurationException Exception indicating that Route layouts configuration has problems.
InvalidTemplateModelException Deprecated. Template model and polymer template support is deprecated - we recommend you to useLitTemplate
instead.IronIcon Deprecated. since Vaadin 21,IronIcon
is deprecated in favor ofIcon
IronList<T> Deprecated. since Vaadin 21,IronList
is deprecated in favor ofVirtualList
ItemClickEvent<T> Event fired when a Grid item is clicked.
ItemCountChangeEvent<T extends Component> Event describing the item count change for a component.
ItemCountChangeListener Listener interface for getting updates on data item count changes.
ItemDoubleClickEvent<T> Event fired when a Grid item is double clicked.
ItemLabelGenerator<T> ItemLabelGenerator
can be used to customize the string shown to the user for an item.ItemPartialFill PartialFill configuration object to be used in
DataSeriesItemXrange
.Items A HTML label that can be positioned anywhere in the chart area.
ItemSlicedEvent Event for information about slicing a pie point
ItemUpdater<T,V> Callback that is called when a new value has been entered to an editor.
JarContentsManager Shared code for managing contents of jar files.
JavaScript Defines JavaScript dependencies on a
Component
class.JavaScript.Container Internal annotation to enable use of multiple
JavaScript
annotations.JavaScriptBootstrapHandler Processes a 'start' request type from the client to initialize server session and UI.
JavaScriptBootstrapHandler.JavaScriptBootstrapContext Custom BootstrapContext for
JavaScriptBootstrapHandler
.JavaScriptBootstrapUI Custom UI for
JavaScriptBootstrapHandler
.JavaScriptBootstrapUI.ClientViewPlaceholder Placeholder view when navigating from server-side views to client-side views.
JavaScriptSemantics Helpers for replicating JavaScript semantics in Java.
JsModule Annotation for defining JavaScript Module dependencies on a
Component
class.JsModule.Container Internal annotation to enable use of multiple
JsModule
annotations.JsonCodec Utility for encoding objects to and from JSON.
JsonConstants A utility class providing constants for JSON related features.
JsonConversionException Thrown when unable to convert back and forth between a Java object instance and a Jackson
JsonNode
instance.JsonSerializable Base interface for classes that are serializable to and from
JsonObject
.JsonSerializer General-purpose serializer of Java objects to
JsonValue
and deserializer of JsonValue to Java objects.JsonUtils Helpers for using
elemental.json
.JSR356WebsocketInitializer Initializer class for JSR 356 websockets.
JSR356WebsocketInitializer.FakeServletConfig "ServletConfig" which only provides information from a
ServletRegistration
and itsServletContext
.Key An interface to represent keyboard keys.
KeyboardEvent Abstract class for keyboard events.
KeyboardNavigation Options for keyboard navigation.
KeyDownEvent The event when a key is pressed.
KeyEventListener<E extends KeyboardEvent> A conditional event listener for
KeyboardEvent
s.KeyLocation Possible keyboard key locations.
KeyMapper<V> KeyMapper
is the simple two-way map for generating textual keys for objects and retrieving the objects later with the key.KeyModifier Modifier keys.
KeyNotifier Mixin interface for components that support adding key event listeners to the their root elements.
KeyPressEvent The event when a key is pressed.
KeyUpEvent The event when a key is released.
Label Text labels for the plot bands
Label Component for a
<label>
element, which represents a caption for an item in a user interface.Labels Lang Language object.
Layer Abstract base class for all map layers
LayoutDirection The layout of the legend items.
LazyDataView<T> DataView for lazy loaded data.
Legend The legend is a box containing a symbol and name for each series item or point item in the chart.
LegendNavigation Options for the paging or navigation appearing when the legend is overflown.
LegendStyle Style options for Legend
LegendTitle A title to be added on top of the legend.
LegendTitleBeanSerializer Serializer for
LegendTitle
.Level Set options on specific levels.
LicenseEvent Event that is fired during license lifecycle, e.g.
LicenseEvent.LicenseEventType The license event type.
LicenseEventHandler Event handler that gets notified on license events.
LicenseStorage The interface to store license usage data.
LinuxProcFileReader Linux /proc file reader.
ListAddChange<T extends Serializable> Change describing an add operation in a
list
node feature.ListBox<T> List Box allows the user to select one or more values from a scrollable list of items.
ListBoxBase<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE> Base class for the
ListBox
andMultiSelectListBox
.ListBoxDataView<T> Implementation of generic data view for ListBox.
ListBoxListDataView<T> Data view implementation for ListBox with in-memory list data.
ListChangeEvent Event that is fired when the value in a collaboration list changes.
ListClearChange<T extends Serializable> Change describing a clear operation in a
list
node feature.ListDataProvider<T> DataProvider
wrapper forCollection
s.ListDataView<T,V extends ListDataView<T,?>> DataView for a in-memory list data that provides information on the data and allows operations on it.
ListenerPriority This annotation sets the priority of execution on
BeforeEnterListener
s,BeforeLeaveListener
s andAfterNavigationListener
s.ListInsertResult<T> Deprecated, for removal: This API element is subject to removal in a future version. Replaced withListOperationResult
.ListItem Component representing a
<li>
element.ListKey An object which identifies each item of a
CollaborationList
.ListModelType<T> Deprecated. Template model and polymer template support is deprecated - we recommend you to useLitTemplate
instead.ListOperation A list operation providing details such as the operation type, related properties and conditions that should be met for the operation to succeed.
ListOperation.OperationType ListOperationResult<T> The result of a list operation in a
CollaborationList
.ListRemoveChange<T extends Serializable> Change describing a remove operation in a
list
node feature.ListSeries A series consisting of a list of numerical values.
ListSubscriber Event handler that gets notified for changes to collaboration lists.
LitRenderer<SOURCE> LitRenderer is a
Renderer
that uses a Lit-based template literal to render given model objects in the components that support the JS renderer functions API.LitTemplate Component which renders a LitElement template.
LitTemplateInitializer Template initialization related logic.
LitTemplateParser Lit template content parser.
LitTemplateParser.LitTemplateParserFactory Lit template parser factory.
LitTemplateParser.TemplateData Wrapper for the parsing result.
LitTemplateParserImpl Lit template parser implementation.
Loading The loading options control the appearance of the loading screen that covers the plot area on chart operations.
LoadingIndicatorConfiguration Provides method for configuring the loading indicator.
LoadingIndicatorConfigurationMap Map for storing configuration for the loading indicator.
LoadMode Determines a way that dependency is loaded.
LocalBackend A simple backend implementation that only distributes events locally and assumes that there is no previous history for event logs.
LocalDateRenderer<SOURCE> A template renderer for presenting date values.
LocalDateTimeRenderer<SOURCE> A template renderer for presenting
LocalDateTime
objects.LocalDateTimeToDateConverter A converter that converts between
LocalDateTime
andDate
.LocalDateToDateConverter A converter that converts between
LocalDate
andDate
.LocaleChangeEvent Event object with data related to locale change.
LocaleChangeObserver Any
com.vaadin.ui.Component
implementing this interface will be informed when the UI locale is changed and on attach.LocaleUtil Utility class for locale handling.
Location Represents a relative URL made up of path segments and query parameters, but lacking e.g.
LocationChangeEvent Event created when the location changes by any of the reasons defined at
NavigationTrigger
.LocationUtil Utility class exposing reusable utility methods for location.
LoginForm Login is a component that contains a login form.
LoginI18n Internationalization object for customizing the component UI texts.
LoginI18n.ErrorMessage I18n properties for the error message.
LoginI18n.Form I18n properties for the form.
LoginI18n.Header I18n properties for the header.
LoginOverlay Server-side component for the
<vaadin-login-overlay>
component.LongPollingCacheFilter A
PerRequestBroadcastFilter
implementation that handlesAtmospherePushConnection.PushMessage
s to ensure that a message is preserved in theBroadcasterCache
until the client has received it.LongRangeValidator Validator for validating that an
Long
is inside a given range.Lookup Provides a way to discover services used by Flow (SPI).
LookupInitializer Default implementation of
AbstractLookupInitializer
.LookupInitializer.AppShellPredicateImpl Default implementation of
AppShellPredicate
.LookupInitializer.LookupImpl Default implementation of
Lookup
.LookupInitializer.ResourceProviderImpl Default implementation of
ResourceProvider
.LookupServletContainerInitializer Standard servlet initializer for collecting all SPI implementations.
Lumo Lumo component theme class implementation.
LumoDarkTheme The dark version of the default theme for Vaadin Charts.
LumoIcon Enumeration of all icons in the Lumo Icons collection.
LumoLightTheme The default theme for Vaadin Charts.
LumoUtility Contains the definition for all the CSS utility classes provided by Lumo.
LumoUtility.Accessibility Accessibility related classes.
LumoUtility.AlignContent Classes for distributing space around and between items along a flexbox?s cross axis or a grid?s block axis.
LumoUtility.AlignItems Classes for aligning items along a flexbox?s cross axis or a grid?s block axis.
LumoUtility.AlignSelf Classes for overriding individual items' align-item property.
LumoUtility.Background Classes for applying a background color.
LumoUtility.Border Border-related classes.
LumoUtility.BorderColor Classes for setting the border color of an element.
LumoUtility.BorderRadius Classes for setting the border radius of an element.
LumoUtility.BoxShadow Classes for applying a box shadow.
LumoUtility.BoxSizing Classes for setting the box sizing property of an element.
LumoUtility.Display Classes for setting the display property of an element.
LumoUtility.Display.Breakpoint Set of classes with styles to be used for certain viewport sizes
LumoUtility.Display.Breakpoint.Large Classes for defining the display property of an element that will be applied when the viewport has a minimum width of 1024px
LumoUtility.Display.Breakpoint.Medium Classes for defining the display property of an element that will be applied when the viewport has a minimum width of 768px
LumoUtility.Display.Breakpoint.Small Classes for defining the display property of an element that will be applied when the viewport has a minimum width of 640px
LumoUtility.Display.Breakpoint.XLarge Classes for defining the display property of an element that will be applied when the viewport has a minimum width of 1280px
LumoUtility.Display.Breakpoint.XXLarge Classes for defining the display property of an element that will be applied when the viewport has a minimum width of 1536px
LumoUtility.Flex Classes for setting how items grow and shrink in a flexbox layout.
LumoUtility.FlexDirection Classes for setting the flex direction of a flexbox layout.
LumoUtility.FlexDirection.Breakpoint Set of classes defining the flex direction of an element that will be applied only for certain viewport sizes.
LumoUtility.FlexDirection.Breakpoint.Large Classes that will be applied when the viewport has a minimum width of 1024px.
LumoUtility.FlexDirection.Breakpoint.Medium Classes that will be applied when the viewport has a minimum width of 768px.
LumoUtility.FlexDirection.Breakpoint.Small Classes that will be applied when the viewport has a minimum width of 640px.
LumoUtility.FlexDirection.Breakpoint.XLarge Classes that will be applied when the viewport has a minimum width of 1280px.
LumoUtility.FlexDirection.Breakpoint.XXLarge Classes that will be applied when the viewport has a minimum width of 1536px.
LumoUtility.FlexWrap Classes for setting how items wrap in a flexbox layout.
LumoUtility.FontSize Classes for setting the font size of an element.
LumoUtility.FontSize.Breakpoint Set of classes defining the font size of an element that will be applied only for certain viewport sizes.
LumoUtility.FontSize.Breakpoint.Large Classes that will be applied when the viewport has a minimum width of 1024px.
LumoUtility.FontSize.Breakpoint.Medium Classes that will be applied when the viewport has a minimum width of 768px.
LumoUtility.FontSize.Breakpoint.Small Classes that will be applied when the viewport has a minimum width of 640px.
LumoUtility.FontSize.Breakpoint.XLarge Classes that will be applied when the viewport has a minimum width of 1280px.
LumoUtility.FontSize.Breakpoint.XXLarge Classes that will be applied when the viewport has a minimum width of 1536px.
LumoUtility.FontWeight Classes for setting the font weight of an element.
LumoUtility.Gap Classes for defining the space between items in a flexbox or grid layout.
LumoUtility.Gap.Column Classes for defining the horizontal space between items in a flexbox or grid layout.
LumoUtility.Gap.Row Classes for defining the vertical space between items in a flexbox or grid layout.
LumoUtility.Grid Set of classes to define the content flow on a grid layout.
LumoUtility.Grid.Breakpoint Set of classes defining the number of columns in a grid layout that will be applied only for certain viewport sizes.
LumoUtility.Grid.Breakpoint.Large Classes that will be applied when the viewport has a minimum width of 1024px.
LumoUtility.Grid.Breakpoint.Medium Classes that will be applied when the viewport has a minimum width of 768px.
LumoUtility.Grid.Breakpoint.Small Classes that will be applied when the viewport has a minimum width of 640px.
LumoUtility.Grid.Breakpoint.XLarge Classes that will be applied when the viewport has a minimum width of 1280px.
LumoUtility.Grid.Breakpoint.XXLarge Classes that will be applied when the viewport has a minimum width of 1536px.
LumoUtility.Grid.Column Classes for setting the number of columns in a grid layout.
LumoUtility.Grid.Row Classes for setting the number of rows in a grid layout.
LumoUtility.Height Classes for defining the height of an element.
LumoUtility.IconSize Classes for defining the size of elements used as icons.
LumoUtility.JustifyContent Classes for aligning items along a flexbox?s main axis or a grid?s inline axis.
LumoUtility.LineHeight Classes for setting the line height of an element.
LumoUtility.ListStyleType Class for removing the default look of a list.
LumoUtility.Margin Classes for setting the margin of an element.
LumoUtility.Margin.Bottom Classes for setting the bottom margin of an element.
LumoUtility.Margin.End Classes for setting the logical inline end margin of an element.
LumoUtility.Margin.Horizontal Classes for setting both the left and the right margins an element.
LumoUtility.Margin.Left Classes for setting the left margin of an element.
LumoUtility.Margin.Right Classes for setting the right margin of an element.
LumoUtility.Margin.Start Classes for setting the logical inline start margin of an element.
LumoUtility.Margin.Top Classes for setting the top margin of an element.
LumoUtility.Margin.Vertical Classes for setting both the top and the bottom margins of an element.
LumoUtility.MaxHeight Classes for defining the maximum height of an element.
LumoUtility.MaxWidth Classes for defining the maximum width of an element.
LumoUtility.MinHeight Classes for defining the minimum height of an element.
LumoUtility.MinWidth Classes for defining the minimum width of an element.
LumoUtility.Overflow Classes for setting the overflow behavior of an element.
LumoUtility.Padding Classes for setting the padding of an element.
LumoUtility.Padding.Bottom Classes for setting the bottom padding of an element.
LumoUtility.Padding.End Classes for setting the logical inline end padding of an element.
LumoUtility.Padding.Horizontal Classes for setting both the right and left paddings of an element.
LumoUtility.Padding.Left Classes for setting the left padding of an element.
LumoUtility.Padding.Right Classes for setting the right padding of an element.
LumoUtility.Padding.Start Classes for setting the logical inline start padding of an element.
LumoUtility.Padding.Top Classes for defining the top padding of an element.
LumoUtility.Padding.Vertical Classes for defining both the vertical and horizontal paddings of an element.
LumoUtility.Position Classes for setting the position of an element.
LumoUtility.TextAlignment Classes for setting an element?s text alignment.
LumoUtility.TextColor Classes for setting an element?s text color.
LumoUtility.TextOverflow Classes for setting the text overflow.
LumoUtility.TextTransform Classes for transforming the text.
LumoUtility.Whitespace Classes for setting how the white space inside an element is handled.
LumoUtility.Width Classes for setting the width of an element.
Main Component representing a
<main>
element.Map Map is a component for displaying geographic maps from various sources.
MapBase Base class for the map component.
MapChangeEvent Event that is fired when the value in a collaboration map changes.
MapClickEvent Representing OpenLayers' @code{click} event
MapFeatureClickEvent Provides data for click events on geographic features
MapPutChange Change describing a changed value in a map feature.
MapRemoveChange Change describing a value removed from a map.
MapSerializer Custom JSON serializer for the map component using a Jackson
ObjectMapper
MapSubscriber Event handler that gets notified for changes to collaboration maps.
MapSyncRpcHandler Model map synchronization RPC handler.
MapVariant Set of theme variants applicable for the
vaadin-map
component.MapViewMoveEndEvent Fired when viewport movement has ended.
Marker In Highcharts 1.0, the appearance of all markers belonging to the hovered series.
MarkerFeature A convenience class for displaying icons or images, such as markers, at a specific location on the map.
MarkerStyle Marker style
MarkerSymbol Interface for all marker symbols
MarkerSymbolEnum A predefined shape or symbol for the marker.
MarkerSymbolUrl Symbol that is fetched from the url, implementing ChartEnum to provide correct serialization
Material Material component theme class implementation.
MembershipEvent The event dispatched when a node joins or leaves the backend.
MembershipEvent.MembershipEventType The type of the event.
MembershipListener A listener of
MembershipEvent
.MemoryBuffer Basic in memory file receiver implementation.
MenuBar Menu Bar is a horizontal button bar with hierarchical drop-down menus.
MenuBar.MenuBarI18n The internationalization properties for
MenuBar
MenuBarVariant Set of theme variants applicable for
vaadin-menu-bar
component.MenuItem Item component used inside
ContextMenu
andSubMenu
.MenuItemBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>> Base class for item component used inside
ContextMenu
s.MenuItemsArrayGenerator<I extends MenuItemBase<?,I,?>> A class which is utilized internally by components such as context menu and menu bar.
MenuManager<C extends Component,I extends MenuItemBase<?,I,S>,S extends SubMenuBase<?,I,S>> Common management logic for context menus and sub menus.
MessageDigestUtil Utility class for common
MessageDigest
operations.MessageHandler Functional interface that defines how to handle a message when it is added to a topic.
MessageHandler.MessageContext The context of the message.
MessageInput Message Input allows users to author and send messages.
MessageInput.SubmitEvent The
submit
event which is fired byMessageInput
component.MessageInputI18n The internationalization properties for
MessageInput
.MessageList Message List allows you to show a list of messages, for example, a chat log.
MessageListItem Item to render as a message component inside a
MessageList
.MessageManager Manager to handle messages sent to a topic.
Meta 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 Internal annotation to enable use of multiple
Meta
annotations.MetadataWriter Serializes miscellaneous metadata to JSON.
ModelDescriptor<T extends TemplateModel> Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.ModelEncoder<D,E extends Serializable> Deprecated. This functionality is bound to template model which is not supported for lit template.ModelItem Deprecated. There is no any replacement in Lit template since template model is not supported for lit template, but you may still use@EventData("some_data")
to receive data from the client side or@Id
mapping and the component API or the element API with property synchronization instead.ModelList List for model values used in data binding in templates.
ModelType Deprecated. Template model and model types are not supported for lit template, but you can use@Id
mapping and the component API or the element API with property synchronization instead.MouseEventDetails Helper class to store and transfer mouse event details.
MouseEventDetails Helper class to store and transfer mouse event details.
MouseEventDetails.MouseButton Constants for mouse buttons.
MouseEventDetails.MouseButton Constants for mouse buttons.
MultiFileBuffer Basic receiver implementation for receiving multiple file upload and storing them as files.
MultiFileMemoryBuffer Basic multi file in memory file receiver implementation.
MultiFileReceiver Interface that must be implemented by the upload receivers to provide the Upload component an output stream to write the uploaded data.
MultiSelect<C extends Component,T> Multi selection component which allows to select and deselect multiple items.
MultiSelectComboBox<TItem> MultiSelectComboBox allows the user to select one or more values from a filterable list of options presented in an overlay.
MultiSelectComboBox.AutoExpandMode Defines possible behavior of the component when not all selected items can be displayed as chips within the current field width.
MultiSelectComboBoxI18n Class for localization of the
MultiSelectComboBox
MultiSelectComboBoxVariant Set of theme variants applicable for
vaadin-multi-select-combo-box
component.MultiSelectionEvent<C extends Component,T> Fired when the selection changes in a listing component that supports multiple item selection.
MultiSelectionListener<C extends Component,T> A listener for listening for selection changes from a multiselection component.
MultiSelectListBox<T> Server-side component for the
vaadin-list-box
element with multi-selection.NativeButton Component representing a
<button>
element.NativeButtonRenderer<SOURCE> A template renderer to create a clickable button.
NativeDetails Component representing a
<details>
element.NativeDetails.Summary Component representing a
<summary>
element.NativeDetails.ToggleEvent Represents the DOM event "toggle".
Nav Component representing a
<nav>
element.Navigation A collection of options for buttons and menus appearing in the exporting module.
NavigationEvent Event object with data related to navigation.
NavigationHandler Handles navigation to a location e.g.
NavigationRouteTarget Contains the information resulted from searching a route target using a navigation url as input.
NavigationRpcHandler RPC handler for Navigation.
NavigationState Contains all relevant information related to a valid navigation.
NavigationStateBuilder A builder class for constructing new
NavigationState
instances.NavigationStateRenderer Handles navigation events by rendering a contained NavigationState in the target UI.
NavigationTargetFilter A filter that can prevent specific navigation targets from being registered.
NavigationTrigger The type of user action that triggered navigation.
Navigator The navigator is a small series below the main series, displaying a view of the entire data set.
NewUserHandler Deprecated. UsePresenceHandler
insteadNoData Options for displaying a message like "No data to display".
Node A collection of options for the individual nodes.
Node<N extends Node<N>> Represents a node in the DOM.
NodeAttachChange Change describing that a node has been attached.
NodeChange Base class describing a change to a state node.
NodeDetachChange Change describing that a node has been detached.
NodeFeature A node feature represents a group of related values and functionality in a state node.
NodeFeatureChange Base class for all node changes related to a feature.
NodeFeatureRegistry A registry of node features that are available based on type.
NodeFeatures Registry of node feature id numbers and map keys shared between server and client.
NodeInstaller Node installation class.
NodeLayout NodeList<T extends Serializable> A state node feature that structures data as a list.
NodeList.SetView<T extends Serializable> NodeMap A state node feature that structures data as a map.
NodeOwner Abstract root of a state node tree.
NodeProperties Various node properties' ids.
NodeSeries A series containing nodes and links to nodes.
NodeSeriesItem Data for the
NodeSeries
.NodeTasks An executor that it's run when the servlet context is initialised in dev-mode or when flow-maven-plugin goals are run.
NodeUpdater Base abstract class for frontend updaters that needs to be run when in dev-mode or from the flow maven plugin.
NodeValue<T extends Serializable> A node feature that carries a single value.
NodeVisitor Element API node visitor interface.
NodeVisitor.ElementType The type of the element.
NoInputStreamEvent FailedEvent that indicates that an input stream could not be obtained.
NoInputStreamException Exception for when there is no
InputStream
available.NoOutputStreamEvent FailedEvent that indicates that an output stream could not be obtained.
NoOutputStreamException Exception for when there is no
OutputStream
available.NotFoundException Exception indicating that something went wrong while resolving navigation routes.
NoTheme A marker annotation to avoid applying any default theme to the application.
Notification Notifications are used to provide feedback to the user.
Notification.OpenedChangeEvent<T extends GeneratedVaadinNotification<T>> Notification.Position Enumeration of all available positions for notification component
NotificationVariant Set of theme variants applicable for
vaadin-notification
component.NotSupported Methods annotated with
NotSupported
are mapped to the original webcomponent implementation, but not supported at Java level.NpmPackage Annotation for defining an npm package dependency on a
Component
class which includes one or more JS modules.NpmPackage.Container Internal annotation to enable use of multiple
NpmPackage
annotations.NpmTemplateParser Deprecated. UseLitTemplateParserImpl
class forLitTemplate
components.NullOwner A stateless singleton node owner that is used for nodes that have not yet been attached to a state tree.
NumberField Number Field sports many of the same features as Text Field but only accepts numeric input.
NumberRenderer<SOURCE> A template renderer for presenting number values.
OhlcItem A DataSeriesItem implementation suitable for OHLC charts.
OhlcOptions OneTimeInitializerPredicate The presence of the service implementing this interface with
OneTimeInitializerPredicate.runOnce()
returningtrue
means thatServletContainerInitializer
s are executed only once and the implementation doesn't have to care about cleaning up data collected based on previous call.Open OptionalParameter Marks a Navigation url parameter as optional.
Options Build a
NodeExecutor
instance.Options Options3d Options to render charts in 3 dimensions.
OrderedList Component representing a
<ol>
element.OrderedList.NumberingType Defines the numbering type of the list items.
OSMSource Map source for loading tiled images from an OpenStreetMap service.
OSMSource.Options OSUtils Page Represents the web page open in the browser, containing the UI it is connected to.
Page.ExecutionCanceler Deprecated. superseded byPendingJavaScriptResult
Page.ExtendedClientDetailsReceiver Callback for receiving extended client-side details.
PageConfigurator Deprecated. since 3.0 useAppShellConfigurator
PagelessDataCommunicator<T> DataCommunicator implementation which disables the paging and does not allow the user to set up the page for IronList.
PagelessDataCommunicator<T> DataCommunicator implementation which disables the paging and does not allow the user to set up the page for VirtualList.
PageTitle Defines the HTML page title for a navigation target.
Pair<U extends Serializable,V extends Serializable> Generic class representing an immutable pair of values.
Pane Applies only to polar charts and angular gauges.
PaneList Pane Container to allow multiple Panes
PaneListSerializer Serializer for
PaneList
PanKey Allows setting a key to switch between zooming and panning.
Paragraph Component representing a
<p>
element.Param Component representing a
<param>
element for<param>
element.ParameterDeserializer Parameter deserialization utility.
ParentLayout Defines the parent layout for components in routing hierarchy.
ParserData Immutable parser data which may be stored in cache.
PartialFill PartialFill configuration object to be used in
PlotOptionsXrange
.PasswordField Password Field is an input field for entering passwords.
PathLookup<T> Deprecated. This functionality is internal and bound to template model which is not supported for lit template.PathUtil Utility class which contains various methods for parsing a route url into segments.
PendingJavaScriptInvocation A pending JavaScript result that can be sent to the client.
PendingJavaScriptResult A pending result from a JavaScript snippet sent to the browser for evaluation.
PendingJavaScriptResult.JavaScriptException Exception used when a
CompletableFuture
returned fromPendingJavaScriptResult
is completed exceptionally because of a client-side error.Pivot Options for the pivot or the center point of the gauge.
Platform Platform contains information about system architecture and OS.
Platform Provides information about the current version of Vaadin Platform.
PlotBand An array of objects defining plot bands on the Y axis.
PlotLine An array of lines stretching across the plot area, marking a specific value on one of the axes.
PlotOptionsArea PlotOptionsArearange The area range is a cartesian series type with higher and lower Y values along an X axis.
PlotOptionsAreaspline PlotOptionsAreasplinerange The area spline range is a cartesian series type with higher and lower Y values along an X axis.
PlotOptionsBar PlotOptionsBoxplot A box plot is a convenient way of depicting groups of data through their five-number summaries: the smallest observation (sample minimum), lower quartile (Q1), median (Q2), upper quartile (Q3), and largest observation (sample maximum).
PlotOptionsBubble A bubble series is a three dimensional series type where each point renders an X, Y and Z value.
PlotOptionsBullet Plot options for
ChartType.BULLET
charts.PlotOptionsCandlestick PlotOptionsColumn PlotOptionsColumnrange The column range is a cartesian series type with higher and lower Y values along an X axis.
PlotOptionsErrorbar Error bars are a graphical representation of the variability of data and are used on graphs to indicate the error, or uncertainty in a reported measurement.
PlotOptionsFlags PlotOptionsFunnel Funnel charts are a type of chart often used to visualize stages in a sales project, where the top are the initial stages with the most clients.
PlotOptionsGauge General plotting options for the gauge series type.
PlotOptionsHeatmap The heatmap series type.
PlotOptionsLine PlotOptionsOhlc PlotOptionsOrganization Plot options for
ChartType.ORGANIZATION
charts.PlotOptionsPie A pie chart is a circular chart divided into sectors, illustrating numerical proportion.
PlotOptionsPolygon A polygon series can be used to draw any freeform shape in the cartesian coordinate system.
PlotOptionsPyramid A pyramid chart consists of a single pyramid with item heights corresponding to each point value.
PlotOptionsScatter PlotOptionsSeries General options for all series types.
PlotOptionsSolidgauge A gauge showing values using a filled arc with colors indicating the value.
PlotOptionsSpline PlotOptionsStyle Styles for PlotOptions of different plot types
PlotOptionsTimeline Plot options for
ChartType.TIMELINE
charts.PlotOptionsTreemap The size of the point shape is determined by its value relative to its siblings values.
PlotOptionsWaterfall Options for the waterfall series type.
PlotOptionsXrange Options for the xrange series type.
Point Geometry that is represented by a single point and coordinate.
PointBasedFeature Abstract base class for features that are represented by a single point and a single coordinate.
PointClickEvent The PointClickEvent class stores data for click events on the points of the chart.
PointLegendItemClickEvent The PointLegendItemClickEvent class stores information on click events on the charts's legend items that correspond to a chart point.
PointMouseOutEvent Fired when the mouse exits the neighborhood of a point
PointMouseOverEvent Fired when the mouse pointer moves within the neighborhood of a point
PointOptions PointPlacement Possible values: null, ON, BETWEEN.
PointRemoveEvent The PointRemoveEvent class stores data for remove events on the points of the chart
PointSelectEvent The PointSelectEvent class stores data for select events on the points of the chart.
PointUnselectEvent The PointUnselectEvent class stores data for unselect events on the points of the chart.
PointUpdateEvent The PointUpdateEvent class stores data for update events on the points of the chart
PollConfigurationMap A node map for storing configuration for polling.
PollEvent An event that is fired whenever a client polls the server for asynchronous UI updates.
PollNotifier The interface for adding and removing
PollEvent
listeners.PolymerEventListenerMap Map of PolymerTemplate events with server-side listeners.
PolymerPublishedEventRpcHandler Polymer utilitiy class for handling polymer rpc events for @EventHandler.
PolymerServerEventHandlers Deprecated. Polymer template support is deprecated - we recommend you to useLitTemplate
instead.PolymerTemplate<M extends TemplateModel> Deprecated. Polymer template support is deprecated - we recommend you to useLitTemplate
instead.Position Position configuration for the credits label.
Postpone Container class for containing left over listeners on postponed navigation.
Pre Component representing a
<pre>
element.PresenceHandler Functional interface that defines how to handle user presence changes in a topic.
PresenceHandler.PresenceContext The context of the user presence.
PresenceManager Manager to handle user presence in topics.
PreserveOnRefresh Indicates that a previous view instance should be-reused when reloading a location in the same browser window/tab.
ProgressBar Progress Bar shows the completion status of a task or process.
ProgressBarVariant Set of theme variants applicable for
vaadin-progress-bar
component.ProgressListener ProgressListener receives events to track progress of upload.
ProgressUpdateEvent ProgressUpdateEvent is sent to track progress of upload.
Projection Defines constants for map coordinate projections.
PropertyChangeDeniedException The exception is thrown when a property change from client is disallowed on the server side.
PropertyChangeEvent An event fired when the value of a property changes.
PropertyChangeHandler Functional interface that defines how to handle value changes for properties in a topic.
PropertyChangeHandler.PropertyChangeEvent The property change event.
PropertyChangeListener A listener for property change events.
PropertyConfiguration<C extends Component,P extends Serializable> Offers a fluent API for configuring the properties of embedded web components produced by
WebComponentExporter
.PropertyConfigurationImpl<C extends Component,P extends Serializable> For internal use only.
PropertyData<P extends Serializable> Value object containing information of a web component's property field.
PropertyDefinition<T,V> A property from a
PropertySet
.PropertyDeploymentConfiguration The property handling implementation of
DeploymentConfiguration
based on a base class for resolving system properties and a set of init parameters.PropertyDescriptor<S,G> Describes a component property that has its value stored in some form in the component's element, typically an element property or attribute.
PropertyDescriptors Factory methods for creating
PropertyDescriptor
instances.PropertyFilter Deprecated. This functionality is internal and bound to template model which is not supported for lit template.PropertyFilterDefinition Contains the constraints for filtering nested properties.
PropertyId Defines the custom property name to be bound to a
field component
usingBinder
.PropertySet<T> Describes a set of properties that can be used for configuration based on property names instead of setter and getter callbacks.
ProxyConfig Proxy configuration used for downloads and executions.
ProxyConfig.Proxy Class for holding proxy information.
PublishedServerEventHandlerRpcHandler RPC handler for events triggered through
element.$server
or simply$server
in template event handlers.Push Configures automatic server push.
PushAtmosphereHandler Handles Atmosphere requests and forwards them to logical methods in
PushHandler
.PushConfiguration Provides method for configuring the push channel.
PushConfigurationMap Map for storing the push configuration for a UI.
PushConfigurationMap.PushConfigurationParametersMap Map for storing push parameters.
PushConnection Represents a bidirectional ("push") connection between a single UI and its client-side.
PushConnectionFactory Factory that produces instances of
PushConnection
.PushConstants Shared constants used by push.
PushHandler Handles incoming push connections and messages and dispatches them to the correct
UI
/AtmospherePushConnection
.PushMode The mode of bidirectional ("push") communication that is in use.
PushRequestHandler Handles requests to open a push (bidirectional) communication channel between the client and the server.
PWA Defines application PWA properties.
PwaConfiguration Holds the configuration from the
PWA
annotation.PwaHandler Handles serving of PWA resources.
PwaIcon Implementation of icons used in PWA resources.
PwaIcon.Domain Place where icon belongs to (header or manifest.webmanifest).
PwaRegistry Registry for PWA data.
PyramidOptions Query<T,F> Immutable query object used to request data from a backend.
QueryParameters Holds query parameters information.
QuerySortOrder Sorting information for
Query
.QuerySortOrderBuilder Helper classes with fluent API for constructing
QuerySortOrder
lists.RadioButtonGroup<T> Radio Button Group allows the user to select exactly one value from a list of related but mutually exclusive options.
RadioButtonGroupDataView<T> Implementation of generic data view for RadioButtonGroup.
RadioButtonGroupListDataView<T> Data view implementation for RadioButtonGroup with in-memory list data.
RadioGroupVariant Set of theme variants applicable for
vaadin-radio-group
component.Range An immutable representation of a range, marked by start and end points.
RangeSelector The range selector is a tool for selecting ranges to display within the chart.
RangeSelectorButton Options for range selector buttons.
RangeSelectorTimespan Possible timespan values for range selector buttons
RangeSeries Series for range type data
RangeValidator<T> Verifies that a value is within the given range.
ReadOnlyHasValue<V> Generic
HasValue
to use any type of component with Vaadin data binding.Receiver Interface that must be implemented by the upload receivers to provide the Upload component an output stream to write the uploaded data.
ReconnectDialogConfiguration Provides methods for configuring the reconnect dialog.
ReconnectDialogConfigurationMap Map for storing the reconnect dialog configuration for a UI.
ReflectionCache<C,T> A thread-safe cache for the result of doing some reflection lookup based on a class.
ReflectTools An util class with helpers for reflection operations.
RegexpValidator A string validator comparing the string against a Java regular expression.
Registration A registration object for removing an event listener added to a source.
Renderer<SOURCE> Base class for all renderers - classes that take a given model object as input and outputs a set of elements that represents that item in the UI.
RendererUtil Contains helper methods to register events triggered by rendered templates.
Rendering<SOURCE> Defines the context of a given
Renderer
when building the output elements.RepeatIndex Deprecated. dom-repeat is not support by Lit templates but you may still use@EventData("some_data")
directly to receive data from the client side.RequestHandler Handler for producing a response to HTTP requests.
RequiredFieldConfigurator This interface represents a predicate which returns
true
if bound field should be configured to have required indicator viaHasValue.setRequiredIndicatorVisible(boolean)
.RequiredFieldConfiguratorUtil Helper methods used by
RequiredFieldConfigurator
.ResetZoomButton The button that appears after a selection zoom, allowing the user to reset zoom.
ResetZoomButtonRelativeTo What frame the button should be placed related to.
ResolveRequest An object used to encapsulate data used in resolving routing requests.
ResourceProvider Static "classpath" resources provider.
ResponseWriter The class that handles writing the response data into the response.
Responsive Allows setting a set of rules to apply for different screen or chart sizes.
Result<R> Represents the result of an operation that might fail, such as type conversion.
ReturnChannelHandler RPC handler for return channel messages.
ReturnChannelMap Server-side node feature that keeps track of the return channels registered for a state node.
ReturnChannelRegistration A registration for a return channel.
RichTextEditor Rich Text Editor is an input field for entering rich text.
RichTextEditor.RichTextEditorI18n The internationalization properties for
RichTextEditor
.RichTextEditorVariant Set of theme variants applicable for
vaadin-rich-text-editor
component.Route Defines the route template suffix for components that function as navigation targets in routing.
RouteAlias Defines the route alias for components that function as navigation targets in routing.
RouteAlias.Container Internal annotation to enable use of multiple
RouteAlias
annotations.RouteAliasData Route data for an 'alias' route.
RouteBaseData<T extends RouteBaseData> Abstract base class for route and route alias data.
RouteConfiguration Route configuration helper class for adding, removing and reading routes from the different registries.
RouteData Data collection of information for a specific registered route target.
RouteNotFoundError This is a basic default error view shown on routing exceptions.
RouteParam Route parameter containing the name and the value used mainly when constructing a
RouteParameters
instance.RouteParameterData Immutable data representing one url parameter.
RouteParameterFormatOption Define the route parameters format flags.
RouteParameterRegex Predefined regex used with template parameters.
RouteParameters Immutable container which stores the route parameters extracted from a navigation url received from the client.
RoutePathProvider Allows to implement a custom navigation target path generation logic for components annotated with
@Route(Route.NAMING_CONVENTION)
.RoutePrefix Defines the route prefix that a Parent layout adds to a route when used in the active view chain.
Router The router takes care of serving content when the user navigates within a site or an application.
RouteRegistry The RouteRegistry interface class that gives the out facing usage needs for a route registry implementation.
RouteRegistryInitializer Servlet initializer for collecting all available
Route
s on startup.RouteResolver Callback interface for resolving
ResolveRequest
s to newNavigationState
s.RouterLayout Implementations of this interface represent a parent for a navigation target components via the
Route.layout()
parameter.RouterLink A link that handles navigation internally using
Router
instead of loading a new page in the browser.RoutesChangedEvent Result class containing the removed and added routes for the latest configuration.
RoutesChangedListener Listener that gets notified when the registered routes for a
RouteRegistry
are changed in some way.RouteTarget Route target stores the target component and parent layouts.
RouteUtil Utility class with methods for route handling.
Row Row class to define rows used in a
Board
instance.RpcDecodeException Thrown if RPC method argument cannot be decoded to the required type.
RpcDecoder Decoder of RPC method arguments (server-side methods invoked from the client-side).
RpcInvocationHandler RPC invocation handler interface.
Rules A set of rules for responsive settings.
Scrollbar An optional scrollbar to display on the Y axis in response to limiting the minimum an maximum of the axis values.
Scroller Scroller is a component container which enables scrolling overflowing content.
Scroller.ScrollDirection Enum for the values of the ScrollDirection property.
Section Component representing a
<section>
element.Select The appearance of the point marker when selected.
Select<T> Select allows users to choose a single value from a list of options presented in an overlay.
SelectDataView<T> Implementation of generic data view for
Select
.SelectionEvent<C extends Component,T> A selection event that unifies the way to access to selection event for multi selection and single selection components (in case when only one selected item is required).
SelectionListener<C extends Component,T> A listener for
SelectionEvent
.SelectionModel<C extends Component,T> Models the selection logic of a
Listing
component.SelectionModel.Multi<C extends Component,T> A selection model in which multiple items can be selected at the same time.
SelectionModel.Single<C extends Component,T> A selection model in which at most one item can be selected at a time.
SelectListDataView<T> Data view implementation for
Select
with in-memory list data.SelectVariant Set of theme variants applicable for
vaadin-select
component.SerializableBiConsumer<T,U> A
BiConsumer
that is alsoSerializable
.SerializableBiFunction<T,U,R> A
BiFunction
that is alsoSerializable
.SerializableBiPredicate<T,U> A
BiPredicate
that is alsoSerializable
.SerializableComparator<T> A
Comparator
that is alsoSerializable
.SerializableConsumer<T> A
Consumer
that is alsoSerializable
.SerializableEventListener Event listener interface that is serializable.
SerializableFunction<T,R> A
Function
that is alsoSerializable
.SerializableNodeList<T extends Serializable> A list which contains
Serializable
values but notStateNode
s.SerializablePredicate<T> A
Predicate
that is alsoSerializable
.SerializableRunnable A
Runnable
that is alsoSerializable
.SerializableSupplier<T> A
Supplier
that is alsoSerializable
.SerializableTriConsumer<T,U,V> Like
SerializableBiConsumer
, but with three arguments.Series Series interface for all kinds of Series
SeriesAddedEvent Event for information about a new series to be added
SeriesAfterAnimateEvent Fired after a chart series is animated
SeriesChangedEvent Event for information about changes in data of series
SeriesCheckboxClickEvent SeriesCheckboxClickEvent triggered when a checkbox in a legend is clicked
SeriesClickEvent The SeriesClickEvent class stores data for click events on the series of the chart.
SeriesHideEvent Fired when a series is hidden
SeriesLegendItemClickEvent The SeriesLegendItemClickEvent class stores information on click events on the charts's legend items that correspond to a chart series.
SeriesMouseOutEvent Fired when the mouse exits the neighborhood of a series
SeriesMouseOverEvent Fired when the mouse moves within the neighborhood of a series
SeriesShowEvent Fired when a series is shown
SeriesStateEvent Listener class for Series enabling and disabling events.
SeriesTooltip A configuration object for the tooltip rendering of each single series.
ServerInfo Data for a info message to the debug window.
ServerRpcHandler Handles a client-to-server message containing serialized RPC invocations.
ServerRpcHandler.InvalidUIDLSecurityKeyException Exception thrown then the security key sent by the client does not match the expected one.
ServerRpcHandler.ResynchronizationRequiredException Exception thrown then the client side resynchronization is required.
ServerRpcHandler.RpcRequest A data transfer object representing an RPC request sent by the client side.
ServerSideFeature Abstract node feature that is only present on the server.
ServiceContextUriResolver A URI resolver which resolves paths for loading through VaadinService resource methods.
ServiceDestroyEvent Event fired to
ServiceDestroyListener
when aVaadinService
is being destroyed.ServiceDestroyListener Listener that gets notified when the
VaadinService
to which it has been registered is destroyed.ServiceException Thrown for problems which occur in the
VaadinService
layer.ServiceInitEvent Event fired to
VaadinServiceInitListener
when aVaadinService
is being initialized.ServletContextListeners All ServletContextListeners in Flow merged into one actual listener to be able to control the order they are executed in.
ServletDeployer Context listener that automatically registers Vaadin servlets.
ServletVerifier Verify the servlet version on container initialization.
SessionDestroyEvent Event fired when a Vaadin service session is no longer in use.
SessionDestroyListener A listener that gets notified when a Vaadin service session is no longer used.
SessionExpiredException Exception indicating that the session has expired.
SessionExpiredHandler A specialized RequestHandler which is capable of sending session expiration messages to the user.
SessionInitEvent Event gets fired when a new Vaadin service session is initialized for a Vaadin service.
SessionInitListener 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 Handles a request by passing it to each registered
RequestHandler
in the session in turn until one produces a response.SessionRouteRegistry SessionRouteRegistry is a mutable route registry that is valid in the scope of VaadinSession.
Setter<BEAN,FIELDVALUE> The function to write the field value to the bean property
ShadowRoot Represents a shadow dom root of an element.
ShadowRootData Map of basic element information.
ShadowRootHost Marker feature for a
StateNode
which is a shadow root for some element.ShadowRootStateProvider Implementation which handles shadow root nodes.
Shape The name of a symbol to use for the border around the
Datalabels
orTooltip
.SharedUtil Misc internal utility methods used by both the server and the client package.
ShortcutEvent Event when shortcut is detected.
ShortcutEventListener Listener for shortcut events.
ShortcutRegistration A registration object for both configuring and removing the registered keyboard shortcut.
Shortcuts Collections of methods for configuring more complex Shortcut interactions.
ShortRangeValidator Validator for validating that an
Short
is inside a given range.Side Note: As of v5.0.12,
frame.left
orframe.right
should be used instead.SimpleGeometry Abstract base class for geometries
SingleSelect<C extends Component,T> Single selection component whose selection is treated as a value.
SingleSelectionEvent<C extends Component,T> Fired when the selection changes in a listing component.
SingleSelectionListener<C extends Component,T> A listener for listening to selection changes on a single selection component.
SlotUtils Util methods for handling child elements inside slots.
SolidColor Solid (non gradient) colors
SolidColorSerializer Serializer for
SolidColor
SortDirection Describes sorting direction.
SortEvent<T extends Component,S extends SortOrder<?>> Event describing a change in sorting of a
DataProvider
.SortEvent.SortNotifier<T extends Component,S extends SortOrder<?>> The interface for adding and removing listeners for
SortEvents
.SortOrder<T> Sorting information for one field.
SortOrderBuilder<T extends SortOrder<V>,V> Base class for helper classes with fluent API for constructing sort order lists.
SortOrderProvider Generates the sort orders when rows are sorted by a column.
Source Abstract base class for all map sources
Source.Options Span Component representing a
<span>
element.SplitLayout Split Layout is a component with two content areas and a draggable split handle between them.
SplitLayout.Orientation numeration of all available orientation for VaadinSplitLayout component
SplitLayout.SplitterDragendEvent<T extends GeneratedVaadinSplitLayout<T>> SplitLayoutVariant Set of theme variants applicable for
vaadin-split-layout
component.SpringCsrfToken A pojo for Spring CSRF token.
SpringCsrfTokenUtil A util class for helping dealing with Spring CSRF token.
Stacking Whether to stack the values of each series on top of each other.
StackLabels The stack labels show the total value for each bar in a stacked column or bar chart.
StartedEvent StartedEvent event is sent when the upload is started to received.
StateNode A node in the state tree that is synchronized with the client-side.
StateNodeNodeList A list which contains
StateNode
s.States StateTree The state tree that is synchronized with the client-side.
StateTree.BeforeClientResponseEntry A task to be executed before the client response, together with an execution sequence number and context object.
StateTree.ExecutionRegistration A registration object for removing a task registered for execution before the client response.
StaticFileHandler Handler for static files.
StaticFileHandlerFactory A factory to create a
StaticFileHandler
.StaticFileServer Handles sending of resources from the WAR root (web content) or META-INF/resources in the case that
VaadinServlet
is mapped using "/*".StatisticsConstants Constants for development mode statistics.
StatisticsContainer Wraps a JSON data structure and provides a slightly easier API for it.
StatisticsSender Handles sending of telemetry data.
StatisticsStorage Development more usage statistic storage and methods for updating the data.
StatusChangeEvent Binder status change event.
StatusChangeListener Listener interface for status change events from binder.
StepsUtil Utility class around the time picker steps functionality.
StepType Defines different step line types.
Stop StopSerializer Serializer for
Stop
.StreamingEndEventImpl Implementation of
StreamVariable.StreamingEndEvent
.StreamingErrorEventImpl Implementation for
StreamVariable.StreamingErrorEvent
.StreamingProgressEventImpl Implementation for
StreamVariable.StreamingProgressEvent
.StreamingStartEventImpl Implementation for
StreamVariable.StreamingStartEvent
.StreamReceiver Represents a receiver for data upload from the client.
StreamReceiverHandler Handles
StreamReceiver
instances registered inVaadinSession
.StreamReceiverHandler.UploadInterruptedException An UploadInterruptedException will be thrown by an ongoing upload if
StreamVariable.isInterrupted()
returnstrue
.StreamRegistration Stream registration result.
StreamRequestHandler Handles
StreamResource
andStreamReceiver
instances registered inVaadinSession
.StreamResource Represents dynamically generated data.
StreamResourceHandler Handles
StreamResource
instances registered inVaadinSession
.StreamResourceRegistry Registry for
StreamResource
instances.StreamResourceWriter Output stream consumer.
StreamVariable StreamVariable is a special kind of variable whose value is streamed to an
OutputStream
provided by theStreamVariable.getOutputStream()
method.StreamVariable.StreamingEndEvent Event passed to
StreamVariable.streamingFinished(StreamingEndEvent)
method the contents have been streamed to StreamVariable successfully.StreamVariable.StreamingErrorEvent Event passed to
StreamVariable.streamingFailed(StreamingErrorEvent)
method when the streaming ended before the end of the input.StreamVariable.StreamingEvent Streaming event interface.
StreamVariable.StreamingProgressEvent Event passed to
StreamVariable.onProgress(StreamingProgressEvent)
method during the streaming progresses.StreamVariable.StreamingStartEvent Event passed to
StreamVariable.streamingStarted(StreamingStartEvent)
method before the streaming of the content toStreamVariable
starts.StringLengthValidator Verifies that the length of a string is within the given range.
StringToBigDecimalConverter A converter that converts from
String
toBigDecimal
and back.StringToBigIntegerConverter A converter that converts from
String
toBigInteger
and back.StringToBooleanConverter StringToDateConverter StringToDoubleConverter StringToEnumDecoder Decodes a
JsonValue
withJsonType.STRING
type toEnum
subclass type.StringToFloatConverter StringToIntegerConverter StringToLongConverter StringToNumberDecoder Decodes a
JsonValue
withJsonType.STRING
type toNumber
subclass type.StringToUuidConverter StringUtil Utility class for special string handling.
Stroke Style Style options for CSS styling
Style Defines how to visually represent a
Feature
Style Provides inline styles for
Element
s.StyleAttributeHandler Emulates the
style
attribute by delegating toElement.getStyle()
.StylePosition CSS position attribute, ABSOLUTE or RELATIVE
StyleSheet Defines style sheet dependencies on a
Component
class.StyleSheet.Container Internal annotation to enable use of multiple
StyleSheet
annotations.StyleUtil Utility methods for
Style
.StyleWrapper Helper class when JSON structure needs object with just style field
SubMenu API that allows adding content into the sub menus of a
ContextMenu
to create hierarchical menus.SubMenuBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>> Base class for sub-menus in
ContextMenuBase
extensions.Subtitle The chart's subtitle
SucceededEvent SucceededEvent event is sent when the upload is received successfully.
Synchronize Annotates getters for which properties should be synchronized to the server.
SynchronizedRequestHandler RequestHandler which takes care of locking and unlocking of the VaadinSession automatically.
SystemConnectionContext A connection context that is always active.
SystemMessages Contains the system messages used to notify the user about various critical situations that can occur.
SystemMessagesInfo Provides information available for
SystemMessagesProvider
when defining whatSystemMessages
to use.SystemMessagesProvider Gives out system messages based on Locale.
SystemUserInfo A
UserInfo
for non-interaction thread.Tab This component provides an accessible and customizable tab to be used inside
Tabs
component.Tabs Tabs are used to organize and group content into sections that the user can navigate between.
Tabs.Orientation The valid orientations of
Tabs
instances.Tabs.SelectedChangeEvent An event to mark that the selected tab has changed.
TabSheet TabSheet consists of a set of tabs and the content area.
TabSheet.SelectedChangeEvent An event to mark that the selected tab has changed.
TabSheetVariant Set of theme variants applicable for
vaadin-tabsheet
component.TabsVariant Set of theme variants applicable for
vaadin-tabs
component.TabVariant Set of theme variants applicable for
vaadin-tab
component.Tag Defines the tag to use for the root element for a component created using the default
Component
constructor.TargetElement Page target element enum for inlining during bootstrap creation.
TargetOptions Set options related with look and position of targets.
TaskCopyFrontendFiles Copies JavaScript and CSS files from JAR files into a given folder.
TaskCopyLocalFrontendFiles Copies JavaScript files from the given local frontend folder.
TaskCopyTemplateFiles Copies template files to the target folder so as to be available for parsing at runtime in production mode.
TaskGenerateBootstrap A task for generating the bootstrap file
FrontendUtils.BOOTSTRAP_FILE_NAME
during `package` Maven goal.TaskGenerateEndpoint Generate the TS files for endpoints, and the Client API file.
TaskGenerateFeatureFlags A task for generating the feature flags file
FrontendUtils.FEATURE_FLAGS_FILE_NAME
during `package` Maven goal.TaskGenerateHilla Generate the Vaadin TS files for endpoints, and the Client API file.
TaskGenerateIndexHtml Generate
index.html
if it is missing in frontend folder.TaskGenerateIndexTs Generate
index.js
if it is missing in frontend folder.TaskGenerateOpenAPI Generate OpenAPI json file for Vaadin Endpoints.
TaskGeneratePackageJson Creates the
package.json
if missing.TaskGenerateServiceWorker Generate
index.html
if it is missing in frontend folder.TaskGenerateTsConfig Generate
tsconfig.json
if it is missing in project folder.TaskGenerateTsDefinitions Generate
types.d.ts
if it is missing in project folder andtsconfig.json
exists in project folder.TaskGenerateViteDevMode Generate
vite-devmode.ts
if it is missing in frontend/generated folder.TaskGenerateWebComponentBootstrap A task for generating the bootstrap file for exported web components
FrontendUtils.WEB_COMPONENT_BOOTSTRAP_FILE_NAME
during `package` Maven goal.TaskGenerateWebComponentHtml Generate
web-component.html
if it is missing in frontend folder.TaskInstallWebpackPlugins Task that installs any Flow webpack plugins into node_modules/@vaadin for use with webpack compilation.
TaskNotifyWebpackConfExistenceWhileUsingVite Notifies the user about the existence of webpack.config.js while the project is running Vite as the frontend build tool.
TaskRunNpmInstall Run
npm install
after dependencies have been updated.TaskRunNpmInstall.Stats Container for npm installation statistics.
TaskUpdateImports An updater that it's run when the servlet context is initialised in dev-mode or when flow-maven-plugin goals are run in order to update Flow imports file and "jar-resources" contents by visiting all classes with
JsModule
andTheme
annotations.TaskUpdatePackages Updates
package.json
by visitingNpmPackage
annotations found in the classpath.TaskUpdateSettingsFile Creates a vaadin-dev-server-settings.json file for use with dev server configuration.
TaskUpdateThemeImport Task generating the theme definition file 'theme.js' for importing application theme into the generated frontend directory.
TaskUpdateVite Updates the Vite configuration files according with current project settings.
TaskUpdateWebpack Updates the webpack config file according with current project settings.
TempDirectory Template Marker interface for (Lit and Polymer) templates.
TemplateDataAnalyzer Deprecated. UseLitTemplateDataAnalyzer
forLitTemplate
components.TemplateDataAnalyzer.InjectableFieldCunsumer Three argument consumer.
TemplateDataAnalyzer.PolymerParserData Deprecated. TemplateInitializer Deprecated. UseLitTemplateInitializer
forLitTemplate
components.TemplateModel Deprecated. Template model and polymer template support is deprecated - we recommend you to useLitTemplate
instead.TemplateModelListProxy<T> Deprecated. This functionality is internal and bound to template model which is not supported for lit template.TemplateModelProxyHandler Deprecated. This functionality is internal and bound to template model which is not supported for lit template.TemplateModelProxyHandler.InterfaceProxy Base type used for interface proxy types.
TemplateModelProxyHandler.ModelProxy Gives access to the state node of a proxy instance.
TemplateModelUtil Deprecated. This functionality is internal and bound to template model which is not supported for lit template.TemplateParser Deprecated. UseLitTemplateParser
forLitTemplate
components.TemplateParser.TemplateData Deprecated. UseLitTemplateParser.TemplateData
insteadTemplateParser.TemplateParserFactory Template parser factory.
TemplateRenderer<SOURCE> Deprecated. since Vaadin 22,TemplateRenderer
is deprecated in favor ofLitRenderer
TemporaryFileFactory Text A component which encapsulates the given text in a text node.
TextAlign The text alignment for the label.
TextArea Text Area is an input field component for multi-line text input.
TextAreaVariant Set of theme variants applicable for
vaadin-text-area
component.TextField Text Field allows the user to input and edit text.
TextFieldVariant Set of theme variants applicable for the
TextField
component, as well as other components based on it.TextNodeMap Map holding the data of a text node.
TextRenderer<ITEM> A renderer that renders each item as a text using provided
ItemLabelGenerator
.ThemableLayout Common logic for
VerticalLayout
andHorizontalLayout
related to dynamic theme adjustment.Theme Theme class for Chart.
Theme Defines the theme to use for the application.
ThemeDefinition Holds all the settings needed to properly set a Theme in the application.
ThemeGradientColorBeanSerializer Custom bean serializer for
GradientColor
insideChartOptions
ThemeList Representation of the theme names for an
Element
.ThemeListImpl Default implementation for the
ThemeList
that stores the theme names of the corresponding element.ThemeVariant Base definition for a typed theme variant enum of a component
TickIntervalStyle TickmarkPlacement For categorized axes only.
TickPosition The position of the tick marks relative to the axis line.
TileImageSource Abstract base class for map sources providing tiled images from a URL
TileImageSource.Options TileLayer Layer for displaying tiled map data
TileSource Abstract base class for map sources providing tiled map data
TileSource.Options TileWMSSource Source for loading tile data from WMS (Web Map Service) servers
TileWMSSource.Options Time These settings affect how datetime axes are laid out, how tooltips are formatted, how series pointIntervalUnit works and how the Highstock range selector handles time.
TimePicker Time Picker is an input field for entering or selecting a specific time.
TimePicker.InvalidChangeEvent<T extends GeneratedVaadinTimePicker<T,?>> TimePickerVariant Set of theme variants applicable for
vaadin-time-picker
component.TimeUnit TimeUnitMultiples Class used to define allowed multiples a time unit is allowed to be grouped to.
TimeUnitMultiplesSerializer Serializer for
TimeUnitMultiples
.Title The chart's main title.
TitleBeanSerializer Serializer for
Title
Tooltip Options for the tooltip that appears when the user hovers over a series or point.
Tooltip A handle that can be used to configure and control tooltips.
Tooltip.TooltipPosition Tooltip position in relation to the target element.
TooltipConfiguration A configuration class for a tooltips default behavior.
TooltipStyle Style options for tooltips
Top The top of the frame around a 3D chart.
TopicConnection API for sending and subscribing to updates between clients collaborating on the same collaboration topic.
TopicConnectionRegistration A registration for configuring or removing a topic connection that is opened with Collaboration Engine.
TopicConnectionRegistration.ConnectionFailedAction An action for handling a failed topic connection.
TopicConnectionRegistration.ConnectionFailedEvent An event that is fired when the topic connection fails.
Transport Transport modes for Push
TreeData<T> Represents hierarchical data.
TreeDataProvider<T> An in-memory data provider for listing components that display hierarchical data.
TreeGrid<T> Tree Grid is a component for displaying hierarchical tabular data grouped into expandable and collapsible nodes.
TreeGridArrayUpdater Array update strategy aware class for TreeGrid.
TreeMapLayoutAlgorithm The layout algorithm used by
ChartType.TREEMAP
charts.TreeMapLayoutStartingDirection The direction where the layout algorithm will start drawing.
TreeSeries A collection of
TreeSeriesItems
that compose a multi-root tree.TreeSeriesItem This class represents one node in a
TreeSeries
.UI The topmost component in any component hierarchy.
UIDetachedException Exception thrown if the UI has been detached when it should not be.
UidlRequestHandler Processes a UIDL request from the client.
UidlWriter Serializes pending server-side changes to UI state to JSON.
UidlWriter.ResolveContext Provides context information for the resolve operations.
UIInitEvent Event fired to
UIInitListener
when aUI
has been initialized.UIInitListener Event listener that can be registered for receiving an event when a
UI
is initialized.UIInternals Holds UI-specific methods and data which are intended for internal use by the framework.
UIInternals.JavaScriptInvocation A
Page.executeJs(String, Serializable...)
invocation that has not yet been sent to the client.UIInternalUpdater The implementation of this interface is responsible for updating the UI with given content.
UniqueSerializable A base class for generating an unique object that is serializable.
Unit Enum of supported units in Css sizes.
UnknownFeatureException Exception thrown for when a FeatureFlag that doesn't exist is checked.
UnknownTaskException Exception thrown for when a node task that is not in the task list is encountered.
UnorderedList Component representing a
<ul>
element.UnsupportedBrowserHandler A
RequestHandler
that presents an informative page that the browser in use will not work.UnsupportedPropertyTypeException UnsupportedPropertyTypeException
is throw whenWebComponentExporter
tries to register a property encasing an unsupported value type.Upload Upload is a component for uploading one or more files.
UploadException Upload exception class.
UploadI18N The I18N helper file for the upload component.
UploadI18N.AddFiles Translations for adding files.
UploadI18N.DropFiles Translations for dropping files.
UploadI18N.Error Exception translations.
UploadI18N.File file translations.
UploadI18N.SingleMulti Abstract translation class for single and multi mode translations.
UploadI18N.Units unit translations.
UploadI18N.Uploading Upload time translation strings.
UploadI18N.Uploading.Error Communication error translations.
UploadI18N.Uploading.RemainingTime Time remaining translations.
UploadI18N.Uploading.Status Upload status strings.
UploadOutputStream FileOutputStream with a reference to the output file.
UrlTileSource Abstract base class for map sources providing tiled map data from a URL
UrlTileSource.Options UrlUtil Internal utility class for URL handling.
UsageStatistics Collects entries that should be exported for vaadin-usage-statistics when running in development mode.
UsageStatistics.UsageEntry A usage statistics entry.
UsageStatisticsExporter A class for exporting
UsageStatistics
entries.UserInfo User information of a collaborating user, used with various features of the collaboration engine.
Uses Marks that an annotated component implicitly uses another component.
Uses.Container Internal annotation to enable use of multiple
Uses
annotations.Util VaadinApplicationInitializationBootstrap Represents Vaadin web application initialization bootstrap.
VaadinAppShellInitializer Servlet initializer visiting
AppShellConfigurator
configuration.VaadinBundles Empty class which makes Flow add npm @vaadin/bundles dependency.
VaadinConfig Configuration in which
VaadinService
is running.VaadinContext Context in which
VaadinService
is running.VaadinContextInitializer Allows to run initialization of
VaadinContext
which for some reasons may not be done viaServletContextListener
.VaadinContextStartupInitializer Applies this initializer to the given
VaadinContext
.VaadinIcon Enumeration of all icons in the Vaadin Icons collection.
VaadinInitializerException Indicates an issue during Vaadin initialization.
VaadinRequest A generic request to the server, wrapping a more specific request type, e.g.
VaadinResponse A generic response from the server, wrapping a more specific response type, e.g.
VaadinService An abstraction of the underlying technology, e.g.
VaadinServiceInitListener Listener for
VaadinService
initialization events.VaadinServlet The main servlet, which handles all incoming requests to the application.
VaadinServletConfig VaadinConfig
implementation for Servlets.VaadinServletContext VaadinContext
that goes withVaadinServletService
.VaadinServletContextStartupInitializer Allows a library/runtime to be notified of a web application's startup phase and perform any required programmatic registration of servlets, filters, and listeners in response to it.
VaadinServletRequest Wrapper for
HttpServletRequest
.VaadinServletResponse Wrapper for
HttpServletResponse
.VaadinServletService A service implementation connected to a
VaadinServlet
.VaadinSession Contains everything that Vaadin needs to store for a specific user.
VaadinSessionState The lifecycle state of a VaadinSession.
VaadinUriResolver Utility for translating special Vaadin URIs into URLs usable by the browser.
ValidationException Indicates validation errors in a
Binder
when a field value is validated.ValidationResult Represents the result of a validation.
ValidationResult.SimpleValidationResult Simple validation result implementation.
ValidationStatusChangeEvent<V> The event to be processed when
ValidationStatusChangeListener.validationStatusChanged(ValidationStatusChangeEvent)
invoked.ValidationStatusChangeListener<V> The listener interface for receiving
ValidationStatusChangeEvent
events.ValidationUtil Util methods for component validation
Validator<T> A functional interface for validating user input or other potentially invalid data.
ValueChangeMode All possible value change modes that can be set for any component extending
HasValueChangeMode
.ValueContext Value context for
Converter
s.ValueProvider<SOURCE,TARGET> A callback interface for providing values from a given source.
VectorLayer Layer for rendering vector data client-side
VectorSource VectorSource.Options Version Provides information about the current version of Vaadin Flow.
VerticalAlign Alignment of the title relative to the axis values and more generically vertical alignment.
VerticalLayout Vertical Layout places components top-to-bottom in a column.
View Represents a map's viewport, responsible for changing properties like center and zoom level
ViewAccessChecker Checks access to views using an
AccessAnnotationChecker
.Viewport Defines a viewport tag that will be added to the HTML of the host page of a UI class.
VirtualChildrenList List of nodes describing the virtually connected child elements of an element.
VirtualList<T> Virtual List allows you to render a long list of items inside a scrollable container without sacrificing performance.
ViteHandler Handles communication with a Vite server.
WaterFallSum DataSeriesItem that can be used as sum or intermediate sum in waterfall charts.
WebBrowser Provides information about the web browser the user is using that is directly available in the request, for instance browser name and version and IP address.
WebComponent<C extends Component> Acts as a proxy to the web component root onto which the exporter
Component
is added.WebComponentBinding<C extends Component> Represents a single instance of a exported web component instance embedded onto a host page.
WebComponentBootstrapHandler Bootstrap handler for WebComponent requests.
WebComponentConfiguration<C extends Component> Result of defining an embeddable web component using
WebComponentExporter
.WebComponentConfigurationRegistry Registry for storing available web component configuration implementations.
WebComponentConfigurationRegistryInitializer Servlet initializer for collecting all classes that extend
WebComponentExporter
/WebComponentExporterFactory
on startup, creates uniqueWebComponentConfiguration
instances, and adds them toWebComponentConfigurationRegistry
.WebComponentExporter<C extends Component> Exports a
Component
as a web component.WebComponentExporter.WebComponentConfigurationFactory Produces
WebComponentConfiguration
instances from eitherWebComponentExporter
classes or instances.WebComponentExporterAwareValidator Checks that specific annotations are not configured wrong.
WebComponentExporterFactory<C extends Component> Exports a
Component
as a web component.WebComponentExporterFactory.DefaultWebComponentExporterFactory<C extends Component> Default factory implementation which uses an exporter class to instantiate it using its default constructor.
WebComponentExporterTagExtractor Retrieves web component tag from a
WebComponentExporterFactory
object.WebComponentExporterUtils Internal utility methods for
WebComponentExporter
andWebComponentExporterFactory
classes.WebComponentGenerator Generates a client-side web component from a Java class.
WebComponentModulesWriter Writes web components generated from
WebComponentExporter
implementation classes to a target directory.WebComponentModulesWriter.DirectoryWriter Enables the usage of given
WebComponentModulesWriter
class via reflection.WebComponentProvider Request handler that supplies the script/html of the web component matching the given tag.
WebComponentUI Custom UI for use with WebComponents served from the server.
WebComponentUI.WebComponentConnectEvent Event used for sending the activation event for an exported web component from the client to the server.
WebComponentWrapper Wrapper component for a web component that exposes
ClientCallable
methods that the client-side components expect to be available.WebpackConnectionException Exception thrown when webpack server doesn't respond with HTTP_OK for a request.
WebpackHandler Runs a webpack dev server and provides files handles getting resources from
webpack-dev-server
.WildcardParameter Marks a Navigation url parameter as a wildcard allowing 0-N parameter parts to be bound for this url parameter.
WrappedHttpSession Wrapper for
HttpSession
.WrappedSession A generic session, wrapping a more specific session implementation, e.g.
XAxesExtremesSetEvent The XAxesExtremesSetEvent class stores data for set extremes events on the x axes of the chart.
XAxis The X axis or category axis.
XYZSource Source for loading tiled images from a map service using the Slippy Map tile numbering scheme, also known as XYZ format.
XYZSource.Options YAxesExtremesSetEvent The YAxesExtremesSetEvent class stores data for set extremes events on the y axes of the chart.
YAxis The Y axis or value axis.
ZAxis The Z axis or depth axis for 3D plots.
ZoneAxis Defines the Axis on which the zones are applied.
Zones An array defining zones within a series.