Package io.jmix.ui.component.data

Interface TableItems<I>

Type Parameters:

I - row item type

All Superinterfaces:

DataUnit

All Known Subinterfaces:

EntityTableItems<E>, GroupTableItems<I>, TableItems.Ordered<T>, TableItems.Sortable<T>, TreeTableItems<I>

All Known Implementing Classes:

ContainerGroupTableItems, ContainerTableItems, ContainerTreeTableItems, EmptyGroupTableItems, EmptyTableItems, EmptyTreeTableItems

public interface TableItems<I>
extends DataUnit

A common interface for providing data for Table component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TableItems.ItemSetChangeEvent<T>	An event that is fired when item set is changed.
static interface	TableItems.Ordered<T>	Ordered table items.
static class	TableItems.SelectedItemChangeEvent<T>	An event that is fired when selected item is changed.
static interface	TableItems.Sortable<T>	Sortable table items.
static class	TableItems.ValueChangeEvent<T>	An event that is fired when value of item property is changed.

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

DataUnit.StateChangeEvent

Method Summary

Modifier and Type	Method	Description
Subscription	addItemSetChangeListener(Consumer<TableItems.ItemSetChangeEvent<I>> listener)	Registers a new item set change listener.
Subscription	addSelectedItemChangeListener(Consumer<TableItems.SelectedItemChangeEvent<I>> listener)	Registers a new selected item change listener.
Subscription	addValueChangeListener(Consumer<TableItems.ValueChangeEvent<I>> listener)	Registers a new value change listener.
boolean	containsId(Object itemId)
I	getItem(Object itemId)
Collection<?>	getItemIds()
default I	getItemNN(Object itemId)
Collection<I>	getItems()
Object	getItemValue(Object itemId, MetaPropertyPath propertyId)
Class<?>	getType(Object propertyId)
int	size()
boolean	supportsProperty(Object propertyId)
void	updateItem(I item)	Update an item in the collection if it is already there.

Methods inherited from interface io.jmix.ui.component.data.DataUnit

addStateChangeListener, getState

Method Details

getItemIds

Collection<?> getItemIds()

getItem

@Nullable
I getItem(Object itemId)

getItemNN

default I getItemNN(Object itemId)

getItemValue

@Nullable
Object getItemValue(Object itemId,
 MetaPropertyPath propertyId)

size

int size()

containsId

boolean containsId(Object itemId)

getType

Class<?> getType(Object propertyId)

supportsProperty

boolean supportsProperty(Object propertyId)

getItems

Collection<I> getItems()

Returns:

unmodifiable collection of items

updateItem

void updateItem(I item)

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

Sends TableItems.ItemSetChangeEvent.

Parameters:

item - the item to update

addValueChangeListener

Subscription addValueChangeListener(Consumer<TableItems.ValueChangeEvent<I>> listener)

Registers a new value change listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addItemSetChangeListener

Subscription addItemSetChangeListener(Consumer<TableItems.ItemSetChangeEvent<I>> listener)

Registers a new item set change listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addSelectedItemChangeListener

Subscription addSelectedItemChangeListener(Consumer<TableItems.SelectedItemChangeEvent<I>> listener)

Registers a new selected item change listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source