DataGrid (CUBA 7.2 API)

Type Parameters:

E - row item type

All Superinterfaces:

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

All Known Subinterfaces:

TreeDataGrid<E>
```
public interface DataGrid<E extends Entity>
extends ListComponent<E>, HasButtonsPanel, Component.HasCaption, Component.HasIcon, HasContextHelp, HasRowsCount, HasSettings, HasDataLoadingSettings, HasHtmlCaption, HasHtmlDescription, LookupComponent<E>, Component.Focusable, RowsCount.RowsCountTarget, HasSubParts, HasHtmlSanitizer, HasMinSize
```
A grid component for displaying tabular data bound to entity type.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DataGrid.AbstractDataGridEditorEvent<E extends Entity>` The root class from which all DataGrid editor event state objects shall be derived.
`static class`	`DataGrid.AbstractDataGridEvent` The root class from which all DataGrid event state objects shall be derived.
`static class`	`DataGrid.AggregationPosition` Defines the position of aggregation row.
`static interface`	`DataGrid.ButtonRenderer<T extends Entity>` A Renderer that displays a button with a textual caption.
`static interface`	`DataGrid.CellDescriptionProvider<E extends Entity>` Deprecated. use `DataGrid.Column.getDescriptionProvider()` instead
`static interface`	`DataGrid.CellStyleProvider<E extends Entity>` Deprecated. use `DataGrid.Column.setStyleProvider(Function)` instead
`static interface`	`DataGrid.CheckBoxRenderer` A renderer that represents a boolean values as a graphical check box icons.
`static interface`	`DataGrid.ClickableTextRenderer<T extends Entity>` A renderer for presenting simple plain-text string values as a link with call back handler.
`static interface`	`DataGrid.Column<E extends Entity>` A column in the DataGrid.
`static class`	`DataGrid.ColumnCollapsingChangeEvent` An event that is fired when a column's collapsing changes.
`static interface`	`DataGrid.ColumnEditorFieldGenerator` Deprecated.
`static interface`	`DataGrid.ColumnGenerator<E extends Entity,T>`
`static class`	`DataGrid.ColumnGeneratorEvent<E extends Entity>` Event provided by a `DataGrid.ColumnGenerator`
`static class`	`DataGrid.ColumnReorderEvent` An event that is fired when the columns are reordered.
`static class`	`DataGrid.ColumnResizeEvent` An event that is fired when a column is resized.
`static class`	`DataGrid.ColumnResizeMode`
`static interface`	`DataGrid.ComponentRenderer` A renderer for UI components.
`static class`	`DataGrid.ContextClickEvent` Context click event fired by a `DataGrid`.
`static interface`	`DataGrid.Converter<P,M>` Deprecated. Use `Column#setRenderer(Renderer, Function)` and presentation provider represented by a `Function` instead
`static class`	`DataGrid.DataGridClickEvent` Class for holding information about a mouse click event.
`static class`	`DataGrid.DataGridStaticCellType` Enumeration, specifying the content type of a Cell in a DataGrid header or footer.
`static interface`	`DataGrid.DateRenderer` A renderer for presenting date values.
`static interface`	`DataGrid.DetailsGenerator<E extends Entity>` A callback interface for generating details for a particular row in Grid.
`static class`	`DataGrid.EditorCloseEvent<E extends Entity>` An event that is fired when the DataGrid editor is closed.
`static class`	`DataGrid.EditorFieldGenerationContext<T>` class which stores information that can be used when creating a component for a `DataGrid` editor.
`static class`	`DataGrid.EditorOpenEvent<E extends Entity>` An event that is fired before the DataGrid editor is opened.
`static class`	`DataGrid.EditorPostCommitEvent<E extends Entity>` An event that is fired after the item is updated.
`static class`	`DataGrid.EditorPreCommitEvent<E extends Entity>` An event that is fired before the item is updated.
`static class`	`DataGrid.EmptyStateClickEvent<E extends Entity>` Describes empty state link click event.
`static interface`	`DataGrid.FooterCell` Represents a footer cell in DataGrid.
`static interface`	`DataGrid.FooterRow` Represents a footer row in DataGrid.
`static interface`	`DataGrid.GenericColumnGenerator<E extends Entity,T>` INTERNAL
`static interface`	`DataGrid.HasDateTimeFormatter` A renderer has a DateTimeFormatter.
`static interface`	`DataGrid.HasFormatString` A renderer has a format string.
`static interface`	`DataGrid.HasLocale` A renderer has a locale.
`static interface`	`DataGrid.HasNullRepresentation` A renderer has a null representation.
`static interface`	`DataGrid.HasRendererClickListener<T extends Entity>` Renderer has click listener.
`static interface`	`DataGrid.HeaderCell` Represents a header cell in DataGrid.
`static interface`	`DataGrid.HeaderRow` Represents a header row in DataGrid.
`static interface`	`DataGrid.HtmlRenderer` A renderer for presenting HTML content.
`static interface`	`DataGrid.IconRenderer<T extends Entity>` A renderer that represents `CubaIcon`.
`static interface`	`DataGrid.ImageRenderer<T extends Entity>` A renderer for presenting images.
`static class`	`DataGrid.ItemClickEvent<E>` Click event fired by a `DataGrid`
`static interface`	`DataGrid.LocalDateRenderer` A renderer for presenting LocalDate values.
`static interface`	`DataGrid.LocalDateTimeRenderer` A renderer for presenting LocalDateTime values.
`static interface`	`DataGrid.NumberRenderer` A renderer for presenting number values.
`static interface`	`DataGrid.ProgressBarRenderer` A renderer that represents a double values as a graphical progress bar.
`static interface`	`DataGrid.Renderer` Marker interface to indicate that the implementing class can be used as a renderer.
`static class`	`DataGrid.RendererClickEvent<T extends Entity>` Click event fired by a `DataGrid.HasRendererClickListener`
`static interface`	`DataGrid.RowDescriptionProvider<E extends Entity>` Deprecated. use `Function` instead
`static interface`	`DataGrid.RowStyleProvider<E extends Entity>` Deprecated. use `Function` instead
`static class`	`DataGrid.ScrollDestination` Enumeration, specifying the destinations that are supported when scrolling rows or columns into view.
`static class`	`DataGrid.SelectionEvent<E extends Entity>` Event sent when the selection changes.
`static class`	`DataGrid.SelectionMode`
`static class`	`DataGrid.SortDirection` Describes sorting direction.
`static class`	`DataGrid.SortEvent` An event that is fired when a sort order is changed.
`static class`	`DataGrid.SortOrder` Sort order descriptor.
`static interface`	`DataGrid.StaticCell` Base interface for DataGrid header or footer cells.
`static interface`	`DataGrid.StaticRow<T extends DataGrid.StaticCell>` Base interface for DataGrid header and footer rows.
`static interface`	`DataGrid.TextRenderer` A renderer for presenting simple plain-text string values.

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.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
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`	`addCellStyleProvider(DataGrid.CellStyleProvider<? super E> styleProvider)` Deprecated. use `DataGrid.Column.setStyleProvider(Function)` instead
`void`	`addColumn(DataGrid.Column<E> column)` Adds the given column to DataGrid.
`void`	`addColumn(DataGrid.Column<E> column, int index)` Adds the given column at the specified index to DataGrid.
`DataGrid.Column<E>`	`addColumn(java.lang.String id, MetaPropertyPath propertyPath)` Creates new column with given Id and property, then adds this column to DataGrid.
`DataGrid.Column<E>`	`addColumn(java.lang.String id, MetaPropertyPath propertyPath, int index)` Creates new column with given Id and property at the specified index, then adds this column to DataGrid.
`Subscription`	`addColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)` Registers a new column collapsing change listener.
`Subscription`	`addColumnReorderListener(java.util.function.Consumer<DataGrid.ColumnReorderEvent> listener)` Registers a new column reorder listener.
`Subscription`	`addColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)` Registers a new column resize listener.
`Subscription`	`addContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)` Registers a new context click listener
`Subscription`	`addEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent> listener)` Registers a new DataGrid editor close listener.
`Subscription`	`addEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent> listener)` Registers a new DataGrid editor open listener.
`Subscription`	`addEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent> listener)` Registers a new DataGrid editor post commit listener.
`Subscription`	`addEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent> listener)` Registers a new DataGrid editor pre commit listener.
`DataGrid.FooterRow`	`addFooterRowAt(int index)` Inserts a new row at the given position to the footer section.
`DataGrid.Column<E>`	`addGeneratedColumn(java.lang.String columnId, DataGrid.ColumnGenerator<E,?> generator)` Add a generated column to the DataGrid.
`DataGrid.Column<E>`	`addGeneratedColumn(java.lang.String columnId, DataGrid.ColumnGenerator<E,?> generator, int index)` Add a generated column to the DataGrid.
`DataGrid.Column<E>`	`addGeneratedColumn(java.lang.String columnId, DataGrid.GenericColumnGenerator<E,?> generator)` INTERNAL
`DataGrid.HeaderRow`	`addHeaderRowAt(int index)` Inserts a new row at the given position to the header section.
`Subscription`	`addItemClickListener(java.util.function.Consumer<DataGrid.ItemClickEvent<E>> listener)` Registers a new item click listener
`void`	`addRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)` Adds style provider for the DataGrid rows.
`Subscription`	`addSelectionListener(java.util.function.Consumer<DataGrid.SelectionEvent<E>> listener)` Registers a new selection listener
`Subscription`	`addSortListener(java.util.function.Consumer<DataGrid.SortEvent> listener)` Registers a new sort order change listener
`DataGrid.FooterRow`	`appendFooterRow()` Adds a new row at the bottom of the footer section.
`DataGrid.HeaderRow`	`appendHeaderRow()` Adds a new row at the bottom of the header section.
`<T extends DataGrid.Renderer> T`	`createRenderer(java.lang.Class<T> type)` Creates renderer implementation by its type.
`void`	`deselect(E item)` Deselects the given item.
`void`	`deselectAll()` Deselects all the items in the current data source.
`void`	`edit(E item)` Opens the editor interface for the provided entity.
`void`	`editItem(java.lang.Object itemId)` Deprecated. Use `edit(Entity)`
`DataGrid.AggregationPosition`	`getAggregationPosition()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getAggregationResults()`
`double`	`getBodyRowHeight()` Returns the current body row height.
`DataGrid.CellDescriptionProvider<E>`	`getCellDescriptionProvider()` Deprecated. use `DataGrid.Column.getDescriptionProvider()` instead
`DataGrid.Column<E>`	`getColumn(java.lang.String id)` Returns a column based on the Id.
`DataGrid.ColumnGenerator<E,?>`	`getColumnGenerator(java.lang.String columnId)` Gets the columns generator for the given column id.
`DataGrid.Column<E>`	`getColumnNN(java.lang.String id)` Returns a column by its Id.
`DataGrid.ColumnResizeMode`	`getColumnResizeMode()` Returns the current column resize mode.
`java.util.List<DataGrid.Column<E>>`	`getColumns()` Returns a copy of currently configured columns in their current visual order in this DataGrid.
`default CollectionDatasource`	`getDatasource()` Deprecated. use `getItems()` instead
`DataGrid.HeaderRow`	`getDefaultHeaderRow()` Returns the current default row of the header section.
`DataGrid.DetailsGenerator<E>`	`getDetailsGenerator()`
`E`	`getEditedItem()` Returns the item that is currently being edited.
`java.lang.Object`	`getEditedItemId()` Deprecated. use `getEditedItem()` instead
`java.lang.String`	`getEditorCancelCaption()` Gets the current caption of the cancel button in the DataGrid editor.
`java.lang.String`	`getEditorSaveCaption()` Gets the current caption of the save button in the DataGrid editor.
`java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>>`	`getEmptyStateLinkClickHandler()`
`java.lang.String`	`getEmptyStateLinkMessage()`
`java.lang.String`	`getEmptyStateMessage()`
`Action`	`getEnterPressAction()`
`DataGrid.FooterRow`	`getFooterRow(int index)` Gets the footer row at given index.
`int`	`getFooterRowCount()` Gets the row count for the footer.
`double`	`getFooterRowHeight()` Returns the current footer row height.
`int`	`getFrozenColumnCount()` Gets the number of frozen columns in this DataGrid.
`DataGrid.HeaderRow`	`getHeaderRow(int index)` Gets the header row at given index.
`int`	`getHeaderRowCount()` Gets the row count for the header section.
`double`	`getHeaderRowHeight()` Returns the current header row height.
`Action`	`getItemClickAction()`
`DataGridItems<E>`	`getItems()`
`java.lang.Float`	`getMinHeight()`
`SizeUnit`	`getMinHeightSizeUnit()`
`java.lang.Float`	`getMinWidth()`
`SizeUnit`	`getMinWidthSizeUnit()`
`java.util.function.Function<E,java.lang.String>`	`getRowDescriptionProvider()` Returns the `RowDescriptionProvider` instance used to generate descriptions (tooltips) for DataGrid rows
`DataGrid.SelectionMode`	`getSelectionMode()`
`java.util.List<DataGrid.SortOrder>`	`getSortOrder()`
`default java.lang.Object`	`getSubPart(java.lang.String name)`
`java.util.List<DataGrid.Column<E>>`	`getVisibleColumns()` Returns a copy of columns not hidden by security permissions.
`boolean`	`isAggregatable()`
`boolean`	`isColumnReorderingAllowed()` Returns whether column reordering is allowed.
`boolean`	`isColumnsCollapsingAllowed()`
`boolean`	`isContextMenuEnabled()`
`boolean`	`isDetailsVisible(E entity)` Checks whether details are visible for the given item.
`boolean`	`isEditorActive()` Returns whether an item is currently being edited in the editor.
`boolean`	`isEditorBuffered()` Gets the buffered editor mode.
`boolean`	`isEditorCrossFieldValidate()`
`boolean`	`isEditorEnabled()` Checks whether the item editor UI is enabled for this DataGrid.
`boolean`	`isFooterVisible()` Returns the visibility of the footer section.
`boolean`	`isHeaderVisible()` Returns the visibility of the header section.
`boolean`	`isSortable()`
`boolean`	`isTextSelectionEnabled()`
`static <T extends Entity> com.google.common.reflect.TypeToken<DataGrid<T>>`	`of(java.lang.Class<T> itemClass)`
`DataGrid.FooterRow`	`prependFooterRow()` Adds a new row at the top of the footer section.
`DataGrid.HeaderRow`	`prependHeaderRow()` Adds a new row at the top of the header section.
`void`	`removeCellStyleProvider(DataGrid.CellStyleProvider<? super E> styleProvider)` Deprecated. use `DataGrid.Column.setStyleProvider(Function)` instead
`void`	`removeColumn(DataGrid.Column<E> column)` Removes the given column from DataGrid or do nothing if column is `null`.
`void`	`removeColumn(java.lang.String id)` Removes a column from DataGrid by its Id or do nothing if column is not found.
`void`	`removeColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`removeColumnReorderListener(java.util.function.Consumer<DataGrid.ColumnReorderEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`removeColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`removeContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)` Removes a previously registered context click listener
`void`	`removeEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`removeEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`removeEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`removeEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`removeFooterRow(DataGrid.FooterRow footerRow)` Removes the given row from the footer section.
`void`	`removeFooterRow(int index)` Removes the row at the given position from the footer section.
`void`	`removeHeaderRow(DataGrid.HeaderRow headerRow)` Removes the given row from the header section.
`void`	`removeHeaderRow(int index)` Removes the row at the given position from the header section.
`void`	`removeItemClickListener(java.util.function.Consumer<DataGrid.ItemClickEvent<E>> listener)` Removes a previously registered item click listener
`void`	`removeRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)` Removes style provider for the DataGrid rows.
`void`	`removeSelectionListener(java.util.function.Consumer<DataGrid.SelectionEvent<E>> listener)` Deprecated. Use `Subscription` instead
`void`	`removeSortListener(java.util.function.Consumer<DataGrid.SortEvent> listener)` Deprecated. Use `Subscription` instead
`void`	`repaint()` Repaint UI representation of the DataGrid without refreshing the table data.
`void`	`scrollTo(E item)` Scrolls to a certain item, using `DataGrid.ScrollDestination.ANY`.
`void`	`scrollTo(E item, DataGrid.ScrollDestination destination)` Scrolls to a certain item, using user-specified scroll destination.
`void`	`scrollToEnd()` Scrolls to the last data item.
`void`	`scrollToStart()` Scrolls to the first data item.
`void`	`selectAll()` Marks all the items in the current data source as selected.
`void`	`setAggregatable(boolean aggregatable)` Set to true if aggregation should be enabled.
`void`	`setAggregationPosition(DataGrid.AggregationPosition position)` Sets aggregation row position.
`void`	`setBodyRowHeight(double rowHeight)` Sets the height of a body row.
`void`	`setCellDescriptionProvider(DataGrid.CellDescriptionProvider<? super E> provider)` Deprecated. use `DataGrid.Column.setDescriptionProvider(Function)` instead
`void`	`setColumnReorderingAllowed(boolean columnReorderingAllowed)` Sets whether or not column reordering is allowed.
`void`	`setColumnResizeMode(DataGrid.ColumnResizeMode mode)` Sets the column resize mode to use.
`void`	`setColumnsCollapsingAllowed(boolean columnsCollapsingAllowed)` Defines if collapsible attribute can be changed for individual column or not.
`void`	`setContextMenuEnabled(boolean contextMenuEnabled)` Sets whether or not context menu is enabled.
`default void`	`setDatasource(CollectionDatasource datasource)` Deprecated. use `setItems(DataGridItems)` instead
`void`	`setDefaultHeaderRow(DataGrid.HeaderRow headerRow)` Sets the default row of the header.
`void`	`setDetailsGenerator(DataGrid.DetailsGenerator<E> detailsGenerator)` Sets a new details generator for row details.
`void`	`setDetailsVisible(E entity, boolean visible)` Shows or hides the details for a specific item.
`void`	`setEditorBuffered(boolean editorBuffered)` Sets the buffered editor mode.
`void`	`setEditorCancelCaption(java.lang.String cancelCaption)` Sets the caption on the cancel button in the DataGrid editor.
`void`	`setEditorCrossFieldValidate(boolean validate)` Enables cross field validation in the inline editor.
`void`	`setEditorEnabled(boolean isEnabled)` Sets whether or not the item editor UI is enabled for this DataGrid.
`void`	`setEditorSaveCaption(java.lang.String saveCaption)` Sets the caption on the save button in the DataGrid editor.
`void`	`setEmptyStateLinkClickHandler(java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>> handler)` Sets click handler for link message.
`void`	`setEmptyStateLinkMessage(java.lang.String linkMessage)` Sets a link message to the middle of DataGrid body that should be appeared when DataGrid is empty.
`void`	`setEmptyStateMessage(java.lang.String message)` Sets a message to the middle of DataGrid body that should be appeared when DataGrid is empty.
`void`	`setEnterPressAction(Action action)` Assigns an action to be executed on Enter key press.
`void`	`setFooterRowHeight(double rowHeight)` Sets the body of a footer row.
`void`	`setFooterVisible(boolean footerVisible)` Sets the visibility of the footer section.
`void`	`setFrozenColumnCount(int numberOfColumns)` Sets the number of frozen columns in this grid.
`void`	`setHeaderRowHeight(double rowHeight)` Sets the body of a body row.
`void`	`setHeaderVisible(boolean headerVisible)` Sets the visibility of the header section.
`void`	`setItemClickAction(Action action)` Assigns an action to be executed on double click on a DataGrid row.
`void`	`setItems(DataGridItems<E> dataGridItems)` Sets an instance of `DataGridItems` as the DataGrid data source.
`void`	`setMinHeight(java.lang.String minHeight)` Sets `minHeight` CSS property value to the Grid (not a composition).
`void`	`setMinWidth(java.lang.String minWidth)` Sets `minWidth` CSS property value to the Grid (not a composition).
`void`	`setRowDescriptionProvider(java.util.function.Function<? super E,java.lang.String> provider)` Sets the `RowDescriptionProvider` instance for generating optional descriptions (tooltips) for DataGrid rows.
`void`	`setRowDescriptionProvider(java.util.function.Function<? super E,java.lang.String> provider, ContentMode contentMode)` Sets the `RowDescriptionProvider` instance for generating optional descriptions (tooltips) for DataGrid rows.
`void`	`setSelectionMode(DataGrid.SelectionMode selectionMode)` Sets the DataGrid's selection mode.
`void`	`setSortable(boolean sortable)` Defines if this attribute can be changed for individual column or not.
`void`	`setTextSelectionEnabled(boolean textSelectionEnabled)` Enable or disable text selection in DataGrid cells.
`void`	`sort(java.lang.String columnId, DataGrid.SortDirection direction)` Sorts the DataGrid data for passed column id in the chosen sort direction.

Methods inherited from interface com.haulmont.cuba.gui.components.ListComponent
getSelected, getSingleSelected, isMultiSelect, setSelected, setSelected

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.HasButtonsPanel
getButtonsPanel, setButtonsPanel

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon
getIcon, setIcon, setIconFromSet

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.HasRowsCount
getRowsCount, setRowsCount, setRowsCountTotalCountDelegate

Methods inherited from interface com.haulmont.cuba.gui.components.HasSettings
applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

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

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

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.Component.BelongToFrame
getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlSanitizer
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

- 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<DataGrid<T>> of(java.lang.Class<T> itemClass)
```
  - getColumns
```
java.util.List<DataGrid.Column<E>> getColumns()
```
    Returns a copy of currently configured columns in their current visual order in this DataGrid.
    
    Returns:
    
    unmodifiable copy of current columns
    
    See Also:
    
    getVisibleColumns()
  - getVisibleColumns
```
java.util.List<DataGrid.Column<E>> getVisibleColumns()
```
    Returns a copy of columns not hidden by security permissions.
    
    Returns:
    
    copy of columns not hidden by security permissions
    
    See Also:
    
    getColumns()
  - getColumn
```
@Nullable
DataGrid.Column<E> getColumn(java.lang.String id)
```
    Returns a column based on the Id.
    
    Parameters:
    
    id - the column Id
    
    Returns:
    
    the column or null if not found
    
    See Also:
    
    getColumnNN(String)
  - getColumnNN
```
DataGrid.Column<E> getColumnNN(java.lang.String id)
```
    Returns a column by its Id.
    
    Parameters:
    
    id - the column Id
    
    Returns:
    
    the column with given Id
    
    Throws:
    
    java.lang.IllegalStateException - if not found
    
    See Also:
    
    getColumn(String)
  - addColumn
```
void addColumn(DataGrid.Column<E> column)
```
    Adds the given column to DataGrid.
    
    Parameters:
    
    column - the column to add
    
    See Also:
    
    addColumn(Column, int), addColumn(String, MetaPropertyPath), addColumn(String, MetaPropertyPath, int)
  - addColumn
```
void addColumn(DataGrid.Column<E> column,
               int index)
```
    Adds the given column at the specified index to DataGrid.
    
    Parameters:
    
    column - the column to add
    
    index - index of a new column
    
    See Also:
    
    addColumn(Column), addColumn(String, MetaPropertyPath), addColumn(String, MetaPropertyPath, int)
  - addColumn
```
DataGrid.Column<E> addColumn(java.lang.String id,
                             @Nullable
                             MetaPropertyPath propertyPath)
```
    Creates new column with given Id and property, then adds this column to DataGrid.
    
    Parameters:
    
    id - the column Id
    
    propertyPath - the instance of MetaPropertyPath representing a relative path to a property from certain MetaClass
    
    Returns:
    
    the newly created column
    
    See Also:
    
    addColumn(Column), addColumn(Column, int), addColumn(String, MetaPropertyPath, int)
  - addColumn
```
DataGrid.Column<E> addColumn(java.lang.String id,
                             MetaPropertyPath propertyPath,
                             int index)
```
    Creates new column with given Id and property at the specified index, then adds this column to DataGrid.
    
    Parameters:
    
    id - the column Id
    
    propertyPath - the instance of MetaPropertyPath representing a relative path to a property from certain MetaClass
    
    index - index of a new column
    
    Returns:
    
    the newly created column
    
    See Also:
    
    addColumn(Column), addColumn(Column, int), addColumn(String, MetaPropertyPath)
  - removeColumn
```
void removeColumn(DataGrid.Column<E> column)
```
    Removes the given column from DataGrid or do nothing if column is null.
    
    Parameters:
    
    column - the column to add
    
    See Also:
    
    removeColumn(String)
  - removeColumn
```
void removeColumn(java.lang.String id)
```
    Removes a column from DataGrid by its Id or do nothing if column is not found.
    
    Parameters:
    
    id - the columns Id
    
    See Also:
    
    removeColumn(Column)
  - getItems
```
@Nullable
DataGridItems<E> getItems()
```
    Specified by:
    
    getItems in interface ListComponent<E extends Entity>
    
    Returns:
    
    The DataGrid source
  - setItems
```
void setItems(@Nullable
              DataGridItems<E> dataGridItems)
```
    Sets an instance of DataGridItems as the DataGrid data source.
    
    Parameters:
    
    dataGridItems - the DataGrid data source
  - getDatasource
```
@Deprecated
default CollectionDatasource getDatasource()
```
    Deprecated. use getItems() instead
    
    Specified by:
    
    getDatasource in interface ListComponent<E extends Entity>
    
    Returns:
    
    the DataGrid data source
  - setDatasource
```
@Deprecated
default void setDatasource(CollectionDatasource datasource)
```
    Deprecated. use setItems(DataGridItems) instead
    
    Sets an instance of CollectionDatasource as the DataGrid data source.
    
    Parameters:
    
    datasource - the DataGrid data source, not null
  - selectAll
```
void selectAll()
```
    Marks all the items in the current data source as selected.
  - deselect
```
void deselect(E item)
```
    Deselects the given item. If the item is not currently selected, does nothing.
    
    Parameters:
    
    item - the item to deselect, not null
  - deselectAll
```
void deselectAll()
```
    Deselects all the items in the current data source.
  - sort
```
void sort(java.lang.String columnId,
          DataGrid.SortDirection direction)
```
    Sorts the DataGrid data for passed column id in the chosen sort direction.
    
    Parameters:
    
    columnId - id of the column to sort
    
    direction - sort direction
  - getSortOrder
```
java.util.List<DataGrid.SortOrder> getSortOrder()
```
    Returns:
    
    sort order list
  - isTextSelectionEnabled
```
boolean isTextSelectionEnabled()
```
    Returns:
    
    true if text selection is enabled.
  - setTextSelectionEnabled
```
void setTextSelectionEnabled(boolean textSelectionEnabled)
```
    Enable or disable text selection in DataGrid cells. Default value is false.
    
    Parameters:
    
    textSelectionEnabled - specifies whether text selection in DataGrid cells is enabled
  - isColumnReorderingAllowed
```
boolean isColumnReorderingAllowed()
```
    Returns whether column reordering is allowed. Default value is true.
    
    Returns:
    
    true if reordering is allowed
  - setColumnReorderingAllowed
```
void setColumnReorderingAllowed(boolean columnReorderingAllowed)
```
    Sets whether or not column reordering is allowed. Default value is true.
    
    Parameters:
    
    columnReorderingAllowed - specifies whether column reordering is allowed
  - isHeaderVisible
```
boolean isHeaderVisible()
```
    Returns the visibility of the header section.
    
    Returns:
    
    true if visible, false otherwise
  - setHeaderVisible
```
void setHeaderVisible(boolean headerVisible)
```
    Sets the visibility of the header section.
    
    Parameters:
    
    headerVisible - true to show the header section, false to hide
  - isFooterVisible
```
boolean isFooterVisible()
```
    Returns the visibility of the footer section.
    
    Returns:
    
    true if visible, false otherwise
  - setFooterVisible
```
void setFooterVisible(boolean footerVisible)
```
    Sets the visibility of the footer section.
    
    Parameters:
    
    footerVisible - true to show the footer section, false to hide
  - getBodyRowHeight
```
double getBodyRowHeight()
```
    Returns the current body row height.
    
    Returns:
    
    body row height, -1 if height is AUTO
  - setBodyRowHeight
```
void setBodyRowHeight(double rowHeight)
```
    Sets the height of a body row. If -1 (default), the row height is calculated based on the theme for an empty row before the DataGrid is displayed.
    
    Parameters:
    
    rowHeight - the height of a row in pixels or -1 for AUTO
  - getHeaderRowHeight
```
double getHeaderRowHeight()
```
    Returns the current header row height.
    
    Returns:
    
    header row height, -1 if height is AUTO
  - setHeaderRowHeight
```
void setHeaderRowHeight(double rowHeight)
```
    Sets the body of a body row. If -1 (default), the row height is calculated based on the theme for an empty row before the DataGrid is displayed.
    
    Parameters:
    
    rowHeight - the height of a row in pixels or -1 for AUTO
  - getFooterRowHeight
```
double getFooterRowHeight()
```
    Returns the current footer row height.
    
    Returns:
    
    footer row height, -1 if height is AUTO
  - setFooterRowHeight
```
void setFooterRowHeight(double rowHeight)
```
    Sets the body of a footer row. If -1 (default), the row height is calculated based on the theme for an empty row before the DataGrid is displayed.
    
    Parameters:
    
    rowHeight - the height of a row in pixels or -1 for AUTO
  - isContextMenuEnabled
```
boolean isContextMenuEnabled()
```
    Returns:
    
    true if context menu is enabled, false otherwise
  - setContextMenuEnabled
```
void setContextMenuEnabled(boolean contextMenuEnabled)
```
    Sets whether or not context menu is enabled. Default value is true.
    
    Parameters:
    
    contextMenuEnabled - specifies whether context menu is enabled
  - getItemClickAction
```
Action getItemClickAction()
```
    Returns:
    
    an action to be executed on double click on a DataGrid row, assigned by setItemClickAction(Action)
    
    See Also:
    
    setItemClickAction(Action)
  - setItemClickAction
```
void setItemClickAction(Action action)
```
    Assigns an action to be executed on double click on a DataGrid row.
    If such action is not set, the table responds to pressing Enter 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.
    Parameters:
    
    action - an action to be executed on double click on a DataGrid row
  - getEnterPressAction
```
Action getEnterPressAction()
```
    Returns:
    
    an action to be executed on Enter key press, assigned by setEnterPressAction(Action)
    
    See Also:
    
    setEnterPressAction(Action)
  - setEnterPressAction
```
void setEnterPressAction(Action action)
```
    Assigns an 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.
    Parameters:
    
    action - an action to be executed on Enter key press
    
    See Also:
    
    setItemClickAction(Action)
  - getFrozenColumnCount
```
int getFrozenColumnCount()
```
    Gets the number of frozen columns in this DataGrid. 0 means that no data columns will be frozen, but the built-in selection checkbox column will still be frozen if it's in use. -1 means that not even the selection column is frozen. NOTE: this count includes hidden columns in the count.
    
    Returns:
    
    the number of frozen columns
    
    See Also:
    
    setFrozenColumnCount(int)
  - setFrozenColumnCount
```
void setFrozenColumnCount(int numberOfColumns)
```
    Sets the number of frozen columns in this grid. Setting the count to 0 means that no data columns will be frozen, but the built-in selection checkbox column will still be frozen if it's in use. Setting the count to -1 will also disable the selection column.
    The default value is 0.
    
    Parameters:
    
    numberOfColumns - the number of columns that should be frozen
    
    Throws:
    
    java.lang.IllegalArgumentException - if the column count is < 0 or > the number of visible columns
  - isSortable
```
boolean isSortable()
```
    Returns:
    
    true if individual column sortable attribute can be set to true, false otherwise
  - setSortable
```
void setSortable(boolean sortable)
```
    Defines if this attribute can be changed for individual column or not. Default value is true.
    
    Parameters:
    
    sortable - true if individual column sortable attribute can be set to true, false otherwise
  - isColumnsCollapsingAllowed
```
boolean isColumnsCollapsingAllowed()
```
    Returns:
    
    true if individual column collapsible attribute can be set to true, false otherwise
  - setColumnsCollapsingAllowed
```
void setColumnsCollapsingAllowed(boolean columnsCollapsingAllowed)
```
    Defines if collapsible attribute can be changed for individual column or not. Default value is true.
    
    Parameters:
    
    columnsCollapsingAllowed - true if individual column collapsible attribute can be set to true, false otherwise
  - isEditorEnabled
```
boolean isEditorEnabled()
```
    Checks whether the item editor UI is enabled for this DataGrid.
    
    Returns:
    
    true if the editor is enabled for this grid
    
    See Also:
    
    setEditorEnabled(boolean), getEditedItem()
  - setEditorEnabled
```
void setEditorEnabled(boolean isEnabled)
```
    Sets whether or not the item editor UI is enabled for this DataGrid. When the editor is enabled, the user can open it by double-clicking a row or hitting enter when a row is focused. The editor can also be opened programmatically using the edit(Entity) method.
    
    Parameters:
    
    isEnabled - true to enable the feature, false otherwise
    
    See Also:
    
    getEditedItem()
  - isEditorBuffered
```
boolean isEditorBuffered()
```
    Gets the buffered editor mode.
    
    Returns:
    
    true if buffered editor is enabled, false otherwise
  - setEditorBuffered
```
void setEditorBuffered(boolean editorBuffered)
```
    Sets the buffered editor mode. The default mode is buffered (true).
    
    Parameters:
    
    editorBuffered - true to enable buffered editor, false to disable it
  - getEditorSaveCaption
```
java.lang.String getEditorSaveCaption()
```
    Gets the current caption of the save button in the DataGrid editor.
    
    Returns:
    
    the current caption of the save button
  - setEditorSaveCaption
```
void setEditorSaveCaption(java.lang.String saveCaption)
```
    Sets the caption on the save button in the DataGrid editor.
    
    Parameters:
    
    saveCaption - the caption to set
  - getEditorCancelCaption
```
java.lang.String getEditorCancelCaption()
```
    Gets the current caption of the cancel button in the DataGrid editor.
    
    Returns:
    
    the current caption of the cancel button
  - setEditorCancelCaption
```
void setEditorCancelCaption(java.lang.String cancelCaption)
```
    Sets the caption on the cancel button in the DataGrid editor.
    
    Parameters:
    
    cancelCaption - the caption to set
  - getEditedItemId
```
@Deprecated
 @Nullable
java.lang.Object getEditedItemId()
```
    Deprecated. use getEditedItem() instead
    
    Gets the id of the item that is currently being edited.
    
    Returns:
    
    the id of the item that is currently being edited, or null if no item is being edited at the moment
  - getEditedItem
```
@Nullable
E getEditedItem()
```
    Returns the item that is currently being edited.
    
    Returns:
    
    the item that is currently being edited, or null if no item is being edited at the moment
  - isEditorActive
```
boolean isEditorActive()
```
    Returns whether an item is currently being edited in the editor.
    
    Returns:
    
    true if the editor is open
  - editItem
```
@Deprecated
void editItem(java.lang.Object itemId)
```
    Deprecated. Use edit(Entity)
    
    Opens the editor interface for the provided item Id. Scrolls the Grid to bring the item to view if it is not already visible.
    
    Parameters:
    
    itemId - the id of the item to edit
    
    Throws:
    
    java.lang.IllegalStateException - if the editor is not enabled or already editing an item in buffered mode
    
    java.lang.IllegalArgumentException - if datasource doesn't contain item with given id
    
    See Also:
    
    setEditorEnabled(boolean)
  - edit
```
void edit(E item)
```
    Opens the editor interface for the provided entity. Scrolls the Grid to bring the entity to view if it is not already visible.
    
    Parameters:
    
    item - the item to edit
    
    Throws:
    
    java.lang.IllegalStateException - if the editor is not enabled or already editing an entity in buffered mode
    
    java.lang.IllegalArgumentException - if datasource doesn't contain the entity
    
    See Also:
    
    setEditorEnabled(boolean)
  - setEditorCrossFieldValidate
```
void setEditorCrossFieldValidate(boolean validate)
```
    Enables cross field validation in the inline editor. True by default.
    
    Parameters:
    
    validate - validate option, true if an editor should validate cross field rules
  - isEditorCrossFieldValidate
```
boolean isEditorCrossFieldValidate()
```
    Returns:
    
    true if editor validates cross field rules
  - addEditorPreCommitListener
```
Subscription addEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent> listener)
```
    Registers a new DataGrid editor pre commit listener. Works in buffered mode only.
    
    Parameters:
    
    listener - the listener to register
  - removeEditorPreCommitListener
```
@Deprecated
void removeEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered DataGrid editor pre commit listener.
    
    Parameters:
    
    listener - the listener to remove
  - addEditorPostCommitListener
```
Subscription addEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent> listener)
```
    Registers a new DataGrid editor post commit listener. Works in buffered mode only.
    
    Parameters:
    
    listener - the listener to register
  - removeEditorPostCommitListener
```
@Deprecated
void removeEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered DataGrid editor post commit listener.
    
    Parameters:
    
    listener - the listener to remove
  - addEditorCloseListener
```
Subscription addEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent> listener)
```
    Registers a new DataGrid editor close listener.
    
    Parameters:
    
    listener - the listener to register
  - removeEditorCloseListener
```
@Deprecated
void removeEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered DataGrid editor close listener.
    
    Parameters:
    
    listener - the listener to remove
  - addEditorOpenListener
```
Subscription addEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent> listener)
```
    Registers a new DataGrid editor open listener.
    
    Parameters:
    
    listener - the listener to register
  - removeEditorOpenListener
```
@Deprecated
void removeEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered DataGrid editor open listener.
    
    Parameters:
    
    listener - the listener to remove
  - repaint
```
void repaint()
```
    Repaint UI representation of the DataGrid without refreshing the table data.
  - scrollTo
```
void scrollTo(E item)
```
    Scrolls to a certain item, using DataGrid.ScrollDestination.ANY.
    
    Parameters:
    
    item - item to scroll to
    
    See Also:
    
    scrollTo(Entity, ScrollDestination), scrollToStart(), scrollToEnd()
  - scrollTo
```
void scrollTo(E item,
              DataGrid.ScrollDestination destination)
```
    Scrolls to a certain item, using user-specified scroll destination.
    
    Parameters:
    
    item - item to scroll to
    
    destination - value specifying desired position of scrolled-to row
    
    See Also:
    
    scrollTo(Entity), scrollToStart(), scrollToEnd()
  - scrollToStart
```
void scrollToStart()
```
    Scrolls to the first data item.
    
    See Also:
    
    scrollTo(Entity), scrollTo(Entity, ScrollDestination), scrollToEnd()
  - scrollToEnd
```
void scrollToEnd()
```
    Scrolls to the last data item.
    
    See Also:
    
    scrollTo(Entity), scrollTo(Entity, ScrollDestination), scrollToStart()
  - getColumnResizeMode
```
DataGrid.ColumnResizeMode getColumnResizeMode()
```
    Returns the current column resize mode. The default mode is DataGrid.ColumnResizeMode.ANIMATED.
    
    Returns:
    
    a ColumnResizeMode value
  - setColumnResizeMode
```
void setColumnResizeMode(DataGrid.ColumnResizeMode mode)
```
    Sets the column resize mode to use. The default mode is DataGrid.ColumnResizeMode.ANIMATED.
    
    Parameters:
    
    mode - a ColumnResizeMode value
  - getSelectionMode
```
DataGrid.SelectionMode getSelectionMode()
```
    Returns:
    
    the currently used DataGrid.SelectionMode
  - setSelectionMode
```
void setSelectionMode(DataGrid.SelectionMode selectionMode)
```
    Sets the DataGrid's selection mode.
    
    Parameters:
    
    selectionMode - the selection mode to use
  - addRowStyleProvider
```
void addRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Adds style provider for the DataGrid rows.
    DataGrid can use several providers to obtain many style names for rows.
    
    Parameters:
    
    styleProvider - a style provider to add, not null
  - removeRowStyleProvider
```
void removeRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Removes style provider for the DataGrid rows.
    
    Parameters:
    
    styleProvider - a style provider to remove, not null
  - addCellStyleProvider
```
@Deprecated
void addCellStyleProvider(DataGrid.CellStyleProvider<? super E> styleProvider)
```
    Deprecated. use DataGrid.Column.setStyleProvider(Function) instead
    
    Adds style provider for the DataGrid cells.
    DataGrid can use several providers to obtain many style names for cells.
  - removeCellStyleProvider
```
@Deprecated
void removeCellStyleProvider(DataGrid.CellStyleProvider<? super E> styleProvider)
```
    Deprecated. use DataGrid.Column.setStyleProvider(Function) instead
    
    Removes style provider for the DataGrid cells.
  - getCellDescriptionProvider
```
@Deprecated
DataGrid.CellDescriptionProvider<E> getCellDescriptionProvider()
```
    Deprecated. use DataGrid.Column.getDescriptionProvider() instead
    
    Returns the CellDescriptionProvider instance used to generate descriptions (tooltips) for DataGrid cells.
    
    Returns:
    
    the description provider or null if no provider is set
  - setCellDescriptionProvider
```
@Deprecated
void setCellDescriptionProvider(DataGrid.CellDescriptionProvider<? super E> provider)
```
    Deprecated. use DataGrid.Column.setDescriptionProvider(Function) instead
    
    Sets the CellDescriptionProvider instance for generating optional descriptions (tooltips) for individual DataGrid cells. If a DataGrid.RowDescriptionProvider is also set, the row description it generates is displayed for cells for which provider returns null.
    
    Parameters:
    
    provider - the description provider to use or null to remove a previously set provider if any
  - getRowDescriptionProvider
```
java.util.function.Function<E,java.lang.String> getRowDescriptionProvider()
```
    Returns the RowDescriptionProvider instance used to generate descriptions (tooltips) for DataGrid rows
    
    Returns:
    
    the description provider or null if no provider is set
  - setRowDescriptionProvider
```
void setRowDescriptionProvider(java.util.function.Function<? super E,java.lang.String> provider)
```
    Sets the RowDescriptionProvider instance for generating optional descriptions (tooltips) for DataGrid rows. If a DataGrid.Column.setDescriptionProvider(Function) is also set, the row description generated by provider is used for cells for which the cell description provider returns null.
    This method uses the ContentMode.PREFORMATTED content mode.
    
    Parameters:
    
    provider - the description provider to use or null to remove a previously set provider if any
  - setRowDescriptionProvider
```
void setRowDescriptionProvider(java.util.function.Function<? super E,java.lang.String> provider,
                               ContentMode contentMode)
```
    Sets the RowDescriptionProvider instance for generating optional descriptions (tooltips) for DataGrid rows. If a DataGrid.Column.setDescriptionProvider(Function) is also set, the row description generated by provider is used for cells for which the cell description provider returns null.
    
    Parameters:
    
    provider - the description provider to use or null to remove a previously set provider if any
    
    contentMode - the content mode for row tooltips
  - addGeneratedColumn
```
DataGrid.Column<E> addGeneratedColumn(java.lang.String columnId,
                                      DataGrid.ColumnGenerator<E,?> generator)
```
    Add a generated column to the DataGrid.
    
    Parameters:
    
    columnId - column identifier as defined in XML descriptor
    
    generator - column generator instance
    
    See Also:
    
    addGeneratedColumn(String, ColumnGenerator, int)
  - addGeneratedColumn
```
DataGrid.Column<E> addGeneratedColumn(java.lang.String columnId,
                                      DataGrid.ColumnGenerator<E,?> generator,
                                      int index)
```
    Add a generated column to the DataGrid.
    
    Parameters:
    
    columnId - column identifier as defined in XML descriptor
    
    generator - column generator instance
    
    index - index of a new generated column
    
    See Also:
    
    addGeneratedColumn(String, ColumnGenerator)
  - addGeneratedColumn
```
DataGrid.Column<E> addGeneratedColumn(java.lang.String columnId,
                                      DataGrid.GenericColumnGenerator<E,?> generator)
```
    INTERNAL
    Adds a generated column to the DataGrid.
    
    Parameters:
    
    columnId - column identifier as defined in XML descriptor
    
    generator - column generator instance
  - getColumnGenerator
```
DataGrid.ColumnGenerator<E,?> getColumnGenerator(java.lang.String columnId)
```
    Gets the columns generator for the given column id.
    
    Parameters:
    
    columnId - the column id for which to return column generator
    
    Returns:
    
    the column generator for given column id
  - getDetailsGenerator
```
@Nullable
DataGrid.DetailsGenerator<E> getDetailsGenerator()
```
    Returns:
    
    the current details generator for row details or null if not set
  - setDetailsGenerator
```
void setDetailsGenerator(DataGrid.DetailsGenerator<E> detailsGenerator)
```
    Sets a new details generator for row details.
    The currently opened row details will be re-rendered.
    
    Parameters:
    
    detailsGenerator - the details generator to set
  - isDetailsVisible
```
boolean isDetailsVisible(E entity)
```
    Checks whether details are visible for the given item.
    
    Parameters:
    
    entity - the item for which to check details visibility
    
    Returns:
    
    true if the details are visible
  - setDetailsVisible
```
void setDetailsVisible(E entity,
                       boolean visible)
```
    Shows or hides the details for a specific item.
    
    Parameters:
    
    entity - the item for which to set details visibility
    
    visible - true to show the details, or false to hide them
  - createRenderer
```
<T extends DataGrid.Renderer> T createRenderer(java.lang.Class<T> type)
```
    Creates renderer implementation by its type.
    
    Parameters:
    
    type - renderer type
    
    Returns:
    
    renderer instance with given type
  - addColumnCollapsingChangeListener
```
Subscription addColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)
```
    Registers a new column collapsing change listener.
    
    Parameters:
    
    listener - the listener to register
  - removeColumnCollapsingChangeListener
```
@Deprecated
void removeColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered column collapsing change listener.
    
    Parameters:
    
    listener - the listener to remove
  - addColumnReorderListener
```
Subscription addColumnReorderListener(java.util.function.Consumer<DataGrid.ColumnReorderEvent> listener)
```
    Registers a new column reorder listener.
    
    Parameters:
    
    listener - the listener to register
  - removeColumnReorderListener
```
@Deprecated
void removeColumnReorderListener(java.util.function.Consumer<DataGrid.ColumnReorderEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered column reorder listener.
    
    Parameters:
    
    listener - the listener to remove
  - addColumnResizeListener
```
Subscription addColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)
```
    Registers a new column resize listener.
    
    Parameters:
    
    listener - the listener to register
  - removeColumnResizeListener
```
@Deprecated
void removeColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered column resize listener.
    
    Parameters:
    
    listener - the listener to remove
  - addSelectionListener
```
Subscription addSelectionListener(java.util.function.Consumer<DataGrid.SelectionEvent<E>> listener)
```
    Registers a new selection listener
    
    Parameters:
    
    listener - the listener to register
  - removeSelectionListener
```
@Deprecated
void removeSelectionListener(java.util.function.Consumer<DataGrid.SelectionEvent<E>> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered selection change listener
    
    Parameters:
    
    listener - the listener to remove
  - addSortListener
```
Subscription addSortListener(java.util.function.Consumer<DataGrid.SortEvent> listener)
```
    Registers a new sort order change listener
    
    Parameters:
    
    listener - the listener to register
  - removeSortListener
```
@Deprecated
void removeSortListener(java.util.function.Consumer<DataGrid.SortEvent> listener)
```
    Deprecated. Use Subscription instead
    
    Removes a previously registered sort order change listener
    
    Parameters:
    
    listener - the listener to remove
  - addContextClickListener
```
Subscription addContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)
```
    Registers a new context click listener
    
    Parameters:
    
    listener - the listener to register
  - removeContextClickListener
```
void removeContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)
```
    Removes a previously registered context click listener
    
    Parameters:
    
    listener - the listener to remove
  - addItemClickListener
```
Subscription addItemClickListener(java.util.function.Consumer<DataGrid.ItemClickEvent<E>> listener)
```
    Registers a new item click listener
    
    Parameters:
    
    listener - the listener to register
  - removeItemClickListener
```
void removeItemClickListener(java.util.function.Consumer<DataGrid.ItemClickEvent<E>> listener)
```
    Removes a previously registered item click listener
    
    Parameters:
    
    listener - the listener to remove
  - getHeaderRow
```
DataGrid.HeaderRow getHeaderRow(int index)
```
    Gets the header row at given index.
    
    Parameters:
    
    index - 0 based index for row. Counted from top to bottom
    
    Returns:
    
    header row at given index
  - appendHeaderRow
```
DataGrid.HeaderRow appendHeaderRow()
```
    Adds a new row at the bottom of the header section.
    
    Returns:
    
    the new row
    
    See Also:
    
    prependHeaderRow(), addHeaderRowAt(int), removeHeaderRow(HeaderRow), removeHeaderRow(int)
  - prependHeaderRow
```
DataGrid.HeaderRow prependHeaderRow()
```
    Adds a new row at the top of the header section.
    
    Returns:
    
    the new row
    
    See Also:
    
    appendHeaderRow(), addHeaderRowAt(int), removeHeaderRow(HeaderRow), removeHeaderRow(int)
  - addHeaderRowAt
```
DataGrid.HeaderRow addHeaderRowAt(int index)
```
    Inserts a new row at the given position to the header section. Shifts the row currently at that position and any subsequent rows down (adds one to their indices).
    
    Parameters:
    
    index - the position at which to insert the row
    
    Returns:
    
    the new row
    
    See Also:
    
    appendHeaderRow(), prependHeaderRow(), removeHeaderRow(HeaderRow), removeHeaderRow(int)
  - removeHeaderRow
```
void removeHeaderRow(DataGrid.HeaderRow headerRow)
```
    Removes the given row from the header section.
    
    Parameters:
    
    headerRow - the row to be removed
    
    See Also:
    
    removeHeaderRow(int), addHeaderRowAt(int), appendHeaderRow(), prependHeaderRow()
  - removeHeaderRow
```
void removeHeaderRow(int index)
```
    Removes the row at the given position from the header section.
    
    Parameters:
    
    index - the position of the row
    
    See Also:
    
    removeHeaderRow(HeaderRow), addHeaderRowAt(int), appendHeaderRow(), prependHeaderRow()
  - getDefaultHeaderRow
```
DataGrid.HeaderRow getDefaultHeaderRow()
```
    Returns the current default row of the header section. The default row is a special header row providing a user interface for sorting columns. Setting a header text for column updates cells in the default header.
    
    Returns:
    
    the default row or null if no default row set
  - setDefaultHeaderRow
```
void setDefaultHeaderRow(DataGrid.HeaderRow headerRow)
```
    Sets the default row of the header. The default row is a special header row providing a user interface for sorting columns.
    
    Parameters:
    
    headerRow - the new default row, or null for no default row
  - getHeaderRowCount
```
int getHeaderRowCount()
```
    Gets the row count for the header section.
    
    Returns:
    
    row count
  - getFooterRow
```
DataGrid.FooterRow getFooterRow(int index)
```
    Gets the footer row at given index.
    
    Parameters:
    
    index - 0 based index for row. Counted from top to bottom
    
    Returns:
    
    footer row at given index
  - appendFooterRow
```
DataGrid.FooterRow appendFooterRow()
```
    Adds a new row at the bottom of the footer section.
    
    Returns:
    
    the new row
    
    See Also:
    
    prependFooterRow(), addFooterRowAt(int), removeFooterRow(FooterRow), removeFooterRow(int)
  - prependFooterRow
```
DataGrid.FooterRow prependFooterRow()
```
    Adds a new row at the top of the footer section.
    
    Returns:
    
    the new row
    
    See Also:
    
    appendFooterRow(), addFooterRowAt(int), removeFooterRow(FooterRow), removeFooterRow(int)
  - addFooterRowAt
```
DataGrid.FooterRow addFooterRowAt(int index)
```
    Inserts a new row at the given position to the footer section. Shifts the row currently at that position and any subsequent rows down (adds one to their indices).
    
    Parameters:
    
    index - the position at which to insert the row
    
    Returns:
    
    the new row
    
    See Also:
    
    appendFooterRow(), prependFooterRow(), removeFooterRow(FooterRow), removeFooterRow(int)
  - removeFooterRow
```
void removeFooterRow(DataGrid.FooterRow footerRow)
```
    Removes the given row from the footer section.
    
    Parameters:
    
    footerRow - the row to be removed
    
    See Also:
    
    removeFooterRow(int), addFooterRowAt(int), appendFooterRow(), prependFooterRow()
  - removeFooterRow
```
void removeFooterRow(int index)
```
    Removes the row at the given position from the footer section.
    
    Parameters:
    
    index - the position of the row
    
    See Also:
    
    removeFooterRow(FooterRow), addFooterRowAt(int), appendFooterRow(), prependFooterRow()
  - getFooterRowCount
```
int getFooterRowCount()
```
    Gets the row count for the footer.
    
    Returns:
    
    row count
  - getSubPart
```
@Nullable
default java.lang.Object getSubPart(java.lang.String name)
```
    Specified by:
    
    getSubPart in interface ActionsHolder
    
    Specified by:
    
    getSubPart in interface HasSubParts
  - isAggregatable
```
boolean isAggregatable()
```
    Returns:
    
    true if DataGrid is aggregatable
  - setAggregatable
```
void setAggregatable(boolean aggregatable)
```
    Set to true if aggregation should be enabled. Default value is false.
    
    Parameters:
    
    aggregatable - aggregatable option
  - getAggregationPosition
```
DataGrid.AggregationPosition getAggregationPosition()
```
    Returns:
    
    return aggregation row position
  - setAggregationPosition
```
void setAggregationPosition(DataGrid.AggregationPosition position)
```
    Sets aggregation row position. Default value is DataGrid.AggregationPosition.TOP.
    
    Parameters:
    
    position - position: DataGrid.AggregationPosition.TOP or DataGrid.AggregationPosition.BOTTOM
  - getAggregationResults
```
java.util.Map<java.lang.String,java.lang.Object> getAggregationResults()
```
    Returns:
    
    aggregated values for columns
  - setEmptyStateMessage
```
void setEmptyStateMessage(java.lang.String message)
```
    Sets a message to the middle of DataGrid body that should be appeared when DataGrid is empty.
    
    Parameters:
    
    message - message that appears when DataGrid is empty
  - getEmptyStateMessage
```
java.lang.String getEmptyStateMessage()
```
    Returns:
    
    message that should be appeared when DataGrid is empty
  - setEmptyStateLinkMessage
```
void setEmptyStateLinkMessage(java.lang.String linkMessage)
```
    Sets a link message to the middle of DataGrid body that should be appeared when DataGrid is empty.
    
    Parameters:
    
    linkMessage - message that appears when DataGrid is empty
    
    See Also:
    
    setEmptyStateLinkClickHandler(Consumer)
  - getEmptyStateLinkMessage
```
java.lang.String getEmptyStateLinkMessage()
```
    Returns:
    
    link message that should be appeared when DataGrid is empty
  - setEmptyStateLinkClickHandler
```
void setEmptyStateLinkClickHandler(java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>> handler)
```
    Sets click handler for link message. Link message can be shown when DataGrid is empty.
    
    Parameters:
    
    handler - handler to set
    
    See Also:
    
    setEmptyStateLinkMessage(String)
  - getEmptyStateLinkClickHandler
```
java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>> getEmptyStateLinkClickHandler()
```
    Returns:
    
    click handler for link message
  - getMinHeight
```
@Nullable
java.lang.Float getMinHeight()
```
    Specified by:
    
    getMinHeight in interface HasMinSize
    
    Returns:
    
    min-height CSS property value of the Grid (not a composition) or null if not set
  - getMinHeightSizeUnit
```
@Nullable
SizeUnit getMinHeightSizeUnit()
```
    Specified by:
    
    getMinHeightSizeUnit in interface HasMinSize
    
    Returns:
    
    unit size of min-height CSS property value of the Grid (not a composition)
  - setMinHeight
```
void setMinHeight(@Nullable
                  java.lang.String minHeight)
```
    Sets minHeight CSS property value to the Grid (not a composition). To set CSS properties to the composition use css attribute in the XML descriptor or HtmlAttributes.applyCss(Component, String).
    
    Specified by:
    
    setMinHeight in interface HasMinSize
    
    Parameters:
    
    minHeight - property value
  - getMinWidth
```
@Nullable
java.lang.Float getMinWidth()
```
    Specified by:
    
    getMinWidth in interface HasMinSize
    
    Returns:
    
    min-width CSS property value of the Grid (not a composition) or null if not set
  - getMinWidthSizeUnit
```
@Nullable
SizeUnit getMinWidthSizeUnit()
```
    Specified by:
    
    getMinWidthSizeUnit in interface HasMinSize
    
    Returns:
    
    unit size of min-width CSS property value of the Grid (not a composition)
  - setMinWidth
```
void setMinWidth(@Nullable
                 java.lang.String minWidth)
```
    Sets minWidth CSS property value to the Grid (not a composition). To set CSS properties to the composition use css attribute in the XML descriptor or HtmlAttributes.applyCss(Component, String).
    
    Specified by:
    
    setMinWidth in interface HasMinSize
    
    Parameters:
    
    minWidth - property value

Interface DataGrid<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.HasContextHelp

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

Field Summary

Method Summary

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

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

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

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

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

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

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

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

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

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

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

Field Detail

NAME

Method Detail

of

getColumns

getVisibleColumns

getColumn

getColumnNN

addColumn

addColumn

addColumn

addColumn

removeColumn

removeColumn

getItems

setItems

getDatasource

setDatasource

selectAll

deselect

deselectAll

sort

getSortOrder

isTextSelectionEnabled

setTextSelectionEnabled

isColumnReorderingAllowed

setColumnReorderingAllowed

isHeaderVisible

setHeaderVisible

isFooterVisible

setFooterVisible

getBodyRowHeight

setBodyRowHeight

getHeaderRowHeight

setHeaderRowHeight

getFooterRowHeight

setFooterRowHeight

isContextMenuEnabled

setContextMenuEnabled

getItemClickAction

setItemClickAction

getEnterPressAction

setEnterPressAction

getFrozenColumnCount

setFrozenColumnCount

isSortable

setSortable

isColumnsCollapsingAllowed

setColumnsCollapsingAllowed

isEditorEnabled

setEditorEnabled

isEditorBuffered

setEditorBuffered

getEditorSaveCaption

setEditorSaveCaption

getEditorCancelCaption

setEditorCancelCaption