Table (CUBA 7.0 API)

Type Parameters:

E - row item type

All Superinterfaces:

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

All Known Subinterfaces:

GroupTable<E>, TreeTable<E>
```
public interface Table<E extends Entity>
extends ListComponent<E>, Component.Editable, HasSettings, HasButtonsPanel, HasPresentations, Component.HasCaption, HasContextHelp, Component.HasIcon, HasRowsCount, LookupComponent<E>, Component.Focusable, RowsCount.RowsCountTarget, HasSubParts, HasHtmlCaption, HasHtmlDescription
```
Table UI component bound to entity type.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Table.AggregationDistributionContext<E>` Object that contains information about aggregation distribution.
`static interface`	`Table.AggregationDistributionProvider<E>` Allows to handle a group or total aggregation value changes.
`static class`	`Table.AggregationStyle`
`static class`	`Table.CellClickEvent<T extends Entity>`
`static interface`	`Table.CellClickListener<T extends Entity>` Deprecated. Use `setCellClickListener(String, Consumer)` instead.
`static class`	`Table.Column<T extends Entity>`
`static class`	`Table.ColumnAlignment`
`static class`	`Table.ColumnCollapseEvent<E extends Entity>` Event sent every time column collapse state changes.
`static interface`	`Table.ColumnCollapseListener` Deprecated. Use `addColumnCollapseListener(Consumer)` instead
`static interface`	`Table.ColumnGenerator<E extends Entity>` Allows rendering of an arbitrary `Component` inside a table cell.
`static class`	`Table.PlainTextCell` Special component for generated columns which will be rendered as simple text cell.
`static interface`	`Table.Printable<E extends Entity,P>` Allows set Printable representation for column in Excel export.
`static interface`	`Table.PrintableColumnGenerator<E extends Entity,P>` Column generator, which supports print to Excel.
`static class`	`Table.RowHeaderMode`
`static class`	`Table.SelectionEvent<E extends Entity>` Event sent when the selection changes.
`static class`	`Table.SortDirection` Describes sorting direction.
`static class`	`Table.SortInfo`
`static interface`	`Table.StyleProvider<E extends Entity>` Allows to define different styles for table cells.

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

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAggregationProperty(java.lang.String columnId, AggregationInfo.Type type)` Deprecated. Use `Table.Column.setAggregation(AggregationInfo)` instead.
`void`	`addAggregationProperty(Table.Column columnId, AggregationInfo.Type type)` Deprecated. Use `Table.Column.setAggregation(AggregationInfo)` instead.
`void`	`addColumn(Table.Column<E> column)`
`default void`	`addColumnCollapsedListener(Table.ColumnCollapseListener columnCollapsedListener)` Deprecated. Use `addColumnCollapseListener(Consumer)` instead
`com.haulmont.bali.events.Subscription`	`addColumnCollapseListener(java.util.function.Consumer<Table.ColumnCollapseEvent> listener)` Adds a listener for column collapse events.
`void`	`addGeneratedColumn(java.lang.String columnId, Table.ColumnGenerator<? super E> generator)` Add a generated column to the table.
`void`	`addGeneratedColumn(java.lang.String columnId, Table.ColumnGenerator<? super E> generator, java.lang.Class<? extends Component> componentClass)` Add a generated column to the table.
`void`	`addPrintable(java.lang.String columnId, Table.Printable<? super E,?> printable)` Adds `Table.Printable` representation for column.
`com.haulmont.bali.events.Subscription`	`addSelectionListener(java.util.function.Consumer<Table.SelectionEvent<E>> listener)` Registers a new selection listener
`void`	`addStyleProvider(Table.StyleProvider<? super E> styleProvider)` Add style provider for the table. Table can use several providers to obtain many style names for cells and rows.
`default void`	`addValidator(java.util.function.Consumer<?> validator)` Deprecated. automatic validation of Table is not supported
`default void`	`addValidator(Table.Column column, java.util.function.Consumer<?> validator)` Deprecated. automatic validation of Table is not supported
`Table.AggregationDistributionProvider<E>`	`getAggregationDistributionProvider()`
`java.util.Map<java.lang.Object,java.lang.Object>`	`getAggregationResults()` Returns a map with aggregation results, where keys are table column ids and values are aggregation values.
`Table.AggregationStyle`	`getAggregationStyle()`
`Table.Column<E>`	`getColumn(java.lang.String id)`
`boolean`	`getColumnCaptionAsHtml(java.lang.String columnId)` Deprecated. Use `Table.Column.isCaptionAsHtml()` instead.
`boolean`	`getColumnCaptionAsHtml(Table.Column column)` Deprecated. Use `Table.Column.isCaptionAsHtml()` instead.
`boolean`	`getColumnControlVisible()`
`boolean`	`getColumnReorderingAllowed()`
`java.util.List<Table.Column<E>>`	`getColumns()`
`boolean`	`getColumnSortable(java.lang.String columnId)` Deprecated. Use `Table.Column.isSortable()` instead.
`boolean`	`getColumnSortable(Table.Column column)` Deprecated. User `Table.Column.isSortable()` instead.
`default CollectionDatasource`	`getDatasource()` Deprecated. Use `getItems()` instead
`Action`	`getEnterPressAction()`
`InstanceContainer<E>`	`getInstanceContainer(E item)` This method returns the InstanceContainer which contains the provided item.
`Action`	`getItemClickAction()`
`Datasource`	`getItemDatasource(Entity item)` Deprecated. Use `getInstanceContainer(Entity)` instead.
`TableItems<E>`	`getItems()`
`java.util.List<Table.Column>`	`getNotCollapsedColumns()`
`Table.Printable`	`getPrintable(java.lang.String columnId)` Get `Table.Printable` representation for column.
`Table.Printable`	`getPrintable(Table.Column column)` Get `Table.Printable` representation for column.
`int`	`getRowHeaderWidth()`
`Table.SortInfo`	`getSortInfo()`
`default java.lang.Object`	`getSubPart(java.lang.String name)`
`boolean`	`isAggregatable()`
`boolean`	`isColumnHeaderVisible()`
`boolean`	`isContextMenuEnabled()`
`boolean`	`isMultiLineCells()`
`boolean`	`isShowSelection()`
`boolean`	`isShowTotalAggregation()`
`boolean`	`isSortable()`
`boolean`	`isTextSelectionEnabled()`
`static <T extends Entity> com.google.common.reflect.TypeToken<Table<T>>`	`of(java.lang.Class<T> itemClass)`
`void`	`refresh()` Deprecated. refresh datasource instead
`void`	`removeAggregationProperty(java.lang.String columnId)` Deprecated. Use `Table.Column.removeAggregationProperty()` instead.
`void`	`removeClickListener(java.lang.String columnId)` Remove click listener.
`void`	`removeColumn(Table.Column<E> column)`
`void`	`removeColumnCollapseListener(java.util.function.Consumer<Table.ColumnCollapseEvent> listener)` Deprecated. Use `Subscription` instead
`default void`	`removeColumnCollapseListener(Table.ColumnCollapseListener columnCollapseListener)` Deprecated. Use `addColumnCollapseListener(Consumer)` instead
`void`	`removeGeneratedColumn(java.lang.String columnId)`
`void`	`removePrintable(java.lang.String columnId)` Removes `Table.Printable` representation of column.
`void`	`removeStyleProvider(Table.StyleProvider<? super E> styleProvider)` Remove style provider for the table.
`void`	`repaint()` Repaint UI representation of the table (columns, generated columns) without refreshing the table data
`void`	`requestFocus(E entity, java.lang.String columnId)` Set focus on inner field of editable/generated column.
`void`	`scrollTo(E entity)` Scroll table to specified row.
`void`	`selectAll()`
`void`	`setAggregatable(boolean aggregatable)`
`void`	`setAggregationDistributionProvider(Table.AggregationDistributionProvider<E> distributionProvider)` Set aggregation distribution provider to handle distribution of data on rows.
`void`	`setAggregationStyle(Table.AggregationStyle aggregationStyle)`
`void`	`setCellClickListener(java.lang.String columnId, java.util.function.Consumer<Table.CellClickEvent<E>> clickListener)` Add lightweight click handler for column cells. Web specific: cell value will be wrapped in span with cuba-table-clickable-cell style name. You can use .cuba-table-clickable-cell for CSS rules to specify custom representation of cell value.
`default void`	`setClickListener(java.lang.String columnId, Table.CellClickListener<? super E> clickListener)` Deprecated. Use `setCellClickListener(String, Consumer)` instead
`void`	`setColumnAlignment(java.lang.String columnId, Table.ColumnAlignment alignment)` Deprecated. Use `Column#setAlignment(ColumnAlignment)` instead.
`void`	`setColumnAlignment(Table.Column column, Table.ColumnAlignment alignment)` Deprecated. Use `Column#setAlignment(ColumnAlignment)` instead.
`void`	`setColumnCaption(java.lang.String columnId, java.lang.String caption)` Deprecated. Use `Table.Column.setCaption(String)` instead.
`void`	`setColumnCaption(Table.Column column, java.lang.String caption)` Deprecated. Use `Table.Column.setCaption(String)` instead.
`void`	`setColumnCaptionAsHtml(java.lang.String columnId, boolean captionAsHtml)` Deprecated. Use `Table.Column.setCaptionAsHtml(boolean)` instead.
`void`	`setColumnCaptionAsHtml(Table.Column column, boolean captionAsHtml)` Deprecated. Use `Table.Column.setCaptionAsHtml(boolean)` instead.
`void`	`setColumnCollapsed(java.lang.String columnId, boolean collapsed)` Deprecated. Use `Table.Column.setCollapsed(boolean)` instead.
`void`	`setColumnCollapsed(Table.Column column, boolean collapsed)` Deprecated. Use `Table.Column.setCollapsed(boolean)` instead.
`void`	`setColumnControlVisible(boolean columnCollapsingAllowed)`
`void`	`setColumnDescription(java.lang.String columnId, java.lang.String description)` Deprecated. Use `Table.Column.setDescription(String)` instead.
`void`	`setColumnDescription(Table.Column column, java.lang.String description)` Deprecated. Use `Table.Column.setDescription(String)` instead.
`void`	`setColumnHeaderVisible(boolean columnHeaderVisible)` Set visibility for table header
`void`	`setColumnReorderingAllowed(boolean columnReorderingAllowed)`
`void`	`setColumnSortable(java.lang.String columnId, boolean sortable)` Deprecated. Use `Table.Column.setSortable(boolean)` instead.
`void`	`setColumnSortable(Table.Column column, boolean sortable)` Deprecated. Use `Table.Column.setSortable(boolean)` instead.
`void`	`setColumnWidth(java.lang.String columnId, int width)` Deprecated. Use `Table.Column.setWidth(Integer)` instead.
`void`	`setColumnWidth(Table.Column column, int width)` Deprecated. Use `Table.Column.setWidth(Integer)` instead.
`void`	`setContextMenuEnabled(boolean contextMenuEnabled)`
`default void`	`setDatasource(CollectionDatasource datasource)` Deprecated. Use `setItems(TableItems)` instead
`void`	`setEnterPressAction(Action action)` Assign action to be executed on Enter key press.
`void`	`setIconProvider(java.util.function.Function<? super E,java.lang.String> iconProvider)` Set the row icon provider for the table.
`void`	`setItemClickAction(Action action)` Assign action to be executed on double click inside a table row.
`void`	`setItems(TableItems<E> tableItems)`
`void`	`setMultiLineCells(boolean multiLineCells)`
`void`	`setMultiSelect(boolean multiselect)`
`void`	`setRequired(Table.Column<E> column, boolean required, java.lang.String message)`
`void`	`setRowHeaderMode(Table.RowHeaderMode mode)`
`void`	`setRowHeaderWidth(int width)` Set width of row header column.
`void`	`setShowSelection(boolean showSelection)` Hide or show selection
`void`	`setShowTotalAggregation(boolean showAggregation)`
`void`	`setSortable(boolean sortable)`
`void`	`setStyleProvider(Table.StyleProvider<? super E> styleProvider)` Set the cell style provider for the table. All style providers added before this call will be removed.
`void`	`setTextSelectionEnabled(boolean value)` Enable or disable text selection in Table cells.
`void`	`showCustomPopup(Component popupComponent)` Show popup inside of Table, relative to last cell click event. Call this method from `Table.CellClickListener` implementation.
`void`	`showCustomPopupActions(java.util.List<Action> actions)` Show autocloseable popup view with actions, relative to last cell click event. Call this method from `Table.CellClickListener` implementation. Autocloseable means that after any click on action popup will be closed.
`void`	`sort(java.lang.String columnId, Table.SortDirection direction)` Sorts the Table data for passed column id in the chosen sort direction.
`void`	`sortBy(java.lang.Object propertyId, boolean ascending)` Deprecated. Use `sort(String, SortDirection)` method

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.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

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<Table<T>> of(java.lang.Class<T> itemClass)
```
  - getColumns
```
java.util.List<Table.Column<E>> getColumns()
```
  - getColumn
```
Table.Column<E> getColumn(java.lang.String id)
```
  - addColumn
```
void addColumn(Table.Column<E> column)
```
  - removeColumn
```
void removeColumn(Table.Column<E> column)
```
  - getAggregationResults
```
java.util.Map<java.lang.Object,java.lang.Object> getAggregationResults()
```
    Returns a map with aggregation results, where keys are table column ids and values are aggregation values.
    
    Returns:
    
    map with aggregation results
  - setItems
```
void setItems(TableItems<E> tableItems)
```
  - getItems
```
TableItems<E> getItems()
```
    Specified by:
    
    getItems in interface ListComponent<E extends Entity>
  - setDatasource
```
@Deprecated
default void setDatasource(CollectionDatasource datasource)
```
    Deprecated. Use setItems(TableItems) instead
    
    Parameters:
    
    datasource - datasource
  - getDatasource
```
@Deprecated
default CollectionDatasource getDatasource()
```
    Deprecated. Use getItems() instead
    
    Specified by:
    
    getDatasource in interface ListComponent<E extends Entity>
    
    Returns:
    
    datasource
  - setRequired
```
void setRequired(Table.Column<E> column,
                 boolean required,
                 java.lang.String message)
```
  - addValidator
```
@Deprecated
default void addValidator(Table.Column column,
                                      java.util.function.Consumer<?> validator)
```
    Deprecated. automatic validation of Table is not supported
  - addValidator
```
@Deprecated
default void addValidator(java.util.function.Consumer<?> validator)
```
    Deprecated. automatic validation of Table is not supported
  - setColumnCaption
```
@Deprecated
void setColumnCaption(java.lang.String columnId,
                                  java.lang.String caption)
```
    Deprecated. Use Table.Column.setCaption(String) instead.
    
    Assign caption for column in runtime.
    
    See Also:
    
    getColumn(String)
  - setColumnCaption
```
@Deprecated
void setColumnCaption(Table.Column column,
                                  java.lang.String caption)
```
    Deprecated. Use Table.Column.setCaption(String) instead.
    
    Assign caption for column in runtime.
    
    See Also:
    
    getColumn(String)
  - setTextSelectionEnabled
```
void setTextSelectionEnabled(boolean value)
```
    Enable or disable text selection in Table cells. Set true to enable.
  - isTextSelectionEnabled
```
boolean isTextSelectionEnabled()
```
    Returns:
    
    true if text selection is enabled.
  - setColumnDescription
```
@Deprecated
void setColumnDescription(java.lang.String columnId,
                                      java.lang.String description)
```
    Deprecated. Use Table.Column.setDescription(String) instead.
    
    Assign description for column in runtime.
    
    See Also:
    
    getColumn(String)
  - setColumnDescription
```
@Deprecated
void setColumnDescription(Table.Column column,
                                      java.lang.String description)
```
    Deprecated. Use Table.Column.setDescription(String) instead.
    
    Assign description for column in runtime.
    
    See Also:
    
    getColumn(String)
  - setColumnCollapsed
```
@Deprecated
void setColumnCollapsed(java.lang.String columnId,
                                    boolean collapsed)
```
    Deprecated. Use Table.Column.setCollapsed(boolean) instead.
    
    Show/hide column in runtime. Hidden column will be available in column control.
    
    See Also:
    
    getColumn(String)
  - setColumnCollapsed
```
@Deprecated
void setColumnCollapsed(Table.Column column,
                                    boolean collapsed)
```
    Deprecated. Use Table.Column.setCollapsed(boolean) instead.
    
    Show/hide column in runtime. Hidden column will be available in column control.
    
    See Also:
    
    getColumn(String)
  - setColumnWidth
```
@Deprecated
void setColumnWidth(java.lang.String columnId,
                                int width)
```
    Deprecated. Use Table.Column.setWidth(Integer) instead.
    
    Set column width in runtime.
    
    See Also:
    
    getColumn(String)
  - setColumnWidth
```
@Deprecated
void setColumnWidth(Table.Column column,
                                int width)
```
    Deprecated. Use Table.Column.setWidth(Integer) instead.
    
    Set column width in runtime.
    
    See Also:
    
    getColumn(String)
  - setColumnAlignment
```
@Deprecated
void setColumnAlignment(java.lang.String columnId,
                                    Table.ColumnAlignment alignment)
```
    Deprecated. Use Column#setAlignment(ColumnAlignment) instead.
    
    See Also:
    
    getColumn(String)
  - setColumnAlignment
```
@Deprecated
void setColumnAlignment(Table.Column column,
                                    Table.ColumnAlignment alignment)
```
    Deprecated. Use Column#setAlignment(ColumnAlignment) instead.
    
    See Also:
    
    getColumn(String)
  - addAggregationProperty
```
@Deprecated
void addAggregationProperty(java.lang.String columnId,
                                        AggregationInfo.Type type)
```
    Deprecated. Use Table.Column.setAggregation(AggregationInfo) instead.
    
    See Also:
    
    getColumn(String)
  - addAggregationProperty
```
@Deprecated
void addAggregationProperty(Table.Column columnId,
                                        AggregationInfo.Type type)
```
    Deprecated. Use Table.Column.setAggregation(AggregationInfo) instead.
    
    See Also:
    
    getColumn(String)
  - removeAggregationProperty
```
@Deprecated
void removeAggregationProperty(java.lang.String columnId)
```
    Deprecated. Use Table.Column.removeAggregationProperty() instead.
    
    See Also:
    
    getColumn(String)
  - setItemClickAction
```
void setItemClickAction(Action action)
```
    Assign action to be executed on double click inside a table row.
    If such action is not set, the table responds to double click by trying to find and execute the following actions:
    - action, assigned to Enter key press by setting its shortcut property
    - action named "edit"
    - action named "view"
    If one of these actions is found and it is enabled, it is executed.
  - getItemClickAction
```
Action getItemClickAction()
```
  - setEnterPressAction
```
void setEnterPressAction(Action action)
```
    Assign action to be executed on Enter key press.
    If such action is not set, the table responds to pressing Enter by trying to find and execute the following actions:
    - action, assigned by setItemClickAction(Action)
    - action, assigned to Enter key press by setting its shortcut property
    - action named "edit"
    - action named "view"
    If one of these actions is found and it is enabled, it is executed.
  - getEnterPressAction
```
Action getEnterPressAction()
```
  - getNotCollapsedColumns
```
java.util.List<Table.Column> getNotCollapsedColumns()
```
  - setSortable
```
void setSortable(boolean sortable)
```
  - isSortable
```
boolean isSortable()
```
  - setAggregatable
```
void setAggregatable(boolean aggregatable)
```
  - isAggregatable
```
boolean isAggregatable()
```
  - setShowTotalAggregation
```
void setShowTotalAggregation(boolean showAggregation)
```
  - isShowTotalAggregation
```
boolean isShowTotalAggregation()
```
  - setColumnReorderingAllowed
```
void setColumnReorderingAllowed(boolean columnReorderingAllowed)
```
  - getColumnReorderingAllowed
```
boolean getColumnReorderingAllowed()
```
  - setColumnControlVisible
```
void setColumnControlVisible(boolean columnCollapsingAllowed)
```
  - getColumnControlVisible
```
boolean getColumnControlVisible()
```
  - setColumnSortable
```
@Deprecated
void setColumnSortable(java.lang.String columnId,
                                   boolean sortable)
```
    Deprecated. Use Table.Column.setSortable(boolean) instead.
    
    See Also:
    
    getColumn(String)
  - getColumnSortable
```
@Deprecated
boolean getColumnSortable(java.lang.String columnId)
```
    Deprecated. Use Table.Column.isSortable() instead.
    
    See Also:
    
    getColumn(String)
  - setColumnSortable
```
@Deprecated
void setColumnSortable(Table.Column column,
                                   boolean sortable)
```
    Deprecated. Use Table.Column.setSortable(boolean) instead.
    
    See Also:
    
    getColumn(String)
  - getColumnSortable
```
@Deprecated
boolean getColumnSortable(Table.Column column)
```
    Deprecated. User Table.Column.isSortable() instead.
    
    See Also:
    
    getColumn(String)
  - setColumnCaptionAsHtml
```
@Deprecated
void setColumnCaptionAsHtml(java.lang.String columnId,
                                        boolean captionAsHtml)
```
    Deprecated. Use Table.Column.setCaptionAsHtml(boolean) instead.
    
    Sets whether caption of column with the given columnId should be interpreted as HTML or not.
    
    Parameters:
    
    columnId - column id
    
    captionAsHtml - interpret caption as HTML or not
    
    See Also:
    
    getColumn(String)
  - setColumnCaptionAsHtml
```
@Deprecated
void setColumnCaptionAsHtml(Table.Column column,
                                        boolean captionAsHtml)
```
    Deprecated. Use Table.Column.setCaptionAsHtml(boolean) instead.
    
    Sets whether caption of the given column should be interpreted as HTML or not.
    
    Parameters:
    
    column - column
    
    captionAsHtml - interpret caption as HTML or not
    
    See Also:
    
    getColumn(String)
  - getColumnCaptionAsHtml
```
@Deprecated
boolean getColumnCaptionAsHtml(java.lang.String columnId)
```
    Deprecated. Use Table.Column.isCaptionAsHtml() instead.
    
    Parameters:
    
    columnId - column id
    
    Returns:
    
    whether caption of column with the given columnId should be interpreted as HTML or not
    
    See Also:
    
    getColumn(String)
  - getColumnCaptionAsHtml
```
@Deprecated
boolean getColumnCaptionAsHtml(Table.Column column)
```
    Deprecated. Use Table.Column.isCaptionAsHtml() instead.
    
    Parameters:
    
    column - column
    
    Returns:
    
    whether caption of the given column should be interpreted as HTML or not
    
    See Also:
    
    getColumn(String)
  - requestFocus
```
void requestFocus(E entity,
                  java.lang.String columnId)
```
    Set focus on inner field of editable/generated column.
    
    Parameters:
    
    entity - entity
    
    columnId - column id
  - scrollTo
```
void scrollTo(E entity)
```
    Scroll table to specified row.
    
    Parameters:
    
    entity - entity
  - sortBy
```
@Deprecated
void sortBy(java.lang.Object propertyId,
                        boolean ascending)
```
    Deprecated. Use sort(String, SortDirection) method
    Sort the table by a column. For example:
```
table.sortBy(table.getDatasource().getMetaClass().getPropertyPath("name"), ascending);
```
    Parameters:
    
    propertyId - column indicated by a corresponding MetaPropertyPath object
    
    ascending - sort direction
  - sort
```
void sort(java.lang.String columnId,
          Table.SortDirection direction)
```
    Sorts the Table data for passed column id in the chosen sort direction.
    
    Parameters:
    
    columnId - id of the column to sort
    
    direction - sort direction
  - getSortInfo
```
@Nullable
Table.SortInfo getSortInfo()
```
    Returns:
    
    current sort information or null if no column is sorted
  - selectAll
```
void selectAll()
```
  - isMultiLineCells
```
boolean isMultiLineCells()
```
  - setMultiLineCells
```
void setMultiLineCells(boolean multiLineCells)
```
  - isContextMenuEnabled
```
boolean isContextMenuEnabled()
```
  - setContextMenuEnabled
```
void setContextMenuEnabled(boolean contextMenuEnabled)
```
  - setRowHeaderWidth
```
void setRowHeaderWidth(int width)
```
    Set width of row header column. Row header shows icons if Icon Provider is specified.
    
    Parameters:
    
    width - width of row header column in px
  - getRowHeaderWidth
```
int getRowHeaderWidth()
```
  - setMultiSelect
```
void setMultiSelect(boolean multiselect)
```
  - refresh
```
@Deprecated
void refresh()
```
    Deprecated. refresh datasource instead
  - repaint
```
void repaint()
```
    Repaint UI representation of the table (columns, generated columns) without refreshing the table data
  - getSubPart
```
@Nullable
default java.lang.Object getSubPart(java.lang.String name)
```
    Specified by:
    
    getSubPart in interface ActionsHolder
    
    Specified by:
    
    getSubPart in interface HasSubParts
  - addColumnCollapsedListener
```
@Deprecated
default void addColumnCollapsedListener(Table.ColumnCollapseListener columnCollapsedListener)
```
    Deprecated. Use addColumnCollapseListener(Consumer) instead
    
    Parameters:
    
    columnCollapsedListener - a listener to add
  - removeColumnCollapseListener
```
@Deprecated
default void removeColumnCollapseListener(Table.ColumnCollapseListener columnCollapseListener)
```
    Deprecated. Use addColumnCollapseListener(Consumer) instead
    
    Parameters:
    
    columnCollapseListener - a listener to remove
  - addColumnCollapseListener
```
com.haulmont.bali.events.Subscription addColumnCollapseListener(java.util.function.Consumer<Table.ColumnCollapseEvent> listener)
```
    Adds a listener for column collapse events.
    
    Parameters:
    
    listener - a listener to add
    
    Returns:
    
    a Subscription object
  - removeColumnCollapseListener
```
@Deprecated
void removeColumnCollapseListener(java.util.function.Consumer<Table.ColumnCollapseEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Parameters:
    
    listener - a listener to remove
  - setRowHeaderMode
```
void setRowHeaderMode(Table.RowHeaderMode mode)
```
  - setAggregationStyle
```
void setAggregationStyle(Table.AggregationStyle aggregationStyle)
```
  - getAggregationStyle
```
Table.AggregationStyle getAggregationStyle()
```
  - setStyleProvider
```
void setStyleProvider(@Nullable
                      Table.StyleProvider<? super E> styleProvider)
```
    Set the cell style provider for the table.
    All style providers added before this call will be removed.
  - addStyleProvider
```
void addStyleProvider(Table.StyleProvider<? super E> styleProvider)
```
    Add style provider for the table.
    Table can use several providers to obtain many style names for cells and rows.
  - removeStyleProvider
```
void removeStyleProvider(Table.StyleProvider<? super E> styleProvider)
```
    Remove style provider for the table.
  - setIconProvider
```
void setIconProvider(java.util.function.Function<? super E,java.lang.String> iconProvider)
```
    Set the row icon provider for the table.
    
    See Also:
    
    setRowHeaderWidth(int)
  - getItemDatasource
```
@Deprecated
Datasource getItemDatasource(Entity item)
```
    Deprecated. Use getInstanceContainer(Entity) instead.
    This method returns the datasource which contains the provided item. It can be used in data-aware components, created in generated columns.
    Do not save to final variables, just get it from table when you need.
```
 modelsTable.addGeneratedColumn(
     "numberOfSeats",
     new Table.ColumnGenerator<Model>() {
         public Component generateCell(Model entity) {
             LookupField lookupField = componentsFactory.createComponent(LookupField.NAME);
             lookupField.setDatasource(modelsTable.getItemDatasource(entity), "numberOfSeats");
             lookupField.setOptionsList(Arrays.asList(2, 4, 5));
             lookupField.setWidth("100px");
             return lookupField;
         }
     }
 );
 
```
    Parameters:
    
    item - entity item
    
    Returns:
    
    datasource containing the item
  - getInstanceContainer
```
InstanceContainer<E> getInstanceContainer(E item)
```
    This method returns the InstanceContainer which contains the provided item. It can be used in data-aware components, created in generated columns.
    Do not save to final variables, just get it from table when you need.
```
 carsTable.addGeneratedColumn("name", car -> {
     TextField<String> textField = uiComponents.create(TextField.NAME);
     textField.setValueSource(new ContainerValueSource<>(carsTable.getInstanceContainer(car),"name"));
     textField.setValue(car.getName());
     return textField;
 });
 
```
    Parameters:
    
    item - entity item
    
    Returns:
    
    InstanceContainer containing the item
  - addGeneratedColumn
```
void addGeneratedColumn(java.lang.String columnId,
                        Table.ColumnGenerator<? super E> generator)
```
    Add a generated column to the table.
    
    Parameters:
    
    columnId - column identifier as defined in XML descriptor. May or may not correspond to an entity property.
    
    generator - column generator instance
  - addGeneratedColumn
```
void addGeneratedColumn(java.lang.String columnId,
                        Table.ColumnGenerator<? super E> generator,
                        java.lang.Class<? extends Component> componentClass)
```
    Add a generated column to the table.
    This method useful for desktop UI. Table can make additional look, feel and performance tweaks if it knows the class of components that will be generated.
    
    Parameters:
    
    columnId - column identifier as defined in XML descriptor. May or may not correspond to an entity property.
    
    generator - column generator instance
    
    componentClass - class of components that generator will provide
  - removeGeneratedColumn
```
void removeGeneratedColumn(java.lang.String columnId)
```
  - addPrintable
```
void addPrintable(java.lang.String columnId,
                  Table.Printable<? super E,?> printable)
```
    Adds Table.Printable representation for column.
    Explicitly added Printable will be used instead of inherited from generated column.
    
    Parameters:
    
    columnId - column id
    
    printable - printable representation
  - removePrintable
```
void removePrintable(java.lang.String columnId)
```
    Removes Table.Printable representation of column.
    Unable to remove Printable representation inherited from generated column.
    
    Parameters:
    
    columnId - column id
  - getPrintable
```
@Nullable
Table.Printable getPrintable(Table.Column column)
```
    Get Table.Printable representation for column.
    
    Parameters:
    
    column - table column
    
    Returns:
    
    printable
  - getPrintable
```
@Nullable
Table.Printable getPrintable(java.lang.String columnId)
```
    Get Table.Printable representation for column.
    
    Parameters:
    
    columnId - column id
    
    Returns:
    
    printable
  - setClickListener
```
@Deprecated
default void setClickListener(java.lang.String columnId,
                                          Table.CellClickListener<? super E> clickListener)
```
    Deprecated. Use setCellClickListener(String, Consumer) instead
    
    Add lightweight click handler for column cells.
    Web specific: cell value will be wrapped in span with cuba-table-clickable-cell style name.
    You can use .cuba-table-clickable-cell for CSS rules to specify custom representation of cell value.
    
    Parameters:
    
    columnId - id of column
    
    clickListener - click listener
  - setCellClickListener
```
void setCellClickListener(java.lang.String columnId,
                          java.util.function.Consumer<Table.CellClickEvent<E>> clickListener)
```
    Add lightweight click handler for column cells.
    Web specific: cell value will be wrapped in span with cuba-table-clickable-cell style name.
    You can use .cuba-table-clickable-cell for CSS rules to specify custom representation of cell value.
    
    Parameters:
    
    columnId - id of column
    
    clickListener - click listener
  - removeClickListener
```
void removeClickListener(java.lang.String columnId)
```
    Remove click listener.
    
    Parameters:
    
    columnId - id of column
  - setAggregationDistributionProvider
```
void setAggregationDistributionProvider(Table.AggregationDistributionProvider<E> distributionProvider)
```
    Set aggregation distribution provider to handle distribution of data on rows. Supports only TOP aggregation style.
    
    Parameters:
    
    distributionProvider - distribution provider
  - getAggregationDistributionProvider
```
Table.AggregationDistributionProvider<E> getAggregationDistributionProvider()
```
    Returns:
    
    aggregation distribution provider
  - showCustomPopup
```
void showCustomPopup(Component popupComponent)
```
    Show popup inside of Table, relative to last cell click event.
    Call this method from Table.CellClickListener implementation.
    
    Parameters:
    
    popupComponent - popup content
  - showCustomPopupActions
```
void showCustomPopupActions(java.util.List<Action> actions)
```
    Show autocloseable popup view with actions, relative to last cell click event.
    Call this method from Table.CellClickListener implementation.
    Autocloseable means that after any click on action popup will be closed.
    
    Parameters:
    
    actions - actions
  - setColumnHeaderVisible
```
void setColumnHeaderVisible(boolean columnHeaderVisible)
```
    Set visibility for table header
  - isColumnHeaderVisible
```
boolean isColumnHeaderVisible()
```
  - setShowSelection
```
void setShowSelection(boolean showSelection)
```
    Hide or show selection
  - isShowSelection
```
boolean isShowSelection()
```
    Returns:
    
    true if selection is visible
  - addSelectionListener
```
com.haulmont.bali.events.Subscription addSelectionListener(java.util.function.Consumer<Table.SelectionEvent<E>> listener)
```
    Registers a new selection listener
    
    Parameters:
    
    listener - the listener to register

Interface Table<E extends Entity>

Nested Class Summary

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

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

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

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

Field Summary

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

Method Summary

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Field Detail

NAME

Method Detail

of

getColumns

getColumn

addColumn

removeColumn

getAggregationResults

setItems

getItems

setDatasource

getDatasource

setRequired

addValidator

addValidator

setColumnCaption

setColumnCaption

setTextSelectionEnabled

isTextSelectionEnabled

setColumnDescription

setColumnDescription

setColumnCollapsed

setColumnCollapsed

setColumnWidth

setColumnWidth

setColumnAlignment

setColumnAlignment

addAggregationProperty

addAggregationProperty

removeAggregationProperty

setItemClickAction

getItemClickAction

setEnterPressAction

getEnterPressAction

getNotCollapsedColumns

setSortable

isSortable

setAggregatable

isAggregatable

setShowTotalAggregation

isShowTotalAggregation

setColumnReorderingAllowed

getColumnReorderingAllowed

setColumnControlVisible

getColumnControlVisible

setColumnSortable

getColumnSortable

setColumnSortable

getColumnSortable

setColumnCaptionAsHtml

setColumnCaptionAsHtml

getColumnCaptionAsHtml

getColumnCaptionAsHtml