Uses of Interface
com.vaadin.flow.function.ValueProvider

Packages that use ValueProvider

Package	Description
com.vaadin.collaborationengine
com.vaadin.flow.component.grid
com.vaadin.flow.component.gridpro
com.vaadin.flow.component.ironlist
com.vaadin.flow.component.treegrid
com.vaadin.flow.component.virtuallist
com.vaadin.flow.data.binder
com.vaadin.flow.data.provider
com.vaadin.flow.data.provider.hierarchy
com.vaadin.flow.data.renderer
com.vaadin.flow.function

Uses of ValueProvider in com.vaadin.collaborationengine

Methods in com.vaadin.collaborationengine with parameters of type ValueProvider

Modifier and Type	Method	Description
<FIELDVALUE> Binder.Binding<BEAN,FIELDVALUE>	CollaborationBinder.bind(HasValue<?,FIELDVALUE> field, ValueProvider<BEAN,FIELDVALUE> getter, Setter<BEAN,FIELDVALUE> setter)	Deprecated. The method does not work with the collaboration binder.
Binder.Binding<BEAN,TARGET>	CollaborationBinder.CollaborationBindingBuilderImpl.bind(ValueProvider<BEAN,TARGET> getter, Setter<BEAN,TARGET> setter)

Uses of ValueProvider in com.vaadin.flow.component.grid

Methods in com.vaadin.flow.component.grid that return ValueProvider

Modifier and Type	Method	Description
protected ValueProvider<T,String>	Grid.getUniqueKeyProvider()	Gets optional value provider for unique key in row's generated JSON.

Methods in com.vaadin.flow.component.grid with parameters of type ValueProvider

Modifier and Type	Method	Description
Grid.Column<T>	Grid.addColumn(ValueProvider<T,?> valueProvider)	Adds a new text column to this Grid with a value provider and default column factory.
protected <C extends Grid.Column<T>> C	Grid.addColumn(ValueProvider<T,?> valueProvider, BiFunction<Renderer<T>,String,C> columnFactory)	Adds a new text column to this Grid with a value provider and column factory provided.
<V extends Comparable<? super V>> Grid.Column<T>	Grid.addColumn(ValueProvider<T,V> valueProvider, String... sortingProperties)	Adds a new text column to this Grid with a value provider and sorting properties.The value is converted to a JSON value by using JsonSerializer.toJson(Object).
<V extends Component> Grid.Column<T>	Grid.addComponentColumn(ValueProvider<T,V> componentProvider)	Adds a new column that shows components.
Registration	Grid.addValueProvider(String property, ValueProvider<T,?> valueProvider)	Adds a ValueProvider to this Grid that is not tied to a Column.
<V extends Comparable<? super V>> Grid.Column<T>	Grid.Column.setComparator(ValueProvider<T,V> keyExtractor)	Sets a comparator to use with in-memory sorting with this column based on the return type of the given ValueProvider.Sorting with a back-end is done using Grid.Column.setSortProperty(String[]).
protected void	Grid.setUniqueKeyProvider(ValueProvider<T,String> uniqueKeyProvider)	Sets value provider for unique key in row's generated JSON.

Method parameters in com.vaadin.flow.component.grid with type arguments of type ValueProvider

Modifier and Type	Method	Description
protected DataCommunicator<T>	Grid.DataCommunicatorBuilder.build(Element element, CompositeDataGenerator<T> dataGenerator, U arrayUpdater, SerializableSupplier<ValueProvider<T,String>> uniqueKeyProviderSupplier)	Build a new DataCommunicator object for the given Grid instance.

Constructors in com.vaadin.flow.component.grid with parameters of type ValueProvider

Constructor	Description
ColumnPathRenderer(String property, ValueProvider<SOURCE,?> provider)	Creates a new renderer based on the property and the value provider for that property.

Uses of ValueProvider in com.vaadin.flow.component.gridpro

Methods in com.vaadin.flow.component.gridpro that return ValueProvider

Modifier and Type	Method	Description
ValueProvider<T,?>	GridPro.EditColumn.getValueProvider()

Methods in com.vaadin.flow.component.gridpro with parameters of type ValueProvider

Modifier and Type	Method	Description
EditColumnConfigurator<E>	GridPro.addEditColumn(ValueProvider<E,?> valueProvider)	Adds a new edit column to this GridPro with a value provider.
EditColumnConfigurator<E>	GridPro.addEditColumn(ValueProvider<E,?> valueProvider, Renderer<E> renderer)	Adds a new edit column to this GridPro with a value provider and renderer which is used to display the content when the cell is not in the edit mode.
<V extends Comparable<? super V>> EditColumnConfigurator<E>	GridPro.addEditColumn(ValueProvider<E,V> valueProvider, String... sortingProperties)	Adds a new edit column to this GridPro with a value provider and sorting properties.
void	GridPro.EditColumn.setValueProvider(ValueProvider<T,?> valueProvider)

Uses of ValueProvider in com.vaadin.flow.component.ironlist

Methods in com.vaadin.flow.component.ironlist with parameters of type ValueProvider

Modifier and Type	Method	Description
void	IronList.setRenderer(ValueProvider<T,String> valueProvider)	Deprecated. Sets a renderer for the items in the list, by using a ValueProvider.

Uses of ValueProvider in com.vaadin.flow.component.treegrid

Methods in com.vaadin.flow.component.treegrid with parameters of type ValueProvider

Modifier and Type	Method	Description
<V extends Component> Grid.Column<T>	TreeGrid.addComponentHierarchyColumn(ValueProvider<T,V> componentProvider)	Adds a new Hierarchy column that shows components.
Grid.Column<T>	TreeGrid.addHierarchyColumn(ValueProvider<T,?> valueProvider)	Adds a new Hierarchy column to this Grid with a value provider.
Grid.Column<T>	TreeGrid.setColumns(String hierarchyPropertyName, ValueProvider<T,?> valueProvider, Collection<String> propertyNames)	Note: This method can only be used for a TreeGrid created from a bean type with TreeGrid(Class).
Grid.Column<T>	TreeGrid.setHierarchyColumn(String propertyName, ValueProvider<T,?> valueProvider)	Note: This method can only be used for a TreeGrid created from a bean type with TreeGrid(Class).
void	TreeGrid.setUniqueKeyDataGenerator(String propertyName, ValueProvider<T,String> uniqueKeyProvider)	Sets property name and value provider for unique key in row's generated JSON.
HierarchyColumnComponentRenderer<COMPONENT,SOURCE>	HierarchyColumnComponentRenderer.withProperty(String property, ValueProvider<SOURCE,?> provider)

Constructors in com.vaadin.flow.component.treegrid with parameters of type ValueProvider

Constructor	Description
HierarchyColumnComponentRenderer(ValueProvider<SOURCE,COMPONENT> componentProvider)

Uses of ValueProvider in com.vaadin.flow.component.virtuallist

Methods in com.vaadin.flow.component.virtuallist with parameters of type ValueProvider

Modifier and Type	Method	Description
void	VirtualList.setRenderer(ValueProvider<T,String> valueProvider)	Sets a renderer for the items in the list, by using a ValueProvider.

Uses of ValueProvider in com.vaadin.flow.data.binder

Methods in com.vaadin.flow.data.binder that return ValueProvider

Modifier and Type	Method	Description
ValueProvider<T,V>	BeanPropertySet.NestedBeanPropertyDefinition.getGetter()
ValueProvider<BEAN,TARGET>	Binder.Binding.getGetter()	Gets the getter associated with this Binding.
ValueProvider<BEAN,TARGET>	Binder.BindingImpl.getGetter()
ValueProvider<T,V>	PropertyDefinition.getGetter()	Gets the value provider that is used for finding the value of this property for a bean.

Methods in com.vaadin.flow.data.binder with parameters of type ValueProvider

Modifier and Type	Method	Description
<FIELDVALUE> Binder.Binding<BEAN,FIELDVALUE>	Binder.bind(HasValue<?,FIELDVALUE> field, ValueProvider<BEAN,FIELDVALUE> getter, Setter<BEAN,FIELDVALUE> setter)	Binds a field to a bean property represented by the given getter and setter pair.
Binder.Binding<BEAN,TARGET>	Binder.BindingBuilder.bind(ValueProvider<BEAN,TARGET> getter, Setter<BEAN,TARGET> setter)	Completes this binding using the given getter and setter functions representing a backing bean property.
Binder.Binding<BEAN,TARGET>	Binder.BindingBuilderImpl.bind(ValueProvider<BEAN,TARGET> getter, Setter<BEAN,TARGET> setter)
Binder.Binding<BEAN,TARGET>	Binder.BindingBuilder.bindReadOnly(ValueProvider<BEAN,TARGET> getter)	Completes this binding using the given getter function representing a backing bean property.
Binder.Binding<BEAN,TARGET>	Binder.BindingBuilderImpl.bindReadOnly(ValueProvider<BEAN,TARGET> getter)
<FIELDVALUE> Binder.Binding<BEAN,FIELDVALUE>	Binder.bindReadOnly(HasValue<?,FIELDVALUE> field, ValueProvider<BEAN,FIELDVALUE> getter)	Binds a field to a bean property represented by the given getter.

Constructors in com.vaadin.flow.data.binder with parameters of type ValueProvider

Constructor	Description
BindingImpl(Binder.BindingBuilderImpl<BEAN,FIELDVALUE,TARGET> builder, ValueProvider<BEAN,TARGET> getter, Setter<BEAN,TARGET> setter)

Uses of ValueProvider in com.vaadin.flow.data.provider

Subinterfaces of ValueProvider in com.vaadin.flow.data.provider

Modifier and Type	Interface	Description
interface	IdentifierProvider<T>	A callback interface that is used to provide the identifier of an item.

Methods in com.vaadin.flow.data.provider with parameters of type ValueProvider

Modifier and Type	Method	Description
default <V> void	InMemoryDataProvider.addFilter(ValueProvider<T,V> valueProvider, SerializablePredicate<V> valueFilter)	Adds a filter for an item property.
default <V> void	InMemoryDataProvider.addFilterByValue(ValueProvider<T,V> valueProvider, V requiredValue)	Adds a filter that requires an item property to have a specific value.
<V1 extends Comparable<? super V1>> AbstractListDataView<T>	AbstractListDataView.addSortOrder(ValueProvider<T,V1> valueProvider, SortDirection sortDirection)
default <V extends Comparable<? super V>> void	InMemoryDataProvider.addSortOrder(ValueProvider<T,V> valueProvider, SortDirection sortDirection)	Adds a property and direction to the default sorting for this data provider.
<V1 extends Comparable<? super V1>> V	ListDataView.addSortOrder(ValueProvider<T,V1> valueProvider, SortDirection sortDirection)	Adds a property and direction to the default sorting.
static <T,V> SerializablePredicate<T>	InMemoryDataProviderHelpers.createEqualsFilter(ValueProvider<T,V> valueProvider, V requiredValue)	Creates a predicate that compares equality of the given required value to the value the given value provider obtains.
static <T,V> SerializablePredicate<T>	InMemoryDataProviderHelpers.createValueProviderFilter(ValueProvider<T,V> valueProvider, SerializablePredicate<V> valueFilter)	Creates a new predicate from the given predicate and value provider.
default <V,Q> DataProvider<T,Q>	InMemoryDataProvider.filteringBy(ValueProvider<T,V> valueProvider, SerializableBiPredicate<V,Q> predicate)	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.
static <T> DataProvider<T,String>	InMemoryDataProviderHelpers.filteringByCaseInsensitiveString(InMemoryDataProvider<T> dataProvider, ValueProvider<T,String> valueProvider, SerializableBiPredicate<String,String> predicate, SerializableSupplier<Locale> localeSupplier)	Wraps a given data provider so that its filter tests the given predicate with the lower case string provided by the given value provider.
default <V> DataProvider<T,V>	InMemoryDataProvider.filteringByEquals(ValueProvider<T,V> valueProvider)	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.
static <T,V,Q> DataProvider<T,Q>	InMemoryDataProviderHelpers.filteringByIgnoreNull(InMemoryDataProvider<T> dataProvider, ValueProvider<T,V> valueProvider, SerializableBiPredicate<V,Q> predicate)	Wraps a given data provider so that its filter ignores null items returned by the given value provider.
default DataProvider<T,String>	InMemoryDataProvider.filteringByPrefix(ValueProvider<T,String> valueProvider)	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.
default DataProvider<T,String>	InMemoryDataProvider.filteringByPrefix(ValueProvider<T,String> valueProvider, Locale locale)	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.
default DataProvider<T,String>	InMemoryDataProvider.filteringBySubstring(ValueProvider<T,String> valueProvider)	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.
default DataProvider<T,String>	InMemoryDataProvider.filteringBySubstring(ValueProvider<T,String> valueProvider, Locale locale)	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.
static <V extends Comparable<? super V>,T> SerializableComparator<T>	InMemoryDataProviderHelpers.propertyComparator(ValueProvider<T,V> valueProvider, SortDirection sortDirection)	Creates a comparator for the return type of the given ValueProvider, sorted in the direction specified by the given SortDirection.
default <V> void	InMemoryDataProvider.setFilter(ValueProvider<T,V> valueProvider, SerializablePredicate<V> valueFilter)	Sets a filter for an item property.
default <V> void	InMemoryDataProvider.setFilterByValue(ValueProvider<T,V> valueProvider, V requiredValue)	Sets a filter that requires an item property to have a specific value.
void	DataKeyMapper.setIdentifierGetter(ValueProvider<T,Object> identifierGetter)	Takes identifier getter into use and updates existing mappings
void	KeyMapper.setIdentifierGetter(ValueProvider<V,Object> identifierGetter)
<V1 extends Comparable<? super V1>> AbstractListDataView<T>	AbstractListDataView.setSortOrder(ValueProvider<T,V1> valueProvider, SortDirection sortDirection)
default <V extends Comparable<? super V>> void	InMemoryDataProvider.setSortOrder(ValueProvider<T,V> valueProvider, SortDirection sortDirection)	Sets the property and direction to use as the default sorting for this data provider.
<V1 extends Comparable<? super V1>> V	ListDataView.setSortOrder(ValueProvider<T,V1> valueProvider, SortDirection sortDirection)	Sets the property and direction to use as the default sorting.

Constructors in com.vaadin.flow.data.provider with parameters of type ValueProvider

Constructor	Description
CallbackDataProvider(CallbackDataProvider.FetchCallback<T,F> fetchCallBack, CallbackDataProvider.CountCallback<T,F> countCallback, ValueProvider<T,Object> identifierGetter)	Constructs a new DataProvider to request data using callbacks for fetching and counting items in the back end.
KeyMapper(ValueProvider<V,Object> identifierGetter)	Constructs a new mapper.

Uses of ValueProvider in com.vaadin.flow.data.provider.hierarchy

Methods in com.vaadin.flow.data.provider.hierarchy with parameters of type ValueProvider

Modifier and Type	Method	Description
TreeData<T>	TreeData.addItems(Collection<T> rootItems, ValueProvider<T,Collection<T>> childItemProvider)	Adds the given items as root items and uses the given value provider to recursively populate children of the root items.
TreeData<T>	TreeData.addItems(Stream<T> rootItems, ValueProvider<T,Stream<T>> childItemProvider)	Adds the given items as root items and uses the given value provider to recursively populate children of the root items.
default void	HasHierarchicalDataProvider.setItems(Collection<T> rootItems, ValueProvider<T,Collection<T>> childItemProvider)	Sets the root data items of this component provided as a collection and recursively populates them with child items with the given value provider.
default void	HasHierarchicalDataProvider.setItems(Stream<T> rootItems, ValueProvider<T,Stream<T>> childItemProvider)	Sets the root data items of this component provided as a stream and recursively populates them with child items with the given value provider.

Constructor parameters in com.vaadin.flow.data.provider.hierarchy with type arguments of type ValueProvider

Constructor	Description
HierarchicalDataCommunicator(CompositeDataGenerator<T> dataGenerator, HierarchicalArrayUpdater arrayUpdater, SerializableConsumer<elemental.json.JsonArray> dataUpdater, StateNode stateNode, SerializableSupplier<ValueProvider<T,String>> uniqueKeyProviderSupplier)	Construct a new hierarchical data communicator backed by a TreeDataProvider.

Uses of ValueProvider in com.vaadin.flow.data.renderer

Methods in com.vaadin.flow.data.renderer that return ValueProvider

Modifier and Type	Method	Description
protected ValueProvider<SOURCE,TARGET>	BasicRenderer.getValueProvider()

Methods in com.vaadin.flow.data.renderer that return types with arguments of type ValueProvider

Modifier and Type	Method	Description
Map<String,ValueProvider<SOURCE,?>>	LitRenderer.getValueProviders()	Gets the property mapped to ValueProviders in this renderer.
Map<String,ValueProvider<SOURCE,?>>	Renderer.getValueProviders()	Deprecated. since Vaadin 23.1

Methods in com.vaadin.flow.data.renderer with parameters of type ValueProvider

Modifier and Type	Method	Description
static <T> void	RendererUtil.registerEventHandlers(Renderer<T> renderer, Element contentTemplate, Element templateDataHost, ValueProvider<String,T> keyMapper)	Registers the event handlers associated to a TemplateRenderer, if any.
protected void	Renderer.setProperty(String property, ValueProvider<SOURCE,?> provider)	Deprecated. since Vaadin 22
LitRenderer<SOURCE>	LitRenderer.withProperty(String property, ValueProvider<SOURCE,?> provider)	Makes a property available to the template expression.
TemplateRenderer<SOURCE>	TemplateRenderer.withProperty(String property, ValueProvider<SOURCE,?> provider)	Deprecated. Sets a property to be used inside the template.

Constructors in com.vaadin.flow.data.renderer with parameters of type ValueProvider

Constructor	Description
BasicRenderer(ValueProvider<SOURCE,TARGET> valueProvider)	Builds a new template renderer using the value provider as the source of values to be rendered.
ComponentDataGenerator(ComponentRenderer<? extends Component,T> componentRenderer, ValueProvider<T,String> keyMapper)	Creates a new generator.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider)	Creates a new LocalDateRenderer.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider, SerializableSupplier<DateTimeFormatter> formatter)	Creates a new LocalDateRenderer.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider, SerializableSupplier<DateTimeFormatter> formatter, String nullRepresentation)	Creates a new LocalDateRenderer.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider, String formatPattern)	Creates a new LocalDateRenderer.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider, String formatPattern, Locale locale)	Creates a new LocalDateRenderer.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider, String formatPattern, Locale locale, String nullRepresentation)	Creates a new LocalDateRenderer.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider, DateTimeFormatter formatter)	Deprecated. Via this constructor renderer is not serializable, use LocalDateRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDate>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>) instead.
LocalDateRenderer(ValueProvider<SOURCE,LocalDate> valueProvider, DateTimeFormatter formatter, String nullRepresentation)	Deprecated. Via this constructor renderer is not serializable, use LocalDateRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDate>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>,java.lang.String) instead.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, SerializableSupplier<DateTimeFormatter> formatter)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, SerializableSupplier<DateTimeFormatter> formatter, String nullRepresentation)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, String formatPattern)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, String formatPattern, Locale locale)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, String formatPattern, Locale locale, String nullRepresentation)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, DateTimeFormatter formatter)	Deprecated. Via this constructor renderer is not serializable, use LocalDateTimeRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDateTime>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>) instead.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, DateTimeFormatter formatter, String nullRepresentation)	Deprecated. Via this constructor renderer is not serializable, use LocalDateTimeRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDateTime>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>,java.lang.String) instead.
NativeButtonRenderer(ValueProvider<SOURCE,String> labelProvider)	Creates a new button renderer with a dynamic label.
NativeButtonRenderer(ValueProvider<SOURCE,String> labelProvider, ClickableRenderer.ItemClickListener<SOURCE> clickListener)	Creates a new button renderer with a dynamic label and registers a ClickableRenderer.ItemClickListener to receive events.
NumberRenderer(ValueProvider<SOURCE,Number> valueProvider)	Creates a new number renderer.
NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, String formatString)	Creates a new number renderer.
NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, String formatString, Locale locale)	Creates a new number renderer.
NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, String formatString, Locale locale, String nullRepresentation)	Creates a new number renderer.
NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, NumberFormat numberFormat)	Creates a new number renderer.
NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, NumberFormat numberFormat, String nullRepresentation)	Creates a new number renderer.
NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, Locale locale)	Creates a new number renderer.

Uses of ValueProvider in com.vaadin.flow.function

Methods in com.vaadin.flow.function that return ValueProvider

Modifier and Type	Method	Description
static <T> ValueProvider<T,T>	ValueProvider.identity()	Returns a value provider that always returns its input argument.