com.haulmont.cuba.gui.components

Interface GroupTable<E extends Entity>

All Superinterfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasButtonsPanel, Component.HasCaption, Component.HasIcon, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, ListComponent<E>, LookupComponent, Table<E>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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.AggregationStyle, Table.CellClickListener, Table.Column, Table.ColumnAlignment, Table.ColumnCollapseListener, Table.ColumnGenerator<E extends Entity>, Table.PlainTextCell, Table.Printable<E extends Entity,P>, Table.PrintableColumnGenerator<E extends Entity,P>, Table.RowHeaderMode, 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.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

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

LookupComponent.LookupSelectionChangeEvent, LookupComponent.LookupSelectionChangeListener, LookupComponent.LookupSelectionChangeNotifier

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, 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.
boolean	getColumnGroupAllowed(java.lang.String columnId)
boolean	getColumnGroupAllowed(Table.Column column)
GroupDatasource	getDatasource()
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()
void	setColumnGroupAllowed(java.lang.String columnId, boolean allowed)
void	setColumnGroupAllowed(Table.Column column, boolean allowed)
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

addAggregationProperty, addAggregationProperty, addColumn, addColumnCollapsedListener, addGeneratedColumn, addGeneratedColumn, addPrintable, addStyleProvider, addValidator, addValidator, getAggregationResults, getAggregationStyle, getColumn, getColumnControlVisible, getColumnReorderingAllowed, getColumns, getColumnSortable, getColumnSortable, getEnterPressAction, getItemClickAction, getItemDatasource, getNotCollapsedColumns, getPrintable, getPrintable, getRowHeaderWidth, getSortInfo, isAggregatable, isColumnHeaderVisible, isContextMenuEnabled, isMultiLineCells, isShowSelection, isShowTotalAggregation, isSortable, isTextSelectionEnabled, refresh, removeAggregationProperty, removeClickListener, removeColumn, removeColumnCollapseListener, removeGeneratedColumn, removePrintable, removeStyleProvider, repaint, requestFocus, scrollTo, selectAll, setAggregatable, setAggregationStyle, setClickListener, setColumnAlignment, setColumnAlignment, setColumnCaption, setColumnCaption, setColumnCollapsed, setColumnCollapsed, setColumnControlVisible, setColumnDescription, setColumnDescription, setColumnHeaderVisible, setColumnReorderingAllowed, setColumnSortable, setColumnSortable, setColumnWidth, setColumnWidth, setContextMenuEnabled, setDatasource, setEnterPressAction, setIconProvider, setItemClickAction, 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.Component.ActionsHolder

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

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.HasButtonsPanel

getButtonsPanel, setButtonsPanel

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

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

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

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

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

getCaption, getDescription, setCaption, setDescription

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

getIcon, setIcon, setIconFromSet

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

getRowsCount, setRowsCount

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

getLookupSelectedItems, setLookupSelectHandler

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

getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getDatasource

GroupDatasource getDatasource()

Specified by:

getDatasource in interface ListComponent<E extends Entity>

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.

getColumnGroupAllowed

boolean getColumnGroupAllowed(java.lang.String columnId)

setColumnGroupAllowed

void setColumnGroupAllowed(java.lang.String columnId,
                           boolean allowed)

getColumnGroupAllowed

boolean getColumnGroupAllowed(Table.Column column)

setColumnGroupAllowed

void setColumnGroupAllowed(Table.Column column,
                           boolean allowed)

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