E
- row item type@StudioComponent(caption="GroupTable", category="Components", xmlElement="groupTable", icon="io/jmix/ui/icon/component/groupTable.svg", canvasBehaviour=TABLE, documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/group-table.html") public interface GroupTable<E> extends Table<E>
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.GroupColumn<E>
GroupTable column.
|
static interface |
GroupTable.GroupStyleProvider<E>
Allows to define different styles for table cells.
|
Table.AggregationDistributionContext<E>, Table.AggregationDistributionProvider<E>, Table.AggregationStyle, Table.Column<E>, Table.ColumnAlignment, Table.ColumnCollapseEvent<E>, Table.ColumnGenerator<E>, Table.ColumnReorderEvent<E>, Table.EmptyStateClickEvent<E>, Table.PlainTextCell, Table.Printable<E,P>, Table.PrintableColumnGenerator<E,P>, Table.RowHeaderMode, Table.SelectionEvent<E>, Table.SortDirection, Table.SortInfo, Table.StyleProvider<E>
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
LookupComponent.LookupSelectionChangeEvent<T>, LookupComponent.LookupSelectionChangeNotifier<T>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Modifier and Type | Method and Description |
---|---|
void |
collapse(GroupInfo groupId) |
void |
collapseAll() |
void |
expand(GroupInfo groupId) |
void |
expandAll() |
void |
expandPath(java.lang.Object 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.
|
java.util.List<Table.Column<E>> |
getColumns()
Returns a copy of currently configured columns in their current visual
order in this Table.
|
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> org.springframework.core.ParameterizedTypeReference<GroupTable<T>> |
of(java.lang.Class<T> itemClass) |
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.
|
addColumn, addColumn, addColumn, addColumn, addColumnCollapseListener, addColumnReorderListener, addGeneratedColumn, addGeneratedColumn, addGeneratedColumn, addPrintable, addSelectionListener, addStyleProvider, getAggregationDistributionProvider, getAggregationResults, getAggregationStyle, getColumn, getColumnControlVisible, getColumnReorderingAllowed, getEmptyStateLinkClickHandler, getEmptyStateLinkMessage, getEmptyStateMessage, getEnterPressAction, getInstanceContainer, getItemClickAction, getItemDescriptionProvider, getItems, getNotCollapsedColumns, getPrintable, getPrintable, getRowHeaderWidth, getSortInfo, getSubPart, isAggregatable, isColumnHeaderVisible, isContextMenuEnabled, isMultiLineCells, isShowSelection, isShowTotalAggregation, isSortable, isTextSelectionEnabled, removeColumn, removeGeneratedColumn, removePrintable, removeStyleProvider, repaint, requestFocus, scrollTo, selectAll, setAggregatable, setAggregationDistributionProvider, setAggregationStyle, setColumnControlVisible, setColumnHeaderVisible, setColumnReorderingAllowed, setContextMenuEnabled, setEmptyStateLinkClickHandler, setEmptyStateLinkMessage, setEmptyStateMessage, setEnterPressAction, setIconProvider, setItemClickAction, setItemDescriptionProvider, setItems, setMultiLineCells, setMultiSelect, setRequired, setRowHeaderMode, setRowHeaderWidth, setShowSelection, setShowTotalAggregation, setSortable, setStyleProvider, setTextSelectionEnabled, showCustomPopup, showCustomPopupActions, sort
getSelected, getSingleSelected, isMultiSelect, setSelected, setSelected
getFrame, setFrame
addAction, addAction, getAction, getActionNN, getActions, removeAction, removeAction, removeAllActions
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition
isEditable, isEditableWithParent, setEditable
getButtonsPanel, setButtonsPanel
applyPresentation, applyPresentationAsDefault, getDefaultPresentationId, getDefaultSettings, getPresentations, loadPresentations, resetPresentation, setDefaultSettings
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
getIcon, setIcon, setIconFromSet
getLookupSelectedItems, setLookupSelectHandler
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
getPagination, setPagination
static final java.lang.String NAME
static <T> org.springframework.core.ParameterizedTypeReference<GroupTable<T>> of(java.lang.Class<T> itemClass)
@StudioElementsGroup(xmlElement="group", caption="Group", icon="io/jmix/ui/icon/element/group.svg", elementXmlName="column") java.util.List<Table.Column<E>> getColumns()
Table
getColumns
in interface Table<E>
Table.getNotCollapsedColumns()
void groupBy(java.lang.Object[] properties)
properties
.properties
- an array of MetaPropertyPath
void groupByColumns(java.lang.String... columnIds)
columnIds
- column idsvoid ungroupByColumns(java.lang.String... columnIds)
columnIds
- column idsvoid ungroup()
GroupTable.GroupCellValueFormatter<E> getGroupCellValueFormatter()
void setGroupCellValueFormatter(GroupTable.GroupCellValueFormatter<E> formatter)
void expandAll()
void expand(GroupInfo groupId)
void expandPath(java.lang.Object item)
void collapseAll()
void collapse(GroupInfo groupId)
boolean isExpanded(GroupInfo groupId)
boolean isFixedGrouping()
@StudioProperty(defaultValue="false") void setFixedGrouping(boolean fixedGrouping)
boolean isShowItemsCountForGroup()
void setShowItemsCountForGroup(boolean showItemsCountForGroup)
java.util.Map<java.lang.Object,java.lang.Object> getAggregationResults(GroupInfo info)
info
- the group info instance