Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractBackEndDataProvider<T,
F> - Class in com.vaadin.flow.data.provider -
Abstract base class for implementing back end data providers.
- AbstractBackEndDataProvider() - Constructor for class com.vaadin.flow.data.provider.AbstractBackEndDataProvider
- AbstractBackEndHierarchicalDataProvider<T,
F> - Class in com.vaadin.flow.data.provider.hierarchy -
Abstract base class for implementing
BackEndHierarchicalDataProvider
s. - AbstractBackEndHierarchicalDataProvider() - Constructor for class com.vaadin.flow.data.provider.hierarchy.AbstractBackEndHierarchicalDataProvider
- AbstractBeanPropertyDefinition<T,
V> - Class in com.vaadin.flow.data.binder -
Abstract base class for PropertyDefinition implementations for beans.
- AbstractBeanPropertyDefinition(BeanPropertySet<T>, Class<?>, PropertyDescriptor) - Constructor for class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
-
Constructor for setting the immutable descriptor, property set and property holder type used by this instance.
- AbstractComponentDataGenerator<T> - Class in com.vaadin.flow.data.provider
-
Abstract class used as base for DataGenerators that need to manage the lifecycle of components, according to what items are requested or destroyed.
- AbstractComponentDataGenerator() - Constructor for class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
- AbstractDataProvider<T,
F> - Class in com.vaadin.flow.data.provider -
Abstract data provider implementation which takes care of refreshing data from the underlying data provider.
- AbstractDataProvider() - Constructor for class com.vaadin.flow.data.provider.AbstractDataProvider
- AbstractDataView<T> - Class in com.vaadin.flow.data.provider
-
Abstract data view implementation which handles parts that apply for any type of data.
- AbstractDataView(SerializableSupplier<? extends DataProvider<T, ?>>, Component) - Constructor for class com.vaadin.flow.data.provider.AbstractDataView
-
Creates a new instance of
AbstractDataView
subclass and verifies the passed data provider is compatible with this data view implementation. - AbstractHierarchicalDataProvider<T,
F> - Class in com.vaadin.flow.data.provider.hierarchy -
Abstract hierarchical data provider implementation which takes care of item refreshes and associated events.
- AbstractHierarchicalDataProvider() - Constructor for class com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider
- AbstractLazyDataView<T> - Class in com.vaadin.flow.data.provider
-
Abstract lazy data view implementation which handles the interaction with a data communicator.
- AbstractLazyDataView(DataCommunicator<T>, Component) - Constructor for class com.vaadin.flow.data.provider.AbstractLazyDataView
-
Creates a new instance and verifies the passed data provider is compatible with this data view implementation.
- AbstractListDataView<T> - Class in com.vaadin.flow.data.provider
-
Abstract list data view implementation which provides common methods for fetching, filtering and sorting in-memory data to all
ListDataView
subclasses. - AbstractListDataView(SerializableSupplier<? extends DataProvider<T, ?>>, Component, SerializableBiConsumer<SerializablePredicate<T>, SerializableComparator<T>>) - Constructor for class com.vaadin.flow.data.provider.AbstractListDataView
-
Creates a new instance of
AbstractListDataView
subclass and verifies the passed data provider is compatible with this data view implementation. - AbstractStringToNumberConverter<T extends Number> - Class in com.vaadin.flow.data.converter
-
A converter that converts from the number type T to
String
and back. - AbstractStringToNumberConverter(T, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.AbstractStringToNumberConverter
-
Creates a new converter instance with the given presentation value for empty string and error message provider.
- AbstractStringToNumberConverter(T, String) - Constructor for class com.vaadin.flow.data.converter.AbstractStringToNumberConverter
-
Creates a new converter instance with the given presentation value for empty string and error message.
- AbstractValidator<T> - Class in com.vaadin.flow.data.validator
-
An abstract base class for typed validators.
- AbstractValidator(String) - Constructor for class com.vaadin.flow.data.validator.AbstractValidator
-
Constructs a validator with the given error message.
- accept(BEAN, FIELDVALUE) - Method in interface com.vaadin.flow.data.binder.Setter
-
Save value to the bean property.
- addComponents(T, Component...) - Method in interface com.vaadin.flow.data.binder.HasItemComponents
-
Adds the components after the given item.
- addDataGenerator(DataGenerator<T>) - Method in class com.vaadin.flow.data.provider.CompositeDataGenerator
- addDataGenerator(DataGenerator<T>) - Method in interface com.vaadin.flow.data.provider.HasDataGenerators
-
Adds the given data generator.
- addDataProviderListener(DataProviderListener<T>) - Method in class com.vaadin.flow.data.provider.AbstractDataProvider
- addDataProviderListener(DataProviderListener<T>) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Adds a data provider listener.
- addDataProviderListener(DataProviderListener<T>) - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
- addFilter(SerializablePredicate<T>) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addFilter(SerializablePredicate<T>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Adds a filter to be applied to all queries.
- addFilter(SerializablePredicate<T>) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds a filter to be applied to all queries.
- addFilter(ValueProvider<T, V>, SerializablePredicate<V>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Adds a filter for an item property.
- addFilterByValue(ValueProvider<T, V>, V) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Adds a filter that requires an item property to have a specific value.
- addIdentifierProviderChangeListener(ComponentEventListener<IdentifierProviderChangeEvent<T, ?>>) - Method in class com.vaadin.flow.data.provider.AbstractDataView
-
Add an identifier provider change listener that is fired when a custom identifier provider is set with
AbstractDataView.setIdentifierProvider(IdentifierProvider)
. - addItem(T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addItem(T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds an item to the data list if it is not already present.
- addItem(T, T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds a data item as a child of
parent
. - addItemAfter(T, T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addItemAfter(T, T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds an item after the given target item.
- addItemBefore(T, T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addItemBefore(T, T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds an item before the given target item.
- addItemCountChangeListener(ComponentEventListener<ItemCountChangeEvent<?>>) - Method in class com.vaadin.flow.data.provider.AbstractDataView
- addItemCountChangeListener(ComponentEventListener<ItemCountChangeEvent<?>>) - Method in interface com.vaadin.flow.data.provider.DataView
-
Add an item count change listener that is fired when the item count changes.
- addItems(Collection<T>) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addItems(Collection<T>) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds multiple items to the data list.
- addItems(Collection<T>, ValueProvider<T, Collection<T>>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds the given items as root items and uses the given value provider to recursively populate children of the root items.
- addItems(Stream<T>, ValueProvider<T, Stream<T>>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds the given items as root items and uses the given value provider to recursively populate children of the root items.
- addItems(T, Collection<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds a list of data items as children of
parent
. - addItems(T, Stream<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds data items contained in a stream as children of
parent
. - addItems(T, T...) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds a list of data items as children of
parent
. - addItemsAfter(Collection<T>, T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addItemsAfter(Collection<T>, T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds multiple items after the given target item.
- addItemsBefore(Collection<T>, T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addItemsBefore(Collection<T>, T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds multiple items before the given target item.
- addListener(Class<E>, SerializableConsumer<E>) - Method in class com.vaadin.flow.data.provider.AbstractDataProvider
-
Registers a new listener with the specified activation method to listen events generated by this component.
- addListener(Class<T>, SerializableConsumer<T>) - Method in class com.vaadin.flow.data.binder.Binder
-
Adds a listener to the binder.
- addRootItems(Collection<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds the items of the given collection as root items to this structure.
- addRootItems(Stream<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds the items of the given stream as root items to this structure.
- addRootItems(T...) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Adds the items as root items to this structure.
- addSelectionListener(MultiSelectionListener<C, T>) - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
- addSelectionListener(SelectionListener<C, T>) - Method in interface com.vaadin.flow.data.selection.SelectionModel
-
Adds a generic listener to this selection model, accepting both single and multiselection events.
- addSortComparator(SerializableComparator<T>) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addSortComparator(SerializableComparator<T>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Adds a comparator to the default sorting for this data provider.
- addSortComparator(SerializableComparator<T>) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds a comparator to the data default sorting.
- addSortListener(ComponentEventListener<SortEvent<T, S>>) - Method in interface com.vaadin.flow.data.event.SortEvent.SortNotifier
-
Adds a sort order change listener that gets notified when the sort order changes.
- addSortOrder(ValueProvider<T, V>, SortDirection) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Adds a property and direction to the default sorting for this data provider.
- addSortOrder(ValueProvider<T, V1>, SortDirection) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- addSortOrder(ValueProvider<T, V1>, SortDirection) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Adds a property and direction to the default sorting.
- addStatusChangeListener(StatusChangeListener) - Method in class com.vaadin.flow.data.binder.Binder
-
Adds status change listener to the binder.
- addValidationStatusChangeListener(ValidationStatusChangeListener<V>) - Method in interface com.vaadin.flow.data.binder.HasValidator
-
Enables the implementing components to notify changes in their validation status to the observers.
- addValueChangeListener(HasValue.ValueChangeListener<? super HasValue.ValueChangeEvent<?>>) - Method in class com.vaadin.flow.data.binder.Binder
-
Adds field value change listener to all the fields in the binder.
- addValueChangeListener(HasValue.ValueChangeListener<? super HasValue.ValueChangeEvent<V>>) - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- alwaysPass() - Static method in interface com.vaadin.flow.data.binder.Validator
-
Returns a validator that passes any value.
- apply(ValueContext) - Method in interface com.vaadin.flow.data.binder.ErrorMessageProvider
-
Returns a generated error message for given
ValueContext
. - apply(Object, ValueContext) - Method in class com.vaadin.flow.data.validator.BeanValidator
-
Validates the given value as if it were the value of the bean property configured for this validator.
- apply(String, ValueContext) - Method in class com.vaadin.flow.data.validator.RegexpValidator
- apply(String, ValueContext) - Method in class com.vaadin.flow.data.validator.StringLengthValidator
- apply(T, ValueContext) - Method in interface com.vaadin.flow.data.binder.Validator
-
Validates the given value.
- apply(T, ValueContext) - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Returns
Result.ok
if the value is within the specified bounds,Result.error
otherwise. - applyChangeTimeout(ValueChangeMode, int, DomListenerRegistration) - Static method in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Applies the value change timeout of the given mode on the registration of the DOM event listener that synchronizes.
- ArrayUpdater - Interface in com.vaadin.flow.data.provider
-
Array update strategy aware class.
- ArrayUpdater.Update - Interface in com.vaadin.flow.data.provider
-
Array updater strategy.
- asc(String) - Static method in class com.vaadin.flow.data.provider.QuerySortOrder
-
Creates a new query sort builder with given sorting using ascending sort direction.
- ASCENDING - Enum constant in enum class com.vaadin.flow.data.provider.SortDirection
-
Ascending (e.g.
- asRequired() - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Sets the field to be required.
- asRequired(ErrorMessageProvider) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Sets the field to be required.
- asRequired(ErrorMessageProvider) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- asRequired(Validator<TARGET>) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Sets the field to be required and delegates the required check to a custom validator.
- asRequired(Validator<TARGET>) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- asRequired(String) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Sets the field to be required.
B
- BackEndDataProvider<T,
F> - Interface in com.vaadin.flow.data.provider -
A data provider that lazy loads items from a back end.
- BackEndHierarchicalDataProvider<T,
F> - Interface in com.vaadin.flow.data.provider.hierarchy -
A data provider that lazy loads items from a back end containing hierarchical data.
- BeanDataGenerator<T> - Class in com.vaadin.flow.data.provider
-
A
DataGenerator
that sends all the fields of the objects in the model to the client, using the field names as property names. - BeanDataGenerator() - Constructor for class com.vaadin.flow.data.provider.BeanDataGenerator
- BeanPropertySet<T> - Class in com.vaadin.flow.data.binder
-
A
PropertySet
that uses reflection to find bean properties. - BeanPropertySet.NestedBeanPropertyDefinition<T,
V> - Class in com.vaadin.flow.data.binder -
Contains properties for a bean type which is nested in another definition.
- BeanValidationBinder<BEAN> - Class in com.vaadin.flow.data.binder
-
Binder that uses reflection based on the provided bean type to resolve bean properties.
- BeanValidationBinder(Class<BEAN>) - Constructor for class com.vaadin.flow.data.binder.BeanValidationBinder
-
Creates a new binder that uses reflection based on the provided bean type to resolve bean properties.
- BeanValidationBinder(Class<BEAN>, boolean) - Constructor for class com.vaadin.flow.data.binder.BeanValidationBinder
-
Creates a new binder that uses reflection based on the provided bean type to resolve bean properties.
- BeanValidator - Class in com.vaadin.flow.data.validator
-
A
Validator
using the JSR-303 (jakarta.validation) annotation-based bean validation mechanism. - BeanValidator(Class<?>, String) - Constructor for class com.vaadin.flow.data.validator.BeanValidator
-
Creates a new JSR-303
BeanValidator
that validates values of the specified property. - BigDecimalRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that an
BigDecimal
is inside a given range. - BigDecimalRangeValidator(String, BigDecimal, BigDecimal) - Constructor for class com.vaadin.flow.data.validator.BigDecimalRangeValidator
-
Creates a validator for checking that an BigDecimal is within a given range.
- BigIntegerRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that an
BigInteger
is inside a given range. - BigIntegerRangeValidator(String, BigInteger, BigInteger) - Constructor for class com.vaadin.flow.data.validator.BigIntegerRangeValidator
-
Creates a validator for checking that an BigInteger is within a given range.
- bind(HasValue<?, FIELDVALUE>, ValueProvider<BEAN, FIELDVALUE>, Setter<BEAN, FIELDVALUE>) - Method in class com.vaadin.flow.data.binder.Binder
-
Binds a field to a bean property represented by the given getter and setter pair.
- bind(HasValue<?, FIELDVALUE>, String) - Method in class com.vaadin.flow.data.binder.Binder
-
Binds the given field to the property with the given name.
- bind(ValueProvider<BEAN, TARGET>, Setter<BEAN, TARGET>) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Completes this binding using the given getter and setter functions representing a backing bean property.
- bind(ValueProvider<BEAN, TARGET>, Setter<BEAN, TARGET>) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- bind(String) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Completes this binding by connecting the field to the property with the given name.
- bind(String) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- Binder<BEAN> - Class in com.vaadin.flow.data.binder
-
Connects one or more
Field
components to properties of a backing data type such as a bean type. - Binder() - Constructor for class com.vaadin.flow.data.binder.Binder
-
Creates a new binder without support for creating bindings based on property names.
- Binder(PropertySet<BEAN>) - Constructor for class com.vaadin.flow.data.binder.Binder
-
Creates a binder using a custom
PropertySet
implementation for finding and resolving property names forBinder.bindInstanceFields(Object)
,Binder.bind(HasValue, String)
andBinder.BindingBuilder.bind(String)
. - Binder(Class<BEAN>) - Constructor for class com.vaadin.flow.data.binder.Binder
-
Creates a new binder that uses reflection based on the provided bean type to resolve bean properties.
- Binder(Class<BEAN>, boolean) - Constructor for class com.vaadin.flow.data.binder.Binder
-
Creates a new binder that uses reflection based on the provided bean type to resolve bean properties.
- Binder.Binding<BEAN,
TARGET> - Interface in com.vaadin.flow.data.binder -
Represents the binding between a field and a data property.
- Binder.BindingBuilder<BEAN,
TARGET> - Interface in com.vaadin.flow.data.binder -
Creates a binding between a field and a data property.
- Binder.BindingBuilderImpl<BEAN,
FIELDVALUE, TARGET> - Class in com.vaadin.flow.data.binder -
An internal implementation of
BindingBuilder
. - Binder.BindingImpl<BEAN,
FIELDVALUE, TARGET> - Class in com.vaadin.flow.data.binder -
An internal implementation of
Binding
. - BinderValidationErrorHandler - Interface in com.vaadin.flow.data.binder
-
Handler for applying effects to
HasValue
components inBinder
based onValidationResult
for the user input. - BinderValidationStatus<BEAN> - Class in com.vaadin.flow.data.binder
-
Binder validation status change.
- BinderValidationStatus(Binder<BEAN>, List<BindingValidationStatus<?>>, List<ValidationResult>) - Constructor for class com.vaadin.flow.data.binder.BinderValidationStatus
-
Creates a new binder validation status for the given binder and validation results.
- BinderValidationStatusHandler<BEAN> - Interface in com.vaadin.flow.data.binder
-
Handler for
BinderValidationStatus
changes. - BindingBuilderImpl(Binder<BEAN>, HasValue<?, FIELDVALUE>, Converter<FIELDVALUE, TARGET>, BindingValidationStatusHandler) - Constructor for class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
-
Creates a new binding builder associated with the given field.
- BindingException - Exception in com.vaadin.flow.data.binder
-
A subclass of
RuntimeException
which may be thrown insideBinder.Binding
logic to wrap an exception caused byHasValue
, validator, converter, etc. - BindingException(String) - Constructor for exception com.vaadin.flow.data.binder.BindingException
-
Constructs a new binding exception with the specified detail message.
- BindingException(String, Throwable) - Constructor for exception com.vaadin.flow.data.binder.BindingException
-
Constructs a new binding exception with the specified detail message and cause.
- BindingException(Throwable) - Constructor for exception com.vaadin.flow.data.binder.BindingException
-
Constructs a new binding exception with the specified cause and a detail message of
(cause==null ? null : cause.toString())
(which typically contains the class and detail message ofcause
). - BindingExceptionHandler - Interface in com.vaadin.flow.data.binder
-
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). - BindingImpl(Binder.BindingBuilderImpl<BEAN, FIELDVALUE, TARGET>, ValueProvider<BEAN, TARGET>, Setter<BEAN, TARGET>) - Constructor for class com.vaadin.flow.data.binder.Binder.BindingImpl
- BindingValidationStatus<TARGET> - Class in com.vaadin.flow.data.binder
-
Represents the status of field validation.
- BindingValidationStatus(Result<TARGET>, Binder.Binding<?, TARGET>) - Constructor for class com.vaadin.flow.data.binder.BindingValidationStatus
-
Creates a new status change event.
- BindingValidationStatus.Status - Enum Class in com.vaadin.flow.data.binder
-
Status of the validation.
- BindingValidationStatusHandler - Interface in com.vaadin.flow.data.binder
-
Handler for
BindingValidationStatus
changes. - bindInstanceFields(Object) - Method in class com.vaadin.flow.data.binder.Binder
-
Binds member fields found in the given object.
- bindReadOnly(HasValue<?, FIELDVALUE>, ValueProvider<BEAN, FIELDVALUE>) - Method in class com.vaadin.flow.data.binder.Binder
-
Binds a field to a bean property represented by the given getter.
- bindReadOnly(HasValue<?, FIELDVALUE>, String) - Method in class com.vaadin.flow.data.binder.Binder
-
Binds the given field to the property with the given name.
- bindReadOnly(ValueProvider<BEAN, TARGET>) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Completes this binding using the given getter function representing a backing bean property.
- bindReadOnly(ValueProvider<BEAN, TARGET>) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- bindReadOnly(String) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Completes this binding by connecting the field to the property with the given name.
- bindReadOnly(String) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- build() - Method in class com.vaadin.flow.data.provider.SortOrderBuilder
-
Returns an unmodifiable copy of the list of current sort orders in this sort builder.
- buildQuery(int, int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Generate a data query with component sorting and filtering.
- ByteRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that an
Byte
is inside a given range. - ByteRangeValidator(String, Byte, Byte) - Constructor for class com.vaadin.flow.data.validator.ByteRangeValidator
-
Creates a validator for checking that an Byte is within a given range.
C
- CallbackDataProvider<T,
F> - Class in com.vaadin.flow.data.provider -
Data provider that uses one callback for fetching items from a back end and another callback for counting the number of available items.
- CallbackDataProvider(CallbackDataProvider.FetchCallback<T, F>, CallbackDataProvider.CountCallback<T, F>) - Constructor for class com.vaadin.flow.data.provider.CallbackDataProvider
-
Constructs a new DataProvider to request data using callbacks for fetching and counting items in the back end.
- CallbackDataProvider(CallbackDataProvider.FetchCallback<T, F>, CallbackDataProvider.CountCallback<T, F>, ValueProvider<T, Object>) - Constructor for class com.vaadin.flow.data.provider.CallbackDataProvider
-
Constructs a new DataProvider to request data using callbacks for fetching and counting items in the back end.
- CallbackDataProvider.CountCallback<T,
F> - Interface in com.vaadin.flow.data.provider -
Callback interface for counting the number of items in a backend based on a query.
- CallbackDataProvider.FetchCallback<T,
F> - Interface in com.vaadin.flow.data.provider -
Callback interface for fetching a stream of items from a backend based on a query.
- chain(RequiredFieldConfigurator) - Method in interface com.vaadin.flow.data.binder.RequiredFieldConfigurator
-
Returns a configurator that chains together this configurator with the given configurator.
- chain(Converter<MODEL, T>) - Method in interface com.vaadin.flow.data.converter.Converter
-
Returns a converter that chains together this converter with the given type-compatible converter.
- checkUnbound() - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
-
Throws if this binding is already completed and cannot be modified anymore.
- clear() - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Clear all items from this structure.
- clear(int, int) - Method in interface com.vaadin.flow.data.provider.ArrayUpdater.Update
-
Clears
length
elements in array from thestart
position. - clear(int, int, String) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalArrayUpdater.HierarchicalUpdate
-
Clears
length
elements in array from thestart
position. - clearError(HasValue<?, ?>) - Method in class com.vaadin.flow.data.binder.Binder
-
Clears the error condition of the given field, if any.
- clearError(HasValue<?, ?>) - Method in interface com.vaadin.flow.data.binder.BinderValidationErrorHandler
-
Clears the error condition of the given field, if one has been previously set with
BinderValidationErrorHandler.handleError(com.vaadin.flow.component.HasValue<?, ?>, com.vaadin.flow.data.binder.ValidationResult)
. - clearError(HasValue<?, ?>) - Method in class com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler
-
Clears the error condition of the given field, if any.
- clearErrorTheme(HasValue<?, ?>) - Method in class com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler
-
Clears error theme for the
field
. - clearFilters() - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Removes any filter that has been set or added previously.
- collapse(Collection<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Collapses the given items and removes its sub-hierarchy.
- collapse(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Collapses the given item and removes its sub-hierarchy.
- collapse(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Collapses the given item.
- collapse(T, boolean) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Collapses the given item and removes its sub-hierarchy.
- collapse(T, Integer) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Collapses the given item.
- com.vaadin.flow.data.binder - package com.vaadin.flow.data.binder
- com.vaadin.flow.data.converter - package com.vaadin.flow.data.converter
- com.vaadin.flow.data.event - package com.vaadin.flow.data.event
- com.vaadin.flow.data.provider - package com.vaadin.flow.data.provider
- com.vaadin.flow.data.provider.hierarchy - package com.vaadin.flow.data.provider.hierarchy
- com.vaadin.flow.data.selection - package com.vaadin.flow.data.selection
- com.vaadin.flow.data.validator - package com.vaadin.flow.data.validator
- com.vaadin.flow.data.value - package com.vaadin.flow.data.value
- combineFilters(SerializableBiFunction<Q, C, F>, Q, C) - Static method in class com.vaadin.flow.data.provider.FilterUtils
-
Combines the configured filter and the filter from the query into one filter instance that can be passed to the wrapped data provider using the
filterCombiner
. - combineFilters(Q, C) - Method in class com.vaadin.flow.data.provider.ConfigurableFilterDataProviderWrapper
-
Combines the configured filter and the filter from the query into one filter instance that can be passed to the wrapped data provider.
- commit() - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalArrayUpdater.HierarchicalUpdate
-
Commits enqueued function calls added via
HierarchicalArrayUpdater.HierarchicalUpdate.enqueue(String, Serializable...)
. - commit(int) - Method in interface com.vaadin.flow.data.provider.ArrayUpdater.Update
-
Commits changes for the given
updateId
. - commit(int, String, int) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalArrayUpdater.HierarchicalUpdate
-
Commits changes for the given
updateId
and parent key. - component - Variable in class com.vaadin.flow.data.provider.AbstractDataView
- CompositeDataGenerator<T> - Class in com.vaadin.flow.data.provider
-
A
DataGenerator
that aggregates multiple DataGenerators and delegates the data generation to them. - CompositeDataGenerator() - Constructor for class com.vaadin.flow.data.provider.CompositeDataGenerator
- computeRequestedRange(int, int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Computes the requested range, limiting the number of requested items to a given threshold of ten pages.
- ConfigurableFilterDataProvider<T,
Q, C> - Interface in com.vaadin.flow.data.provider -
A data provider that supports programmatically setting a filter that will be applied to all queries.
- ConfigurableFilterDataProviderWrapper<T,
Q, C, F> - Class in com.vaadin.flow.data.provider -
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.
- ConfigurableFilterDataProviderWrapper(DataProvider<T, F>) - Constructor for class com.vaadin.flow.data.provider.ConfigurableFilterDataProviderWrapper
-
Creates a new configurable filter data provider by wrapping an existing data provider.
- configureBinding(Binder.BindingBuilder<BEAN, ?>, PropertyDefinition<BEAN, ?>) - Method in class com.vaadin.flow.data.binder.BeanValidationBinder
- configureBinding(Binder.BindingBuilder<BEAN, ?>, PropertyDefinition<BEAN, ?>) - Method in class com.vaadin.flow.data.binder.Binder
-
Configures the
binding
with the property definitiondefinition
before it's being bound. - confirmUpdate(int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Confirm update with the given
updateId
. - confirmUpdate(int) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController
- confirmUpdate(int, String) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- contains(T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- contains(T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Check whether the given item is in this hierarchy.
- contains(T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Check if item is present in the currently filtered data set.
- containsKey(String) - Method in class com.vaadin.flow.data.provider.KeyMapper
-
Checks if the given key is mapped to an object.
- Converter<PRESENTATION,
MODEL> - Interface in com.vaadin.flow.data.converter -
Defines conversion between a model and a presentation type.
- ConverterFactory - Interface in com.vaadin.flow.data.converter
-
Creates
Converter
instances capable to handle conversion between a model and a presentation type. - convertFilter(SerializableFunction<C, F>, Query<T, C>) - Static method in class com.vaadin.flow.data.provider.FilterUtils
-
Gets the filter converted from a query filter by the
filterConverter
. - convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToBigDecimalConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToBigIntegerConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToBooleanConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToDateConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToDoubleConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToFloatConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToIntegerConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToLongConverter
- convertToModel(String, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToUuidConverter
- convertToModel(LocalDate, ValueContext) - Method in class com.vaadin.flow.data.converter.LocalDateToDateConverter
- convertToModel(LocalDateTime, ValueContext) - Method in class com.vaadin.flow.data.converter.LocalDateTimeToDateConverter
- convertToModel(LocalDateTime, ValueContext) - Method in class com.vaadin.flow.data.converter.LocalDateTimeToInstantConverter
- convertToModel(Date, ValueContext) - Method in class com.vaadin.flow.data.converter.DateToLongConverter
- convertToModel(Date, ValueContext) - Method in class com.vaadin.flow.data.converter.DateToSqlDateConverter
- convertToModel(PRESENTATION, ValueContext) - Method in interface com.vaadin.flow.data.converter.Converter
-
Converts the given value from presentation type to model type.
- convertToNumber(String, ValueContext) - Method in class com.vaadin.flow.data.converter.AbstractStringToNumberConverter
-
Convert the value to a Number using the given locale and
AbstractStringToNumberConverter.getFormat(Locale)
. - convertToPresentation(Boolean, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToBooleanConverter
- convertToPresentation(Long, ValueContext) - Method in class com.vaadin.flow.data.converter.DateToLongConverter
- convertToPresentation(Date, ValueContext) - Method in class com.vaadin.flow.data.converter.DateToSqlDateConverter
- convertToPresentation(Instant, ValueContext) - Method in class com.vaadin.flow.data.converter.LocalDateTimeToInstantConverter
- convertToPresentation(Date, ValueContext) - Method in class com.vaadin.flow.data.converter.LocalDateTimeToDateConverter
- convertToPresentation(Date, ValueContext) - Method in class com.vaadin.flow.data.converter.LocalDateToDateConverter
- convertToPresentation(Date, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToDateConverter
- convertToPresentation(UUID, ValueContext) - Method in class com.vaadin.flow.data.converter.StringToUuidConverter
- convertToPresentation(MODEL, ValueContext) - Method in interface com.vaadin.flow.data.converter.Converter
-
Converts the given value from model type to presentation type.
- convertToPresentation(T, ValueContext) - Method in class com.vaadin.flow.data.converter.AbstractStringToNumberConverter
- count(Query<T, F>) - Method in interface com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback
-
Counts the number of available items based on a query.
- countChildItems(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
- create(String, ErrorLevel) - Static method in interface com.vaadin.flow.data.binder.ValidationResult
-
Creates the validation result with the given
errorMessage
anderrorLevel
. - createBinding(HasValue<?, FIELDVALUE>, Converter<FIELDVALUE, TARGET>, BindingValidationStatusHandler) - Method in class com.vaadin.flow.data.binder.Binder
-
Creates a new binding with the given field.
- createComponent(T) - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
-
Creates a new component based on the provided item.
- createContext(ConstraintViolation<?>) - Method in class com.vaadin.flow.data.validator.BeanValidator
-
Creates a simple message interpolation context based on the given constraint violation.
- createEqualsFilter(ValueProvider<T, V>, V) - Static method in class com.vaadin.flow.data.provider.InMemoryDataProviderHelpers
-
Creates a predicate that compares equality of the given required value to the value the given value provider obtains.
- createHierarchyMapper(HierarchicalDataProvider<T, F>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Create new
HierarchyMapper
for the given data provider. - createKey() - Method in class com.vaadin.flow.data.provider.KeyMapper
-
Creates a key for a new item.
- createSortOrder(String, SortDirection) - Method in class com.vaadin.flow.data.provider.QuerySortOrderBuilder
- createSortOrder(V, SortDirection) - Method in class com.vaadin.flow.data.provider.SortOrderBuilder
-
Creates a sort order object with the given parameters.
- createUnresolvedStatus(Binder.Binding<?, TARGET>) - Static method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Convenience method for creating a
BindingValidationStatus.Status.UNRESOLVED
validation status for the given binding. - createUnresolvedStatus(Binder<BEAN>) - Static method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Convenience method for creating a unresolved validation status for the given binder.
- createValueContext() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
-
Creates a value context from the current state of the binding and its field.
- createValueProviderFilter(ValueProvider<T, V>, SerializablePredicate<V>) - Static method in class com.vaadin.flow.data.provider.InMemoryDataProviderHelpers
-
Creates a new predicate from the given predicate and value provider.
- CRITICAL - Enum constant in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Error level for critical messages.
- CURRENT_LOCALE_SUPPLIER - Static variable in class com.vaadin.flow.data.provider.InMemoryDataProviderHelpers
-
Supplier that attempts to resolve a locale from the current UI.
D
- DataChangeEvent<T> - Class in com.vaadin.flow.data.provider
-
An event fired when the data of a
DataProvider
changes. - DataChangeEvent(DataProvider<T, ?>) - Constructor for class com.vaadin.flow.data.provider.DataChangeEvent
-
Creates a new
DataChangeEvent
event originating from the given data provider. - DataChangeEvent.DataRefreshEvent<T> - Class in com.vaadin.flow.data.provider
-
An event fired when a single item of a
DataProvider
has been updated. - DataCommunicator<T> - Class in com.vaadin.flow.data.provider
-
DataProvider base class.
- DataCommunicator(DataGenerator<T>, ArrayUpdater, SerializableConsumer<JsonArray>, StateNode) - Constructor for class com.vaadin.flow.data.provider.DataCommunicator
-
Creates a new instance.
- DataCommunicator(DataGenerator<T>, ArrayUpdater, SerializableConsumer<JsonArray>, StateNode, boolean) - Constructor for class com.vaadin.flow.data.provider.DataCommunicator
-
Creates a new instance.
- DataCommunicator.EmptyDataProvider<T1> - Class in com.vaadin.flow.data.provider
-
In-memory data provider with no items.
- DataCommunicator.Filter<F> - Class in com.vaadin.flow.data.provider
-
Wraps the component's filter object with the meta information whether this filter changing should trigger the item count change event.
- DataGenerator<T> - Interface in com.vaadin.flow.data.provider
-
A data generator for
DataCommunicator
. - DataKeyMapper<T> - Interface in com.vaadin.flow.data.provider
-
DataKeyMapper to map data objects to key strings.
- dataProvider - Variable in class com.vaadin.flow.data.provider.DataProviderWrapper
-
The actual data provider behind this wrapper.
- DataProvider<T,
F> - Interface in com.vaadin.flow.data.provider -
A common interface for fetching data from a backend.
- DataProviderListener<T> - Interface in com.vaadin.flow.data.provider
-
Data change events listener.
- dataProviderSupplier - Variable in class com.vaadin.flow.data.provider.AbstractDataView
- DataProviderWrapper<T,
F, M> - Class in com.vaadin.flow.data.provider -
Wrapper class for modifying, chaining and replacing filters and sorting in a query.
- DataProviderWrapper(DataProvider<T, M>) - Constructor for class com.vaadin.flow.data.provider.DataProviderWrapper
-
Constructs a filtering wrapper for a data provider.
- DataRefreshEvent(DataProvider<T, ?>, T) - Constructor for class com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent
-
Creates a new data refresh event originating from the given data provider.
- DataRefreshEvent(DataProvider<T, ?>, T, boolean) - Constructor for class com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent
-
Creates a new data refresh event originating from the given data provider.
- DataView<T> - Interface in com.vaadin.flow.data.provider
-
Base view interface for getting information on current data set of a Component.
- DataViewUtils - Class in com.vaadin.flow.data.provider
-
Internal utility class used by data view implementations and components to simplify the filtering and sorting handling, but not limited to it.
- DateRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that a
LocalDate
is inside a given range. - DateRangeValidator(String, LocalDate, LocalDate) - Constructor for class com.vaadin.flow.data.validator.DateRangeValidator
-
Creates a validator for checking that a LocalDate is within a given range.
- DateTimeRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that a
LocalDateTime
is inside a given range. - DateTimeRangeValidator(String, LocalDateTime, LocalDateTime) - Constructor for class com.vaadin.flow.data.validator.DateTimeRangeValidator
-
Creates a validator for checking that a
LocalDateTime
is within a given range. - DateToLongConverter - Class in com.vaadin.flow.data.converter
- DateToLongConverter() - Constructor for class com.vaadin.flow.data.converter.DateToLongConverter
- DateToSqlDateConverter - Class in com.vaadin.flow.data.converter
- DateToSqlDateConverter() - Constructor for class com.vaadin.flow.data.converter.DateToSqlDateConverter
- DEFAULT - Static variable in interface com.vaadin.flow.data.binder.RequiredFieldConfigurator
-
Default configurator which is combination of
RequiredFieldConfigurator.NOT_NULL
,RequiredFieldConfigurator.NOT_EMPTY
andRequiredFieldConfigurator.SIZE
configurators. - DEFAULT_CHANGE_TIMEOUT - Static variable in interface com.vaadin.flow.data.value.HasValueChangeMode
-
Default value change timeout for textual inputs in milliseconds.
- DEFAULT_PAGE_INCREASE_COUNT - Static variable in class com.vaadin.flow.data.provider.DataCommunicator
- DefaultBinderValidationErrorHandler - Class in com.vaadin.flow.data.binder
-
Default implementation of
BinderValidationErrorHandler
. - DefaultBinderValidationErrorHandler() - Constructor for class com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler
- DefaultBindingExceptionHandler - Class in com.vaadin.flow.data.binder
-
Default implementation of
BindingExceptionHandler
. - DefaultBindingExceptionHandler() - Constructor for class com.vaadin.flow.data.binder.DefaultBindingExceptionHandler
- DefaultConverterFactory - Enum Class in com.vaadin.flow.data.converter
-
Default implementation of
ConverterFactory
, handling all standard converters defined incom.vaadin.flow.data.converters
package. - desc(String) - Static method in class com.vaadin.flow.data.provider.QuerySortOrder
-
Creates a new query sort builder with given sorting using descending sort direction.
- DESCENDING - Enum constant in enum class com.vaadin.flow.data.provider.SortDirection
-
Descending (e.g.
- deselect(Iterable<T>) - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Removes the given items from the set of currently selected items.
- deselect(T) - Method in interface com.vaadin.flow.data.selection.SelectionModel
-
Deselects the given item.
- deselect(T) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Multi
- deselect(T...) - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Removes the given items from the set of currently selected items.
- deselectAll() - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Deselects all currently selected items.
- deselectAll() - Method in interface com.vaadin.flow.data.selection.SelectionModel
-
Deselects all currently selected items, if any.
- deselectAll() - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
- deselectItems(T...) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Multi
-
Removes the given items from the set of currently selected items.
- destroyAllData() - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
- destroyAllData() - Method in class com.vaadin.flow.data.provider.CompositeDataGenerator
- destroyAllData() - Method in interface com.vaadin.flow.data.provider.DataGenerator
-
Informs the
DataGenerator
that all data has been dropped. - destroyAllData() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
- destroyData(T) - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
- destroyData(T) - Method in class com.vaadin.flow.data.provider.CompositeDataGenerator
- destroyData(T) - Method in interface com.vaadin.flow.data.provider.DataGenerator
-
Informs the
DataGenerator
that the given data item has been dropped and is no longer needed. - doCreateBinding(HasValue<?, FIELDVALUE>, Converter<FIELDVALUE, TARGET>, BindingValidationStatusHandler) - Method in class com.vaadin.flow.data.binder.Binder
- DoubleRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that a
Double
is inside a given range. - DoubleRangeValidator(String, Double, Double) - Constructor for class com.vaadin.flow.data.validator.DoubleRangeValidator
-
Creates a validator for checking that an Double is within a given range.
E
- EAGER - Enum constant in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Syncs the value to the server each time it's changed on the client.
- EmailValidator - Class in com.vaadin.flow.data.validator
-
A string validator for e-mail addresses.
- EmailValidator(String) - Constructor for class com.vaadin.flow.data.validator.EmailValidator
-
Creates a validator for checking that a string is a syntactically valid e-mail address.
- EmailValidator(String, boolean) - Constructor for class com.vaadin.flow.data.validator.EmailValidator
-
Creates a validator for checking that a string is a syntactically valid e-mail address.
- EmptyDataProvider() - Constructor for class com.vaadin.flow.data.provider.DataCommunicator.EmptyDataProvider
-
Create in-memory data provider instance with no items in the backed collection.
- enablePushUpdates(Executor) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Control whether DataCommunicator should push data updates to the component asynchronously or not.
- enqueue(String, Serializable...) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalArrayUpdater.HierarchicalUpdate
-
Enqueue function call with the given arguments.
- equals(Object) - Method in class com.vaadin.flow.data.binder.ValidationResult.SimpleValidationResult
- equals(Object) - Method in class com.vaadin.flow.data.provider.DataCommunicator.Filter
- equals(T, T) - Method in class com.vaadin.flow.data.provider.AbstractDataView
- error(String) - Static method in interface com.vaadin.flow.data.binder.Result
-
Returns a failure result wrapping the given error message.
- error(String) - Static method in interface com.vaadin.flow.data.binder.ValidationResult
-
Creates the validation result which represent an error with the given
errorMessage
. - ERROR - Enum constant in enum class com.vaadin.flow.data.binder.BindingValidationStatus.Status
-
Validation failed.
- ERROR - Enum constant in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Error level for regular messages.
- ErrorLevel - Enum Class in com.vaadin.flow.data.binder
-
Represents the error levels displayed on components.
- ErrorMessageProvider - Interface in com.vaadin.flow.data.binder
-
Provider interface for generating localizable error messages using
ValueContext
. - eventForMode(ValueChangeMode, String) - Static method in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Gets the name of the event associated with the given mode.
- expand(Collection<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Expands the given items.
- expand(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Expands the given item.
- expand(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Expands the given item.
- expand(T, boolean) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Expands the given item.
- expand(T, Integer) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Expands the given item.
F
- fetch(Query<T, SerializablePredicate<T>>) - Method in class com.vaadin.flow.data.provider.ListDataProvider
- fetch(Query<T, F>) - Method in class com.vaadin.flow.data.provider.AbstractBackEndDataProvider
- fetch(Query<T, F>) - Method in interface com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback
-
Fetches a stream of items based on a query.
- fetch(Query<T, F>) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Fetches data from this DataProvider using given
query
. - fetch(Query<T, F>) - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
- fetch(Query<T, F>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
-
Fetches data from this HierarchicalDataProvider using given
query
. - fetchChildItems(T, Range) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
- fetchChildren(HierarchicalQuery<T, SerializablePredicate<T>>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
- fetchChildren(HierarchicalQuery<T, F>) - Method in class com.vaadin.flow.data.provider.hierarchy.AbstractBackEndHierarchicalDataProvider
- fetchChildren(HierarchicalQuery<T, F>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
-
Fetches data from this HierarchicalDataProvider using given
query
. - fetchChildrenFromBackEnd(HierarchicalQuery<T, F>) - Method in class com.vaadin.flow.data.provider.hierarchy.AbstractBackEndHierarchicalDataProvider
-
Fetches data from the back end using the given query.
- fetchFromBackEnd(Query<T, F>) - Method in class com.vaadin.flow.data.provider.AbstractBackEndDataProvider
-
Fetches data from the back end using the given query.
- fetchFromBackEnd(Query<T, F>) - Method in class com.vaadin.flow.data.provider.CallbackDataProvider
- fetchFromProvider(int, int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Fetches a list of items from the DataProvider.
- fetchFromProvider(int, int) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- fetchHierarchyItems(Range) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Gets a stream of items in the form of a flattened hierarchy from the back-end and filter the wanted results from the list.
- fetchHierarchyItems(T, Range) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Gets a stream of children for the given item in the form of a flattened hierarchy from the back-end and filter the wanted results from the list.
- fetchRootItems(Range) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Gets a stream of root items from the back-end and filter the wanted results from the list.
- Filter(F) - Constructor for class com.vaadin.flow.data.provider.DataCommunicator.Filter
-
Creates the filter object and sets it notify item count change listeners by default.
- Filter(F, boolean) - Constructor for class com.vaadin.flow.data.provider.DataCommunicator.Filter
-
Creates the filter object and sets its lifespan.
- filteringBy(SerializableBiPredicate<T, Q>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Wraps this data provider to create a new data provider that is filtered by comparing an item to the filter value provided in the query.
- filteringBy(ValueProvider<T, V>, SerializableBiPredicate<V, Q>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Wraps this data provider to create a new data provider that is filtered by comparing an item property value to the filter value provided in the query.
- filteringByCaseInsensitiveString(InMemoryDataProvider<T>, ValueProvider<T, String>, SerializableBiPredicate<String, String>, SerializableSupplier<Locale>) - Static method in class com.vaadin.flow.data.provider.InMemoryDataProviderHelpers
-
Wraps a given data provider so that its filter tests the given predicate with the lower case string provided by the given value provider.
- filteringByEquals(ValueProvider<T, V>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Wraps this data provider to create a new data provider that is filtered by testing whether the value of a property is equals to the filter value provided in the query.
- filteringByIgnoreNull(InMemoryDataProvider<T>, ValueProvider<T, V>, SerializableBiPredicate<V, Q>) - Static method in class com.vaadin.flow.data.provider.InMemoryDataProviderHelpers
-
Wraps a given data provider so that its filter ignores null items returned by the given value provider.
- filteringByPrefix(ValueProvider<T, String>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Wraps this data provider to create a new data provider that is filtered by a string by checking whether the lower case representation of an item property value starts with the lower case representation of the filter value provided in the query.
- filteringByPrefix(ValueProvider<T, String>, Locale) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Wraps this data provider to create a new data provider that is filtered by a string by checking whether the lower case representation of an item property value starts with the lower case representation of the filter value provided in the query.
- filteringBySubstring(ValueProvider<T, String>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Wraps this data provider to create a new data provider that is filtered by a string by checking whether the lower case representation of the filter value provided in the query is a substring of the lower case representation of an item property value.
- filteringBySubstring(ValueProvider<T, String>, Locale) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Wraps this data provider to create a new data provider that is filtered by a string by checking whether the lower case representation of the filter value provided in the query is a substring of the lower case representation of an item property value.
- FilterUtils - Class in com.vaadin.flow.data.provider
-
Internal filter related utilities for data provider.
- findLocale() - Static method in class com.vaadin.flow.data.binder.Binder.BindingImpl
-
Finds an appropriate locale to be used in conversion and validation.
- fireEvent(EventObject) - Method in class com.vaadin.flow.data.provider.AbstractDataProvider
-
Sends the event to all listeners.
- flatMap(SerializableFunction<R, Result<S>>) - Method in interface com.vaadin.flow.data.binder.Result
-
If this Result has a value, applies the given Result-returning function to the value.
- FloatRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that a
Float
is inside a given range. - FloatRangeValidator(String, Float, Float) - Constructor for class com.vaadin.flow.data.validator.FloatRangeValidator
-
Creates a validator for checking that an Float is within a given range.
- flush() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController
- forField(HasValue<?, FIELDVALUE>) - Method in class com.vaadin.flow.data.binder.Binder
-
Creates a new binding for the given field.
- forMemberField(HasValue<?, FIELDVALUE>) - Method in class com.vaadin.flow.data.binder.Binder
-
Creates a new binding for the given field.
- from(SerializableFunction<P, Result<M>>, SerializableFunction<M, P>) - Static method in interface com.vaadin.flow.data.converter.Converter
-
Constructs a converter from a filter and a function.
- from(SerializableFunction<P, M>, SerializableFunction<M, P>, SerializableFunction<Exception, String>) - Static method in interface com.vaadin.flow.data.converter.Converter
-
Constructs a converter from two functions.
- from(SerializablePredicate<T>, ErrorMessageProvider) - Static method in interface com.vaadin.flow.data.binder.Validator
-
Builds a validator out of a conditional function and an error message provider.
- from(SerializablePredicate<T>, ErrorMessageProvider, ErrorLevel) - Static method in interface com.vaadin.flow.data.binder.Validator
-
Builds a validator out of a conditional function and an error message provider.
- from(SerializablePredicate<T>, String) - Static method in interface com.vaadin.flow.data.binder.Validator
-
Builds a validator out of a conditional function and an error message.
- from(SerializablePredicate<T>, String, ErrorLevel) - Static method in interface com.vaadin.flow.data.binder.Validator
-
Builds a validator out of a conditional function and an error message.
- fromCallbacks(CallbackDataProvider.FetchCallback<T, Void>, CallbackDataProvider.CountCallback<T, Void>) - Static method in interface com.vaadin.flow.data.provider.DataProvider
-
Creates a new data provider that uses callbacks for fetching and counting items from any backing store.
- fromFilteringCallbacks(CallbackDataProvider.FetchCallback<T, F>, CallbackDataProvider.CountCallback<T, F>) - Static method in interface com.vaadin.flow.data.provider.DataProvider
-
Creates a new data provider that uses filtering callbacks for fetching and counting items from any backing store.
- fromStream(Stream<T>) - Static method in interface com.vaadin.flow.data.provider.DataProvider
-
Creates a new data provider from the given stream.
G
- generateData(T, JsonObject) - Method in class com.vaadin.flow.data.provider.BeanDataGenerator
- generateData(T, JsonObject) - Method in class com.vaadin.flow.data.provider.CompositeDataGenerator
- generateData(T, JsonObject) - Method in interface com.vaadin.flow.data.provider.DataGenerator
-
Adds custom data for the given item to its serialized
JsonObject
representation. - generateJson(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController
- get(Class<? extends T>) - Static method in class com.vaadin.flow.data.binder.BeanPropertySet
-
Gets a
BeanPropertySet
for the given bean type. - get(Class<? extends T>, boolean, PropertyFilterDefinition) - Static method in class com.vaadin.flow.data.binder.BeanPropertySet
-
Gets a
BeanPropertySet
for the given bean type. - get(String) - Method in interface com.vaadin.flow.data.provider.DataKeyMapper
-
Gets the data object identified by given key.
- get(String) - Method in class com.vaadin.flow.data.provider.KeyMapper
-
Retrieves object with the key.
- getAddedSelection() - Method in class com.vaadin.flow.data.selection.MultiSelectionEvent
-
Gets the items that were added to selection.
- getAllSelectedItems() - Method in class com.vaadin.flow.data.selection.MultiSelectionEvent
- getAllSelectedItems() - Method in interface com.vaadin.flow.data.selection.SelectionEvent
-
Gets all the currently selected items.
- getAllSelectedItems() - Method in class com.vaadin.flow.data.selection.SingleSelectionEvent
- getBackEndSorting() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Returns the
QuerySortOrder
to use with backend sorting. - getBackEndSorting() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Gets the current back-end sorting.
- getBean() - Method in class com.vaadin.flow.data.binder.Binder
-
Returns the bean that has been bound with
Binder.bind(com.vaadin.flow.component.HasValue<?, FIELDVALUE>, com.vaadin.flow.function.ValueProvider<BEAN, FIELDVALUE>, com.vaadin.flow.data.binder.Setter<BEAN, FIELDVALUE>)
, or null if a bean is not currently bound. - getBeanState(BEAN, Collection<Binder.Binding<BEAN, ?>>) - Method in class com.vaadin.flow.data.binder.Binder
-
Stores the state of the given bean.
- getBeanType() - Method in class com.vaadin.flow.data.binder.BeanPropertySet
-
Gets the bean type of this bean property set.
- getBeanValidationErrors() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets the failed bean level validation results.
- getBeanValidationErrors() - Method in exception com.vaadin.flow.data.binder.ValidationException
-
Returns a list of the bean level validation errors which caused the exception, or an empty list if the exception was caused by
field level validation errors
. - getBeanValidationResults() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets the bean level validation results.
- getBinder() - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
-
Returns the
Binder
connected to thisBinding
instance. - getBinder() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
-
Returns the
Binder
connected to thisBinding
instance. - getBinder() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets the source binder of the status.
- getBinder() - Method in class com.vaadin.flow.data.binder.StatusChangeEvent
-
Gets the binder.
- getBinding() - Method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Gets the source binding of the validation status.
- getBinding(String) - Method in class com.vaadin.flow.data.binder.Binder
-
Gets the binding for a property name.
- getBindingExceptionHandler() - Method in class com.vaadin.flow.data.binder.Binder
-
Gets the current exception handler.
- getBindings() - Method in class com.vaadin.flow.data.binder.Binder
-
Returns the bindings for this binder.
- getCaption() - Method in class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
- getCaption() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the human readable caption to show for this property.
- getChildCount(HierarchicalQuery<T, SerializablePredicate<T>>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
- getChildCount(HierarchicalQuery<T, F>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
-
Get the number of immediate child data items for the parent item returned by a given query.
- getChildren(T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Get the immediate child items for the given item.
- getComponent() - Method in class com.vaadin.flow.data.binder.ValueContext
-
Returns an
Optional
for theComponent
related to value conversion. - getComponentFilter(Component) - Static method in class com.vaadin.flow.data.provider.DataViewUtils
-
Gets the in-memory filter of a given component instance.
- getComponentSortComparator(Component) - Static method in class com.vaadin.flow.data.provider.DataViewUtils
-
Gets the in-memory sort comparator of a given component instance.
- getContainer() - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
-
Gets the element where the generated components will be attached to.
- getConverterFactory() - Method in class com.vaadin.flow.data.binder.Binder
-
Gets an instance of
ConverterFactory
that can be used to detect a suitable converter for bindings when presentation and model types are not compatible and a converter has not been explicitly configured. - getDataCommunicator() - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
-
Returns the data communicator for the component and checks that the data provider is of the correct type.
- getDataProvider() - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- getDataProvider() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Gets the current data provider from this DataCommunicator.
- getDataProvider() - Method in interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider
- getDataProvider() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- getDataProvider() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Gets the
HierarchicalDataProvider
for thisHierarchyMapper
. - getDataProviderSize() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Getter method for determining the item count of the data.
- getDataProviderSize() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- getDefaultFilter() - Static method in class com.vaadin.flow.data.binder.PropertyFilterDefinition
-
Get the default nested property filtering conditions.
- getDefaultValidator() - Method in interface com.vaadin.flow.data.binder.HasValidator
-
Returns a validator that checks the state of the Value.
- getDepth(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns depth of item in the tree starting from zero representing a root.
- getDepth(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Returns depth of item in the tree starting from zero representing a root.
- getDescriptor() - Method in class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
-
Gets the property descriptor of this instance.
- getDirection() - Method in class com.vaadin.flow.data.provider.SortOrder
-
Sorting direction.
- getEmptyValue() - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- getEmptyValue() - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
MultiSelect empty value should always be an empty set by default and not
null
. - getErrorLevel() - Method in interface com.vaadin.flow.data.binder.ValidationResult
-
Returns optional error level for this validation result.
- getErrorLevel() - Method in class com.vaadin.flow.data.binder.ValidationResult.SimpleValidationResult
- getErrorMessage() - Method in interface com.vaadin.flow.data.binder.ValidationResult
-
Returns the result message.
- getErrorMessage() - Method in class com.vaadin.flow.data.binder.ValidationResult.SimpleValidationResult
- getErrorMessage(ValueContext) - Method in class com.vaadin.flow.data.converter.AbstractStringToNumberConverter
-
Gets the error message to use when conversion fails.
- getErrorThemeName(ErrorLevel) - Method in class com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler
-
Gets the theme name for the
ErrorLevel
. - getExpandedItems() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Returns the expanded items in form of an unmodifiable collection.
- getFalseString(Locale) - Method in class com.vaadin.flow.data.converter.StringToBooleanConverter
-
Gets the locale-depended string representation for false.
- getField() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Gets the field the binding uses.
- getField() - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Gets the field the binding is being built for.
- getField() - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- getField() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- getField() - Method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Gets the bound field for this status.
- getFields() - Method in class com.vaadin.flow.data.binder.Binder
-
Returns the fields this binder has been bound to.
- getFieldValidationErrors() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets the failed field level validation statuses.
- getFieldValidationErrors() - Method in exception com.vaadin.flow.data.binder.ValidationException
-
Returns a list of the field level validation errors which caused the exception, or an empty list if the exception was caused by
bean level validation errors
. - getFieldValidationStatuses() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets the field level validation statuses.
- getFilter() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Get the object used for filtering in this data communicator.
- getFilter() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Gets the current filter.
- getFilter() - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
- getFilter() - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Gets the current filter of this data provider.
- getFilter() - Method in class com.vaadin.flow.data.provider.ListDataProvider
- getFilter() - Method in class com.vaadin.flow.data.provider.Query
-
Gets the filter for items to fetch.
- getFilter(Query<T, F>) - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
-
Gets the filter that should be used in the modified Query.
- getFilter(Query<T, Q>) - Method in class com.vaadin.flow.data.provider.ConfigurableFilterDataProviderWrapper
- getFilterObject() - Method in class com.vaadin.flow.data.provider.DataCommunicator.Filter
-
Returns a filter object for this component.
- getFirstSelectedItem() - Method in class com.vaadin.flow.data.selection.MultiSelectionEvent
- getFirstSelectedItem() - Method in interface com.vaadin.flow.data.selection.SelectionEvent
-
Get first selected data item.
- getFirstSelectedItem() - Method in interface com.vaadin.flow.data.selection.SelectionModel
-
Get first selected data item.
- getFirstSelectedItem() - Method in interface com.vaadin.flow.data.selection.SelectionModel.Multi
- getFirstSelectedItem() - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
- getFirstSelectedItem() - Method in class com.vaadin.flow.data.selection.SingleSelectionEvent
- getFormat(Locale) - Method in class com.vaadin.flow.data.converter.AbstractStringToNumberConverter
-
Returns the format used by
Converter.convertToPresentation(Object, ValueContext)
andConverter.convertToModel(Object, ValueContext)
. - getFormat(Locale) - Method in class com.vaadin.flow.data.converter.StringToBigDecimalConverter
- getFormat(Locale) - Method in class com.vaadin.flow.data.converter.StringToBigIntegerConverter
- getFormat(Locale) - Method in class com.vaadin.flow.data.converter.StringToDateConverter
-
Returns the format used by
StringToDateConverter.convertToPresentation(Date, ValueContext)
andStringToDateConverter.convertToModel(String, ValueContext)
. - getFormat(Locale) - Method in class com.vaadin.flow.data.converter.StringToIntegerConverter
-
Returns the format used by
Converter.convertToPresentation(Object, ValueContext)
andStringToIntegerConverter.convertToModel(String, ValueContext)
. - getFormat(Locale) - Method in class com.vaadin.flow.data.converter.StringToLongConverter
-
Returns the format used by
Converter.convertToPresentation(Object, ValueContext)
andStringToLongConverter.convertToModel(String, ValueContext)
. - getGenericDataView() - Method in interface com.vaadin.flow.data.provider.HasDataView
-
Get the DataView for the component.
- getGetter() - Method in class com.vaadin.flow.data.binder.BeanPropertySet.NestedBeanPropertyDefinition
- getGetter() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Gets the getter associated with this Binding.
- getGetter() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- getGetter() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the value provider that is used for finding the value of this property for a bean.
- getHasValue() - Method in class com.vaadin.flow.data.binder.ValueContext
-
Returns an
Optional
for theHasValue
used in the value conversion. - getHierarchyMapper() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns the
HierarchyMapper
used by this data communicator. - getId(T) - Method in class com.vaadin.flow.data.provider.CallbackDataProvider
- getId(T) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Gets an identifier for the given item.
- getId(T) - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
- getIdentifierProvider() - Method in class com.vaadin.flow.data.provider.AbstractDataView
- getIdentifierProvider() - Method in class com.vaadin.flow.data.provider.IdentifierProviderChangeEvent
-
Returns the new identifier provider for the component.
- getIgnorePackageNamesStartingWith() - Method in class com.vaadin.flow.data.binder.PropertyFilterDefinition
-
Returns a list of package name prefixes to ignore.
- getIndex(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns index for the row or
null
. - getIndex(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Finds the index of the item in active tree.
- getIndexOf(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Finds the current index of given object.
- getInMemorySorting() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Returns the
Comparator
to use with in-memory sorting. - getInMemorySorting() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Gets the current in-memory sorting.
- getInMemorySorting() - Method in class com.vaadin.flow.data.provider.Query
-
Gets the comparator for sorting in-memory data.
- getItem() - Method in interface com.vaadin.flow.data.binder.HasItemComponents.ItemComponent
- getItem() - Method in class com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent
-
Gets the refreshed item.
- getItem(int) - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
-
Gets the item at the given index from the data available to the component.
- getItem(int) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- getItem(int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Gets the item at the given index from the data available to the component.
- getItem(int) - Method in interface com.vaadin.flow.data.provider.DataView
-
Gets the item at the given index from the data available to the component.
- getItemCount() - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- getItemCount() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
This is the latest DataProvider item count informed to the client or fetched from the DataProvider if client data has not been sent.
- getItemCount() - Method in class com.vaadin.flow.data.provider.ItemCountChangeEvent
-
Get the new item count for the component.
- getItemCount() - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Get the full item count with filters if any set.
- getItemCountEstimate() - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- getItemCountEstimate() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Gets the item count estimate used.
- getItemCountEstimate() - Method in interface com.vaadin.flow.data.provider.LazyDataView
-
Gets the item count estimate.
- getItemCountEstimateIncrease() - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- getItemCountEstimateIncrease() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Gets the item count estimate increase used.
- getItemCountEstimateIncrease() - Method in interface com.vaadin.flow.data.provider.LazyDataView
-
Gets the item count estimate increase - how much the item count estimate is increased once the previous item count estimate has been reached.
- getItemKey(T) - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
-
Gets a unique key for a given item.
- getItemPosition(T) - Method in interface com.vaadin.flow.data.binder.HasItemComponents
-
Gets the index of the child element that represents the given item.
- getItems() - Method in class com.vaadin.flow.data.provider.AbstractDataView
- getItems() - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- getItems() - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- getItems() - Method in interface com.vaadin.flow.data.provider.DataView
-
Get the full data available to the component.
- getItems() - Method in class com.vaadin.flow.data.provider.ListDataProvider
-
Returns the underlying data items.
- getJavaxBeanValidator() - Method in class com.vaadin.flow.data.validator.BeanValidator
-
Returns a shared JSR-303 validator instance to use.
- getJavaxBeanValidatorFactory() - Static method in class com.vaadin.flow.data.validator.BeanValidator
-
Returns the underlying JSR-303 bean validator factory used.
- getKeyMapper() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Gets the
DataKeyMapper
used by thisDataCommunicator
. - getLazyDataView() - Method in interface com.vaadin.flow.data.provider.HasLazyDataView
-
Get the LazyDataView for the component that allows access to the items in the component.
- getLimit() - Method in class com.vaadin.flow.data.provider.Query
-
Gets the number of items to fetch.
- getListDataView() - Method in interface com.vaadin.flow.data.provider.HasListDataView
-
Get the ListDataView for the component.
- getLocale() - Method in class com.vaadin.flow.data.binder.ValueContext
-
Returns an
Optional
for theLocale
used in the value conversion. - getMaxLength() - Method in class com.vaadin.flow.data.validator.StringLengthValidator
-
Gets the maximum permissible length of the string.
- getMaxNestingDepth() - Method in class com.vaadin.flow.data.binder.PropertyFilterDefinition
-
Returns the maximum amount of nesting levels for sub-properties.
- getMaxValue() - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Gets the maximum value of the range.
- getMessage() - Method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Gets error validation message if status is
BindingValidationStatus.Status.ERROR
. - getMessage() - Method in interface com.vaadin.flow.data.binder.Result
-
Returns an Optional of the result message, or an empty Optional if none.
- getMessage(ConstraintViolation<?>, Locale) - Method in class com.vaadin.flow.data.validator.BeanValidator
-
Returns the interpolated error message for the given constraint violation using the locale specified for this validator.
- getMessage(T) - Method in class com.vaadin.flow.data.validator.AbstractValidator
-
Returns the error message for the given value.
- getMinLength() - Method in class com.vaadin.flow.data.validator.StringLengthValidator
-
Gets the minimum permissible length of the string.
- getMinValue() - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Returns the minimum value of the range.
- getName() - Method in class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
- getName() - Method in class com.vaadin.flow.data.binder.BeanPropertySet.NestedBeanPropertyDefinition
- getName() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the full name of this property.
- getNaturalSortComparator(SortDirection) - Static method in class com.vaadin.flow.data.provider.InMemoryDataProviderHelpers
-
Gets the natural order comparator for the type argument, or the natural order comparator reversed if the given sorting direction is
SortDirection.DESCENDING
. - getNewStatus() - Method in class com.vaadin.flow.data.binder.ValidationStatusChangeEvent
- getNextItem(T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- getNextItem(T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Gets the item after given item from the filtered and sorted data.
- getOffset() - Method in class com.vaadin.flow.data.provider.Query
-
Gets the first index of items to fetch.
- getOldSelection() - Method in class com.vaadin.flow.data.selection.MultiSelectionEvent
-
Gets the old selection.
- getOpposite() - Method in enum class com.vaadin.flow.data.provider.SortDirection
-
Get the sort direction that is the direct opposite to this one.
- getOrThrow(SerializableFunction<String, ? extends X>) - Method in interface com.vaadin.flow.data.binder.Result
-
Return the value, if the result denotes success, otherwise throw an exception to be created by the provided supplier.
- getPage() - Method in class com.vaadin.flow.data.provider.Query
-
Returns a zero-based page index to be retrieved.
- getPageSize() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Returns the page size set to fetch items.
- getPageSize() - Method in class com.vaadin.flow.data.provider.Query
-
Returns the page size that should be returned.
- getParent() - Method in class com.vaadin.flow.data.binder.BeanPropertySet.NestedBeanPropertyDefinition
- getParent() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the parent property of this property if this is a sub-property of the property set.
- getParent() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery
-
Get the hierarchical parent object, where
null
corresponds to the root node. - getParent(T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Get the parent item for the given item.
- getParentIndex(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns parent index for the row or
null
. - getParentIndex(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Finds the index of the parent of the item in given target index.
- getParentItem(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns parent item for the row or
null
. - getParentOfItem(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Find parent for the given item among open folders.
- getParentOptional() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery
-
Get an Optional of the hierarchical parent object.
- getPassivatedKeys(Set<String>) - Method in class com.vaadin.flow.data.provider.DataCommunicator
- getPassivatedKeys(Set<String>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- getPreviousItem(T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- getPreviousItem(T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Gets the item before given item from the filtered and sorted data.
- getProperties() - Method in class com.vaadin.flow.data.binder.BeanPropertySet
- getProperties() - Method in interface com.vaadin.flow.data.binder.PropertySet
-
Gets all known properties as a stream.
- getProperty(String) - Method in class com.vaadin.flow.data.binder.BeanPropertySet
- getProperty(String) - Method in interface com.vaadin.flow.data.binder.PropertySet
-
Gets the definition for the named property, or an empty optional if there is no property with the given name.
- getPropertyHolderType() - Method in class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
- getPropertyHolderType() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the type of the class containing this property.
- getPropertySet() - Method in class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
- getPropertySet() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the
PropertySet
that this property belongs to. - getQuery(Component) - Static method in class com.vaadin.flow.data.provider.DataViewUtils
-
Generates a data query with component's in-memory filter and sort comparator.
- getQuery(Component, boolean) - Static method in class com.vaadin.flow.data.provider.DataViewUtils
-
Generates a data query with component's in-memory filter and sort comparator, which is optionally included if
withSorting
is set totrue
. - getRemovedSelection() - Method in class com.vaadin.flow.data.selection.MultiSelectionEvent
-
Gets the items that were removed from selection.
- getRenderedComponent(String) - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
- getRequestedRangeEnd() - Method in class com.vaadin.flow.data.provider.Query
-
Gets the requested range end.
- getRequiredConfigurator() - Method in class com.vaadin.flow.data.binder.BeanValidationBinder
-
Gets field required indicator configuration logic.
- getResult() - Method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Gets the validation result if status is either
BindingValidationStatus.Status.OK
orBindingValidationStatus.Status.ERROR
or an empty optional if status isBindingValidationStatus.Status.UNRESOLVED
. - getRootItems() - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Gets the root items of this structure.
- getRootSize() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Returns the size of root level.
- getSelectedItem() - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
-
Returns the currently selected item, or an empty optional if no item is selected.
- getSelectedItem() - Method in class com.vaadin.flow.data.selection.SingleSelectionEvent
-
Returns an optional of the item that was selected, or an empty optional if a previously selected item was deselected.
- getSelectedItems() - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Returns an immutable set of the currently selected items.
- getSelectedItems() - Method in interface com.vaadin.flow.data.selection.SelectionModel
-
Returns an immutable set of the currently selected items.
- getSelectedItems() - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
-
Returns a singleton set of the currently selected item or an empty set if no item is selected.
- getSetter() - Method in class com.vaadin.flow.data.binder.BeanPropertySet.NestedBeanPropertyDefinition
- getSetter() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Gets the setter associated with this Binding.
- getSetter() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- getSetter() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets an optional setter for storing a property value in a bean.
- getSortComparator() - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
- getSortComparator() - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Gets the current sort comparator of this data provider.
- getSortComparator() - Method in class com.vaadin.flow.data.provider.ListDataProvider
- getSorted() - Method in class com.vaadin.flow.data.provider.SortOrder
-
Sorting information.
- getSortingComparator() - Method in class com.vaadin.flow.data.provider.Query
-
Gets the optional comparator for sorting data.
- getSortOrder() - Method in class com.vaadin.flow.data.event.SortEvent
-
Gets the sort order list.
- getSortOrders() - Method in class com.vaadin.flow.data.provider.Query
-
Gets the sorting for items to fetch.
- getSource() - Method in class com.vaadin.flow.data.binder.StatusChangeEvent
- getSource() - Method in class com.vaadin.flow.data.binder.ValidationStatusChangeEvent
- getSource() - Method in class com.vaadin.flow.data.provider.DataChangeEvent
- getSource() - Method in interface com.vaadin.flow.data.selection.SelectionEvent
-
The component on which the Event initially occurred.
- getSource() - Method in class com.vaadin.flow.data.selection.SingleSelectionEvent
-
The listing component on which the Event initially occurred.
- getStatus() - Method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Gets status of the validation.
- getStatusLabel() - Method in class com.vaadin.flow.data.binder.Binder
-
Gets the status label or an empty optional if none has been set.
- getSupportedDataProviderType() - Method in class com.vaadin.flow.data.provider.AbstractDataView
-
Returns supported
DataProvider
type for thisDataView
. - getSupportedDataProviderType() - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- getSupportedDataProviderType() - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- getThemes(HasValue<?, ?>) - Method in class com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler
-
Gets themes for the
field
. - getTopLevelName() - Method in class com.vaadin.flow.data.binder.BeanPropertySet.NestedBeanPropertyDefinition
- getTopLevelName() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the top level name of this property.
- getTreeData() - Method in interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider
-
Gets the backing
TreeData
instance of the data provider, if the data provider is aTreeDataProvider
. - getTreeData() - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
-
Return the underlying hierarchical data of this provider.
- getTreeSize() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Returns the size of the currently expanded hierarchy.
- getTrueString(Locale) - Method in class com.vaadin.flow.data.converter.StringToBooleanConverter
-
Gets the locale-depended string representation for true.
- getType() - Method in class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
- getType() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets the type of this property.
- getValidationErrorHandler() - Method in class com.vaadin.flow.data.binder.Binder
-
Gets the validation error of this form.
- getValidationErrors() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets both field and bean level validation errors.
- getValidationErrors() - Method in exception com.vaadin.flow.data.binder.ValidationException
-
Gets both field and bean level validation errors.
- getValidationResults() - Method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Gets all the validation results related to this binding validation status.
- getValidationStatusHandler() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Gets the validation status handler for this Binding.
- getValidationStatusHandler() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- getValidationStatusHandler() - Method in class com.vaadin.flow.data.binder.Binder
-
Gets the status handler of this form.
- getValue() - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- getValue() - Method in interface com.vaadin.flow.data.selection.MultiSelect
- getValue() - Method in class com.vaadin.flow.data.selection.MultiSelectionEvent
-
Gets the current selection.
- getValueChangeMode() - Method in interface com.vaadin.flow.data.value.HasValueChangeMode
-
Gets current value change mode of the component.
- getValueChangeTimeout() - Method in interface com.vaadin.flow.data.value.HasValueChangeMode
-
Returns the currently set timeout, for how often
HasValue.ValueChangeEvent
s are triggered when the ValueChangeMode is set toLAZY
, orTIMEOUT
.
H
- handle(SerializableConsumer<R>, SerializableConsumer<String>) - Method in interface com.vaadin.flow.data.binder.Result
-
Invokes either the first callback or the second one, depending on whether this Result denotes a success or a failure, respectively.
- handleBinderValidationStatus(BinderValidationStatus<BEAN>) - Method in class com.vaadin.flow.data.binder.Binder
-
The default binder level status handler.
- handleDataRefreshEvent(DataChangeEvent.DataRefreshEvent<T>) - Method in class com.vaadin.flow.data.provider.DataCommunicator
- handleDataRefreshEvent(DataChangeEvent.DataRefreshEvent<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- handleError(HasValue<?, ?>, ValidationResult) - Method in class com.vaadin.flow.data.binder.Binder
-
Handles a validation error emitted when trying to write the value of the given field.
- handleError(HasValue<?, ?>, ValidationResult) - Method in interface com.vaadin.flow.data.binder.BinderValidationErrorHandler
-
Handles a validation error emitted when trying to write the value of the given field.
- handleError(HasValue<?, ?>, ValidationResult) - Method in class com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler
-
Handles a validation error emitted when trying to write the value of the given field.
- handleException(HasValue<?, ?>, Exception) - Method in interface com.vaadin.flow.data.binder.BindingExceptionHandler
-
Produces a
BindingException
instance based on originalexception
and field as a subject of the exception. - handleException(HasValue<?, ?>, Exception) - Method in class com.vaadin.flow.data.binder.DefaultBindingExceptionHandler
- handleFieldValueChange(Binder.Binding<BEAN, ?>) - Method in class com.vaadin.flow.data.binder.Binder
-
Informs the Binder that a value in Binding was changed.
- handleValidationStatus(BindingValidationStatus<?>) - Method in class com.vaadin.flow.data.binder.Binder
-
Default
BindingValidationStatusHandler
functional method implementation. - has(T) - Method in interface com.vaadin.flow.data.provider.DataKeyMapper
-
Check whether this key mapper contains the given data object.
- has(V) - Method in class com.vaadin.flow.data.provider.KeyMapper
- hasChanges() - Method in class com.vaadin.flow.data.binder.Binder
-
Check whether any of the bound fields' have uncommitted changes since last explicit call to
Binder.readBean(Object)
,Binder.removeBean()
,Binder.writeBean(Object)
orBinder.writeBeanIfValid(Object)
. - hasChildren(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns whether given item has children.
- hasChildren(T) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
-
Check whether a given item has any children associated with it.
- hasChildren(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Returns whether given item has children.
- hasChildren(T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
- HasDataGenerators<T> - Interface in com.vaadin.flow.data.provider
-
Defines the contract of adding and removing multiple
DataGenerator
s to a given object. - HasDataProvider<T> - Interface in com.vaadin.flow.data.binder
-
A generic interface for listing components that use a data provider for showing data.
- HasDataView<T,
F, V extends DataView<T>> - Interface in com.vaadin.flow.data.provider -
An interface for components that get items from the generic data provider types
DataProvider
andInMemoryDataProvider
. - hasErrors() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets whether the validation for the binder failed or not.
- hasExpandedItems() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns true if there is any expanded items.
- hasExpandedItems() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Returns true if there is any expanded items.
- HasFilterableDataProvider<T,
F> - Interface in com.vaadin.flow.data.binder -
A generic interface for listing components that use a filterable data provider for showing data.
- hashCode() - Method in class com.vaadin.flow.data.binder.ValidationResult.SimpleValidationResult
- hashCode() - Method in class com.vaadin.flow.data.provider.DataCommunicator.Filter
- HasHierarchicalDataProvider<T> - Interface in com.vaadin.flow.data.provider.hierarchy
-
A generic interface for hierarchical listing components that use a data provider for showing hierarchical data.
- HasItemComponents<T> - Interface in com.vaadin.flow.data.binder
-
Represents a component that can have additional components between the items.
- HasItemComponents.ItemComponent<T> - Interface in com.vaadin.flow.data.binder
-
Represents a single item component that is used inside a
HasItemComponents
. - HasItems<T> - Interface in com.vaadin.flow.data.binder
-
Mixin interface for components that displays a collection of items.
- HasItemsAndComponents<T> - Interface in com.vaadin.flow.data.binder
-
Represents a component that display a collection of items and can have additional components between the items.
- HasLazyDataView<T,
F, V extends LazyDataView<T>> - Interface in com.vaadin.flow.data.provider -
Interface that defines methods for fetching items lazily from a backend.
- HasListDataView<T,
V extends ListDataView<T, ?>> - Interface in com.vaadin.flow.data.provider -
An interface for components that accept setting items in-memory and returns a
ListDataView
that provides information and allows operations on the items. - hasValidationErrors() - Method in class com.vaadin.flow.data.binder.StatusChangeEvent
-
Gets the associated validation status.
- HasValidator<V> - Interface in com.vaadin.flow.data.binder
-
A generic interface for field components and other user interface objects that have a user-editable value that should be validated.
- HasValueChangeMode - Interface in com.vaadin.flow.data.value
-
Denotes that the component is able to change the way its value on the client side is synchronized with the server side.
- hasZeroSize(Object) - Static method in class com.vaadin.flow.data.binder.RequiredFieldConfiguratorUtil
-
Checks whether the given object would be considered empty according to the
Size
constraint. - HierarchicalArrayUpdater - Interface in com.vaadin.flow.data.provider.hierarchy
-
Hierarchical array update strategy aware class.
- HierarchicalArrayUpdater.HierarchicalUpdate - Interface in com.vaadin.flow.data.provider.hierarchy
-
Array updater strategy that is aware of hierarchical changes.
- HierarchicalCommunicationController<T> - Class in com.vaadin.flow.data.provider.hierarchy
-
HierarchicalCommunicationController controls all the communication to client.
- HierarchicalCommunicationController(String, DataKeyMapper<T>, HierarchyMapper<T, ?>, DataGenerator<T>, SerializableFunction<Integer, HierarchicalArrayUpdater.HierarchicalUpdate>, SerializableBiFunction<String, Range, Stream<T>>) - Constructor for class com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController
-
Constructs communication controller with support for hierarchical data structure.
- HierarchicalConfigurableFilterDataProvider<T,
Q, C> - Interface in com.vaadin.flow.data.provider.hierarchy -
A hierarchical data provider that supports programmatically setting a filter that will be applied to all queries.
- HierarchicalDataCommunicator<T> - Class in com.vaadin.flow.data.provider.hierarchy
-
Data communicator that handles requesting hierarchical data from
HierarchicalDataProvider
and sending it to client side. - HierarchicalDataCommunicator(CompositeDataGenerator<T>, HierarchicalArrayUpdater, SerializableConsumer<JsonArray>, StateNode, SerializableSupplier<ValueProvider<T, String>>) - Constructor for class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Construct a new hierarchical data communicator backed by a
TreeDataProvider
. - HierarchicalDataProvider<T,
F> - Interface in com.vaadin.flow.data.provider.hierarchy -
A common interface for fetching hierarchical data from a data source, such as an in-memory collection or a backend database.
- HierarchicalQuery<T,
F> - Class in com.vaadin.flow.data.provider.hierarchy -
Immutable hierarchical query object used to request data from a backend.
- HierarchicalQuery(int, int, List<QuerySortOrder>, Comparator<T>, F, T) - Constructor for class com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery
-
Constructs a new hierarchical query object with given offset, limit, sorting and filtering.
- HierarchicalQuery(F, T) - Constructor for class com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery
-
Constructs a new hierarchical query object with given filter and parent node.
- HierarchyMapper<T,
F> - Class in com.vaadin.flow.data.provider.hierarchy -
Mapper for hierarchical data.
- HierarchyMapper(HierarchicalDataProvider<T, F>) - Constructor for class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Constructs a new HierarchyMapper.
I
- IdentifierProvider<T> - Interface in com.vaadin.flow.data.provider
-
A callback interface that is used to provide the identifier of an item.
- IdentifierProviderChangeEvent<T,
C extends Component> - Class in com.vaadin.flow.data.provider -
Event notifying the component that its identifier provider has been changed through a data view.
- IdentifierProviderChangeEvent(C, IdentifierProvider<T>) - Constructor for class com.vaadin.flow.data.provider.IdentifierProviderChangeEvent
-
Creates a new event using the given source and the new identifier provider.
- identity() - Static method in interface com.vaadin.flow.data.converter.Converter
-
Returns a converter that returns its input as-is in both directions.
- identity() - Static method in interface com.vaadin.flow.data.provider.IdentifierProvider
-
Returns an identifier provider that always returns its input argument.
- ifError(SerializableConsumer<String>) - Method in interface com.vaadin.flow.data.binder.Result
-
Applies the
consumer
if result is an error. - ifOk(SerializableConsumer<R>) - Method in interface com.vaadin.flow.data.binder.Result
-
Applies the
consumer
if result is not an error. - INFO - Enum constant in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Error level for informational messages.
- initialize() - Method in interface com.vaadin.flow.data.provider.ArrayUpdater
-
Initialize the array.
- InMemoryDataProvider<T> - Interface in com.vaadin.flow.data.provider
-
A mixin interface for in-memory data providers.
- InMemoryDataProviderHelpers - Class in com.vaadin.flow.data.provider
-
Helper methods for implementing
InMemoryDataProvider
s. - INSTANCE - Enum constant in enum class com.vaadin.flow.data.converter.DefaultConverterFactory
- IntegerRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that an
Integer
is inside a given range. - IntegerRangeValidator(String, Integer, Integer) - Constructor for class com.vaadin.flow.data.validator.IntegerRangeValidator
-
Creates a validator for checking that an Integer is within a given range.
- intValue() - Method in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Integer representation of error severity for comparison.
- isAsRequiredEnabled() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Returns whether asRequired validator is currently enabled or not.
- isAsRequiredEnabled() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- isConvertBackToPresentation() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Returns whether the value is converted back to the presentation in the field when a converter is used in binding.
- isConvertBackToPresentation() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- isDefinedSize() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Returns whether defined or undefined size is used.
- isDeselectAllowed() - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
-
Gets whether it's allowed to deselect the selected row through the UI.
- isError() - Method in class com.vaadin.flow.data.binder.BindingValidationStatus
-
Gets whether the validation failed or not.
- isError() - Method in interface com.vaadin.flow.data.binder.Result
-
Checks if the result denotes an error.
- isError() - Method in interface com.vaadin.flow.data.binder.ValidationResult
-
Checks if the result denotes an error.
- isExpanded(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Returns whether given item is expanded.
- isExpanded(T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Returns whether the given item is expanded.
- isFetchEnabled() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Returns whether the data communicator will call Data Provider for fetching the items and/or getting the items count, or ignore such a calls.
- isFieldsValidationStatusChangeListenerEnabled() - Method in class com.vaadin.flow.data.binder.Binder
-
Returns if the bound fields implementing
HasValidator
subscribe for field'sValidationStatusChangeEvent
s and willvalidate
upon receiving them. - isFromClient() - Method in interface com.vaadin.flow.data.selection.SelectionEvent
-
Checks if this event originated from the client side.
- isGenericType() - Method in class com.vaadin.flow.data.binder.AbstractBeanPropertyDefinition
- isGenericType() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets whether the type of this property references a generic type (thus
PropertyDefinition.getType()
will returnObject
) or a concrete type. - isInMemory() - Method in interface com.vaadin.flow.data.provider.BackEndDataProvider
- isInMemory() - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Gets whether the DataProvider content all available in memory or does it use some external backend.
- isInMemory() - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
- isInMemory() - Method in class com.vaadin.flow.data.provider.hierarchy.AbstractBackEndHierarchicalDataProvider
- isInMemory() - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
- isItemActive(T) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Returns whether the given item is part of the active items.
- isItemCountEstimated() - Method in class com.vaadin.flow.data.provider.ItemCountChangeEvent
-
Returns whether the item count
ItemCountChangeEvent.getItemCount()
is an estimate or the exact count. - isMaxValueIncluded() - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Returns whether the maximum value is part of the accepted range.
- isMinValueIncluded() - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Returns whether the minimum value is part of the accepted range.
- isNotifyOnChange() - Method in class com.vaadin.flow.data.provider.DataCommunicator.Filter
-
Returns whether to fire the item change event or not upon filter changing.
- isOk() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Gets whether validation for the binder passed or not.
- isPagingEnabled() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Returns whether paged queries are enabled or not.
- isReadOnly() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Gets the current read-only status for this Binding.
- isReadOnly() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- isReadOnly() - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- isRefreshChildren() - Method in class com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent
-
Gets the a boolean whether the refresh is supposed to be refreshChildren (in hierarchical data providers).
- isRequiredIndicatorVisible() - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- isSelected(T) - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Returns whether the given item is currently selected.
- isSelected(T) - Method in interface com.vaadin.flow.data.selection.SelectionModel
-
Returns whether the given item is currently selected.
- isSubProperty() - Method in interface com.vaadin.flow.data.binder.PropertyDefinition
-
Gets whether this property belongs to some other property in the property set, or directly to the property set.
- isValid() - Method in class com.vaadin.flow.data.binder.Binder
-
Runs all currently configured field level validators, as well as all bean level validators if a bean is currently set with
Binder.setBean(Object)
, and returns whether any of the validators failed. - isValid(String) - Method in class com.vaadin.flow.data.validator.EmailValidator
- isValid(String) - Method in class com.vaadin.flow.data.validator.RegexpValidator
-
Returns whether the given string matches the regular expression.
- isValid(T) - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Returns whether the given value lies in the valid range.
- isValidatorsDisabled() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Returns if validators are currently disabled or not.
- isValidatorsDisabled() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- isValidatorsDisabled() - Method in class com.vaadin.flow.data.binder.Binder
-
Returns if the validators including bean level validators are disabled or enabled for this Binder.
- itemCountChanged(ItemCountChangeEvent) - Method in interface com.vaadin.flow.data.provider.ItemCountChangeListener
-
Invoked for changes in the data size.
- ItemCountChangeEvent<T extends Component> - Class in com.vaadin.flow.data.provider
-
Event describing the item count change for a component.
- ItemCountChangeEvent(T, int, boolean) - Constructor for class com.vaadin.flow.data.provider.ItemCountChangeEvent
-
Creates a new event using the given source and indicator whether the event originated from the client side or the server side.
- ItemCountChangeListener - Interface in com.vaadin.flow.data.provider
-
Listener interface for getting updates on data item count changes.
K
- key(T) - Method in interface com.vaadin.flow.data.provider.DataKeyMapper
-
Gets the key for data object.
- key(V) - Method in class com.vaadin.flow.data.provider.KeyMapper
-
Gets key for an object.
- KeyMapper<V> - Class in com.vaadin.flow.data.provider
-
KeyMapper
is the simple two-way map for generating textual keys for objects and retrieving the objects later with the key. - KeyMapper() - Constructor for class com.vaadin.flow.data.provider.KeyMapper
-
Constructs a new mapper with trivial
identifierGetter
- KeyMapper(ValueProvider<V, Object>) - Constructor for class com.vaadin.flow.data.provider.KeyMapper
-
Constructs a new mapper.
L
- LAZY - Enum constant in enum class com.vaadin.flow.data.value.ValueChangeMode
-
On every user event, schedule a synchronization after a defined interval, cancelling the currently-scheduled event if any.
- LazyDataView<T> - Interface in com.vaadin.flow.data.provider
-
DataView for lazy loaded data.
- ListDataProvider<T> - Class in com.vaadin.flow.data.provider
-
DataProvider
wrapper forCollection
s. - ListDataProvider(Collection<T>) - Constructor for class com.vaadin.flow.data.provider.ListDataProvider
-
Constructs a new ListDataProvider.
- ListDataView<T,
V extends ListDataView<T, ?>> - Interface in com.vaadin.flow.data.provider -
DataView for a in-memory list data that provides information on the data and allows operations on it.
- LocalDateTimeToDateConverter - Class in com.vaadin.flow.data.converter
-
A converter that converts between
LocalDateTime
andDate
. - LocalDateTimeToDateConverter(ZoneId) - Constructor for class com.vaadin.flow.data.converter.LocalDateTimeToDateConverter
-
Creates a new converter using the given time zone.
- LocalDateTimeToInstantConverter - Class in com.vaadin.flow.data.converter
-
A converter that converts between
LocalDateTime
andInstant
. - LocalDateTimeToInstantConverter(ZoneId) - Constructor for class com.vaadin.flow.data.converter.LocalDateTimeToInstantConverter
-
Creates a new converter using the given time zone.
- LocalDateToDateConverter - Class in com.vaadin.flow.data.converter
-
A converter that converts between
LocalDate
andDate
. - LocalDateToDateConverter() - Constructor for class com.vaadin.flow.data.converter.LocalDateToDateConverter
-
Creates a new converter using the system's default time zone.
- LocalDateToDateConverter(ZoneId) - Constructor for class com.vaadin.flow.data.converter.LocalDateToDateConverter
-
Creates a new converter using the given time zone.
- LongRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that an
Long
is inside a given range. - LongRangeValidator(String, Long, Long) - Constructor for class com.vaadin.flow.data.validator.LongRangeValidator
-
Creates a validator for checking that an Long is within a given range.
M
- map(SerializableFunction<R, S>) - Method in interface com.vaadin.flow.data.binder.Result
-
If this Result has a value, returns a Result of applying the given function to the value.
- MAX_PROPERTY_NESTING_DEPTH - Static variable in class com.vaadin.flow.data.binder.BeanPropertySet.NestedBeanPropertyDefinition
-
Default maximum depth for scanning nested properties.
- moveAfterSibling(T, T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Moves an item to the position immediately after a sibling item.
- MultiSelect<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
Multi selection component which allows to select and deselect multiple items.
- MultiSelectionEvent<C extends Component,
T> - Class in com.vaadin.flow.data.selection -
Fired when the selection changes in a listing component that supports multiple item selection.
- MultiSelectionEvent(C, HasValue<AbstractField.ComponentValueChangeEvent<C, Set<T>>, Set<T>>, Set<T>, boolean) - Constructor for class com.vaadin.flow.data.selection.MultiSelectionEvent
-
Creates a new multi selection change event in a component.
- MultiSelectionListener<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
A listener for listening for selection changes from a multiselection component.
N
- NestedBeanPropertyDefinition(BeanPropertySet<T>, PropertyDefinition<T, ?>, PropertyDescriptor) - Constructor for class com.vaadin.flow.data.binder.BeanPropertySet.NestedBeanPropertyDefinition
-
Creates a new instance of a nested property definition.
- newInstance(Class<P>, Class<M>) - Method in interface com.vaadin.flow.data.converter.ConverterFactory
-
Attempts to create a
Converter
instance, capable to handle conversion between the given presentation and model types. - newInstance(Class<P>, Class<M>) - Method in enum class com.vaadin.flow.data.converter.DefaultConverterFactory
- NOT_EMPTY - Static variable in interface com.vaadin.flow.data.binder.RequiredFieldConfigurator
-
Configurator which is aware of @NotEmpty annotation presence for a property where the default value is empty.
- NOT_NULL - Static variable in interface com.vaadin.flow.data.binder.RequiredFieldConfigurator
-
Configurator which is aware of @NotNull annotation presence for a property where the default value is
null
. - notifyBindingValidationStatusHandlers() - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Notifies all validation status handlers in bindings.
- notifyBindingValidationStatusHandlers(SerializablePredicate<BindingValidationStatus<?>>) - Method in class com.vaadin.flow.data.binder.BinderValidationStatus
-
Notifies validation status handlers for bindings that pass given filter.
- NULL_IDENTIFIER_ERROR_MESSAGE - Static variable in class com.vaadin.flow.data.provider.AbstractDataView
- NULL_ITEM_ERROR_MESSAGE - Static variable in class com.vaadin.flow.data.provider.AbstractDataView
O
- of(SerializableSupplier<R>, SerializableFunction<Exception, String>) - Static method in interface com.vaadin.flow.data.binder.Result
-
Returns a Result representing the result of invoking the given supplier.
- of(String, C, C) - Static method in class com.vaadin.flow.data.validator.RangeValidator
-
Returns a
RangeValidator
comparing values of aComparable
type using their natural order. - ofCollection(Collection<T>) - Static method in interface com.vaadin.flow.data.provider.DataProvider
-
Creates a new data provider backed by a collection.
- ofItems(T...) - Static method in interface com.vaadin.flow.data.provider.DataProvider
-
Creates a new data provider from the given items.
- ok() - Static method in interface com.vaadin.flow.data.binder.ValidationResult
-
Returns a successful result.
- ok(R) - Static method in interface com.vaadin.flow.data.binder.Result
-
Returns a successful result wrapping the given value.
- OK - Enum constant in enum class com.vaadin.flow.data.binder.BindingValidationStatus.Status
-
Validation passed.
- ON_BLUR - Enum constant in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Syncs the value to the server on
blur
event, i.e. - ON_CHANGE - Enum constant in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Syncs the value to the server on
change
event, i.e. - onDataChange(DataChangeEvent<T>) - Method in interface com.vaadin.flow.data.provider.DataProviderListener
-
Invoked when this listener receives a data change event from a data source to which it has been added.
P
- PATTERN - Static variable in class com.vaadin.flow.data.validator.EmailValidator
- prependComponents(T, Component...) - Method in interface com.vaadin.flow.data.binder.HasItemComponents
-
Adds the components before the given item.
- propertyComparator(ValueProvider<T, V>, SortDirection) - Static method in class com.vaadin.flow.data.provider.InMemoryDataProviderHelpers
-
Creates a comparator for the return type of the given
ValueProvider
, sorted in the direction specified by the givenSortDirection
. - PropertyDefinition<T,
V> - Interface in com.vaadin.flow.data.binder -
A property from a
PropertySet
. - PropertyFilterDefinition - Class in com.vaadin.flow.data.binder
-
Contains the constraints for filtering nested properties.
- PropertyFilterDefinition(int, List<String>) - Constructor for class com.vaadin.flow.data.binder.PropertyFilterDefinition
-
Create a property filter with max nesting depth and package names to ignore.
- PropertyId - Annotation Interface in com.vaadin.flow.data.binder
-
Defines the custom property name to be bound to a
field component
usingBinder
. - PropertySet<T> - Interface in com.vaadin.flow.data.binder
-
Describes a set of properties that can be used for configuration based on property names instead of setter and getter callbacks.
Q
- Query<T,
F> - Class in com.vaadin.flow.data.provider -
Immutable query object used to request data from a backend.
- Query() - Constructor for class com.vaadin.flow.data.provider.Query
-
Constructs a Query for all rows from 0 to
Integer.MAX_VALUE
without sorting and filtering. - Query(int, int, List<QuerySortOrder>, Comparator<T>, F) - Constructor for class com.vaadin.flow.data.provider.Query
-
Constructs a new Query object with given offset, limit, sorting and filtering.
- Query(F) - Constructor for class com.vaadin.flow.data.provider.Query
-
Constructs a Query for all rows from 0 to
Integer.MAX_VALUE
with filtering. - QuerySortOrder - Class in com.vaadin.flow.data.provider
-
Sorting information for
Query
. - QuerySortOrder(String, SortDirection) - Constructor for class com.vaadin.flow.data.provider.QuerySortOrder
-
Constructs sorting information for usage in a
Query
. - QuerySortOrderBuilder - Class in com.vaadin.flow.data.provider
-
Helper classes with fluent API for constructing
QuerySortOrder
lists. - QuerySortOrderBuilder() - Constructor for class com.vaadin.flow.data.provider.QuerySortOrderBuilder
R
- RangeValidator<T> - Class in com.vaadin.flow.data.validator
-
Verifies that a value is within the given range.
- RangeValidator(String, Comparator<? super T>, T, T) - Constructor for class com.vaadin.flow.data.validator.RangeValidator
-
Creates a new range validator of the given type.
- read(BEAN) - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Reads the value from given item and stores it to the bound field.
- read(BEAN) - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- readBean(BEAN) - Method in class com.vaadin.flow.data.binder.Binder
-
Reads the bound property values from the given bean to the corresponding fields.
- ReadOnlyHasValue<V> - Class in com.vaadin.flow.data.binder
-
Generic
HasValue
to use any type of component with Vaadin data binding. - ReadOnlyHasValue(SerializableConsumer<V>) - Constructor for class com.vaadin.flow.data.binder.ReadOnlyHasValue
-
Creates new
ReadOnlyHasValue
withnull
as an empty value. - ReadOnlyHasValue(SerializableConsumer<V>, V) - Constructor for class com.vaadin.flow.data.binder.ReadOnlyHasValue
-
Creates new
ReadOnlyHasValue
- refresh(T) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Informs the DataCommunicator that a data object has been updated.
- refresh(T) - Method in interface com.vaadin.flow.data.provider.DataKeyMapper
-
Updates any existing mappings of given data object.
- refresh(V) - Method in class com.vaadin.flow.data.provider.KeyMapper
- refreshAll() - Method in class com.vaadin.flow.data.provider.AbstractDataProvider
- refreshAll() - Method in class com.vaadin.flow.data.provider.AbstractDataView
- refreshAll() - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Refreshes all data based on currently available data in the underlying provider.
- refreshAll() - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
- refreshAll() - Method in interface com.vaadin.flow.data.provider.DataView
-
Notifies the component that all the items should be refreshed.
- refreshData(T) - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
- refreshData(T) - Method in class com.vaadin.flow.data.provider.CompositeDataGenerator
- refreshData(T) - Method in interface com.vaadin.flow.data.provider.DataGenerator
-
Informs the
DataGenerator
that a data object has been updated. - refreshFields() - Method in class com.vaadin.flow.data.binder.Binder
-
Refreshes the fields values by reading them again from the currently associated bean via invoking their corresponding value provider methods.
- refreshItem(T) - Method in class com.vaadin.flow.data.provider.AbstractDataProvider
- refreshItem(T) - Method in class com.vaadin.flow.data.provider.AbstractDataView
- refreshItem(T) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Refreshes the given item.
- refreshItem(T) - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
- refreshItem(T) - Method in interface com.vaadin.flow.data.provider.DataView
-
Notifies the component that the item has been updated and thus should be refreshed.
- refreshItem(T, boolean) - Method in class com.vaadin.flow.data.provider.AbstractDataProvider
- refreshItem(T, boolean) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Refreshes the given item and all of the children of the item as well.
- RegexpValidator - Class in com.vaadin.flow.data.validator
-
A string validator comparing the string against a Java regular expression.
- RegexpValidator(String, String) - Constructor for class com.vaadin.flow.data.validator.RegexpValidator
-
Creates a validator for checking that the regular expression matches the complete string to validate.
- RegexpValidator(String, String, boolean) - Constructor for class com.vaadin.flow.data.validator.RegexpValidator
-
Creates a validator for checking that the regular expression matches the string to validate.
- registerChildren(T, List<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Register parent and children items into inner structures.
- registerRenderedComponent(String, Component) - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
-
Appends the component to the container and registers it for future use during the lifecycle of the generator.
- remove(T) - Method in interface com.vaadin.flow.data.provider.DataKeyMapper
-
Removes a data object from the key mapping.
- remove(V) - Method in class com.vaadin.flow.data.provider.KeyMapper
-
Removes object from the mapper.
- removeAll() - Method in interface com.vaadin.flow.data.provider.DataKeyMapper
-
Removes all data objects from the key mapping.
- removeAll() - Method in class com.vaadin.flow.data.provider.KeyMapper
-
Removes all objects from the mapper.
- removeBean() - Method in class com.vaadin.flow.data.binder.Binder
-
Removes the currently set bean and clears bound fields.
- removeBinding(HasValue<?, ?>) - Method in class com.vaadin.flow.data.binder.Binder
-
Finds and removes all Bindings for the given field.
- removeBinding(Binder.Binding<BEAN, ?>) - Method in class com.vaadin.flow.data.binder.Binder
-
Removes the given Binding from this Binder.
- removeBinding(String) - Method in class com.vaadin.flow.data.binder.Binder
-
Finds and removes the Binding for the given property name.
- removeBindingInternal(Binder.Binding<BEAN, ?>) - Method in class com.vaadin.flow.data.binder.Binder
-
Removes (internally) the
Binding
from the bound properties map (if present) and from the list ofBinding
s. - removeChildren(Object) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Removes all children of an item identified by a given id.
- removeComponentFilterAndSortComparator(Component) - Static method in class com.vaadin.flow.data.provider.DataViewUtils
-
Removes the in-memory filter and sort comparator from a given component instance.
- removeFilters() - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- removeFilters() - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Removes all in-memory filters set or added.
- removeItem(T) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- removeItem(T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Remove a given item from this structure.
- removeItem(T) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Remove an item from the data list.
- removeItems(Collection<T>) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- removeItems(Collection<T>) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Remove multiple items from the data list.
- removeSorting() - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- removeSorting() - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Removes any default sorting that has been set or added previously.
- RequiredFieldConfigurator - Interface in com.vaadin.flow.data.binder
-
This interface represents a predicate which returns
true
if bound field should be configured to have required indicator viaHasValue.setRequiredIndicatorVisible(boolean)
. - RequiredFieldConfiguratorUtil - Class in com.vaadin.flow.data.binder
-
Helper methods used by
RequiredFieldConfigurator
. - reset() - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Resets all the data.
- reset() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Resets all the data.
- restoreBeanState(BEAN, Map<Binder.Binding<BEAN, ?>, Object>) - Method in class com.vaadin.flow.data.binder.Binder
-
Restores the state of the bean from the given values.
- Result<R> - Interface in com.vaadin.flow.data.binder
-
Represents the result of an operation that might fail, such as type conversion.
S
- select(Iterable<T>) - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Adds the given items to the set of currently selected items.
- select(T) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Multi
-
Adds the given item to the set of currently selected items.
- select(T) - Method in interface com.vaadin.flow.data.selection.SelectionModel
-
Selects the given item.
- select(T) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
-
Selects the given item.
- select(T...) - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Adds the given items to the set of currently selected items.
- selectAll() - Method in interface com.vaadin.flow.data.selection.SelectionModel.Multi
-
Selects all available the items.
- selectionChange(MultiSelectionEvent<C, T>) - Method in interface com.vaadin.flow.data.selection.MultiSelectionListener
-
Invoked when the selection has changed by the user or programmatically.
- selectionChange(SelectionEvent<C, T>) - Method in interface com.vaadin.flow.data.selection.SelectionListener
-
Invoked when the selection has changed.
- selectionChange(SingleSelectionEvent<C, T>) - Method in interface com.vaadin.flow.data.selection.SingleSelectionListener
-
Invoked when selection has been changed.
- SelectionEvent<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
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> - Interface in com.vaadin.flow.data.selection -
A listener for
SelectionEvent
. - SelectionModel<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
Models the selection logic of a
Listing
component. - SelectionModel.Multi<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
A selection model in which multiple items can be selected at the same time.
- SelectionModel.Single<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
A selection model in which at most one item can be selected at a time.
- selectItems(T...) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Multi
-
Adds the given items to the set of currently selected items.
- set(int, List<JsonValue>) - Method in interface com.vaadin.flow.data.provider.ArrayUpdater.Update
-
Sets the
items
at thestart
position. - set(int, List<JsonValue>, String) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalArrayUpdater.HierarchicalUpdate
-
Sets the
items
at thestart
position. - setAsRequiredEnabled(boolean) - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Enable or disable asRequired validator.
- setAsRequiredEnabled(boolean) - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- setBackEndSorting(List<QuerySortOrder>) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the
QuerySortOrder
s to use with backend sorting. - setBackEndSorting(List<QuerySortOrder>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- setBackEndSorting(List<QuerySortOrder>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Sets the current back-end sorting.
- setBean(BEAN) - Method in class com.vaadin.flow.data.binder.Binder
-
Binds the given bean to all the fields added to this Binder.
- setBindingExceptionHandler(BindingExceptionHandler) - Method in class com.vaadin.flow.data.binder.Binder
-
Sets a
handler
to customize theRuntimeException
thrown by delegates (likeSetter
,ValueProvider
,HasValue
) used insideBinder
to be able to identify the bound field. - setComponentFilter(Component, SerializablePredicate<T>) - Static method in class com.vaadin.flow.data.provider.DataViewUtils
-
Sets the in-memory filter to a given component instance.
- setComponentSortComparator(Component, SerializableComparator<T>) - Static method in class com.vaadin.flow.data.provider.DataViewUtils
-
Sets the in-memory sort comparator to a given component instance.
- setConvertBackToPresentation(boolean) - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Define whether the value should be converted back to the presentation in the field when a converter is used in binding.
- setConvertBackToPresentation(boolean) - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- setCountCallback(CallbackDataProvider.CountCallback<T, ?>) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the size callback to be used and switches the component to exact row count.
- setDataProvider(DataProvider<T, ?>) - Method in interface com.vaadin.flow.data.binder.HasDataProvider
-
Sets the data provider for this listing.
- setDataProvider(DataProvider<T, C>, SerializableFunction<F, C>) - Method in interface com.vaadin.flow.data.binder.HasFilterableDataProvider
-
Sets the data provider and filter converter for this listing.
- setDataProvider(DataProvider<T, F>) - Method in interface com.vaadin.flow.data.binder.HasFilterableDataProvider
-
Sets the data provider for this listing.
- setDataProvider(DataProvider<T, F>, F) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the current data provider for this DataCommunicator.
- setDataProvider(DataProvider<T, F>, F) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Set the current hierarchical data provider for this communicator.
- setDataProvider(DataProvider<T, F>, F, boolean) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the current data provider for this DataCommunicator.
- setDataProvider(HierarchicalDataProvider<T, ?>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider
-
Sets the hierarchical data provider for this listing.
- setDataProvider(HierarchicalDataProvider<T, F>, F) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
-
Set the current hierarchical data provider for this communicator.
- setDefinedSize(boolean) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Changes between defined and undefined size and clears any previously set count callback.
- setDeselectAllowed(boolean) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
-
Sets whether it's allowed to deselect the selected row through the UI.
- setErrorTheme(HasValue<?, ?>, ValidationResult) - Method in class com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler
-
Sets error theme for the
field
based onresult
. - setFetchEnabled(boolean) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets whether the data communicator will call Data Provider for fetching the items and/or getting the items count, or ignore such a calls.
- setFieldsValidationStatusChangeListenerEnabled(boolean) - Method in class com.vaadin.flow.data.binder.Binder
-
Control whether bound fields implementing
HasValidator
subscribe for field'sValidationStatusChangeEvent
s and willvalidate
upon receiving them. - setFilter(C) - Method in interface com.vaadin.flow.data.provider.ConfigurableFilterDataProvider
-
Sets the filter to use for all queries handled by this data provider.
- setFilter(C) - Method in class com.vaadin.flow.data.provider.ConfigurableFilterDataProviderWrapper
- setFilter(SerializablePredicate<T>) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- setFilter(SerializablePredicate<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
- setFilter(SerializablePredicate<T>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Sets a filter to be applied to all queries.
- setFilter(SerializablePredicate<T>) - Method in class com.vaadin.flow.data.provider.ListDataProvider
- setFilter(SerializablePredicate<T>) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Sets a filter to be applied to the data.
- setFilter(ValueProvider<T, V>, SerializablePredicate<V>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Sets a filter for an item property.
- setFilter(F) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- setFilter(Object) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Sets the current filter.
- setFilterByValue(ValueProvider<T, V>, V) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Sets a filter that requires an item property to have a specific value.
- setIdentifierGetter(ValueProvider<T, Object>) - Method in interface com.vaadin.flow.data.provider.DataKeyMapper
-
Takes identifier getter into use and updates existing mappings
- setIdentifierGetter(ValueProvider<V, Object>) - Method in class com.vaadin.flow.data.provider.KeyMapper
- setIdentifierProvider(IdentifierProvider<T>) - Method in class com.vaadin.flow.data.provider.AbstractDataView
- setIdentifierProvider(IdentifierProvider<T>) - Method in interface com.vaadin.flow.data.provider.DataView
-
Sets an identifier provider, which returns an identifier for the given item.
- setInMemorySorting(SerializableComparator<T>) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the
Comparator
to use with in-memory sorting. - setInMemorySorting(SerializableComparator<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- setInMemorySorting(Comparator<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchyMapper
-
Sets the current in-memory sorting.
- setItemCountEstimate(int) - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- setItemCountEstimate(int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the item count estimate to use and switches component to undefined size.
- setItemCountEstimate(int) - Method in interface com.vaadin.flow.data.provider.LazyDataView
-
Sets the estimated item count for the component.
- setItemCountEstimateIncrease(int) - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- setItemCountEstimateIncrease(int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the item count estimate increase to use and switches the component to undefined size if not yet used.
- setItemCountEstimateIncrease(int) - Method in interface com.vaadin.flow.data.provider.LazyDataView
-
Sets how much the item count estimate is increased once the previous item count estimate has been reached.
- setItemCountFromDataProvider() - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- setItemCountFromDataProvider() - Method in interface com.vaadin.flow.data.provider.LazyDataView
-
Switches the component to get the exact item count from the data provider's
DataProvider.size(Query)
. - setItemCountUnknown() - Method in class com.vaadin.flow.data.provider.AbstractLazyDataView
- setItemCountUnknown() - Method in interface com.vaadin.flow.data.provider.LazyDataView
-
Switches the component to automatically extend the number of items as the previous end is almost reached.
- setItems(BackEndDataProvider<T, F>) - Method in interface com.vaadin.flow.data.provider.HasLazyDataView
-
Supply items with a
BackEndDataProvider
that lazy loads items from a backend. - setItems(CallbackDataProvider.FetchCallback<T, F>) - Method in interface com.vaadin.flow.data.provider.HasLazyDataView
-
Supply items lazily with a callback from a backend.
- setItems(CallbackDataProvider.FetchCallback<T, F>, CallbackDataProvider.CountCallback<T, F>) - Method in interface com.vaadin.flow.data.provider.HasLazyDataView
-
Supply items lazily with callbacks: the first one fetches the items based on offset, limit and an optional filter, the second provides the exact count of items in the backend.
- setItems(DataProvider<T, F>) - Method in interface com.vaadin.flow.data.provider.HasDataView
-
Set a generic data provider for the component to use and returns the base
DataView
that provides API to get information on the items. - setItems(InMemoryDataProvider<T>) - Method in interface com.vaadin.flow.data.provider.HasDataView
-
Sets an in-memory data provider for the component to use
- setItems(ListDataProvider<T>) - Method in interface com.vaadin.flow.data.provider.HasListDataView
-
Sets a ListDataProvider for the component to use and returns a
ListDataView
that provides information and allows operations on the items. - setItems(Collection<T>) - Method in interface com.vaadin.flow.data.binder.HasDataProvider
- setItems(Collection<T>) - Method in interface com.vaadin.flow.data.binder.HasItems
-
Sets the data items of this component provided as a collection.
- setItems(Collection<T>) - Method in interface com.vaadin.flow.data.provider.HasListDataView
-
Sets the items from the given Collection and returns a
ListDataView
that provides information and allows operations on the items. - setItems(Collection<T>, ValueProvider<T, Collection<T>>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider
-
Sets the root data items of this component provided as a collection and recursively populates them with child items with the given value provider.
- setItems(Stream<T>) - Method in interface com.vaadin.flow.data.binder.HasItems
-
Sets the data items of this listing provided as a stream.
- setItems(Stream<T>, ValueProvider<T, Stream<T>>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider
-
Sets the root data items of this component provided as a stream and recursively populates them with child items with the given value provider.
- setItems(T...) - Method in interface com.vaadin.flow.data.binder.HasItems
-
Sets the data items of this listing.
- setItems(T...) - Method in interface com.vaadin.flow.data.provider.HasListDataView
-
Sets the items of this component.
- setKeyMapper(DataKeyMapper<T>) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the
DataKeyMapper
used in thisDataCommunicator
. - setMaxLength(Integer) - Method in class com.vaadin.flow.data.validator.StringLengthValidator
-
Sets the maximum permissible length of the string.
- setMaxValue(T) - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Sets the maximum value of the range.
- setMaxValueIncluded(boolean) - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Sets whether the maximum value is part of the accepted range.
- setMinLength(Integer) - Method in class com.vaadin.flow.data.validator.StringLengthValidator
-
Sets the minimum permissible length.
- setMinValue(T) - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Sets the minimum value of the range.
- setMinValueIncluded(boolean) - Method in class com.vaadin.flow.data.validator.RangeValidator
-
Sets whether the minimum value is part of the accepted range.
- setPageSize(int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the page size that is used to fetch items.
- setPagingEnabled(boolean) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets whether paged queries or offset/limit queries will be used.
- setParent(T, T) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Moves an item to become a child of the given parent item.
- setParentRequestedRange(int, int, T) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalDataCommunicator
- setReadOnly(boolean) - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Sets the read-only status on for this Binding.
- setReadOnly(boolean) - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- setReadOnly(boolean) - Method in class com.vaadin.flow.data.binder.Binder
-
Sets the read only state to the given value for all currently bound fields.
- setReadOnly(boolean) - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- setRequestedRange(int, int) - Method in class com.vaadin.flow.data.provider.DataCommunicator
-
Sets the requested range of data to be sent.
- setRequestRange(int, int) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController
- setRequiredConfigurator(RequiredFieldConfigurator) - Method in class com.vaadin.flow.data.binder.BeanValidationBinder
-
Sets a logic which allows to configure require indicator via
HasValue.setRequiredIndicatorVisible(boolean)
based on property descriptor. - setRequiredIndicatorVisible(boolean) - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- setResendEntireRange(boolean) - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController
- setSelectedItem(T) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Single
-
Sets the current selection to the given item, or clears selection if given
null
. - setSortComparator(SerializableComparator<T>) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- setSortComparator(SerializableComparator<T>) - Method in class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
- setSortComparator(SerializableComparator<T>) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Sets the comparator to use as the default sorting for this data provider.
- setSortComparator(SerializableComparator<T>) - Method in class com.vaadin.flow.data.provider.ListDataProvider
- setSortComparator(SerializableComparator<T>) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Sets the comparator to use as the default sorting.
- setSortOrder(QuerySortOrder) - Method in interface com.vaadin.flow.data.provider.BackEndDataProvider
-
Sets a single sort order to use as the default sorting for this data provider.
- setSortOrder(ValueProvider<T, V>, SortDirection) - Method in interface com.vaadin.flow.data.provider.InMemoryDataProvider
-
Sets the property and direction to use as the default sorting for this data provider.
- setSortOrder(ValueProvider<T, V1>, SortDirection) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
- setSortOrder(ValueProvider<T, V1>, SortDirection) - Method in interface com.vaadin.flow.data.provider.ListDataView
-
Sets the property and direction to use as the default sorting.
- setSortOrders(QuerySortOrderBuilder) - Method in interface com.vaadin.flow.data.provider.BackEndDataProvider
-
Sets the sort order to use, given a
QuerySortOrderBuilder
. - setSortOrders(List<QuerySortOrder>) - Method in class com.vaadin.flow.data.provider.AbstractBackEndDataProvider
- setSortOrders(List<QuerySortOrder>) - Method in interface com.vaadin.flow.data.provider.BackEndDataProvider
-
Sets a list of sort orders to use as the default sorting for this data provider.
- setSortOrders(List<QuerySortOrder>) - Method in class com.vaadin.flow.data.provider.hierarchy.AbstractBackEndHierarchicalDataProvider
- setStatusLabel(HasText) - Method in class com.vaadin.flow.data.binder.Binder
-
Sets the label to show the binder level validation errors not related to any specific field.
- Setter<BEAN,
FIELDVALUE> - Interface in com.vaadin.flow.data.binder -
The function to write the field value to the bean property
- setTreeData(TreeData<T>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider
-
Sets a new
TreeDataProvider
wrapping the givenTreeData
. - setValidationErrorHandler(BinderValidationErrorHandler) - Method in class com.vaadin.flow.data.binder.Binder
-
Sets the validation error handler to update error status for fields when the user input is validated.
- setValidationStatusHandler(BinderValidationStatusHandler<BEAN>) - Method in class com.vaadin.flow.data.binder.Binder
-
Sets the status handler to track form status changes.
- setValidatorsDisabled(boolean) - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Define whether validators are disabled or enabled for this specific binding.
- setValidatorsDisabled(boolean) - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- setValidatorsDisabled(boolean) - Method in class com.vaadin.flow.data.binder.Binder
-
Control whether validators including bean level validators are disabled or enabled globally for this Binder.
- setValue(Set<T>) - Method in interface com.vaadin.flow.data.selection.MultiSelect
- setValue(V) - Method in class com.vaadin.flow.data.binder.ReadOnlyHasValue
- setValueChangeMode(ValueChangeMode) - Method in interface com.vaadin.flow.data.value.HasValueChangeMode
-
Sets new value change mode for the component.
- setValueChangeTimeout(int) - Method in interface com.vaadin.flow.data.value.HasValueChangeMode
-
Sets how often
HasValue.ValueChangeEvent
s are triggered when the ValueChangeMode is set toLAZY
, orTIMEOUT
. - ShortRangeValidator - Class in com.vaadin.flow.data.validator
-
Validator for validating that an
Short
is inside a given range. - ShortRangeValidator(String, Short, Short) - Constructor for class com.vaadin.flow.data.validator.ShortRangeValidator
-
Creates a validator for checking that an Short is within a given range.
- SingleSelect<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
Single selection component whose selection is treated as a value.
- SingleSelectionEvent<C extends Component,
T> - Class in com.vaadin.flow.data.selection -
Fired when the selection changes in a listing component.
- SingleSelectionEvent(C, SingleSelect<C, T>, T, boolean) - Constructor for class com.vaadin.flow.data.selection.SingleSelectionEvent
-
Creates a new selection change event in a component.
- SingleSelectionListener<C extends Component,
T> - Interface in com.vaadin.flow.data.selection -
A listener for listening to selection changes on a single selection component.
- size(Query<T, SerializablePredicate<T>>) - Method in class com.vaadin.flow.data.provider.ListDataProvider
- size(Query<T, F>) - Method in class com.vaadin.flow.data.provider.AbstractBackEndDataProvider
- size(Query<T, F>) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Gets the amount of data in this DataProvider.
- size(Query<T, F>) - Method in class com.vaadin.flow.data.provider.DataProviderWrapper
- size(Query<T, F>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
-
Get the number of immediate child data items for the parent item returned by a given query.
- SIZE - Static variable in interface com.vaadin.flow.data.binder.RequiredFieldConfigurator
-
Configurator which is aware of Size annotation with
min()> 0
presence for a property where the size of the default value is 0. - sizeInBackEnd(Query<T, F>) - Method in class com.vaadin.flow.data.provider.AbstractBackEndDataProvider
-
Counts the number of items available in the back end.
- sizeInBackEnd(Query<T, F>) - Method in class com.vaadin.flow.data.provider.CallbackDataProvider
- SortDirection - Enum Class in com.vaadin.flow.data.provider
-
Describes sorting direction.
- SortEvent<T extends Component,
S extends SortOrder<?>> - Class in com.vaadin.flow.data.event -
Event describing a change in sorting of a
DataProvider
. - SortEvent(T, List<S>, boolean) - Constructor for class com.vaadin.flow.data.event.SortEvent
-
Creates a new sort order change event with a sort order list.
- SortEvent.SortNotifier<T extends Component,
S extends SortOrder<?>> - Interface in com.vaadin.flow.data.event -
The interface for adding and removing listeners for
SortEvents
. - SortOrder<T> - Class in com.vaadin.flow.data.provider
-
Sorting information for one field.
- SortOrder(T, SortDirection) - Constructor for class com.vaadin.flow.data.provider.SortOrder
-
Constructs a field sorting information.
- SortOrderBuilder<T extends SortOrder<V>,
V> - Class in com.vaadin.flow.data.provider -
Base class for helper classes with fluent API for constructing sort order lists.
- SortOrderBuilder() - Constructor for class com.vaadin.flow.data.provider.SortOrderBuilder
- startUpdate(int) - Method in interface com.vaadin.flow.data.provider.ArrayUpdater
-
Starts update of an array.
- startUpdate(int) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalArrayUpdater
- statusChange(BinderValidationStatus<BEAN>) - Method in interface com.vaadin.flow.data.binder.BinderValidationStatusHandler
-
Invoked when the validation status has changed in binder.
- statusChange(BindingValidationStatus<?>) - Method in interface com.vaadin.flow.data.binder.BindingValidationStatusHandler
-
Invoked when the validation status has changed in a binding.
- statusChange(StatusChangeEvent) - Method in interface com.vaadin.flow.data.binder.StatusChangeListener
-
Notifies the listener about status change
event
. - StatusChangeEvent - Class in com.vaadin.flow.data.binder
-
Binder status change event.
- StatusChangeEvent(Binder<?>, boolean) - Constructor for class com.vaadin.flow.data.binder.StatusChangeEvent
-
Create a new status change event for given
binder
, storing information of whether the change that triggered this event caused validation errors. - StatusChangeListener - Interface in com.vaadin.flow.data.binder
-
Listener interface for status change events from binder.
- StringLengthValidator - Class in com.vaadin.flow.data.validator
-
Verifies that the length of a string is within the given range.
- StringLengthValidator(String, Integer, Integer) - Constructor for class com.vaadin.flow.data.validator.StringLengthValidator
-
Creates a new StringLengthValidator with a given error message and minimum and maximum length limits.
- StringToBigDecimalConverter - Class in com.vaadin.flow.data.converter
-
A converter that converts from
String
toBigDecimal
and back. - StringToBigDecimalConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToBigDecimalConverter
-
Creates a new converter instance with the given error message provider.
- StringToBigDecimalConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToBigDecimalConverter
-
Creates a new converter instance with the given error message.
- StringToBigDecimalConverter(BigDecimal, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToBigDecimalConverter
-
Creates a new converter instance with the given presentation value for empty string and error message provider.
- StringToBigDecimalConverter(BigDecimal, String) - Constructor for class com.vaadin.flow.data.converter.StringToBigDecimalConverter
-
Creates a new converter instance with the given presentation value for empty string and error message.
- StringToBigIntegerConverter - Class in com.vaadin.flow.data.converter
-
A converter that converts from
String
toBigInteger
and back. - StringToBigIntegerConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToBigIntegerConverter
-
Creates a new converter instance with the given error message provider.
- StringToBigIntegerConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToBigIntegerConverter
-
Creates a new converter instance with the given error message.
- StringToBigIntegerConverter(BigInteger, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToBigIntegerConverter
-
Creates a new converter instance with the given presentation value for empty string and error message provider.
- StringToBigIntegerConverter(BigInteger, String) - Constructor for class com.vaadin.flow.data.converter.StringToBigIntegerConverter
-
Creates a new converter instance with the given presentation value for empty string and error message.
- StringToBooleanConverter - Class in com.vaadin.flow.data.converter
- StringToBooleanConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToBooleanConverter
-
Creates a new converter instance with the given error message provider.
- StringToBooleanConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToBooleanConverter
-
Creates converter with default string representations - "true" and "false".
- StringToBooleanConverter(String, String, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToBooleanConverter
-
Creates converter with custom string representation.
- StringToBooleanConverter(String, String, String) - Constructor for class com.vaadin.flow.data.converter.StringToBooleanConverter
-
Creates converter with custom string representation.
- StringToDateConverter - Class in com.vaadin.flow.data.converter
- StringToDateConverter() - Constructor for class com.vaadin.flow.data.converter.StringToDateConverter
- StringToDoubleConverter - Class in com.vaadin.flow.data.converter
- StringToDoubleConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToDoubleConverter
-
Creates a new converter instance with the given error message provider.
- StringToDoubleConverter(Double, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToDoubleConverter
-
Creates a new converter instance with the given presentation value for empty string and error message provider.
- StringToDoubleConverter(Double, String) - Constructor for class com.vaadin.flow.data.converter.StringToDoubleConverter
-
Creates a new converter instance with the given presentation value for empty string and error message.
- StringToDoubleConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToDoubleConverter
-
Creates a new converter instance with the given error message.
- StringToFloatConverter - Class in com.vaadin.flow.data.converter
- StringToFloatConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToFloatConverter
-
Creates a new converter instance with the given error message provider.
- StringToFloatConverter(Float, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToFloatConverter
-
Creates a new converter instance with the given presentation value for empty string and error message provider.
- StringToFloatConverter(Float, String) - Constructor for class com.vaadin.flow.data.converter.StringToFloatConverter
-
Creates a new converter instance with the given presentation value for empty string and error message.
- StringToFloatConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToFloatConverter
-
Creates a new converter instance with the given error message.
- StringToIntegerConverter - Class in com.vaadin.flow.data.converter
- StringToIntegerConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToIntegerConverter
-
Creates a new converter instance with the given error message provider.
- StringToIntegerConverter(Integer, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToIntegerConverter
-
Creates a new converter instance with the given presentation value for empty string and error message provider.
- StringToIntegerConverter(Integer, String) - Constructor for class com.vaadin.flow.data.converter.StringToIntegerConverter
-
Creates a new converter instance with the given presentation value for empty string and error message.
- StringToIntegerConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToIntegerConverter
-
Creates a new converter instance with the given error message.
- StringToLongConverter - Class in com.vaadin.flow.data.converter
- StringToLongConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToLongConverter
-
Creates a new converter instance with the given error message provider.
- StringToLongConverter(Long, ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToLongConverter
-
Creates a new converter instance with the given presentation value for empty string and error message provider.
- StringToLongConverter(Long, String) - Constructor for class com.vaadin.flow.data.converter.StringToLongConverter
-
Creates a new converter instance with the given presentation value for empty string and error message.
- StringToLongConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToLongConverter
-
Creates a new converter instance with the given error message.
- StringToUuidConverter - Class in com.vaadin.flow.data.converter
- StringToUuidConverter(ErrorMessageProvider) - Constructor for class com.vaadin.flow.data.converter.StringToUuidConverter
-
Constructs a new converter instance with the given error message provider.
- StringToUuidConverter(String) - Constructor for class com.vaadin.flow.data.converter.StringToUuidConverter
-
Constructs a converter for String to UUID and back.
- SYSTEM - Enum constant in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Error level for system errors and bugs.
T
- testConvertedDefaultValue(Binder.BindingBuilder<?, ?>, Predicate<Object>) - Static method in class com.vaadin.flow.data.binder.RequiredFieldConfiguratorUtil
-
Tests the converted default value of the provided binding builder if possible.
- thenAsc(String) - Method in class com.vaadin.flow.data.provider.QuerySortOrderBuilder
- thenAsc(V) - Method in class com.vaadin.flow.data.provider.SortOrderBuilder
-
Appends sorting with ascending sort direction.
- thenDesc(String) - Method in class com.vaadin.flow.data.provider.QuerySortOrderBuilder
- thenDesc(V) - Method in class com.vaadin.flow.data.provider.SortOrderBuilder
-
Appends sorting with descending sort direction.
- TIMEOUT - Enum constant in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Syncs the value at defined intervals as long as the value changes from one event to the next.
- toResult(T, boolean) - Method in class com.vaadin.flow.data.validator.AbstractValidator
-
A helper method for creating a
Result
from a value and a validity flag. - toString() - Method in class com.vaadin.flow.data.binder.BeanPropertySet
- toString() - Method in class com.vaadin.flow.data.binder.ValidationResult.SimpleValidationResult
- toString() - Method in class com.vaadin.flow.data.validator.BeanValidator
- toString() - Method in class com.vaadin.flow.data.validator.RangeValidator
- toString() - Method in class com.vaadin.flow.data.validator.RegexpValidator
- toString() - Method in class com.vaadin.flow.data.validator.StringLengthValidator
- TreeData<T> - Class in com.vaadin.flow.data.provider.hierarchy
-
Represents hierarchical data.
- TreeData() - Constructor for class com.vaadin.flow.data.provider.hierarchy.TreeData
-
Creates an initially empty hierarchical data representation to which items can be added or removed.
- TreeDataProvider<T> - Class in com.vaadin.flow.data.provider.hierarchy
-
An in-memory data provider for listing components that display hierarchical data.
- TreeDataProvider(TreeData<T>) - Constructor for class com.vaadin.flow.data.provider.hierarchy.TreeDataProvider
-
Constructs a new TreeDataProvider.
U
- unbind() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Unbinds the binding from its respective
Binder
. - unbind() - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
-
Removes this binding from its binder and unregisters the
ValueChangeListener
from any boundHasValue
, andValidationStatusChangeListener
from any boundHasValidator
. - unregisterListener() - Method in class com.vaadin.flow.data.provider.DataChangeEvent
-
Unregisters the event listener currently being invoked.
- unregisterPassivatedKeys() - Method in class com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController
- UNRESOLVED - Enum constant in enum class com.vaadin.flow.data.binder.BindingValidationStatus.Status
-
Unresolved status, e.g field has not yet been validated because value was cleared.
- updateComponent(Component, T) - Method in class com.vaadin.flow.data.provider.AbstractComponentDataGenerator
-
Updates an existing component after the item has been updated.
- updateSelection(Set<T>, Set<T>) - Method in interface com.vaadin.flow.data.selection.MultiSelect
-
Updates the selection by adding and removing the given items from it.
- updateSelection(Set<T>, Set<T>) - Method in interface com.vaadin.flow.data.selection.SelectionModel.Multi
-
Updates the selection by adding and removing the given items from it.
V
- validate() - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Validates the field value and returns a
ValidationStatus
instance representing the outcome of the validation. - validate() - Method in class com.vaadin.flow.data.binder.Binder
-
Validates the values of all bound fields and returns the validation status.
- validate(boolean) - Method in interface com.vaadin.flow.data.binder.Binder.Binding
-
Validates the field value and returns a
ValidationStatus
instance representing the outcome of the validation. - validate(boolean) - Method in class com.vaadin.flow.data.binder.Binder.BindingImpl
- validate(boolean) - Method in class com.vaadin.flow.data.binder.Binder
-
Validates the values of all bound fields and returns the validation status.
- validateItemIndex(int) - Method in class com.vaadin.flow.data.provider.AbstractListDataView
-
Validate that index is inside bounds of the data available.
- ValidationException - Exception in com.vaadin.flow.data.binder
-
Indicates validation errors in a
Binder
when a field value is validated. - ValidationException(List<BindingValidationStatus<?>>, List<ValidationResult>) - Constructor for exception com.vaadin.flow.data.binder.ValidationException
-
Constructs a new exception with validation
errors
list. - ValidationResult - Interface in com.vaadin.flow.data.binder
-
Represents the result of a validation.
- ValidationResult.SimpleValidationResult - Class in com.vaadin.flow.data.binder
-
Simple validation result implementation.
- validationStatusChanged(ValidationStatusChangeEvent<V>) - Method in interface com.vaadin.flow.data.binder.ValidationStatusChangeListener
-
Invoked when a ValidationStatusChangeEvent occurs.
- ValidationStatusChangeEvent<V> - Class in com.vaadin.flow.data.binder
-
The event to be processed when
ValidationStatusChangeListener.validationStatusChanged(ValidationStatusChangeEvent)
invoked. - ValidationStatusChangeEvent(HasValue<?, V>, boolean) - Constructor for class com.vaadin.flow.data.binder.ValidationStatusChangeEvent
- ValidationStatusChangeListener<V> - Interface in com.vaadin.flow.data.binder
-
The listener interface for receiving
ValidationStatusChangeEvent
events. - Validator<T> - Interface in com.vaadin.flow.data.binder
-
A functional interface for validating user input or other potentially invalid data.
- value() - Element in annotation interface com.vaadin.flow.data.binder.PropertyId
-
Returns the name of the property.
- ValueChangeMode - Enum Class in com.vaadin.flow.data.value
-
All possible value change modes that can be set for any component extending
HasValueChangeMode
. - ValueContext - Class in com.vaadin.flow.data.binder
-
Value context for
Converter
s. - ValueContext() - Constructor for class com.vaadin.flow.data.binder.ValueContext
-
Constructor for
ValueContext
without aLocale
. - ValueContext(Component) - Constructor for class com.vaadin.flow.data.binder.ValueContext
-
Constructor for
ValueContext
. - ValueContext(Component, HasValue<?, ?>) - Constructor for class com.vaadin.flow.data.binder.ValueContext
-
Constructor for
ValueContext
. - ValueContext(Component, HasValue<?, ?>, Locale) - Constructor for class com.vaadin.flow.data.binder.ValueContext
-
Constructor for
ValueContext
. - ValueContext(Locale) - Constructor for class com.vaadin.flow.data.binder.ValueContext
-
Constructor for
ValueContext
without aComponent
. - valueOf(String) - Static method in enum class com.vaadin.flow.data.binder.BindingValidationStatus.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.data.converter.DefaultConverterFactory
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.data.provider.SortDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.vaadin.flow.data.binder.BindingValidationStatus.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.data.converter.DefaultConverterFactory
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.data.provider.SortDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.data.value.ValueChangeMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyDataProviderType(Class<?>) - Method in class com.vaadin.flow.data.provider.AbstractDataView
-
Verifies an obtained
DataProvider
type is appropriate for current Data View type.
W
- WARNING - Enum constant in enum class com.vaadin.flow.data.binder.ErrorLevel
-
Error level for warning messages.
- withConfigurableFilter() - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Wraps this data provider to create a data provider that supports programmatically setting a filter but no filtering through the query.
- withConfigurableFilter() - Method in class com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider
- withConfigurableFilter() - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
- withConfigurableFilter(SerializableBiFunction<Q, C, F>) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Wraps this data provider to create a data provider that supports programmatically setting a filter that will be combined with a filter provided through the query.
- withConfigurableFilter(SerializableBiFunction<Q, C, F>) - Method in class com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider
- withConfigurableFilter(SerializableBiFunction<Q, C, F>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
- withConvertedFilter(SerializableFunction<C, F>) - Method in interface com.vaadin.flow.data.provider.DataProvider
-
Wraps this data provider to create a data provider that uses a different filter type.
- withConvertedFilter(SerializableFunction<C, F>) - Method in class com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider
- withConvertedFilter(SerializableFunction<C, F>) - Method in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
- withConverter(Converter<TARGET, NEWTARGET>) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Maps the binding to another data type using the given
Converter
. - withConverter(Converter<TARGET, NEWTARGET>) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- withConverter(Converter<TARGET, NEWTARGET>, boolean) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
-
Implements
Binder.BindingBuilderImpl.withConverter(Converter)
method with additional possibility to disable (reset) default null representation converter. - withConverter(SerializableFunction<TARGET, NEWTARGET>, SerializableFunction<NEWTARGET, TARGET>) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Maps the binding to another data type using the mapping functions and a possible exception as the error message.
- withConverter(SerializableFunction<TARGET, NEWTARGET>, SerializableFunction<NEWTARGET, TARGET>, String) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Maps the binding to another data type using the mapping functions and the given error error message if a value cannot be converted to the new target type.
- withNullRepresentation(TARGET) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Maps binding value
null
to given null representation and back tonull
when converting back to model value. - withPropertySet(PropertySet<BEAN>) - Static method in class com.vaadin.flow.data.binder.Binder
-
Creates a binder using a custom
PropertySet
implementation for finding and resolving property names forBinder.bindInstanceFields(Object)
,Binder.bind(HasValue, String)
andBinder.BindingBuilder.bind(String)
. - withStatusLabel(HasText) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Sets the given
label
to show an error message if validation fails. - withValidationStatusHandler(BindingValidationStatusHandler) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Sets a
BindingValidationStatusHandler
to track validation status changes. - withValidationStatusHandler(BindingValidationStatusHandler) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- withValidator(Validator<? super BEAN>) - Method in class com.vaadin.flow.data.binder.Binder
-
Adds an bean level validator.
- withValidator(Validator<? super TARGET>) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
Adds a validator to this binding.
- withValidator(Validator<? super TARGET>) - Method in class com.vaadin.flow.data.binder.Binder.BindingBuilderImpl
- withValidator(SerializablePredicate<? super TARGET>, ErrorMessageProvider) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
A convenience method to add a validator to this binding using the
Validator.from(SerializablePredicate, ErrorMessageProvider)
factory method. - withValidator(SerializablePredicate<? super TARGET>, ErrorMessageProvider, ErrorLevel) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
A convenience method to add a validator to this binding using the
Validator.from(SerializablePredicate, ErrorMessageProvider, ErrorLevel)
factory method. - withValidator(SerializablePredicate<? super TARGET>, String) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
A convenience method to add a validator to this binding using the
Validator.from(SerializablePredicate, String)
factory method. - withValidator(SerializablePredicate<? super TARGET>, String, ErrorLevel) - Method in interface com.vaadin.flow.data.binder.Binder.BindingBuilder
-
A convenience method to add a validator to this binding using the
Validator.from(SerializablePredicate, String, ErrorLevel)
factory method. - withValidator(SerializablePredicate<BEAN>, ErrorMessageProvider) - Method in class com.vaadin.flow.data.binder.Binder
-
A convenience method to add a validator to this binder using the
Validator.from(SerializablePredicate, ErrorMessageProvider)
factory method. - withValidator(SerializablePredicate<BEAN>, String) - Method in class com.vaadin.flow.data.binder.Binder
-
A convenience method to add a validator to this binder using the
Validator.from(SerializablePredicate, String)
factory method. - writeBean(BEAN) - Method in class com.vaadin.flow.data.binder.Binder
-
Writes changes from the bound fields to the given bean if all validators (binding and bean level) pass.
- writeBeanAsDraft(BEAN) - Method in class com.vaadin.flow.data.binder.Binder
-
Writes successfully converted and validated changes from the bound fields to the bean even if there are other fields with non-validated changes.
- writeBeanAsDraft(BEAN, boolean) - Method in class com.vaadin.flow.data.binder.Binder
-
Writes successfully converted changes from the bound fields bypassing all the Validation or all fields passing conversion if forced = true.
- writeBeanIfValid(BEAN) - Method in class com.vaadin.flow.data.binder.Binder
-
Writes changes from the bound fields to the given bean if all validators (binding and bean level) pass.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form