Package io.jmix.flowui.data.grid

Class ContainerDataGridItems<T>

java.lang.Object

com.vaadin.flow.data.provider.AbstractDataProvider<T,Void>

io.jmix.flowui.data.grid.ContainerDataGridItems<T>

All Implemented Interfaces:

com.vaadin.flow.data.provider.DataProvider<T,Void>, ContainerDataUnit<T>, DataUnit, EntityDataUnit, DataGridItems<T>, DataGridItems.Sortable<T>, EntityDataGridItems<T>, HasType<T>, Serializable

Direct Known Subclasses:

ContainerTreeDataGridItems

public class ContainerDataGridItems<T>
extends com.vaadin.flow.data.provider.AbstractDataProvider<T,Void>
implements ContainerDataUnit<T>, EntityDataGridItems<T>, DataGridItems.Sortable<T>

See Also:

• Serialized Form

Nested Class Summary

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

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

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

DataUnit.StateChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionContainer<T>	container
protected boolean	suppressSorting

Constructor Summary

Constructors

Constructor	Description
ContainerDataGridItems(CollectionContainer<T> container)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addItemSetChangeListener(Consumer<DataGridItems.ItemSetChangeEvent<T>> listener)	Registers a new item set change listener.
com.vaadin.flow.shared.Registration	addSelectedItemChangeListener(Consumer<DataGridItems.SelectedItemChangeEvent<T>> listener)	Registers a new selected item change listener.
com.vaadin.flow.shared.Registration	addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)	Registers a new state change listener.
com.vaadin.flow.shared.Registration	addValueChangeListener(Consumer<DataGridItems.ValueChangeEvent<T>> listener)	Registers a new value change listener.
protected void	containerCollectionChanged(CollectionContainer.CollectionChangeEvent<T> event)
protected void	containerItemChanged(InstanceContainer.ItemChangeEvent<T> event)
protected void	containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<T> event)
boolean	containsItem(T item)
protected Sort	createSort(Object[] propertyId, boolean[] ascending)
void	enableSorting()
Stream<T>	fetch(com.vaadin.flow.data.provider.Query<T,Void> query)
CollectionContainer<T>	getContainer()
MetaClass	getEntityMetaClass()
protected EventBus	getEventBus()
T	getItem(Object entityId)
Collection<T>	getItems()
Object	getItemValue(Object itemId, MetaPropertyPath propertyId)
T	getSelectedItem()
BindingState	getState()
Class<T>	getType()
protected void	initContainer(CollectionContainer<T> container)
boolean	isInMemory()
void	resetSortOrder()
void	setSelectedItem(T item)	Set current item in the source.
int	size(com.vaadin.flow.data.provider.Query<T,Void> query)
void	sort(Object[] propertyId, boolean[] ascending)
void	suppressSorting()

Methods inherited from class com.vaadin.flow.data.provider.AbstractDataProvider

addDataProviderListener, addListener, fireEvent, refreshAll, refreshItem, refreshItem

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.data.provider.DataProvider

getId, withConfigurableFilter, withConfigurableFilter, withConvertedFilter

Field Details

container

protected CollectionContainer<T> container

suppressSorting

protected boolean suppressSorting

Constructor Details

ContainerDataGridItems

public ContainerDataGridItems(CollectionContainer<T> container)

Method Details

initContainer

protected void initContainer(CollectionContainer<T> container)

containerItemChanged

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

containerCollectionChanged

protected void containerCollectionChanged(CollectionContainer.CollectionChangeEvent<T> event)

containerItemPropertyChanged

protected void containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<T> event)

getItems

public Collection<T> getItems()

Specified by:

getItems in interface DataGridItems<T>

Returns:

unmodifiable collection of items

getSelectedItem

@Nullable
public T getSelectedItem()

Specified by:

getSelectedItem in interface DataGridItems<T>

Returns:

the current item contained in the source

setSelectedItem

public void setSelectedItem(@Nullable
 T item)

Description copied from interface: DataGridItems

Set current item in the source.

Specified by:

setSelectedItem in interface DataGridItems<T>

Parameters:

item - the item to set

containsItem

public boolean containsItem(T item)

Specified by:

containsItem in interface DataGridItems<T>

Parameters:

item - an item to check

Returns:

true if the underlying collection contains an item, false otherwise

sort

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

Specified by:

sort in interface DataGridItems.Sortable<T>

createSort

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

resetSortOrder

public void resetSortOrder()

Specified by:

resetSortOrder in interface DataGridItems.Sortable<T>

suppressSorting

public void suppressSorting()

Specified by:

suppressSorting in interface DataGridItems.Sortable<T>

enableSorting

public void enableSorting()

Specified by:

enableSorting in interface DataGridItems.Sortable<T>

addValueChangeListener

public com.vaadin.flow.shared.Registration addValueChangeListener(Consumer<DataGridItems.ValueChangeEvent<T>> listener)

Description copied from interface: DataGridItems

Registers a new value change listener.

Specified by:

addValueChangeListener in interface DataGridItems<T>

Parameters:

listener - the listener to be added

Returns:

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

addItemSetChangeListener

public com.vaadin.flow.shared.Registration addItemSetChangeListener(Consumer<DataGridItems.ItemSetChangeEvent<T>> listener)

Description copied from interface: DataGridItems

Registers a new item set change listener.

Specified by:

addItemSetChangeListener in interface DataGridItems<T>

Parameters:

listener - the listener to be added

Returns:

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

addSelectedItemChangeListener

public com.vaadin.flow.shared.Registration addSelectedItemChangeListener(Consumer<DataGridItems.SelectedItemChangeEvent<T>> listener)

Description copied from interface: DataGridItems

Registers a new selected item change listener.

Specified by:

addSelectedItemChangeListener in interface DataGridItems<T>

Parameters:

listener - the listener to be added

Returns:

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

isInMemory

public boolean isInMemory()

Specified by:

isInMemory in interface com.vaadin.flow.data.provider.DataProvider<T,Void>

size

public int size(com.vaadin.flow.data.provider.Query<T,Void> query)

Specified by:

size in interface com.vaadin.flow.data.provider.DataProvider<T,Void>

fetch

public Stream<T> fetch(com.vaadin.flow.data.provider.Query<T,Void> query)

Specified by:

fetch in interface com.vaadin.flow.data.provider.DataProvider<T,Void>

getItem

@Nullable
public T getItem(Object entityId)

Specified by:

getItem in interface DataGridItems<T>

Parameters:

entityId - 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<T>

Parameters:

itemId - the item id

propertyId - the property id

Returns:

the item value

getContainer

public CollectionContainer<T> getContainer()

Specified by:

getContainer in interface ContainerDataUnit<T>

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

getEntityMetaClass

public MetaClass getEntityMetaClass()

Specified by:

getEntityMetaClass in interface EntityDataUnit

Returns:

MetaClass of an entity contained in the source

addStateChangeListener

public com.vaadin.flow.shared.Registration 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

getType

public Class<T> getType()

Specified by:

getType in interface HasType<T>

Returns:

type of value

getEventBus

protected EventBus getEventBus()