ContainerDataGridItems (CUBA 7.2 API)

java.lang.Object
- com.haulmont.cuba.gui.components.data.datagrid.ContainerDataGridItems<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

ContainerTreeDataGridItems
```
public class ContainerDataGridItems<E extends Entity>
extends java.lang.Object
implements EntityDataGridItems<E>, AggregatableDataGridItems<E>, DataGridItems.Sortable<E>, ContainerDataUnit<E>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.DataGridItems
  DataGridItems.ItemSetChangeEvent<T>, DataGridItems.SelectedItemChangeEvent<T>, DataGridItems.Sortable<T>, DataGridItems.ValueChangeEvent<T>
- Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.DataUnit
  DataUnit.StateChangeEvent

Field Summary

Fields
Modifier and Type	Field and Description
`protected AggregatableDelegate`	`aggregatableDelegate`
`protected CollectionContainer<E>`	`container`
`protected EventHub`	`events`
`protected boolean`	`suppressSorting`

Constructor Summary

Constructors
Constructor and Description

ContainerDataGridItems(CollectionContainer<E> container)

Constructors
Constructor and Description
`ContainerDataGridItems(CollectionContainer<E> container)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subscription`	`addItemSetChangeListener(java.util.function.Consumer<DataGridItems.ItemSetChangeEvent<E>> listener)` Registers a new item set change listener.
`Subscription`	`addSelectedItemChangeListener(java.util.function.Consumer<DataGridItems.SelectedItemChangeEvent<E>> listener)` Registers a new selected item change listener.
`Subscription`	`addStateChangeListener(java.util.function.Consumer<DataUnit.StateChangeEvent> listener)` Registers a new state change listener.
`Subscription`	`addValueChangeListener(java.util.function.Consumer<DataGridItems.ValueChangeEvent<E>> listener)` Registers a new value change listener.
`java.util.Map<AggregationInfo,java.lang.String>`	`aggregate(AggregationInfo[] aggregationInfos, java.util.Collection<?> itemIds)` Perform aggregation and return map with formatted string values.
`java.util.Map<AggregationInfo,java.lang.Object>`	`aggregateValues(AggregationInfo[] aggregationInfos, java.util.Collection<?> itemIds)` Perform aggregation and return map with aggregation info and aggregation column type, i.e.
`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 AggregatableDelegate`	`createAggregatableDelegate()`
`protected Sort`	`createSort(java.lang.Object[] propertyId, boolean[] ascending)`
`void`	`enableSorting()`
`CollectionContainer<E>`	`getContainer()`
`MetaClass`	`getEntityMetaClass()`
`E`	`getItem(java.lang.Object itemId)`
`E`	`getItemByIndex(int index)`
`java.lang.Object`	`getItemId(E item)`
`java.util.stream.Stream<E>`	`getItems()`
`java.util.List<E>`	`getItems(int startIndex, int numberOfItems)`
`E`	`getSelectedItem()`
`BindingState`	`getState()`
`int`	`indexOfItem(E item)`
`void`	`resetSortOrder()`
`void`	`setSelectedItem(E item)` Set current item in the source.
`int`	`size()`
`void`	`sort(java.lang.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 Detail
  - container
```
protected CollectionContainer<E extends Entity> container
```
  - suppressSorting
```
protected boolean suppressSorting
```
  - aggregatableDelegate
```
protected AggregatableDelegate aggregatableDelegate
```
  - events
```
protected EventHub events
```
- Constructor Detail
  - ContainerDataGridItems
```
public ContainerDataGridItems(CollectionContainer<E> container)
```
- Method Detail
  - getContainer
```
public CollectionContainer<E> getContainer()
```
    Specified by:
    
    getContainer in interface ContainerDataUnit<E extends Entity>
  - 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
```
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
```
public java.lang.Object getItemId(E item)
```
    Specified by:
    
    getItemId in interface DataGridItems<E extends Entity>
    
    Parameters:
    
    item - the item for obtaining the id
    
    Returns:
    
    the id on the given item
  - getItem
```
public E getItem(java.lang.Object itemId)
```
    Specified by:
    
    getItem in interface DataGridItems<E extends Entity>
    
    Parameters:
    
    itemId - the item id
    
    Returns:
    
    the item by the given id
  - indexOfItem
```
public int indexOfItem(E item)
```
    Specified by:
    
    indexOfItem in interface DataGridItems<E extends Entity>
    
    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 extends Entity>
    
    Parameters:
    
    index - the item index
    
    Returns:
    
    the item by the given index
  - getItems
```
public java.util.stream.Stream<E> getItems()
```
    Specified by:
    
    getItems in interface DataGridItems<E extends Entity>
    
    Returns:
    
    the stream of all items
  - getItems
```
public java.util.List<E> getItems(int startIndex,
                                  int numberOfItems)
```
    Specified by:
    
    getItems in interface DataGridItems<E extends Entity>
    
    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 extends Entity>
    
    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 extends Entity>
    
    Returns:
    
    size of the underlying collection
  - getSelectedItem
```
@Nullable
public E getSelectedItem()
```
    Specified by:
    
    getSelectedItem in interface DataGridItems<E extends Entity>
    
    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 extends Entity>
    
    Parameters:
    
    item - the item to set
  - addStateChangeListener
```
public 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 Subscription addValueChangeListener(java.util.function.Consumer<DataGridItems.ValueChangeEvent<E>> listener)
```
    Description copied from interface: DataGridItems
    
    Registers a new value change listener.
    
    Specified by:
    
    addValueChangeListener in interface DataGridItems<E extends Entity>
    
    Parameters:
    
    listener - the listener to be added
    
    Returns:
    
    a registration object for removing an event listener added to a source
  - addItemSetChangeListener
```
public Subscription addItemSetChangeListener(java.util.function.Consumer<DataGridItems.ItemSetChangeEvent<E>> listener)
```
    Description copied from interface: DataGridItems
    
    Registers a new item set change listener.
    
    Specified by:
    
    addItemSetChangeListener in interface DataGridItems<E extends Entity>
    
    Parameters:
    
    listener - the listener to be added
    
    Returns:
    
    a registration object for removing an event listener added to a source
  - addSelectedItemChangeListener
```
public Subscription addSelectedItemChangeListener(java.util.function.Consumer<DataGridItems.SelectedItemChangeEvent<E>> listener)
```
    Description copied from interface: DataGridItems
    
    Registers a new selected item change listener.
    
    Specified by:
    
    addSelectedItemChangeListener in interface DataGridItems<E extends Entity>
    
    Parameters:
    
    listener - the listener to be added
    
    Returns:
    
    a registration object for removing an event listener added to a source
  - sort
```
public void sort(java.lang.Object[] propertyId,
                 boolean[] ascending)
```
    Specified by:
    
    sort in interface DataGridItems.Sortable<E extends Entity>
  - createSort
```
protected Sort createSort(java.lang.Object[] propertyId,
                          boolean[] ascending)
```
  - resetSortOrder
```
public void resetSortOrder()
```
    Specified by:
    
    resetSortOrder in interface DataGridItems.Sortable<E extends Entity>
  - suppressSorting
```
public void suppressSorting()
```
    Specified by:
    
    suppressSorting in interface DataGridItems.Sortable<E extends Entity>
  - enableSorting
```
public void enableSorting()
```
    Specified by:
    
    enableSorting in interface DataGridItems.Sortable<E extends Entity>
  - aggregate
```
public java.util.Map<AggregationInfo,java.lang.String> aggregate(AggregationInfo[] aggregationInfos,
                                                                 java.util.Collection<?> itemIds)
```
    Description copied from interface: AggregatableDataGridItems
    
    Perform aggregation and return map with formatted string values.
    
    Specified by:
    
    aggregate in interface AggregatableDataGridItems<E extends Entity>
    
    Parameters:
    
    aggregationInfos - aggregation infos
    
    itemIds - collection of item ids
    
    Returns:
    
    map with aggregation info and formatted string values
  - aggregateValues
```
public java.util.Map<AggregationInfo,java.lang.Object> aggregateValues(AggregationInfo[] aggregationInfos,
                                                                       java.util.Collection<?> itemIds)
```
    Description copied from interface: AggregatableDataGridItems
    
    Perform aggregation and return map with aggregation info and aggregation column type, i.e. if aggregation was performed for Long type column it will return pair: AggregationInfo - Long.
    
    Specified by:
    
    aggregateValues in interface AggregatableDataGridItems<E extends Entity>
    
    Parameters:
    
    aggregationInfos - aggregation infos
    
    itemIds - collection of item ids
    
    Returns:
    
    map with aggregation info and aggregation column type
  - createAggregatableDelegate
```
protected AggregatableDelegate createAggregatableDelegate()
```

Class ContainerDataGridItems<E extends Entity>

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

container

suppressSorting

aggregatableDelegate

events

Constructor Detail

ContainerDataGridItems

Method Detail

getContainer

containerItemChanged

containerCollectionChanged

containerItemPropertyChanged

getEntityMetaClass

getState

getItemId

getItem

indexOfItem

getItemByIndex

getItems

getItems

containsItem

size

getSelectedItem

setSelectedItem

addStateChangeListener

addValueChangeListener

addItemSetChangeListener

addSelectedItemChangeListener

sort

createSort

resetSortOrder

suppressSorting

enableSorting

aggregate

aggregateValues

createAggregatableDelegate