Package io.jmix.groupgridflowui.component

Interface EnhancedGroupDataGrid<T>

All Known Implementing Classes:

GroupDataGrid

public interface EnhancedGroupDataGrid<T>

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
void	addAggregation(Grid.Column<T> column, AggregationInfo info)	Add aggregation info to perform aggregation for column.
DataGridColumn<T>	addColumn(MetaPropertyPath metaPropertyPath)	Adds a column by the meta-property path.
DataGridColumn<T>	addColumn(String key, MetaPropertyPath metaPropertyPath)	Adds a column by the meta-property path and specified key.
EnhancedGroupDataGrid.AggregationPosition	getAggregationPosition()
Map<Grid.Column<T>,Object>	getAggregationResults()
DataGridColumn<T>	getColumnByMetaPropertyPath(MetaPropertyPath metaPropertyPath)
MetaPropertyPath	getColumnMetaPropertyPath(Grid.Column<T> column)
JmixGroupGridContextMenu<T>	getContextMenu()
boolean	isAggregatable()
boolean	isEditorCreated()
void	setAggregatable(boolean aggregatable)	Set to true if aggregation should be enabled.
void	setAggregationPosition(EnhancedGroupDataGrid.AggregationPosition position)	Sets aggregation row position.

Method Details

getColumnMetaPropertyPath

@Nullable
MetaPropertyPath getColumnMetaPropertyPath(Grid.Column<T> column)

Parameters:

column - column to get the meta-property path for

Returns:

MetaPropertyPath that refers to the column or null if the column is not bound to any property

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)

Adds a column by the meta-property path.

Parameters:

metaPropertyPath - meta-property path to add a column

Returns:

added column

addColumn

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

Adds a column by the meta-property path and specified key. The key is used to identify the column, see Grid.getColumnByKey(String).

Parameters:

key - column key

metaPropertyPath - meta-property path to add a column

Returns:

added column

isEditorCreated

boolean isEditorCreated()

Returns:

true if the editor is created

isAggregatable

boolean isAggregatable()

Returns:

true if DataGrid is aggregatable

setAggregatable

void setAggregatable(boolean aggregatable)

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

Parameters:

aggregatable - whether to aggregate DataGrid columns

getAggregationPosition

EnhancedGroupDataGrid.AggregationPosition getAggregationPosition()

Returns:

return aggregation row position

setAggregationPosition

void setAggregationPosition(EnhancedGroupDataGrid.AggregationPosition position)

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

Parameters:

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

addAggregation

void addAggregation(Grid.Column<T> column,
 AggregationInfo info)

Add aggregation info to perform aggregation for column.

Parameters:

column - column for aggregation

info - aggregation info

See Also:

• GroupDataGrid.setAggregatable(boolean)

getAggregationResults

Map<Grid.Column<T>,Object> getAggregationResults()

Returns:

aggregated values for columns

getContextMenu

JmixGroupGridContextMenu<T> getContextMenu()

Returns:

context menu instance attached to the grid