Package io.jmix.flowui.component.grid

Interface EnhancedDataGrid<T>

All Known Subinterfaces:

EnhancedTreeDataGrid<T>

All Known Implementing Classes:

AbstractGroupDataGridAdapter, DataGrid, GroupDataGridAdapter, TreeDataGrid

public interface EnhancedDataGrid<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EnhancedDataGrid.AggregationPosition	Defines the position of aggregation row.

Method Summary

Modifier and Type	Method	Description
void	addAggregation(com.vaadin.flow.component.grid.Grid.Column<T> column, AggregationInfo info)	Add an aggregation info in order to perform aggregation for column.
DataGridColumn<T>	addColumn(MetaPropertyPath metaPropertyPath)
DataGridColumn<T>	addColumn(String key, MetaPropertyPath metaPropertyPath)
EnhancedDataGrid.AggregationPosition	getAggregationPosition()
Map<com.vaadin.flow.component.grid.Grid.Column<T>,Object>	getAggregationResults()
DataGridColumn<T>	getColumnByMetaPropertyPath(MetaPropertyPath metaPropertyPath)
MetaPropertyPath	getColumnMetaPropertyPath(com.vaadin.flow.component.grid.Grid.Column<T> column)
JmixGridContextMenu<T>	getContextMenu()
boolean	isAggregatable()
boolean	isEditorCreated()
void	setAggregatable(boolean aggregatable)	Set to true if aggregation should be enabled.
void	setAggregationPosition(EnhancedDataGrid.AggregationPosition position)	Sets aggregation row position.

Method Details

getColumnMetaPropertyPath

@Nullable
MetaPropertyPath getColumnMetaPropertyPath(com.vaadin.flow.component.grid.Grid.Column<T> column)

getColumnByMetaPropertyPath

@Nullable
DataGridColumn<T> getColumnByMetaPropertyPath(MetaPropertyPath metaPropertyPath)

Parameters:

metaPropertyPath - MetaPropertyPath that refers to the column

Returns:

DataGridColumn that is bound to the passed metaPropertyPath

addColumn

DataGridColumn<T> addColumn(MetaPropertyPath metaPropertyPath)

addColumn

DataGridColumn<T> addColumn(String key,
 MetaPropertyPath metaPropertyPath)

isEditorCreated

boolean isEditorCreated()

isAggregatable

boolean isAggregatable()

Returns:

true if DataGrid is aggregatable

setAggregatable

void setAggregatable(boolean aggregatable)

Set to true if aggregation should be enabled. Default value is false.

Parameters:

aggregatable - whether to aggregate DataGrid columns

getAggregationPosition

EnhancedDataGrid.AggregationPosition getAggregationPosition()

Returns:

return aggregation row position

setAggregationPosition

void setAggregationPosition(EnhancedDataGrid.AggregationPosition position)

Sets aggregation row position. Default value is EnhancedDataGrid.AggregationPosition.BOTTOM.

Parameters:

position - position: EnhancedDataGrid.AggregationPosition.TOP or EnhancedDataGrid.AggregationPosition.BOTTOM

addAggregation

void addAggregation(com.vaadin.flow.component.grid.Grid.Column<T> column,
 AggregationInfo info)

Add an aggregation info in order to perform aggregation for column.

Parameters:

column - column for aggregation

info - aggregation info

See Also:

• DataGrid.setAggregatable(boolean)

getAggregationResults

Map<com.vaadin.flow.component.grid.Grid.Column<T>,Object> getAggregationResults()

Returns:

aggregated values for columns

getContextMenu

JmixGridContextMenu<T> getContextMenu()

Returns:

context menu instance attached to the grid