com.haulmont.cuba.desktop.gui.components

Class DesktopGroupTable<E extends Entity>

java.lang.Object

com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent<C>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractActionsHolderComponent<C>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractTable<org.jdesktop.swingx.JXTable,E>

com.haulmont.cuba.desktop.gui.components.DesktopTable<E>

com.haulmont.cuba.desktop.gui.components.DesktopGroupTable<E>

All Implemented Interfaces:

DesktopComponent, Component, Component.ActionsHolder, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasButtonsPanel, Component.HasCaption, Component.HasIcon, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasXmlDescriptor, Component.SecuredActionsHolder, Component.Wrapper, GroupTable<E>, ListComponent<E>, LookupComponent, LookupComponent.LookupSelectionChangeNotifier, Table<E>

public class DesktopGroupTable<E extends Entity>
extends DesktopTable<E>
implements GroupTable<E>

Nested Class Summary

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

GroupTable.GroupCellContext<E>, GroupTable.GroupCellValueFormatter<E>, GroupTable.GroupStyleProvider<E extends Entity>

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

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

DesktopComponent.HasContextHelpClickHandler

Field Summary

Fields inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

SWING_PROPERTY_CLASS, SWING_PROPERTY_ID

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
DesktopGroupTable()

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 groupingByUserEnabled)
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 class com.haulmont.cuba.desktop.gui.components.DesktopTable

setSortable

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractTable

addAggregationProperty, addAggregationProperty, addColumn, addColumnCollapsedListener, addGeneratedColumn, addGeneratedColumn, addLookupValueChangeListener, addPrintable, addStyleProvider, addValidator, addValidator, applyPresentation, applyPresentationAsDefault, applySettings, assignAutoDebugId, getAggregationResults, getAggregationStyle, getButtonsPanel, getColumn, getColumnControlVisible, getColumnReorderingAllowed, getColumns, getColumnSortable, getColumnSortable, getComposition, getDefaultPresentationId, getDescription, getEnterPressAction, getItemClickAction, getItemDatasource, getLookupSelectedItems, getNotCollapsedColumns, getPreferredRowHeight, getPresentations, getPrintable, getPrintable, getRowHeaderWidth, getRowsCount, getSelected, getSingleSelected, getSortInfo, getTableModel, isAggregatable, isColumnHeaderVisible, isContentRepaintEnabled, isContextMenuEnabled, isEditable, isMultiLineCells, isMultiSelect, isSettingsEnabled, isShowSelection, isShowTotalAggregation, isSortable, isTextSelectionEnabled, isUsePresentations, loadPresentations, packRows, refresh, removeAggregationProperty, removeClickListener, removeColumn, removeColumnCollapseListener, removeGeneratedColumn, removeLookupValueChangeListener, removePrintable, removeStyleProvider, repaint, requestFocus, resetPresentation, saveSettings, scrollTo, selectAll, setAggregatable, setAggregationStyle, setButtonsPanel, setClickListener, setColumnAlignment, setColumnAlignment, setColumnCaption, setColumnCaption, setColumnCollapsed, setColumnCollapsed, setColumnControlVisible, setColumnDescription, setColumnDescription, setColumnHeaderVisible, setColumnReorderingAllowed, setColumnSortable, setColumnSortable, setColumnWidth, setColumnWidth, setContentRepaintEnabled, setContextMenuEnabled, setDatasource, setDescription, setEditable, setEnterPressAction, setIconProvider, setId, setItemClickAction, setLookupSelectHandler, setMultiLineCells, setMultiSelect, setRequired, setRowHeaderMode, setRowHeaderWidth, setRowsCount, setSelected, setSelected, setSettingsEnabled, setShowSelection, setShowTotalAggregation, setStyleProvider, setTextSelectionEnabled, setWidth, showCustomPopup, showCustomPopupActions, sort, sortBy, updateEnabled, usePresentations

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractActionsHolderComponent

addAction, addAction, getAction, getActions, getActionsPermissions, removeAction, removeAction, removeAllActions

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

addStyleName, getAlignment, getCaption, getComponent, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getTabIndex, getWidth, getWidthUnits, getXmlDescriptor, isComponentVisible, isEnabled, isEnabledItself, isParentEnabled, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setContainer, setDebugId, setEnabled, setExpanded, setFrame, setHeight, setIcon, setIconFromSet, setParent, setParentEnabled, setResponsive, setStyleName, setTabIndex, setVisible, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

DesktopGroupTable

public DesktopGroupTable()

Method Detail

getDatasource

public GroupDatasource getDatasource()

Specified by:

getDatasource in interface GroupTable<E extends Entity>

Specified by:

getDatasource in interface ListComponent<E extends Entity>

Overrides:

getDatasource in class DesktopAbstractTable<org.jdesktop.swingx.JXTable,E extends Entity>

groupBy

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

Description copied from interface: GroupTable

Performs grouping by the given properties.

Specified by:

groupBy in interface GroupTable<E extends Entity>

Parameters:

properties - an array of MetaPropertyPath

groupByColumns

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

Description copied from interface: GroupTable

Performs grouping by the given ids of table columns.

Specified by:

groupByColumns in interface GroupTable<E extends Entity>

Parameters:

columnIds - column ids

ungroupByColumns

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

Description copied from interface: GroupTable

Resets grouping by the given ids of table columns.

Specified by:

ungroupByColumns in interface GroupTable<E extends Entity>

Parameters:

columnIds - column ids

ungroup

public void ungroup()

Description copied from interface: GroupTable

Resets grouping at all.

Specified by:

ungroup in interface GroupTable<E extends Entity>

getColumnGroupAllowed

public boolean getColumnGroupAllowed(java.lang.String columnId)

Specified by:

getColumnGroupAllowed in interface GroupTable<E extends Entity>

setColumnGroupAllowed

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

Specified by:

setColumnGroupAllowed in interface GroupTable<E extends Entity>

getColumnGroupAllowed

public boolean getColumnGroupAllowed(Table.Column column)

Specified by:

getColumnGroupAllowed in interface GroupTable<E extends Entity>

setColumnGroupAllowed

public void setColumnGroupAllowed(Table.Column column,
                                  boolean allowed)

Specified by:

setColumnGroupAllowed in interface GroupTable<E extends Entity>

getGroupCellValueFormatter

public GroupTable.GroupCellValueFormatter<E> getGroupCellValueFormatter()

Specified by:

getGroupCellValueFormatter in interface GroupTable<E extends Entity>

setGroupCellValueFormatter

public void setGroupCellValueFormatter(GroupTable.GroupCellValueFormatter<E> formatter)

Specified by:

setGroupCellValueFormatter in interface GroupTable<E extends Entity>

expandAll

public void expandAll()

Specified by:

expandAll in interface GroupTable<E extends Entity>

expand

public void expand(GroupInfo groupId)

Specified by:

expand in interface GroupTable<E extends Entity>

expandPath

public void expandPath(Entity item)

Description copied from interface: GroupTable

Expand all groups for specified item.

Specified by:

expandPath in interface GroupTable<E extends Entity>

collapseAll

public void collapseAll()

Specified by:

collapseAll in interface GroupTable<E extends Entity>

collapse

public void collapse(GroupInfo groupId)

Specified by:

collapse in interface GroupTable<E extends Entity>

isExpanded

public boolean isExpanded(GroupInfo groupId)

Specified by:

isExpanded in interface GroupTable<E extends Entity>

isFixedGrouping

public boolean isFixedGrouping()

Specified by:

isFixedGrouping in interface GroupTable<E extends Entity>

setFixedGrouping

public void setFixedGrouping(boolean groupingByUserEnabled)

Specified by:

setFixedGrouping in interface GroupTable<E extends Entity>

isShowItemsCountForGroup

public boolean isShowItemsCountForGroup()

Specified by:

isShowItemsCountForGroup in interface GroupTable<E extends Entity>

Returns:

true if GroupTable shows items count for group

setShowItemsCountForGroup

public void setShowItemsCountForGroup(boolean showItemsCountForGroup)

Description copied from interface: GroupTable

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

Specified by:

setShowItemsCountForGroup in interface GroupTable<E extends Entity>

getAggregationResults

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

Description copied from interface: GroupTable

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

Specified by:

getAggregationResults in interface GroupTable<E extends Entity>

Parameters:

info - the group info instance

Returns:

aggregation results for the given group info instance