com.haulmont.cuba.gui.components.data

Interface DataGridItems<T>

Type Parameters:

T - row item type

All Superinterfaces:

DataUnit

All Known Subinterfaces:

AggregatableDataGridItems<E>, DataGridItems.Sortable<T>, EntityDataGridItems<E>, TreeDataGridItems<T>

All Known Implementing Classes:

ContainerDataGridItems, ContainerTreeDataGridItems, DatasourceDataGridItems, DatasourceTreeDataGridItems, EmptyDataGridItems, EmptyTreeDataGridItems, SortableDatasourceDataGridItems

public interface DataGridItems<T>
extends DataUnit

A common interface for providing data for DataGrid component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataGridItems.ItemSetChangeEvent<T> An event that is fired when item set is changed.
static class	DataGridItems.SelectedItemChangeEvent<T> An event that is fired when selected item is changed.
static interface	DataGridItems.Sortable<T> The DataGridItems that supports sorting.
static class	DataGridItems.ValueChangeEvent<T> An event that is fired when value of item property is changed.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.DataUnit

DataUnit.StateChangeEvent

Method Summary

Modifier and Type	Method and Description
Subscription	addItemSetChangeListener(java.util.function.Consumer<DataGridItems.ItemSetChangeEvent<T>> listener) Registers a new item set change listener.
Subscription	addSelectedItemChangeListener(java.util.function.Consumer<DataGridItems.SelectedItemChangeEvent<T>> listener) Registers a new selected item change listener.
Subscription	addValueChangeListener(java.util.function.Consumer<DataGridItems.ValueChangeEvent<T>> listener) Registers a new value change listener.
boolean	containsItem(T item)
T	getItem(java.lang.Object itemId)
T	getItemByIndex(int index)
java.lang.Object	getItemId(T item)
java.util.stream.Stream<T>	getItems()
java.util.List<T>	getItems(int startIndex, int numberOfItems)
T	getSelectedItem()
int	indexOfItem(T item)
void	setSelectedItem(T item) Set current item in the source.
int	size()

Methods inherited from interface com.haulmont.cuba.gui.components.data.DataUnit

addStateChangeListener, getState

Method Detail

getItemId

java.lang.Object getItemId(T item)

Parameters:

item - the item for obtaining the id

Returns:

the id on the given item

getItem

@Nullable
T getItem(java.lang.Object itemId)

Parameters:

itemId - the item id

Returns:

the item by the given id

indexOfItem

int indexOfItem(T item)

Parameters:

item - the item for obtaining the index

Returns:

the index of the given item

getItemByIndex

@Nullable
T getItemByIndex(int index)

Parameters:

index - the item index

Returns:

the item by the given index

getItems

java.util.stream.Stream<T> getItems()

Returns:

the stream of all items

getItems

java.util.List<T> getItems(int startIndex,
                           int numberOfItems)

Parameters:

startIndex - the start index

numberOfItems - the number of items

Returns:

items from the startIndex and size not exceeding the specified number

containsItem

boolean containsItem(T item)

Parameters:

item - an item to check

Returns:

true if the underlying collection contains an item, false otherwise

size

int size()

Returns:

size of the underlying collection

getSelectedItem

@Nullable
T getSelectedItem()

Returns:

the current item contained in the source

setSelectedItem

void setSelectedItem(@Nullable
                     T item)

Set current item in the source.

Parameters:

item - the item to set

addValueChangeListener

Subscription addValueChangeListener(java.util.function.Consumer<DataGridItems.ValueChangeEvent<T>> 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(java.util.function.Consumer<DataGridItems.ItemSetChangeEvent<T>> 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(java.util.function.Consumer<DataGridItems.SelectedItemChangeEvent<T>> 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