io.jmix.ui.component.data.table

Class ContainerTableItems<E>

java.lang.Object

io.jmix.ui.component.data.table.ContainerTableItems<E>

All Implemented Interfaces:

DataUnit, ContainerDataUnit<E>, EntityDataUnit, EntityTableItems<E>, TableItems<E>, TableItems.Ordered<E>, TableItems.Sortable<E>

Direct Known Subclasses:

ContainerGroupTableItems, ContainerTreeTableItems

public class ContainerTableItems<E>
extends java.lang.Object
implements EntityTableItems<E>, TableItems.Sortable<E>, ContainerDataUnit<E>

Nested Class Summary

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

TableItems.ItemSetChangeEvent<T>, TableItems.Ordered<T>, TableItems.SelectedItemChangeEvent<T>, TableItems.Sortable<T>, TableItems.ValueChangeEvent<T>

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

DataUnit.StateChangeEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected AggregatableDelegate	aggregatableDelegate
protected CollectionContainer<E>	container
protected io.jmix.core.common.event.EventHub	events
protected boolean	suppressSorting

Constructor Summary

Constructors

Constructor and Description
ContainerTableItems(CollectionContainer<E> container)

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addItemSetChangeListener(java.util.function.Consumer<TableItems.ItemSetChangeEvent<E>> listener) Registers a new item set change listener.
io.jmix.core.common.event.Subscription	addSelectedItemChangeListener(java.util.function.Consumer<TableItems.SelectedItemChangeEvent<E>> listener) Registers a new selected item change listener.
io.jmix.core.common.event.Subscription	addStateChangeListener(java.util.function.Consumer<DataUnit.StateChangeEvent> listener) Registers a new state change listener.
io.jmix.core.common.event.Subscription	addValueChangeListener(java.util.function.Consumer<TableItems.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	containsId(java.lang.Object itemId)
protected io.jmix.core.Sort	createSort(java.lang.Object[] propertyId, boolean[] ascending)
void	enableSorting()
java.lang.Object	firstItemId()
CollectionContainer<E>	getContainer()
io.jmix.core.metamodel.model.MetaClass	getEntityMetaClass()
E	getItem(java.lang.Object itemId)
java.util.Collection<?>	getItemIds()
E	getItemNN(java.lang.Object itemId)
java.util.Collection<E>	getItems()
java.lang.Object	getItemValue(java.lang.Object itemId, io.jmix.core.metamodel.model.MetaPropertyPath propertyId)
E	getSelectedItem()
BindingState	getState()
java.lang.Class<?>	getType(java.lang.Object propertyId)
boolean	isFirstId(java.lang.Object itemId) Tests if the Item corresponding to the given Item ID is the first item.
boolean	isLastId(java.lang.Object itemId) Tests if the item corresponding to the given item ID is the last item.
java.lang.Object	lastItemId()
java.lang.Object	nextItemId(java.lang.Object itemId) Gets the ID of the item following the Item that corresponds to itemId.
java.lang.Object	prevItemId(java.lang.Object itemId) Gets the ID of the item preceding the item that corresponds to itemId.
void	resetSortOrder() Resets sort order.
void	setSelectedItem(E item) Set current item in the source.
int	size()
void	sort(java.lang.Object[] propertyId, boolean[] ascending) Sorts data.
boolean	supportsProperty(java.lang.Object propertyId)
void	suppressSorting()
void	updateItem(E item) Update an item in the collection if it is already there.

Methods inherited from class java.lang.Object

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

Field Detail

container

protected CollectionContainer<E> container

aggregatableDelegate

protected AggregatableDelegate aggregatableDelegate

suppressSorting

protected boolean suppressSorting

events

protected io.jmix.core.common.event.EventHub events

Constructor Detail

ContainerTableItems

public ContainerTableItems(CollectionContainer<E> container)

Method Detail

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)

getItemIds

public java.util.Collection<?> getItemIds()

Specified by:

getItemIds in interface TableItems<E>

getItems

public java.util.Collection<E> getItems()

Specified by:

getItems in interface TableItems<E>

Returns:

unmodifiable collection of items

getItem

@Nullable
public E getItem(java.lang.Object itemId)

Specified by:

getItem in interface TableItems<E>

getItemNN

public E getItemNN(java.lang.Object itemId)

Specified by:

getItemNN in interface TableItems<E>

updateItem

public void updateItem(E item)

Description copied from interface: TableItems

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

Sends TableItems.ItemSetChangeEvent.

Specified by:

updateItem in interface TableItems<E>

Parameters:

item - the item to update

getItemValue

@Nullable
public java.lang.Object getItemValue(java.lang.Object itemId,
                                               io.jmix.core.metamodel.model.MetaPropertyPath propertyId)

Specified by:

getItemValue in interface TableItems<E>

size

public int size()

Specified by:

size in interface TableItems<E>

containsId

public boolean containsId(java.lang.Object itemId)

Specified by:

containsId in interface TableItems<E>

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

getType

public java.lang.Class<?> getType(java.lang.Object propertyId)

Specified by:

getType in interface TableItems<E>

supportsProperty

public boolean supportsProperty(java.lang.Object propertyId)

Specified by:

supportsProperty in interface TableItems<E>

getSelectedItem

@Nullable
public E getSelectedItem()

Specified by:

getSelectedItem in interface EntityTableItems<E>

Returns:

the current item contained in the source

setSelectedItem

public void setSelectedItem(@Nullable
                            E item)

Description copied from interface: EntityTableItems

Set current item in the source.

Specified by:

setSelectedItem in interface EntityTableItems<E>

Parameters:

item - the item to set

addStateChangeListener

public io.jmix.core.common.event.Subscription addStateChangeListener(java.util.function.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 io.jmix.core.common.event.Subscription addValueChangeListener(java.util.function.Consumer<TableItems.ValueChangeEvent<E>> listener)

Description copied from interface: TableItems

Registers a new value change listener.

Specified by:

addValueChangeListener in interface TableItems<E>

Parameters:

listener - the listener to be added

Returns:

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

addItemSetChangeListener

public io.jmix.core.common.event.Subscription addItemSetChangeListener(java.util.function.Consumer<TableItems.ItemSetChangeEvent<E>> listener)

Description copied from interface: TableItems

Registers a new item set change listener.

Specified by:

addItemSetChangeListener in interface TableItems<E>

Parameters:

listener - the listener to be added

Returns:

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

addSelectedItemChangeListener

public io.jmix.core.common.event.Subscription addSelectedItemChangeListener(java.util.function.Consumer<TableItems.SelectedItemChangeEvent<E>> listener)

Description copied from interface: TableItems

Registers a new selected item change listener.

Specified by:

addSelectedItemChangeListener in interface TableItems<E>

Parameters:

listener - the listener to be added

Returns:

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

getEntityMetaClass

@Nullable
public io.jmix.core.metamodel.model.MetaClass getEntityMetaClass()

Specified by:

getEntityMetaClass in interface EntityDataUnit

Returns:

MetaClass of an entity contained in the source

nextItemId

@Nullable
public java.lang.Object nextItemId(@Nullable
                                             java.lang.Object itemId)

Description copied from interface: TableItems.Ordered

Gets the ID of the item following the Item that corresponds to itemId.

Specified by:

nextItemId in interface TableItems.Ordered<E>

Parameters:

itemId - item id

Returns:

ID of the next visible Item or null

prevItemId

@Nullable
public java.lang.Object prevItemId(@Nullable
                                             java.lang.Object itemId)

Description copied from interface: TableItems.Ordered

Gets the ID of the item preceding the item that corresponds to itemId.

Specified by:

prevItemId in interface TableItems.Ordered<E>

Parameters:

itemId - item id

Returns:

ID of the previous visible item or null

firstItemId

@Nullable
public java.lang.Object firstItemId()

Specified by:

firstItemId in interface TableItems.Ordered<E>

Returns:

ID of the first visible item

lastItemId

@Nullable
public java.lang.Object lastItemId()

Specified by:

lastItemId in interface TableItems.Ordered<E>

Returns:

ID of the last visible item

isFirstId

public boolean isFirstId(@Nullable
                         java.lang.Object itemId)

Description copied from interface: TableItems.Ordered

Tests if the Item corresponding to the given Item ID is the first item.

Specified by:

isFirstId in interface TableItems.Ordered<E>

Parameters:

itemId - item id

Returns:

true if the item is first visible item, false if not

isLastId

public boolean isLastId(@Nullable
                        java.lang.Object itemId)

Description copied from interface: TableItems.Ordered

Tests if the item corresponding to the given item ID is the last item.

Specified by:

isLastId in interface TableItems.Ordered<E>

Parameters:

itemId - item id

Returns:

true if the item is last visible item in the, false if not

sort

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

Description copied from interface: TableItems.Sortable

Sorts data.

Specified by:

sort in interface TableItems.Sortable<E>

Parameters:

propertyId - id of property

ascending - asc / desc flags

createSort

protected io.jmix.core.Sort createSort(java.lang.Object[] propertyId,
                                       boolean[] ascending)

resetSortOrder

public void resetSortOrder()

Description copied from interface: TableItems.Sortable

Resets sort order.

Specified by:

resetSortOrder in interface TableItems.Sortable<E>

suppressSorting

public void suppressSorting()

Specified by:

suppressSorting in interface TableItems.Sortable<E>

enableSorting

public void enableSorting()

Specified by:

enableSorting in interface TableItems.Sortable<E>