Package io.jmix.flowui.data

Interface EntityItems<E>

Type Parameters:

E - the type of entity items in the collection

All Superinterfaces:

DataUnit, EntityDataUnit

All Known Implementing Classes:

ContainerDataProvider

@NullMarked
public interface EntityItems<E>
extends EntityDataUnit

Represents a data unit bound to a collection of entity items. Provides capabilities for managing the collection and interacting with its state and events.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EntityItems.ItemsChangeEvent<T>	Event that is fired then item collection is changed.

Nested classes/interfaces inherited from interface io.jmix.flowui.data.DataUnit

DataUnit.StateChangeEvent

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addItemsChangeListener(Consumer<EntityItems.ItemsChangeEvent<E>> listener)	Adds an items change listener.
boolean	containsItem(@Nullable E item)
void	refresh()	Refreshes the source moving it to the BindingState.ACTIVE state
void	setSelectedItem(@Nullable E item)	Set current item in the source.
void	updateItem(E item)	Update an item in the collection if it is already there.

Methods inherited from interface io.jmix.flowui.data.DataUnit

addStateChangeListener, getState

Methods inherited from interface io.jmix.flowui.data.EntityDataUnit

getEntityMetaClass

Method Details

setSelectedItem

void setSelectedItem(@Nullable E item)

Set current item in the source.

Parameters:

item - the item to set

containsItem

boolean containsItem(@Nullable E item)

Returns:

true if the underlying collection contains an item with the specified ID

updateItem

void updateItem(E item)

Update an item in the collection if it is already there.

refresh

void refresh()

Refreshes the source moving it to the BindingState.ACTIVE state

addItemsChangeListener

com.vaadin.flow.shared.Registration addItemsChangeListener(Consumer<EntityItems.ItemsChangeEvent<E>> listener)

Adds an items change listener. The listener is called when the item collection is changed.

Parameters:

listener - a listener to register, not null

Returns:

a registration for the listener