Package io.jmix.ui.component.data.datagrid

Class ContainerDataGridItems<E>

java.lang.Object

io.jmix.ui.component.data.datagrid.ContainerDataGridItems<E>

All Implemented Interfaces:

DataGridItems<E>, DataGridItems.Sortable<E>, DataUnit, ContainerDataUnit<E>, EntityDataGridItems<E>, EntityDataUnit

Direct Known Subclasses:

ContainerTreeDataGridItems

public class ContainerDataGridItems<E>
extends Object
implements EntityDataGridItems<E>, DataGridItems.Sortable<E>, ContainerDataUnit<E>

Nested Class Summary

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

DataGridItems.ItemSetChangeEvent<T>, DataGridItems.SelectedItemChangeEvent<T>, DataGridItems.Sortable<T>, DataGridItems.ValueChangeEvent<T>

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

DataUnit.StateChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionContainer<E>	container
protected EventHub	events
protected boolean	suppressSorting

Constructor Summary

Constructors

Constructor	Description
ContainerDataGridItems(CollectionContainer<E> container)

Method Summary

Modifier and Type	Method	Description
Subscription	addItemSetChangeListener(Consumer<DataGridItems.ItemSetChangeEvent<E>> listener)	Registers a new item set change listener.
Subscription	addSelectedItemChangeListener(Consumer<DataGridItems.SelectedItemChangeEvent<E>> listener)	Registers a new selected item change listener.
Subscription	addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)	Registers a new state change listener.
Subscription	addValueChangeListener(Consumer<DataGridItems.ValueChangeEvent<E>> listener)	Registers a new value change listener.
protected void	containerCollectionChanged(CollectionContainer.CollectionChangeEvent<E> e)
protected void	containerItemChanged(InstanceContainer.ItemChangeEvent<E> event)
protected void	containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> e)
boolean	containsItem(E item)
protected Sort	createSort(Object[] propertyId, boolean[] ascending)
void	enableSorting()
CollectionContainer<E>	getContainer()
MetaClass	getEntityMetaClass()
E	getItem(Object itemId)
E	getItemByIndex(int index)
Object	getItemId(E item)
Stream<E>	getItems()
List<E>	getItems(int startIndex, int numberOfItems)
Object	getItemValue(Object itemId, MetaPropertyPath propertyId)
E	getSelectedItem()
BindingState	getState()
int	indexOfItem(E item)
void	resetSortOrder()
void	setSelectedItem(E item)	Set current item in the source.
int	size()
void	sort(Object[] propertyId, boolean[] ascending)
void	suppressSorting()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

container

protected CollectionContainer<E> container

suppressSorting

protected boolean suppressSorting

events

protected EventHub events

Constructor Details

ContainerDataGridItems

public ContainerDataGridItems(CollectionContainer<E> container)

Method Details

getContainer

public CollectionContainer<E> getContainer()

Specified by:

getContainer in interface ContainerDataUnit<E>

containerItemChanged

protected void containerItemChanged(InstanceContainer.ItemChangeEvent<E> event)

containerCollectionChanged

protected void containerCollectionChanged(CollectionContainer.CollectionChangeEvent<E> e)

containerItemPropertyChanged

protected void containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> e)

getEntityMetaClass

@Nullable
public MetaClass getEntityMetaClass()

Specified by:

getEntityMetaClass in interface EntityDataUnit

Returns:

MetaClass of an entity contained in the source

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

getItemId

@Nullable
public Object getItemId(E item)

Specified by:

getItemId in interface DataGridItems<E>

Parameters:

item - the item for obtaining the id

Returns:

the id on the given item

getItem

@Nullable
public E getItem(@Nullable
 Object itemId)

Specified by:

getItem in interface DataGridItems<E>

Parameters:

itemId - the item id

Returns:

the item by the given id

getItemValue

@Nullable
public Object getItemValue(Object itemId,
 MetaPropertyPath propertyId)

Specified by:

getItemValue in interface DataGridItems<E>

Parameters:

itemId - the item id

propertyId - the property id

Returns:

the item value

indexOfItem

public int indexOfItem(E item)

Specified by:

indexOfItem in interface DataGridItems<E>

Parameters:

item - the item for obtaining the index

Returns:

the index of the given item

getItemByIndex

@Nullable
public E getItemByIndex(int index)

Specified by:

getItemByIndex in interface DataGridItems<E>

Parameters:

index - the item index

Returns:

the item by the given index

getItems

public Stream<E> getItems()

Specified by:

getItems in interface DataGridItems<E>

Returns:

the stream of all items

getItems

public List<E> getItems(int startIndex,
 int numberOfItems)

Specified by:

getItems in interface DataGridItems<E>

Parameters:

startIndex - the start index

numberOfItems - the number of items

Returns:

items from the startIndex and size not exceeding the specified number

containsItem

public boolean containsItem(E item)

Specified by:

containsItem in interface DataGridItems<E>

Parameters:

item - an item to check

Returns:

true if the underlying collection contains an item, false otherwise

size

public int size()

Specified by:

size in interface DataGridItems<E>

Returns:

size of the underlying collection

getSelectedItem

@Nullable
public E getSelectedItem()

Specified by:

getSelectedItem in interface DataGridItems<E>

Returns:

the current item contained in the source

setSelectedItem

public void setSelectedItem(@Nullable
 E item)

Description copied from interface: DataGridItems

Set current item in the source.

Specified by:

setSelectedItem in interface DataGridItems<E>

Parameters:

item - the item to set

addStateChangeListener

public Subscription addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)

Description copied from interface: DataUnit

Registers a new state change listener.

Specified by:

addStateChangeListener in interface DataUnit

Parameters:

listener - the listener to be added

Returns:

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

addValueChangeListener

public Subscription addValueChangeListener(Consumer<DataGridItems.ValueChangeEvent<E>> listener)

Description copied from interface: DataGridItems

Registers a new value change listener.

Specified by:

addValueChangeListener in interface DataGridItems<E>

Parameters:

listener - the listener to be added

Returns:

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

addItemSetChangeListener

public Subscription addItemSetChangeListener(Consumer<DataGridItems.ItemSetChangeEvent<E>> listener)

Description copied from interface: DataGridItems

Registers a new item set change listener.

Specified by:

addItemSetChangeListener in interface DataGridItems<E>

Parameters:

listener - the listener to be added

Returns:

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

addSelectedItemChangeListener

public Subscription addSelectedItemChangeListener(Consumer<DataGridItems.SelectedItemChangeEvent<E>> listener)

Description copied from interface: DataGridItems

Registers a new selected item change listener.

Specified by:

addSelectedItemChangeListener in interface DataGridItems<E>

Parameters:

listener - the listener to be added

Returns:

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

sort

public void sort(Object[] propertyId,
 boolean[] ascending)

Specified by:

sort in interface DataGridItems.Sortable<E>

createSort

protected Sort createSort(Object[] propertyId,
 boolean[] ascending)

resetSortOrder

public void resetSortOrder()

Specified by:

resetSortOrder in interface DataGridItems.Sortable<E>

suppressSorting

public void suppressSorting()

Specified by:

suppressSorting in interface DataGridItems.Sortable<E>

enableSorting

public void enableSorting()

Specified by:

enableSorting in interface DataGridItems.Sortable<E>