com.haulmont.cuba.gui.components

Interface GroupTable<E extends Entity>

Type Parameters:

E - row item type

All Superinterfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasButtonsPanel, HasContextHelp, HasDataLoadingSettings, HasHtmlCaption, HasHtmlDescription, HasPresentations, HasRowsCount, HasSettings, HasSubParts, ListComponent<E>, LookupComponent<E>, RowsCount.RowsCountTarget, Table<E>

public interface GroupTable<E extends Entity>
extends Table<E>

Table UI component that supports grouping of rows by property values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GroupTable.GroupAggregationDistributionContext<V> Object that contains information about group aggregation distribution.
static class	GroupTable.GroupCellContext<E>
static interface	GroupTable.GroupCellValueFormatter<E>
static interface	GroupTable.GroupStyleProvider<E extends Entity> Allows to define different styles for table cells.

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

Table.AggregationDistributionContext<E>, Table.AggregationDistributionProvider<E>, Table.AggregationStyle, Table.CellClickEvent<T extends Entity>, Table.CellClickListener<T extends Entity>, Table.Column<T extends Entity>, Table.ColumnAlignment, Table.ColumnCollapseEvent<E extends Entity>, Table.ColumnCollapseListener, Table.ColumnGenerator<E extends Entity>, Table.PlainTextCell, Table.Printable<E extends Entity,P>, Table.PrintableColumnGenerator<E extends Entity,P>, Table.RowHeaderMode, Table.SelectionEvent<E extends Entity>, Table.SortDirection, Table.SortInfo, Table.StyleProvider<E extends Entity>

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

ListComponent.IconProvider<E extends Entity>

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

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

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

HasContextHelp.ContextHelpIconClickEvent

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

LookupComponent.LookupSelectionChangeEvent<T extends Entity>, LookupComponent.LookupSelectionChangeNotifier<T extends Entity>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	collapse(GroupInfo groupId)
void	collapseAll()
void	expand(GroupInfo groupId)
void	expandAll()
void	expandPath(Entity item) Expand all groups for specified item.
java.util.Map<java.lang.Object,java.lang.Object>	getAggregationResults(GroupInfo info) Returns a map with aggregation results for the given group info instance, where keys are table column ids and values are aggregation value.
default GroupDatasource	getDatasource() Deprecated.
GroupTable.GroupCellValueFormatter<E>	getGroupCellValueFormatter()
void	groupBy(java.lang.Object[] properties) Performs grouping by the given properties.
void	groupByColumns(java.lang.String... columnIds) Performs grouping by the given ids of table columns.
boolean	isExpanded(GroupInfo groupId)
boolean	isFixedGrouping()
boolean	isShowItemsCountForGroup()
static <T extends Entity> com.google.common.reflect.TypeToken<GroupTable<T>>	of(java.lang.Class<T> itemClass)
default void	setDatasource(CollectionDatasource datasource) Deprecated.
void	setFixedGrouping(boolean fixedGrouping)
void	setGroupCellValueFormatter(GroupTable.GroupCellValueFormatter<E> formatter)
void	setShowItemsCountForGroup(boolean showItemsCountForGroup) Show or hide items count for GroupTable groups.
void	ungroup() Resets grouping at all.
void	ungroupByColumns(java.lang.String... columnIds) Resets grouping by the given ids of table columns.

Methods inherited from interface com.haulmont.cuba.gui.components.Table

addColumn, addColumn, addColumnCollapsedListener, addColumnCollapseListener, addGeneratedColumn, addGeneratedColumn, addGeneratedColumn, addPrintable, addSelectionListener, addStyleProvider, addValidator, addValidator, getAggregationDistributionProvider, getAggregationResults, getAggregationStyle, getColumn, getColumnControlVisible, getColumnReorderingAllowed, getColumns, getEnterPressAction, getInstanceContainer, getItemClickAction, getItemDatasource, getItems, getNotCollapsedColumns, getPrintable, getPrintable, getRowHeaderWidth, getSortInfo, getSubPart, isAggregatable, isAutoScrolling, isColumnHeaderVisible, isContextMenuEnabled, isMultiLineCells, isShowSelection, isShowTotalAggregation, isSortable, isTextSelectionEnabled, refresh, removeClickListener, removeColumn, removeColumnCollapseListener, removeColumnCollapseListener, removeGeneratedColumn, removePrintable, removeStyleProvider, repaint, requestFocus, scrollTo, selectAll, setAggregatable, setAggregationDistributionProvider, setAggregationStyle, setAutoScrolling, setCellClickListener, setClickListener, setColumnControlVisible, setColumnHeaderVisible, setColumnReorderingAllowed, setContextMenuEnabled, setEnterPressAction, setIconProvider, setItemClickAction, setItems, setMultiLineCells, setMultiSelect, setRequired, setRowHeaderMode, setRowHeaderWidth, setShowSelection, setShowTotalAggregation, setSortable, setStyleProvider, setTextSelectionEnabled, showCustomPopup, showCustomPopupActions, sort, sortBy

Methods inherited from interface com.haulmont.cuba.gui.components.ListComponent

getSelected, getSingleSelected, isMultiSelect, setSelected, setSelected

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, removeAction, removeAction, removeAllActions

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.HasDataLoadingSettings

applyDataLoadingSettings

Methods inherited from interface com.haulmont.cuba.gui.components.HasButtonsPanel

getButtonsPanel, setButtonsPanel

Methods inherited from interface com.haulmont.cuba.gui.components.HasPresentations

applyPresentation, applyPresentationAsDefault, getDefaultPresentationId, getPresentations, isUsePresentations, loadPresentations, resetPresentation, usePresentations

Methods inherited from interface com.haulmont.cuba.gui.components.HasSettings

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasRowsCount

getRowsCount, setRowsCount, setRowsCountTotalCountDelegate

Methods inherited from interface com.haulmont.cuba.gui.components.LookupComponent

getLookupSelectedItems, setLookupSelectHandler

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

of

static <T extends Entity> com.google.common.reflect.TypeToken<GroupTable<T>> of(java.lang.Class<T> itemClass)

Specified by:

of in interface Table<E extends Entity>

getDatasource

@Deprecated
default GroupDatasource getDatasource()

Deprecated.

Specified by:

getDatasource in interface ListComponent<E extends Entity>

Specified by:

getDatasource in interface Table<E extends Entity>

Returns:

datasource

setDatasource

@Deprecated
default void setDatasource(CollectionDatasource datasource)

Deprecated.

Specified by:

setDatasource in interface Table<E extends Entity>

Parameters:

datasource - datasource

groupBy

void groupBy(java.lang.Object[] properties)

Performs grouping by the given properties.

Parameters:

properties - an array of MetaPropertyPath

groupByColumns

void groupByColumns(java.lang.String... columnIds)

Performs grouping by the given ids of table columns.

Parameters:

columnIds - column ids

ungroupByColumns

void ungroupByColumns(java.lang.String... columnIds)

Resets grouping by the given ids of table columns.

Parameters:

columnIds - column ids

ungroup

void ungroup()

Resets grouping at all.

getGroupCellValueFormatter

GroupTable.GroupCellValueFormatter<E> getGroupCellValueFormatter()

setGroupCellValueFormatter

void setGroupCellValueFormatter(GroupTable.GroupCellValueFormatter<E> formatter)

expandAll

void expandAll()

expand

void expand(GroupInfo groupId)

expandPath

void expandPath(Entity item)

Expand all groups for specified item.

collapseAll

void collapseAll()

collapse

void collapse(GroupInfo groupId)

isExpanded

boolean isExpanded(GroupInfo groupId)

isFixedGrouping

boolean isFixedGrouping()

setFixedGrouping

void setFixedGrouping(boolean fixedGrouping)

isShowItemsCountForGroup

boolean isShowItemsCountForGroup()

Returns:

true if GroupTable shows items count for group

setShowItemsCountForGroup

void setShowItemsCountForGroup(boolean showItemsCountForGroup)

Show or hide items count for GroupTable groups.
Default value is true.

getAggregationResults

java.util.Map<java.lang.Object,java.lang.Object> getAggregationResults(GroupInfo info)

Returns a map with aggregation results for the given group info instance, where keys are table column ids and values are aggregation value.

Parameters:

info - the group info instance

Returns:

aggregation results for the given group info instance