AbstractDataGrid (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.component.impl.AbstractComponent<C>
- - io.jmix.ui.component.impl.AbstractDataGrid<C,E>

All Implemented Interfaces:

ActionsHolder, AttachNotifier, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, DataGrid<E>, DataGridItemsEventsDelegate<E>, HasButtonsPanel, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInnerComponents, HasPagination, HasSubParts, ListComponent<E>, LookupComponent<E>, LookupComponent.LookupSelectionChangeNotifier<E>, SecuredActionsHolder, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

DataGridImpl, TreeDataGridImpl
```
public abstract class AbstractDataGrid<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>,E>
extends AbstractComponent<C>
implements DataGrid<E>, SecuredActionsHolder, LookupComponent.LookupSelectionChangeNotifier<E>, DataGridItemsEventsDelegate<E>, HasInnerComponents, org.springframework.beans.factory.InitializingBean
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractDataGrid.AbstractRenderer<T,V>`
`protected static class`	`AbstractDataGrid.AbstractStaticCellImpl`
`protected static class`	`AbstractDataGrid.AbstractStaticRowImp<T extends DataGrid.StaticCell>`
`static class`	`AbstractDataGrid.ActionMenuItemWrapper`
`protected class`	`AbstractDataGrid.CellDescriptionGeneratorAdapter<T extends E>`
`protected class`	`AbstractDataGrid.CellStyleGeneratorAdapter<T extends E>`
`protected static class`	`AbstractDataGrid.ColumnImpl<E>`
`protected static class`	`AbstractDataGrid.DataGridEditorCustomField<T>`
`protected static class`	`AbstractDataGrid.DataGridEditorFieldFactoryAdapter<E>`
`protected static class`	`AbstractDataGrid.FooterCellImpl`
`protected static class`	`AbstractDataGrid.FooterRowImpl`
`protected static class`	`AbstractDataGrid.GridComposition`
`protected static class`	`AbstractDataGrid.HeaderCellImpl`
`protected static class`	`AbstractDataGrid.HeaderRowImpl`

Nested classes/interfaces inherited from interface io.jmix.ui.component.DataGrid
DataGrid.AbstractDataGridEditorEvent<E>, DataGrid.AbstractDataGridEvent, DataGrid.AggregationPosition, DataGrid.ButtonRenderer<T>, DataGrid.CheckBoxRenderer, DataGrid.ClickableTextRenderer<T>, DataGrid.Column<E>, DataGrid.ColumnCollapsingChangeEvent, DataGrid.ColumnGeneratorEvent<E>, DataGrid.ColumnReorderEvent, DataGrid.ColumnResizeEvent, DataGrid.ColumnResizeMode, DataGrid.ComponentRenderer, DataGrid.ContextClickEvent, DataGrid.DataGridClickEvent, DataGrid.DataGridStaticCellType, DataGrid.DateRenderer, DataGrid.EditorCloseEvent<E>, DataGrid.EditorFieldGenerationContext<T>, DataGrid.EditorOpenEvent<E>, DataGrid.EditorPostCommitEvent<E>, DataGrid.EditorPreCommitEvent<E>, DataGrid.EmptyStateClickEvent<E>, DataGrid.FooterCell, DataGrid.FooterRow, DataGrid.HasDateTimeFormatter, DataGrid.HasFormatString, DataGrid.HasLocale, DataGrid.HasNullRepresentation, DataGrid.HasRendererClickListener<T>, DataGrid.HeaderCell, DataGrid.HeaderRow, DataGrid.HtmlRenderer, DataGrid.IconRenderer<T>, DataGrid.ImageRenderer<T>, DataGrid.ItemClickEvent<E>, DataGrid.LocalDateRenderer, DataGrid.LocalDateTimeRenderer, DataGrid.NumberRenderer, DataGrid.ProgressBarRenderer, DataGrid.Renderer, DataGrid.RendererClickEvent<T>, DataGrid.ScrollDestination, DataGrid.SelectionEvent<E>, DataGrid.SelectionMode, DataGrid.SortDirection, DataGrid.SortEvent, DataGrid.SortOrder, DataGrid.StaticCell, DataGrid.StaticRow<T extends DataGrid.StaticCell>, DataGrid.TextRenderer

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp
HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.LookupComponent
LookupComponent.LookupSelectionChangeEvent<T>, LookupComponent.LookupSelectionChangeNotifier<T>

Field Summary

Fields
Modifier and Type	Field and Description
`protected io.jmix.core.AccessManager`	`accessManager`
`protected java.util.List<Action>`	`actionList`
`protected Actions`	`actions`
`protected ActionsPermissions`	`actionsPermissions`
`protected AggregatableDelegate<java.lang.Object>`	`aggregatableDelegate`
`protected Aggregations`	`aggregations`
`protected ButtonsPanel`	`buttonsPanel`
`protected com.vaadin.shared.Registration`	`columnCollapsingChangeListenerRegistration`
`protected java.util.Map<java.lang.String,java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?>>`	`columnGenerators`
`protected com.vaadin.shared.Registration`	`columnResizeListenerRegistration`
`protected java.util.Map<java.lang.String,DataGrid.Column<E>>`	`columns`
`protected boolean`	`columnsCollapsingAllowed`
`protected java.util.List<DataGrid.Column<E>>`	`columnsOrder`
`protected AbstractDataGrid.GridComposition`	`componentComposition`
`protected com.vaadin.shared.Registration`	`contextClickListenerRegistration`
`protected JmixGridContextMenu<E>`	`contextMenu`
`protected java.util.List<AbstractDataGrid.ActionMenuItemWrapper>`	`contextMenuItems`
`protected DataGridDataProvider<E>`	`dataBinding`
`protected java.util.function.Function<E,Component>`	`detailsGenerator`
`protected com.vaadin.shared.Registration`	`editorBeforeSaveListener`
`protected com.vaadin.shared.Registration`	`editorCancelListener`
`protected boolean`	`editorCrossFieldValidate`
`protected com.vaadin.shared.Registration`	`editorOpenListener`
`protected com.vaadin.shared.Registration`	`editorSaveListener`
`protected java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>>`	`emptyStateClickEventHandler`
`protected Action`	`enterPressAction`
`protected com.vaadin.ui.components.grid.FooterRow`	`footerAggregationRow`
`protected java.util.List<DataGrid.FooterRow>`	`footerRows`
`protected static java.lang.String`	`HAS_TOP_PANEL_STYLE_NAME`
`protected com.vaadin.ui.components.grid.HeaderRow`	`headerAggregationRow`
`protected java.util.List<DataGrid.HeaderRow>`	`headerRows`
`protected IconResolver`	`iconResolver`
`protected java.util.List<java.lang.String>`	`internalStyles`
`protected Action`	`itemClickAction`
`protected java.util.Map<E,java.lang.Object>`	`itemDatasources`
`protected io.jmix.core.Messages`	`messages`
`protected io.jmix.core.MessageTools`	`messageTools`
`protected io.jmix.core.MetadataTools`	`metadataTools`
`protected PaginationComponent`	`pagination`
`protected java.util.function.Function<? super E,java.lang.String>`	`rowDescriptionProvider`
`protected java.util.List<java.util.function.Function<? super E,java.lang.String>>`	`rowStyleProviders`
`protected ScreenValidation`	`screenValidation`
`protected DataGrid.SelectionMode`	`selectionMode`
`protected ShortcutsDelegate<com.vaadin.event.ShortcutListener>`	`shortcutsDelegate`
`protected boolean`	`showIconsForPopupMenuActions`
`protected boolean`	`sortable`
`protected static java.lang.String`	`TEXT_SELECTION_ENABLED_STYLE`
`protected boolean`	`textSelectionEnabled`
`protected com.vaadin.ui.CssLayout`	`topPanel`
`protected UiTestIdsSupport`	`uiTestIdsSupport`

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent
alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.DataGrid
NAME

Fields inherited from interface io.jmix.ui.component.Component
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors
Constructor and Description

AbstractDataGrid()

Constructors
Constructor and Description
`AbstractDataGrid()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.Map<java.lang.String,java.lang.String>`	`__aggregate()`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`__aggregateValues()`
`void`	`addAction(Action action)` Add an action to the component
`void`	`addAction(Action action, int index)` Add an action to the component with index.
`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, io.jmix.core.metamodel.model.MetaPropertyPath propertyPath)` Creates new column with given Id and property, then adds this column to DataGrid.
`DataGrid.Column<E>`	`addColumn(java.lang.String id, io.jmix.core.metamodel.model.MetaPropertyPath propertyPath, int index)` Creates new column with given Id and property at the specified index, then adds this column to DataGrid.
`io.jmix.core.common.event.Subscription`	`addColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)` Registers a new column collapsing change listener.
`protected void`	`addColumnId(com.vaadin.ui.Grid.Column<E,?> gridColumn, DataGrid.Column<E> column)`
`protected void`	`addColumnInternal(AbstractDataGrid.ColumnImpl<E> column, int index)`
`io.jmix.core.common.event.Subscription`	`addColumnReorderListener(java.util.function.Consumer<DataGrid.ColumnReorderEvent> listener)` Registers a new column reorder listener.
`io.jmix.core.common.event.Subscription`	`addColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)` Registers a new column resize listener.
`io.jmix.core.common.event.Subscription`	`addContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)` Registers a new context click listener
`io.jmix.core.common.event.Subscription`	`addEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent<E>> listener)` Registers a new DataGrid editor close listener.
`io.jmix.core.common.event.Subscription`	`addEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent<E>> listener)` Registers a new DataGrid editor open listener.
`io.jmix.core.common.event.Subscription`	`addEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent<E>> listener)` Registers a new DataGrid editor post commit listener.
`io.jmix.core.common.event.Subscription`	`addEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent<E>> 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.
`protected DataGrid.FooterRow`	`addFooterRowInternal(com.vaadin.ui.components.grid.FooterRow footerRow)`
`DataGrid.Column<E>`	`addGeneratedColumn(java.lang.String columnId, java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?> generator)` Add a generated column to the DataGrid.
`DataGrid.Column<E>`	`addGeneratedColumn(java.lang.String columnId, java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?> generator, int index)` Add a generated column to the DataGrid.
`DataGrid.HeaderRow`	`addHeaderRowAt(int index)` Inserts a new row at the given position to the header section.
`protected DataGrid.HeaderRow`	`addHeaderRowInternal(com.vaadin.ui.components.grid.HeaderRow headerRow)`
`io.jmix.core.common.event.Subscription`	`addItemClickListener(java.util.function.Consumer<DataGrid.ItemClickEvent<E>> listener)` Registers a new item click listener
`io.jmix.core.common.event.Subscription`	`addLookupValueChangeListener(java.util.function.Consumer<LookupComponent.LookupSelectionChangeEvent<E>> listener)` Adds a listener that invoked when lookup selected items set is changed.
`void`	`addRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)` Adds style provider for the DataGrid rows.
`io.jmix.core.common.event.Subscription`	`addSelectionListener(java.util.function.Consumer<DataGrid.SelectionEvent<E>> listener)` Registers a new selection listener
`io.jmix.core.common.event.Subscription`	`addSortListener(java.util.function.Consumer<DataGrid.SortEvent> listener)` Registers a new sort order change listener
`void`	`afterPropertiesSet()`
`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.
`protected void`	`attachAction(Action action)`
`protected int`	`calculateFooterIndex(int index)`
`protected boolean`	`canBeSorted(DataGridItems<E> dataGridItems)`
`protected void`	`checkAggregation(AggregationInfo aggregationInfo)`
`protected void`	`checkHeaderIndexInRange(int index, boolean includeBounds)`
`protected void`	`clearFieldDatasources(E item)`
`protected <V> java.util.Map<java.lang.String,V>`	`convertAggregationKeyMapToColumnIdKeyMap(java.util.Map<AggregationInfo,V> aggregationInfoMap)`
`protected java.util.List<DataGrid.SortOrder>`	`convertToDataGridSortOrder(java.util.List<com.vaadin.data.provider.GridSortOrder<E>> gridSortOrder)`
`protected java.util.Map<java.lang.String,Field>`	`convertToJmixFields(java.util.Map<com.vaadin.ui.Grid.Column<E,?>,com.vaadin.ui.Component> columnFieldMap)`
`protected void`	`copyColumnProperties(DataGrid.Column<E> column, DataGrid.Column<E> existingColumn)`
`protected AbstractDataGrid.ColumnImpl<E>`	`createColumn(java.lang.String id, io.jmix.core.metamodel.model.MetaPropertyPath propertyPath, AbstractDataGrid<?,E> owner)`
`protected abstract C`	`createComponent()`
`protected AbstractDataGrid.GridComposition`	`createComponentComposition()`
`protected AbstractDataGrid.ActionMenuItemWrapper`	`createContextMenuItem(Action action)`
`protected DataGridDataProvider<E>`	`createDataGridDataProvider(DataGridItems<E> dataGridItems)`
`protected JmixGridEditorFieldFactory<E>`	`createEditorFieldFactory()`
`protected com.vaadin.data.provider.DataProvider<E,?>`	`createEmptyDataProvider()`
`protected ShortcutListenerDelegate`	`createEnterShortcutListener()`
`protected com.vaadin.data.ValueProvider<E,java.lang.Object>`	`createGeneratedColumnValueProvider(java.lang.String columnId, java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?> generator)`
`protected InstanceContainer<E>`	`createInstanceContainer(E item)`
`protected ShortcutsDelegate<com.vaadin.event.ShortcutListener>`	`createShortcutsDelegate()`
`protected com.vaadin.ui.CssLayout`	`createTopPanel()`
`protected ValueSourceProvider`	`createValueSourceProvider(E item)`
`void`	`dataGridSourceItemSetChanged(DataGridItems.ItemSetChangeEvent<E> event)`
`void`	`dataGridSourcePropertyValueChanged(DataGridItems.ValueChangeEvent<E> event)`
`void`	`dataGridSourceSelectedItemChanged(DataGridItems.SelectedItemChangeEvent<E> event)`
`void`	`dataGridSourceStateChanged(DataUnit.StateChangeEvent event)`
`void`	`deselect(E item)` Deselects the given item.
`void`	`deselectAll()` Deselects all the items in the current data source.
`protected void`	`detachItemContainer(java.lang.Object container)`
`void`	`edit(E item)` Opens the editor interface for the provided entity.
`protected void`	`editItemInternal(E item)`
`protected void`	`enableCrossFieldValidationHandling(boolean enable)`
`protected void`	`fillAggregationRow(java.util.Map<java.lang.String,java.lang.String> values)`
`protected void`	`fireSelectionEvent(com.vaadin.event.selection.SelectionEvent<E> e)`
`void`	`focus()` Sets focus to this component
`protected java.lang.String`	`generateColumnCaption(DataGrid.Column<E> column)`
`Action`	`getAction(java.lang.String id)`
`java.util.Collection<Action>`	`getActions()`
`ActionsPermissions`	`getActionsPermissions()`
`protected AggregatableDelegate<java.lang.Object>`	`getAggregatableDelegate()`
`protected java.util.List<AggregationInfo>`	`getAggregationInfos()`
`DataGrid.AggregationPosition`	`getAggregationPosition()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getAggregationResults()`
`protected java.util.Collection<io.jmix.core.metamodel.model.MetaPropertyPath>`	`getAutowiredProperties(EntityDataGridItems<E> entityDataGridSource)`
`double`	`getBodyRowHeight()` Returns the current body row height.
`ButtonsPanel`	`getButtonsPanel()`
`java.lang.String`	`getCaption()`
`DataGrid.Column<E>`	`getColumn(java.lang.String id)` Returns a column based on the Id.
`protected java.lang.String`	`getColumnAggregationDescription(DataGrid.Column<E> column)`
`protected java.lang.String`	`getColumnAggregationDescriptionByType(DataGrid.Column<E> column)`
`protected AbstractDataGrid.ColumnImpl<E>`	`getColumnByGridColumn(com.vaadin.ui.Grid.Column<E,?> gridColumn)`
`protected DataGrid.Column<E>`	`getColumnById(java.lang.Object id)`
`java.util.function.Function<DataGrid.ColumnGeneratorEvent<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.
`protected java.lang.String[]`	`getColumnOrder()`
`protected com.vaadin.data.ValueProvider`	`getColumnPresentationValueProvider(DataGrid.Column<E> column)`
`protected com.vaadin.ui.renderers.Renderer`	`getColumnRendererImplementation(DataGrid.Column<E> column)`
`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.
`protected java.util.List<DataGrid.Column<E>>`	`getColumnsOrderInternal()`
`com.vaadin.ui.Component`	`getComposition()`
`protected DataGridItems<E>`	`getDataGridItemsNN()`
`DataGrid.HeaderRow`	`getDefaultHeaderRow()` Returns the current default row of the header section.
`protected com.vaadin.data.ValueProvider`	`getDefaultPresentationValueProvider(DataGrid.Column<E> column)`
`protected com.vaadin.ui.renderers.Renderer`	`getDefaultRenderer(DataGrid.Column<E> column)`
`java.util.function.Function<E,Component>`	`getDetailsGenerator()`
`E`	`getEditedItem()` Returns the item that is currently being edited.
`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()`
`protected Action`	`getEnterAction()`
`Action`	`getEnterPressAction()`
`protected EntityDataGridItems<E>`	`getEntityDataGridItems()`
`protected EntityDataGridItems<E>`	`getEntityDataGridItemsNN()`
`DataGrid.FooterRow`	`getFooterRow(int index)` Gets the footer row at given index.
`protected DataGrid.FooterRow`	`getFooterRowByGridRow(com.vaadin.ui.components.grid.FooterRow gridRow)`
`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.
`protected java.lang.String`	`getGeneratedCellDescription(E item, DataGrid.Column<E> column)`
`protected java.lang.String`	`getGeneratedCellStyle(E item, DataGrid.Column<E> column)`
`protected java.lang.String`	`getGeneratedRowStyle(E item)`
`DataGrid.HeaderRow`	`getHeaderRow(int index)` Gets the header row at given index.
`protected DataGrid.HeaderRow`	`getHeaderRowByGridRow(com.vaadin.ui.components.grid.HeaderRow gridRow)`
`int`	`getHeaderRowCount()` Gets the row count for the header section.
`double`	`getHeaderRowHeight()` Returns the current header row height.
`protected java.util.List<DataGrid.Column<E>>`	`getInitialVisibleColumns()`
`java.util.Collection<Component>`	`getInnerComponents()`
`Action`	`getItemClickAction()`
`DataGridItems<E>`	`getItems()`
`java.util.Collection<E>`	`getLookupSelectedItems()`
`PaginationComponent`	`getPagination()`
`protected java.lang.String`	`getRowDescription(E item)`
`java.util.function.Function<E,java.lang.String>`	`getRowDescriptionProvider()` Returns the `RowDescriptionProvider` instance used to generate descriptions (tooltips) for DataGrid rows
`protected com.vaadin.ui.Component`	`getRowDetails(E item)`
`java.util.Set<E>`	`getSelected()` Returns a set of entity instances corresponding to the selected rows of the list component.
`DataGrid.SelectionMode`	`getSelectionMode()`
`E`	`getSingleSelected()` Returns an instance of entity corresponding to the selected row of the list component.
`java.util.List<DataGrid.SortOrder>`	`getSortOrder()`
`int`	`getTabIndex()` Gets the tabulator index of the `HasTabIndex` component.
`java.util.List<DataGrid.Column<E>>`	`getVisibleColumns()` Returns a copy of columns not hidden by security permissions.
`protected void`	`handleDoubleClickAction()`
`protected void`	`initAggregationRow()`
`protected void`	`initComponent(com.vaadin.ui.Grid<E> component)`
`protected void`	`initComponentComposition(AbstractDataGrid.GridComposition componentComposition)`
`protected void`	`initContextMenu()`
`protected void`	`initEditor(com.vaadin.ui.Grid<E> component)`
`protected void`	`initEmptyState()`
`protected void`	`initFooterRows(com.vaadin.ui.Grid<E> component)`
`protected void`	`initHeaderRows(com.vaadin.ui.Grid<E> component)`
`protected void`	`initSidebarMenu()`
`protected void`	`internalRemoveColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)`
`protected void`	`internalRemoveColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)`
`protected void`	`internalRemoveContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)`
`protected void`	`internalRemoveEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent<E>> listener)`
`protected void`	`internalRemoveEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent<E>> listener)`
`protected void`	`internalRemoveEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent<E>> listener)`
`protected void`	`internalRemoveEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent<E>> listener)`
`boolean`	`isAggregatable()`
`boolean`	`isCaptionAsHtml()`
`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`	`isMultiSelect()`
`boolean`	`isSortable()`
`boolean`	`isTextSelectionEnabled()`
`protected void`	`onBeforeRefreshGridData(E item)`
`protected void`	`onColumnReorder(com.vaadin.ui.Grid.ColumnReorderEvent e)`
`protected void`	`onColumnResize(com.vaadin.ui.Grid.ColumnResizeEvent e)`
`protected void`	`onColumnVisibilityChanged(com.vaadin.ui.Grid.ColumnVisibilityChangeEvent e)`
`protected void`	`onContextClick(com.vaadin.event.ContextClickEvent e)`
`protected void`	`onEditorBeforeSave(JmixEditorBeforeSaveEvent<E> event)`
`protected void`	`onEditorCancel(com.vaadin.ui.components.grid.EditorCancelEvent<E> cancelEvent)`
`protected void`	`onEditorOpen(com.vaadin.ui.components.grid.EditorOpenEvent<E> editorOpenEvent)`
`protected void`	`onEditorSave(com.vaadin.ui.components.grid.EditorSaveEvent<E> saveEvent)`
`protected void`	`onItemClick(com.vaadin.ui.Grid.ItemClick<E> e)`
`protected void`	`onPaginationAfterRefresh(PaginationComponent.AfterRefreshEvent event)`
`protected void`	`onSelectionChange(com.vaadin.event.selection.SelectionEvent<E> e)`
`protected void`	`onSort(com.vaadin.event.SortEvent<com.vaadin.data.provider.GridSortOrder<E>> e)`
`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.
`protected void`	`refreshActionsState()`
`void`	`removeAction(Action action)` Remove the action from the component
`void`	`removeAction(java.lang.String id)` Remove the action by its ID.
`protected void`	`removeAggregationRow()`
`void`	`removeAllActions()` Remove all actions from the component
`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.
`protected void`	`removeColumnId(com.vaadin.ui.Grid.Column<E,?> gridColumn)`
`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`	`removeRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)` Removes style provider for the DataGrid rows.
`void`	`repaint()` Repaint UI representation of the DataGrid without refreshing the table data.
`protected java.util.List<DataGrid.Column<E>>`	`restoreColumnsOrder(java.util.List<DataGrid.Column<E>> visibleColumns)` Inserts columns hidden by security permissions (or with visible = false, which means that where is no Grid.Column associated with DatGrid.Column) into a list of visible columns, passed as a parameter, in they original positions.
`protected void`	`restoreColumnsOrderAndUpdate(java.util.List<DataGrid.Column<E>> visibleColumns)`
`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`	`setAccessManager(io.jmix.core.AccessManager accessManager)`
`void`	`setActions(Actions actions)`
`void`	`setAggregatable(boolean aggregatable)` Set to true if aggregation should be enabled.
`void`	`setAggregationPosition(DataGrid.AggregationPosition position)` Sets aggregation row position.
`void`	`setAggregations(Aggregations aggregations)`
`void`	`setBodyRowHeight(double rowHeight)` Sets the height of a body row.
`void`	`setButtonsPanel(ButtonsPanel panel)` Sets a `ButtonsPanel` component.
`void`	`setCaption(java.lang.String caption)` Sets the component's caption.
`void`	`setCaptionAsHtml(boolean captionAsHtml)` Sets whether the caption is rendered as HTML.
`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.
`void`	`setDebugId(java.lang.String id)` INTERNAL.
`void`	`setDefaultHeaderRow(DataGrid.HeaderRow headerRow)` Sets the default row of the header.
`void`	`setDetailsGenerator(java.util.function.Function<E,Component> 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`	`setIconResolver(IconResolver iconResolver)`
`void`	`setId(java.lang.String id)` Set component ID
`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`	`setLookupSelectHandler(java.util.function.Consumer<java.util.Collection<E>> selectHandler)`
`void`	`setMessages(io.jmix.core.Messages messages)`
`void`	`setMessageTools(io.jmix.core.MessageTools messageTools)`
`void`	`setMetadataTools(io.jmix.core.MetadataTools metadataTools)`
`void`	`setPagination(PaginationComponent pagination)` Sets pagination component.
`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.
`protected void`	`setScreenValidation(ScreenValidation screenValidation)`
`void`	`setSelected(java.util.Collection<E> items)` Selects the rows of the list component for a given collection of entity instances.
`void`	`setSelected(E item)` Selects a row of the list component for a given entity instance.
`protected void`	`setSelectedItems(java.util.Collection<E> items)`
`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`	`setStyleName(java.lang.String name)` Sets one or more style names of the component, replacing any previous styles.
`void`	`setTabIndex(int tabIndex)` Sets the tabulator index of the `Focusable` component.
`void`	`setTextSelectionEnabled(boolean textSelectionEnabled)` Enable or disable text selection in DataGrid cells.
`void`	`setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)`
`protected void`	`setUiTestId(DataGridItems<E> items)`
`void`	`setUiTestIdsSupport(UiTestIdsSupport uiTestIdsSupport)`
`protected void`	`setupAutowiredColumns(EntityDataGridItems<E> entityDataGridSource)`
`protected void`	`setupGridColumnProperties(com.vaadin.ui.Grid.Column<E,?> gridColumn, DataGrid.Column<E> column)`
`void`	`setupPaginationDataSourceProvider()`
`protected void`	`setVisibleColumns(java.util.List<DataGrid.Column<E>> visibleColumnsOrder)`
`protected void`	`showEmptyStateIfPossible()`
`void`	`sort(java.lang.String columnId, DataGrid.SortDirection direction)` Sorts the DataGrid data for passed column id in the chosen sort direction.
`protected void`	`updateAggregationRow()`
`protected void`	`updateCompositionStylesTopPanelVisible()`
`protected java.lang.String`	`validateCrossFieldRules(java.util.Map<java.lang.String,java.lang.Object> properties)`

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent
addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getComponent, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setParent, setResponsive, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.DataGrid
getSubPart, of

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame
getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.ActionsHolder
getActionNN

Methods inherited from interface io.jmix.ui.component.Component
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setParent, setResponsive, setSizeAuto, setSizeFull, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasIcon
getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.Component.HasDescription
getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription
isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.Focusable
isFocusable, setFocusable

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

- Field Detail
  - HAS_TOP_PANEL_STYLE_NAME
```
protected static final java.lang.String HAS_TOP_PANEL_STYLE_NAME
```
    See Also:
    
    Constant Field Values
  - TEXT_SELECTION_ENABLED_STYLE
```
protected static final java.lang.String TEXT_SELECTION_ENABLED_STYLE
```
    See Also:
    
    Constant Field Values
  - metadataTools
```
protected io.jmix.core.MetadataTools metadataTools
```
  - accessManager
```
protected io.jmix.core.AccessManager accessManager
```
  - messages
```
protected io.jmix.core.Messages messages
```
  - messageTools
```
protected io.jmix.core.MessageTools messageTools
```
  - screenValidation
```
protected ScreenValidation screenValidation
```
  - actions
```
protected Actions actions
```
  - iconResolver
```
protected IconResolver iconResolver
```
  - aggregations
```
protected Aggregations aggregations
```
  - aggregatableDelegate
```
protected AggregatableDelegate<java.lang.Object> aggregatableDelegate
```
  - uiTestIdsSupport
```
protected UiTestIdsSupport uiTestIdsSupport
```
  - internalStyles
```
protected final java.util.List<java.lang.String> internalStyles
```
  - columns
```
protected final java.util.Map<java.lang.String,DataGrid.Column<E>> columns
```
  - columnsOrder
```
protected java.util.List<DataGrid.Column<E>> columnsOrder
```
  - columnGenerators
```
protected final java.util.Map<java.lang.String,java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?>> columnGenerators
```
  - actionList
```
protected final java.util.List<Action> actionList
```
  - shortcutsDelegate
```
protected final ShortcutsDelegate<com.vaadin.event.ShortcutListener> shortcutsDelegate
```
  - actionsPermissions
```
protected final ActionsPermissions actionsPermissions
```
  - contextMenu
```
protected JmixGridContextMenu<E> contextMenu
```
  - contextMenuItems
```
protected final java.util.List<AbstractDataGrid.ActionMenuItemWrapper> contextMenuItems
```
  - sortable
```
protected boolean sortable
```
  - columnsCollapsingAllowed
```
protected boolean columnsCollapsingAllowed
```
  - textSelectionEnabled
```
protected boolean textSelectionEnabled
```
  - editorCrossFieldValidate
```
protected boolean editorCrossFieldValidate
```
  - itemClickAction
```
protected Action itemClickAction
```
  - enterPressAction
```
protected Action enterPressAction
```
  - selectionMode
```
protected DataGrid.SelectionMode selectionMode
```
  - componentComposition
```
protected AbstractDataGrid.GridComposition componentComposition
```
  - topPanel
```
protected com.vaadin.ui.CssLayout topPanel
```
  - buttonsPanel
```
protected ButtonsPanel buttonsPanel
```
  - pagination
```
protected PaginationComponent pagination
```
  - rowStyleProviders
```
protected java.util.List<java.util.function.Function<? super E,java.lang.String>> rowStyleProviders
```
  - rowDescriptionProvider
```
protected java.util.function.Function<? super E,java.lang.String> rowDescriptionProvider
```
  - detailsGenerator
```
protected java.util.function.Function<E,Component> detailsGenerator
```
  - columnCollapsingChangeListenerRegistration
```
protected com.vaadin.shared.Registration columnCollapsingChangeListenerRegistration
```
  - columnResizeListenerRegistration
```
protected com.vaadin.shared.Registration columnResizeListenerRegistration
```
  - contextClickListenerRegistration
```
protected com.vaadin.shared.Registration contextClickListenerRegistration
```
  - editorCancelListener
```
protected com.vaadin.shared.Registration editorCancelListener
```
  - editorOpenListener
```
protected com.vaadin.shared.Registration editorOpenListener
```
  - editorBeforeSaveListener
```
protected com.vaadin.shared.Registration editorBeforeSaveListener
```
  - editorSaveListener
```
protected com.vaadin.shared.Registration editorSaveListener
```
  - headerRows
```
protected final java.util.List<DataGrid.HeaderRow> headerRows
```
  - footerRows
```
protected final java.util.List<DataGrid.FooterRow> footerRows
```
  - headerAggregationRow
```
protected com.vaadin.ui.components.grid.HeaderRow headerAggregationRow
```
  - footerAggregationRow
```
protected com.vaadin.ui.components.grid.FooterRow footerAggregationRow
```
  - showIconsForPopupMenuActions
```
protected boolean showIconsForPopupMenuActions
```
  - dataBinding
```
protected DataGridDataProvider<E> dataBinding
```
  - itemDatasources
```
protected java.util.Map<E,java.lang.Object> itemDatasources
```
  - emptyStateClickEventHandler
```
protected java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>> emptyStateClickEventHandler
```
- Constructor Detail
  - AbstractDataGrid
```
public AbstractDataGrid()
```
- Method Detail
  - createComponentComposition
```
protected AbstractDataGrid.GridComposition createComponentComposition()
```
  - createComponent
```
protected abstract C createComponent()
```
  - createShortcutsDelegate
```
protected ShortcutsDelegate<com.vaadin.event.ShortcutListener> createShortcutsDelegate()
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    java.lang.Exception
  - setMetadataTools
```
@Autowired
public void setMetadataTools(io.jmix.core.MetadataTools metadataTools)
```
  - setAccessManager
```
@Autowired
public void setAccessManager(io.jmix.core.AccessManager accessManager)
```
  - setMessages
```
@Autowired
public void setMessages(io.jmix.core.Messages messages)
```
  - setMessageTools
```
@Autowired
public void setMessageTools(io.jmix.core.MessageTools messageTools)
```
  - setThemeConstantsManager
```
@Autowired
public void setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)
```
  - setScreenValidation
```
@Autowired
protected void setScreenValidation(ScreenValidation screenValidation)
```
  - setActions
```
@Autowired
public void setActions(Actions actions)
```
  - setIconResolver
```
@Autowired
public void setIconResolver(IconResolver iconResolver)
```
  - setAggregations
```
@Autowired
public void setAggregations(Aggregations aggregations)
```
  - setUiTestIdsSupport
```
@Autowired
public void setUiTestIdsSupport(UiTestIdsSupport uiTestIdsSupport)
```
  - initComponent
```
protected void initComponent(com.vaadin.ui.Grid<E> component)
```
  - onBeforeRefreshGridData
```
protected void onBeforeRefreshGridData(E item)
```
  - createEditorFieldFactory
```
protected JmixGridEditorFieldFactory<E> createEditorFieldFactory()
```
  - initComponentComposition
```
protected void initComponentComposition(AbstractDataGrid.GridComposition componentComposition)
```
  - onItemClick
```
protected void onItemClick(com.vaadin.ui.Grid.ItemClick<E> e)
```
  - onColumnReorder
```
protected void onColumnReorder(com.vaadin.ui.Grid.ColumnReorderEvent e)
```
  - onSort
```
protected void onSort(com.vaadin.event.SortEvent<com.vaadin.data.provider.GridSortOrder<E>> e)
```
  - onSelectionChange
```
protected void onSelectionChange(com.vaadin.event.selection.SelectionEvent<E> e)
```
  - fireSelectionEvent
```
protected void fireSelectionEvent(com.vaadin.event.selection.SelectionEvent<E> e)
```
  - createEnterShortcutListener
```
protected ShortcutListenerDelegate createEnterShortcutListener()
```
  - getInnerComponents
```
public java.util.Collection<Component> getInnerComponents()
```
    Specified by:
    
    getInnerComponents in interface HasInnerComponents
  - initEditor
```
protected void initEditor(com.vaadin.ui.Grid<E> component)
```
  - initHeaderRows
```
protected void initHeaderRows(com.vaadin.ui.Grid<E> component)
```
  - initFooterRows
```
protected void initFooterRows(com.vaadin.ui.Grid<E> component)
```
  - getColumnsOrderInternal
```
protected java.util.List<DataGrid.Column<E>> getColumnsOrderInternal()
```
  - restoreColumnsOrder
```
protected java.util.List<DataGrid.Column<E>> restoreColumnsOrder(java.util.List<DataGrid.Column<E>> visibleColumns)
```
    Inserts columns hidden by security permissions (or with visible = false, which means that where is no Grid.Column associated with DatGrid.Column) into a list of visible columns, passed as a parameter, in they original positions.
    
    Parameters:
    
    visibleColumns - the list of DataGrid columns, not hidden by security permissions
    
    Returns:
    
    a list of all columns in DataGrid
  - restoreColumnsOrderAndUpdate
```
protected void restoreColumnsOrderAndUpdate(java.util.List<DataGrid.Column<E>> visibleColumns)
```
  - initContextMenu
```
protected void initContextMenu()
```
  - initSidebarMenu
```
protected void initSidebarMenu()
```
  - refreshActionsState
```
protected void refreshActionsState()
```
  - handleDoubleClickAction
```
protected void handleDoubleClickAction()
```
  - focus
```
public void focus()
```
    Description copied from interface: Component.Focusable
    
    Sets focus to this component
    
    Specified by:
    
    focus in interface Component.Focusable
  - setLookupSelectHandler
```
public void setLookupSelectHandler(java.util.function.Consumer<java.util.Collection<E>> selectHandler)
```
    Specified by:
    
    setLookupSelectHandler in interface LookupComponent<E>
    
    Parameters:
    
    selectHandler - handler that should be executed when a user select an item in the lookup screen
  - getLookupSelectedItems
```
public java.util.Collection<E> getLookupSelectedItems()
```
    Specified by:
    
    getLookupSelectedItems in interface LookupComponent<E>
    
    Returns:
    
    items selected in lookup component
  - getEnterAction
```
@Nullable
protected Action getEnterAction()
```
  - getColumns
```
public java.util.List<DataGrid.Column<E>> getColumns()
```
    Description copied from interface: DataGrid
    
    Returns a copy of currently configured columns in their current visual order in this DataGrid.
    
    Specified by:
    
    getColumns in interface DataGrid<E>
    
    Returns:
    
    unmodifiable copy of current columns
    
    See Also:
    
    DataGrid.getVisibleColumns()
  - getVisibleColumns
```
public java.util.List<DataGrid.Column<E>> getVisibleColumns()
```
    Description copied from interface: DataGrid
    
    Returns a copy of columns not hidden by security permissions.
    
    Specified by:
    
    getVisibleColumns in interface DataGrid<E>
    
    Returns:
    
    copy of columns not hidden by security permissions
    
    See Also:
    
    DataGrid.getColumns()
  - getColumn
```
@Nullable
public DataGrid.Column<E> getColumn(java.lang.String id)
```
    Description copied from interface: DataGrid
    
    Returns a column based on the Id.
    
    Specified by:
    
    getColumn in interface DataGrid<E>
    
    Parameters:
    
    id - the column Id
    
    Returns:
    
    the column or null if not found
    
    See Also:
    
    DataGrid.getColumnNN(String)
  - getColumnNN
```
public DataGrid.Column<E> getColumnNN(java.lang.String id)
```
    Description copied from interface: DataGrid
    
    Returns a column by its Id.
    
    Specified by:
    
    getColumnNN in interface DataGrid<E>
    
    Parameters:
    
    id - the column Id
    
    Returns:
    
    the column with given Id
    
    See Also:
    
    DataGrid.getColumn(String)
  - addColumn
```
public void addColumn(DataGrid.Column<E> column)
```
    Description copied from interface: DataGrid
    
    Adds the given column to DataGrid.
    
    Specified by:
    
    addColumn in interface DataGrid<E>
    
    Parameters:
    
    column - the column to add
    
    See Also:
    
    DataGrid.addColumn(Column, int), DataGrid.addColumn(String, MetaPropertyPath), DataGrid.addColumn(String, MetaPropertyPath, int)
  - addColumn
```
public void addColumn(DataGrid.Column<E> column,
                      int index)
```
    Description copied from interface: DataGrid
    
    Adds the given column at the specified index to DataGrid.
    
    Specified by:
    
    addColumn in interface DataGrid<E>
    
    Parameters:
    
    column - the column to add
    
    index - index of a new column
    
    See Also:
    
    DataGrid.addColumn(Column), DataGrid.addColumn(String, MetaPropertyPath), DataGrid.addColumn(String, MetaPropertyPath, int)
  - addColumn
```
public DataGrid.Column<E> addColumn(java.lang.String id,
                                    @Nullable
                                    io.jmix.core.metamodel.model.MetaPropertyPath propertyPath)
```
    Description copied from interface: DataGrid
    
    Creates new column with given Id and property, then adds this column to DataGrid.
    
    Specified by:
    
    addColumn in interface DataGrid<E>
    
    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:
    
    DataGrid.addColumn(Column), DataGrid.addColumn(Column, int), DataGrid.addColumn(String, MetaPropertyPath, int)
  - addColumn
```
public DataGrid.Column<E> addColumn(java.lang.String id,
                                    @Nullable
                                    io.jmix.core.metamodel.model.MetaPropertyPath propertyPath,
                                    int index)
```
    Description copied from interface: DataGrid
    
    Creates new column with given Id and property at the specified index, then adds this column to DataGrid.
    
    Specified by:
    
    addColumn in interface DataGrid<E>
    
    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:
    
    DataGrid.addColumn(Column), DataGrid.addColumn(Column, int), DataGrid.addColumn(String, MetaPropertyPath)
  - createColumn
```
protected AbstractDataGrid.ColumnImpl<E> createColumn(java.lang.String id,
                                                      @Nullable
                                                      io.jmix.core.metamodel.model.MetaPropertyPath propertyPath,
                                                      AbstractDataGrid<?,E> owner)
```
  - addColumnInternal
```
protected void addColumnInternal(AbstractDataGrid.ColumnImpl<E> column,
                                 int index)
```
  - generateColumnCaption
```
protected java.lang.String generateColumnCaption(DataGrid.Column<E> column)
```
  - setupGridColumnProperties
```
protected void setupGridColumnProperties(com.vaadin.ui.Grid.Column<E,?> gridColumn,
                                         DataGrid.Column<E> column)
```
  - getColumnPresentationValueProvider
```
@Nullable
protected com.vaadin.data.ValueProvider getColumnPresentationValueProvider(DataGrid.Column<E> column)
```
  - getDefaultPresentationValueProvider
```
protected com.vaadin.data.ValueProvider getDefaultPresentationValueProvider(DataGrid.Column<E> column)
```
  - getColumnRendererImplementation
```
protected com.vaadin.ui.renderers.Renderer getColumnRendererImplementation(DataGrid.Column<E> column)
```
  - getDefaultRenderer
```
protected com.vaadin.ui.renderers.Renderer getDefaultRenderer(DataGrid.Column<E> column)
```
  - addColumnId
```
protected void addColumnId(com.vaadin.ui.Grid.Column<E,?> gridColumn,
                           DataGrid.Column<E> column)
```
  - removeColumnId
```
protected void removeColumnId(com.vaadin.ui.Grid.Column<E,?> gridColumn)
```
  - removeColumn
```
public void removeColumn(@Nullable
                         DataGrid.Column<E> column)
```
    Description copied from interface: DataGrid
    
    Removes the given column from DataGrid or do nothing if column is null.
    
    Specified by:
    
    removeColumn in interface DataGrid<E>
    
    Parameters:
    
    column - the column to add
    
    See Also:
    
    DataGrid.removeColumn(String)
  - removeColumn
```
public void removeColumn(java.lang.String id)
```
    Description copied from interface: DataGrid
    
    Removes a column from DataGrid by its Id or do nothing if column is not found.
    
    Specified by:
    
    removeColumn in interface DataGrid<E>
    
    Parameters:
    
    id - the columns Id
    
    See Also:
    
    DataGrid.removeColumn(Column)
  - getItems
```
@Nullable
public DataGridItems<E> getItems()
```
    Specified by:
    
    getItems in interface DataGrid<E>
    
    Specified by:
    
    getItems in interface ListComponent<E>
    
    Returns:
    
    The DataGrid source
  - getDataGridItemsNN
```
protected DataGridItems<E> getDataGridItemsNN()
```
  - getEntityDataGridItems
```
@Nullable
protected EntityDataGridItems<E> getEntityDataGridItems()
```
  - getEntityDataGridItemsNN
```
protected EntityDataGridItems<E> getEntityDataGridItemsNN()
```
  - setItems
```
public void setItems(@Nullable
                     DataGridItems<E> dataGridItems)
```
    Description copied from interface: DataGrid
    
    Sets an instance of DataGridItems as the DataGrid data source.
    
    Specified by:
    
    setItems in interface DataGrid<E>
    
    Parameters:
    
    dataGridItems - the DataGrid data source
  - setUiTestId
```
protected void setUiTestId(DataGridItems<E> items)
```
  - createEmptyDataProvider
```
protected com.vaadin.data.provider.DataProvider<E,?> createEmptyDataProvider()
```
  - setVisibleColumns
```
protected void setVisibleColumns(java.util.List<DataGrid.Column<E>> visibleColumnsOrder)
```
  - getAutowiredProperties
```
protected java.util.Collection<io.jmix.core.metamodel.model.MetaPropertyPath> getAutowiredProperties(EntityDataGridItems<E> entityDataGridSource)
```
  - setupAutowiredColumns
```
protected void setupAutowiredColumns(EntityDataGridItems<E> entityDataGridSource)
```
  - createDataGridDataProvider
```
protected DataGridDataProvider<E> createDataGridDataProvider(DataGridItems<E> dataGridItems)
```
  - dataGridSourceItemSetChanged
```
public void dataGridSourceItemSetChanged(DataGridItems.ItemSetChangeEvent<E> event)
```
    Specified by:
    
    dataGridSourceItemSetChanged in interface DataGridItemsEventsDelegate<E>
  - dataGridSourcePropertyValueChanged
```
public void dataGridSourcePropertyValueChanged(DataGridItems.ValueChangeEvent<E> event)
```
    Specified by:
    
    dataGridSourcePropertyValueChanged in interface DataGridItemsEventsDelegate<E>
  - dataGridSourceStateChanged
```
public void dataGridSourceStateChanged(DataUnit.StateChangeEvent event)
```
    Specified by:
    
    dataGridSourceStateChanged in interface DataGridItemsEventsDelegate<E>
  - dataGridSourceSelectedItemChanged
```
public void dataGridSourceSelectedItemChanged(DataGridItems.SelectedItemChangeEvent<E> event)
```
    Specified by:
    
    dataGridSourceSelectedItemChanged in interface DataGridItemsEventsDelegate<E>
  - getColumnOrder
```
protected java.lang.String[] getColumnOrder()
```
  - getCaption
```
@Nullable
public java.lang.String getCaption()
```
    Specified by:
    
    getCaption in interface Component.HasCaption
    
    Overrides:
    
    getCaption in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
    
    Returns:
    
    the caption of the component
  - setCaption
```
public void setCaption(@Nullable
                       java.lang.String caption)
```
    Description copied from interface: Component.HasCaption
    
    Sets the component's caption.
    
    Specified by:
    
    setCaption in interface Component.HasCaption
    
    Overrides:
    
    setCaption in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
    
    Parameters:
    
    caption - the new component's caption
  - isCaptionAsHtml
```
public boolean isCaptionAsHtml()
```
    Specified by:
    
    isCaptionAsHtml in interface HasHtmlCaption
    
    Overrides:
    
    isCaptionAsHtml in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
    
    Returns:
    
    true if the caption is rendered as HTML, false if rendered as plain text
  - setCaptionAsHtml
```
public void setCaptionAsHtml(boolean captionAsHtml)
```
    Description copied from interface: HasHtmlCaption
    
    Sets whether the caption is rendered as HTML.
    
    Specified by:
    
    setCaptionAsHtml in interface HasHtmlCaption
    
    Overrides:
    
    setCaptionAsHtml in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
    
    Parameters:
    
    captionAsHtml - true if the caption is rendered as HTML, false if rendered as plain text
    
    See Also:
    
    Component.HasCaption.setCaption(String)
  - isTextSelectionEnabled
```
public boolean isTextSelectionEnabled()
```
    Specified by:
    
    isTextSelectionEnabled in interface DataGrid<E>
    
    Returns:
    
    true if text selection is enabled.
  - setTextSelectionEnabled
```
public void setTextSelectionEnabled(boolean textSelectionEnabled)
```
    Description copied from interface: DataGrid
    
    Enable or disable text selection in DataGrid cells. Default value is false.
    
    Specified by:
    
    setTextSelectionEnabled in interface DataGrid<E>
    
    Parameters:
    
    textSelectionEnabled - specifies whether text selection in DataGrid cells is enabled
  - isColumnReorderingAllowed
```
public boolean isColumnReorderingAllowed()
```
    Description copied from interface: DataGrid
    
    Returns whether column reordering is allowed. Default value is true.
    
    Specified by:
    
    isColumnReorderingAllowed in interface DataGrid<E>
    
    Returns:
    
    true if reordering is allowed
  - setColumnReorderingAllowed
```
public void setColumnReorderingAllowed(boolean columnReorderingAllowed)
```
    Description copied from interface: DataGrid
    
    Sets whether or not column reordering is allowed. Default value is true.
    
    Specified by:
    
    setColumnReorderingAllowed in interface DataGrid<E>
    
    Parameters:
    
    columnReorderingAllowed - specifies whether column reordering is allowed
  - isSortable
```
public boolean isSortable()
```
    Specified by:
    
    isSortable in interface DataGrid<E>
    
    Returns:
    
    true if individual column sortable attribute can be set to true, false otherwise
  - setSortable
```
public void setSortable(boolean sortable)
```
    Description copied from interface: DataGrid
    
    Defines if this attribute can be changed for individual column or not. Default value is true.
    
    Specified by:
    
    setSortable in interface DataGrid<E>
    
    Parameters:
    
    sortable - true if individual column sortable attribute can be set to true, false otherwise
  - isColumnsCollapsingAllowed
```
public boolean isColumnsCollapsingAllowed()
```
    Specified by:
    
    isColumnsCollapsingAllowed in interface DataGrid<E>
    
    Returns:
    
    true if individual column collapsible attribute can be set to true, false otherwise
  - setColumnsCollapsingAllowed
```
public void setColumnsCollapsingAllowed(boolean columnsCollapsingAllowed)
```
    Description copied from interface: DataGrid
    
    Defines if collapsible attribute can be changed for individual column or not. Default value is true.
    
    Specified by:
    
    setColumnsCollapsingAllowed in interface DataGrid<E>
    
    Parameters:
    
    columnsCollapsingAllowed - true if individual column collapsible attribute can be set to true, false otherwise
  - isEditorEnabled
```
public boolean isEditorEnabled()
```
    Description copied from interface: DataGrid
    
    Checks whether the item editor UI is enabled for this DataGrid.
    
    Specified by:
    
    isEditorEnabled in interface DataGrid<E>
    
    Returns:
    
    true if the editor is enabled for this grid
    
    See Also:
    
    DataGrid.setEditorEnabled(boolean), DataGrid.getEditedItem()
  - setEditorEnabled
```
public void setEditorEnabled(boolean isEnabled)
```
    Description copied from interface: DataGrid
    
    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 DataGrid.edit(Object) method.
    
    Specified by:
    
    setEditorEnabled in interface DataGrid<E>
    
    Parameters:
    
    isEnabled - true to enable the feature, false otherwise
    
    See Also:
    
    DataGrid.getEditedItem()
  - isEditorBuffered
```
public boolean isEditorBuffered()
```
    Description copied from interface: DataGrid
    
    Gets the buffered editor mode.
    
    Specified by:
    
    isEditorBuffered in interface DataGrid<E>
    
    Returns:
    
    true if buffered editor is enabled, false otherwise
  - setEditorBuffered
```
public void setEditorBuffered(boolean editorBuffered)
```
    Description copied from interface: DataGrid
    
    Sets the buffered editor mode. The default mode is buffered (true).
    
    Specified by:
    
    setEditorBuffered in interface DataGrid<E>
    
    Parameters:
    
    editorBuffered - true to enable buffered editor, false to disable it
  - getEditorSaveCaption
```
public java.lang.String getEditorSaveCaption()
```
    Description copied from interface: DataGrid
    
    Gets the current caption of the save button in the DataGrid editor.
    
    Specified by:
    
    getEditorSaveCaption in interface DataGrid<E>
    
    Returns:
    
    the current caption of the save button
  - setEditorSaveCaption
```
public void setEditorSaveCaption(java.lang.String saveCaption)
```
    Description copied from interface: DataGrid
    
    Sets the caption on the save button in the DataGrid editor.
    
    Specified by:
    
    setEditorSaveCaption in interface DataGrid<E>
    
    Parameters:
    
    saveCaption - the caption to set
  - getEditorCancelCaption
```
public java.lang.String getEditorCancelCaption()
```
    Description copied from interface: DataGrid
    
    Gets the current caption of the cancel button in the DataGrid editor.
    
    Specified by:
    
    getEditorCancelCaption in interface DataGrid<E>
    
    Returns:
    
    the current caption of the cancel button
  - setEditorCancelCaption
```
public void setEditorCancelCaption(java.lang.String cancelCaption)
```
    Description copied from interface: DataGrid
    
    Sets the caption on the cancel button in the DataGrid editor.
    
    Specified by:
    
    setEditorCancelCaption in interface DataGrid<E>
    
    Parameters:
    
    cancelCaption - the caption to set
  - getEditedItem
```
public E getEditedItem()
```
    Description copied from interface: DataGrid
    
    Returns the item that is currently being edited.
    
    Specified by:
    
    getEditedItem in interface DataGrid<E>
    
    Returns:
    
    the item that is currently being edited, or null if no item is being edited at the moment
  - isEditorActive
```
public boolean isEditorActive()
```
    Description copied from interface: DataGrid
    
    Returns whether an item is currently being edited in the editor.
    
    Specified by:
    
    isEditorActive in interface DataGrid<E>
    
    Returns:
    
    true if the editor is open
  - edit
```
public void edit(E item)
```
    Description copied from interface: DataGrid
    
    Opens the editor interface for the provided entity. Scrolls the Grid to bring the entity to view if it is not already visible.
    
    Specified by:
    
    edit in interface DataGrid<E>
    
    Parameters:
    
    item - the item to edit
    
    See Also:
    
    DataGrid.setEditorEnabled(boolean)
  - editItemInternal
```
protected void editItemInternal(E item)
```
  - convertToJmixFields
```
protected java.util.Map<java.lang.String,Field> convertToJmixFields(java.util.Map<com.vaadin.ui.Grid.Column<E,?>,com.vaadin.ui.Component> columnFieldMap)
```
  - addEditorOpenListener
```
public io.jmix.core.common.event.Subscription addEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent<E>> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new DataGrid editor open listener.
    
    Specified by:
    
    addEditorOpenListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - onEditorOpen
```
protected void onEditorOpen(com.vaadin.ui.components.grid.EditorOpenEvent<E> editorOpenEvent)
```
  - internalRemoveEditorOpenListener
```
protected void internalRemoveEditorOpenListener(java.util.function.Consumer<DataGrid.EditorOpenEvent<E>> listener)
```
  - addEditorCloseListener
```
public io.jmix.core.common.event.Subscription addEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent<E>> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new DataGrid editor close listener.
    
    Specified by:
    
    addEditorCloseListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - onEditorCancel
```
protected void onEditorCancel(com.vaadin.ui.components.grid.EditorCancelEvent<E> cancelEvent)
```
  - internalRemoveEditorCloseListener
```
protected void internalRemoveEditorCloseListener(java.util.function.Consumer<DataGrid.EditorCloseEvent<E>> listener)
```
  - addEditorPreCommitListener
```
public io.jmix.core.common.event.Subscription addEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent<E>> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new DataGrid editor pre commit listener. Works in buffered mode only.
    
    Specified by:
    
    addEditorPreCommitListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - onEditorBeforeSave
```
protected void onEditorBeforeSave(JmixEditorBeforeSaveEvent<E> event)
```
  - internalRemoveEditorPreCommitListener
```
protected void internalRemoveEditorPreCommitListener(java.util.function.Consumer<DataGrid.EditorPreCommitEvent<E>> listener)
```
  - addEditorPostCommitListener
```
public io.jmix.core.common.event.Subscription addEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent<E>> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new DataGrid editor post commit listener. Works in buffered mode only.
    
    Specified by:
    
    addEditorPostCommitListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - onEditorSave
```
protected void onEditorSave(com.vaadin.ui.components.grid.EditorSaveEvent<E> saveEvent)
```
  - internalRemoveEditorPostCommitListener
```
protected void internalRemoveEditorPostCommitListener(java.util.function.Consumer<DataGrid.EditorPostCommitEvent<E>> listener)
```
  - setEditorCrossFieldValidate
```
public void setEditorCrossFieldValidate(boolean validate)
```
    Description copied from interface: DataGrid
    
    Enables cross field validation in the inline editor. True by default.
    
    Specified by:
    
    setEditorCrossFieldValidate in interface DataGrid<E>
    
    Parameters:
    
    validate - validate option, true if an editor should validate cross field rules
  - isEditorCrossFieldValidate
```
public boolean isEditorCrossFieldValidate()
```
    Specified by:
    
    isEditorCrossFieldValidate in interface DataGrid<E>
    
    Returns:
    
    true if editor validates cross field rules
  - createInstanceContainer
```
protected InstanceContainer<E> createInstanceContainer(E item)
```
  - clearFieldDatasources
```
protected void clearFieldDatasources(@Nullable
                                     E item)
```
  - detachItemContainer
```
protected void detachItemContainer(java.lang.Object container)
```
  - createValueSourceProvider
```
protected ValueSourceProvider createValueSourceProvider(E item)
```
  - isHeaderVisible
```
public boolean isHeaderVisible()
```
    Description copied from interface: DataGrid
    
    Returns the visibility of the header section.
    
    Specified by:
    
    isHeaderVisible in interface DataGrid<E>
    
    Returns:
    
    true if visible, false otherwise
  - setHeaderVisible
```
public void setHeaderVisible(boolean headerVisible)
```
    Description copied from interface: DataGrid
    
    Sets the visibility of the header section.
    
    Specified by:
    
    setHeaderVisible in interface DataGrid<E>
    
    Parameters:
    
    headerVisible - true to show the header section, false to hide
  - isFooterVisible
```
public boolean isFooterVisible()
```
    Description copied from interface: DataGrid
    
    Returns the visibility of the footer section.
    
    Specified by:
    
    isFooterVisible in interface DataGrid<E>
    
    Returns:
    
    true if visible, false otherwise
  - setFooterVisible
```
public void setFooterVisible(boolean footerVisible)
```
    Description copied from interface: DataGrid
    
    Sets the visibility of the footer section.
    
    Specified by:
    
    setFooterVisible in interface DataGrid<E>
    
    Parameters:
    
    footerVisible - true to show the footer section, false to hide
  - getBodyRowHeight
```
public double getBodyRowHeight()
```
    Description copied from interface: DataGrid
    
    Returns the current body row height.
    
    Specified by:
    
    getBodyRowHeight in interface DataGrid<E>
    
    Returns:
    
    body row height, -1 if height is AUTO
  - setBodyRowHeight
```
public void setBodyRowHeight(double rowHeight)
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    setBodyRowHeight in interface DataGrid<E>
    
    Parameters:
    
    rowHeight - the height of a row in pixels or -1 for AUTO
  - getHeaderRowHeight
```
public double getHeaderRowHeight()
```
    Description copied from interface: DataGrid
    
    Returns the current header row height.
    
    Specified by:
    
    getHeaderRowHeight in interface DataGrid<E>
    
    Returns:
    
    header row height, -1 if height is AUTO
  - setHeaderRowHeight
```
public void setHeaderRowHeight(double rowHeight)
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    setHeaderRowHeight in interface DataGrid<E>
    
    Parameters:
    
    rowHeight - the height of a row in pixels or -1 for AUTO
  - getFooterRowHeight
```
public double getFooterRowHeight()
```
    Description copied from interface: DataGrid
    
    Returns the current footer row height.
    
    Specified by:
    
    getFooterRowHeight in interface DataGrid<E>
    
    Returns:
    
    footer row height, -1 if height is AUTO
  - setFooterRowHeight
```
public void setFooterRowHeight(double rowHeight)
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    setFooterRowHeight in interface DataGrid<E>
    
    Parameters:
    
    rowHeight - the height of a row in pixels or -1 for AUTO
  - isContextMenuEnabled
```
public boolean isContextMenuEnabled()
```
    Specified by:
    
    isContextMenuEnabled in interface DataGrid<E>
    
    Returns:
    
    true if context menu is enabled, false otherwise
  - setContextMenuEnabled
```
public void setContextMenuEnabled(boolean contextMenuEnabled)
```
    Description copied from interface: DataGrid
    
    Sets whether or not context menu is enabled. Default value is true.
    
    Specified by:
    
    setContextMenuEnabled in interface DataGrid<E>
    
    Parameters:
    
    contextMenuEnabled - specifies whether context menu is enabled
  - getColumnResizeMode
```
public DataGrid.ColumnResizeMode getColumnResizeMode()
```
    Description copied from interface: DataGrid
    
    Returns the current column resize mode. The default mode is DataGrid.ColumnResizeMode.ANIMATED.
    
    Specified by:
    
    getColumnResizeMode in interface DataGrid<E>
    
    Returns:
    
    a ColumnResizeMode value
  - setColumnResizeMode
```
public void setColumnResizeMode(DataGrid.ColumnResizeMode mode)
```
    Description copied from interface: DataGrid
    
    Sets the column resize mode to use. The default mode is DataGrid.ColumnResizeMode.ANIMATED.
    
    Specified by:
    
    setColumnResizeMode in interface DataGrid<E>
    
    Parameters:
    
    mode - a ColumnResizeMode value
  - getSelectionMode
```
public DataGrid.SelectionMode getSelectionMode()
```
    Specified by:
    
    getSelectionMode in interface DataGrid<E>
    
    Returns:
    
    the currently used DataGrid.SelectionMode
  - setSelectionMode
```
public void setSelectionMode(DataGrid.SelectionMode selectionMode)
```
    Description copied from interface: DataGrid
    
    Sets the DataGrid's selection mode.
    
    Specified by:
    
    setSelectionMode in interface DataGrid<E>
    
    Parameters:
    
    selectionMode - the selection mode to use
  - isMultiSelect
```
public boolean isMultiSelect()
```
    Specified by:
    
    isMultiSelect in interface ListComponent<E>
    
    Returns:
    
    true if multiple selection mode is enabled
  - getSingleSelected
```
@Nullable
public E getSingleSelected()
```
    Description copied from interface: ListComponent
    
    Returns an instance of entity corresponding to the selected row of the list component. If nothing is selected, the method returns null. If multiple selection mode is enabled, returns the first selected instance.
    
    Specified by:
    
    getSingleSelected in interface ListComponent<E>
    
    Returns:
    
    an instance of entity corresponding to the selected row of the list component
  - getSelected
```
public java.util.Set<E> getSelected()
```
    Description copied from interface: ListComponent
    
    Returns a set of entity instances corresponding to the selected rows of the list component. If nothing is selected, the method returns a Collections.emptySet().
    
    Specified by:
    
    getSelected in interface ListComponent<E>
    
    Returns:
    
    a set of entity instances corresponding to the selected rows of the list component
  - setSelected
```
public void setSelected(@Nullable
                        E item)
```
    Description copied from interface: ListComponent
    
    Selects a row of the list component for a given entity instance.
    
    Specified by:
    
    setSelected in interface ListComponent<E>
    
    Parameters:
    
    item - entity instance to select the row, null to reset the selection
  - setSelected
```
public void setSelected(java.util.Collection<E> items)
```
    Description copied from interface: ListComponent
    
    Selects the rows of the list component for a given collection of entity instances.
    
    Specified by:
    
    setSelected in interface ListComponent<E>
    
    Parameters:
    
    items - collection of entity instances to select rows
  - setSelectedItems
```
protected void setSelectedItems(java.util.Collection<E> items)
```
  - selectAll
```
public void selectAll()
```
    Description copied from interface: DataGrid
    
    Marks all the items in the current data source as selected.
    
    Specified by:
    
    selectAll in interface DataGrid<E>
  - deselect
```
public void deselect(E item)
```
    Description copied from interface: DataGrid
    
    Deselects the given item. If the item is not currently selected, does nothing.
    
    Specified by:
    
    deselect in interface DataGrid<E>
    
    Parameters:
    
    item - the item to deselect, not null
  - deselectAll
```
public void deselectAll()
```
    Description copied from interface: DataGrid
    
    Deselects all the items in the current data source.
    
    Specified by:
    
    deselectAll in interface DataGrid<E>
  - sort
```
public void sort(java.lang.String columnId,
                 DataGrid.SortDirection direction)
```
    Description copied from interface: DataGrid
    
    Sorts the DataGrid data for passed column id in the chosen sort direction.
    
    Specified by:
    
    sort in interface DataGrid<E>
    
    Parameters:
    
    columnId - id of the column to sort
    
    direction - sort direction
  - getSortOrder
```
public java.util.List<DataGrid.SortOrder> getSortOrder()
```
    Specified by:
    
    getSortOrder in interface DataGrid<E>
    
    Returns:
    
    sort order list
  - convertToDataGridSortOrder
```
protected java.util.List<DataGrid.SortOrder> convertToDataGridSortOrder(java.util.List<com.vaadin.data.provider.GridSortOrder<E>> gridSortOrder)
```
  - addAction
```
public void addAction(Action action)
```
    Description copied from interface: ActionsHolder
    
    Add an action to the component
    
    Specified by:
    
    addAction in interface ActionsHolder
  - addAction
```
public void addAction(Action action,
                      int index)
```
    Description copied from interface: ActionsHolder
    
    Add an action to the component with index.
    
    Specified by:
    
    addAction in interface ActionsHolder
  - createContextMenuItem
```
protected AbstractDataGrid.ActionMenuItemWrapper createContextMenuItem(Action action)
```
  - attachAction
```
protected void attachAction(Action action)
```
  - removeAction
```
public void removeAction(Action action)
```
    Description copied from interface: ActionsHolder
    
    Remove the action from the component
    
    Specified by:
    
    removeAction in interface ActionsHolder
  - removeAction
```
public void removeAction(java.lang.String id)
```
    Description copied from interface: ActionsHolder
    
    Remove the action by its ID. If there is no action with that ID, nothing happens.
    
    Specified by:
    
    removeAction in interface ActionsHolder
  - removeAllActions
```
public void removeAllActions()
```
    Description copied from interface: ActionsHolder
    
    Remove all actions from the component
    
    Specified by:
    
    removeAllActions in interface ActionsHolder
  - getActions
```
public java.util.Collection<Action> getActions()
```
    Specified by:
    
    getActions in interface ActionsHolder
    
    Returns:
    
    unmodifiable collection of actions
  - getAction
```
@Nullable
public Action getAction(java.lang.String id)
```
    Specified by:
    
    getAction in interface ActionsHolder
    
    Returns:
    
    an action by its ID, or null if not found
  - getActionsPermissions
```
public ActionsPermissions getActionsPermissions()
```
    Specified by:
    
    getActionsPermissions in interface SecuredActionsHolder
    
    Returns:
    
    permissions container
  - getInitialVisibleColumns
```
protected java.util.List<DataGrid.Column<E>> getInitialVisibleColumns()
```
  - getComposition
```
public com.vaadin.ui.Component getComposition()
```
    Specified by:
    
    getComposition in interface Component.Wrapper
    
    Overrides:
    
    getComposition in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
  - getFrozenColumnCount
```
public int getFrozenColumnCount()
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    getFrozenColumnCount in interface DataGrid<E>
    
    Returns:
    
    the number of frozen columns
    
    See Also:
    
    DataGrid.setFrozenColumnCount(int)
  - setFrozenColumnCount
```
public void setFrozenColumnCount(int numberOfColumns)
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    setFrozenColumnCount in interface DataGrid<E>
    
    Parameters:
    
    numberOfColumns - the number of columns that should be frozen
  - scrollTo
```
public void scrollTo(E item)
```
    Description copied from interface: DataGrid
    
    Scrolls to a certain item, using DataGrid.ScrollDestination.ANY.
    
    Specified by:
    
    scrollTo in interface DataGrid<E>
    
    Parameters:
    
    item - item to scroll to
    
    See Also:
    
    DataGrid.scrollTo(Object, ScrollDestination), DataGrid.scrollToStart(), DataGrid.scrollToEnd()
  - scrollTo
```
public void scrollTo(E item,
                     DataGrid.ScrollDestination destination)
```
    Description copied from interface: DataGrid
    
    Scrolls to a certain item, using user-specified scroll destination.
    
    Specified by:
    
    scrollTo in interface DataGrid<E>
    
    Parameters:
    
    item - item to scroll to
    
    destination - value specifying desired position of scrolled-to row
    
    See Also:
    
    DataGrid.scrollTo(Object), DataGrid.scrollToStart(), DataGrid.scrollToEnd()
  - scrollToStart
```
public void scrollToStart()
```
    Description copied from interface: DataGrid
    
    Scrolls to the first data item.
    
    Specified by:
    
    scrollToStart in interface DataGrid<E>
    
    See Also:
    
    DataGrid.scrollTo(Object), DataGrid.scrollTo(Object, ScrollDestination), DataGrid.scrollToEnd()
  - scrollToEnd
```
public void scrollToEnd()
```
    Description copied from interface: DataGrid
    
    Scrolls to the last data item.
    
    Specified by:
    
    scrollToEnd in interface DataGrid<E>
    
    See Also:
    
    DataGrid.scrollTo(Object), DataGrid.scrollTo(Object, ScrollDestination), DataGrid.scrollToStart()
  - repaint
```
public void repaint()
```
    Description copied from interface: DataGrid
    
    Repaint UI representation of the DataGrid without refreshing the table data.
    
    Specified by:
    
    repaint in interface DataGrid<E>
  - canBeSorted
```
protected boolean canBeSorted(@Nullable
                              DataGridItems<E> dataGridItems)
```
  - setDebugId
```
public void setDebugId(@Nullable
                       java.lang.String id)
```
    Description copied from interface: HasDebugId
    
    INTERNAL. Managed by debug Id system.
    
    Specified by:
    
    setDebugId in interface HasDebugId
    
    Overrides:
    
    setDebugId in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
  - setId
```
public void setId(@Nullable
                  java.lang.String id)
```
    Description copied from interface: Component
    
    Set component ID
    
    Specified by:
    
    setId in interface Component
    
    Overrides:
    
    setId in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
  - setStyleName
```
public void setStyleName(@Nullable
                         java.lang.String name)
```
    Description copied from interface: Component
    
    Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.
    
    Specified by:
    
    setStyleName in interface Component
    
    Overrides:
    
    setStyleName in class AbstractComponent<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>>
    
    Parameters:
    
    name - one or more style names separated by space.
  - getButtonsPanel
```
@Nullable
public ButtonsPanel getButtonsPanel()
```
    Specified by:
    
    getButtonsPanel in interface HasButtonsPanel
    
    Returns:
    
    a buttons panel component.
  - setButtonsPanel
```
public void setButtonsPanel(@Nullable
                            ButtonsPanel panel)
```
    Description copied from interface: HasButtonsPanel
    
    Sets a ButtonsPanel component.
    
    Specified by:
    
    setButtonsPanel in interface HasButtonsPanel
    
    Parameters:
    
    panel - a buttons panel component
  - getPagination
```
@Nullable
public PaginationComponent getPagination()
```
    Specified by:
    
    getPagination in interface HasPagination
    
    Returns:
    
    pagination component
  - setPagination
```
public void setPagination(@Nullable
                          PaginationComponent pagination)
```
    Description copied from interface: HasPagination
    
    Sets pagination component.
    
    Specified by:
    
    setPagination in interface HasPagination
  - onPaginationAfterRefresh
```
protected void onPaginationAfterRefresh(PaginationComponent.AfterRefreshEvent event)
```
  - setupPaginationDataSourceProvider
```
public void setupPaginationDataSourceProvider()
```
  - createTopPanel
```
protected com.vaadin.ui.CssLayout createTopPanel()
```
  - updateCompositionStylesTopPanelVisible
```
protected void updateCompositionStylesTopPanelVisible()
```
  - getEnterPressAction
```
@Nullable
public Action getEnterPressAction()
```
    Specified by:
    
    getEnterPressAction in interface DataGrid<E>
    
    Returns:
    
    an action to be executed on Enter key press, assigned by DataGrid.setEnterPressAction(Action)
    
    See Also:
    
    DataGrid.setEnterPressAction(Action)
  - setEnterPressAction
```
public void setEnterPressAction(@Nullable
                                Action action)
```
    Description copied from interface: DataGrid
    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 DataGrid.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.
    Specified by:
    
    setEnterPressAction in interface DataGrid<E>
    
    Parameters:
    
    action - an action to be executed on Enter key press
    
    See Also:
    
    DataGrid.setItemClickAction(Action)
  - getItemClickAction
```
@Nullable
public Action getItemClickAction()
```
    Specified by:
    
    getItemClickAction in interface DataGrid<E>
    
    Returns:
    
    an action to be executed on double click on a DataGrid row, assigned by DataGrid.setItemClickAction(Action)
    
    See Also:
    
    DataGrid.setItemClickAction(Action)
  - setItemClickAction
```
public void setItemClickAction(@Nullable
                               Action action)
```
    Description copied from interface: DataGrid
    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.
    Specified by:
    
    setItemClickAction in interface DataGrid<E>
    
    Parameters:
    
    action - an action to be executed on double click on a DataGrid row
  - getColumnByGridColumn
```
@Nullable
protected AbstractDataGrid.ColumnImpl<E> getColumnByGridColumn(com.vaadin.ui.Grid.Column<E,?> gridColumn)
```
  - getColumnById
```
@Nullable
protected DataGrid.Column<E> getColumnById(java.lang.Object id)
```
  - addRowStyleProvider
```
public void addRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Description copied from interface: DataGrid
    
    Adds style provider for the DataGrid rows.
    DataGrid can use several providers to obtain many style names for rows.
    
    Specified by:
    
    addRowStyleProvider in interface DataGrid<E>
    
    Parameters:
    
    styleProvider - a style provider to add, not null
  - removeRowStyleProvider
```
public void removeRowStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Description copied from interface: DataGrid
    
    Removes style provider for the DataGrid rows.
    
    Specified by:
    
    removeRowStyleProvider in interface DataGrid<E>
    
    Parameters:
    
    styleProvider - a style provider to remove, not null
  - getRowDescriptionProvider
```
@Nullable
public java.util.function.Function<E,java.lang.String> getRowDescriptionProvider()
```
    Description copied from interface: DataGrid
    
    Returns the RowDescriptionProvider instance used to generate descriptions (tooltips) for DataGrid rows
    
    Specified by:
    
    getRowDescriptionProvider in interface DataGrid<E>
    
    Returns:
    
    the description provider or null if no provider is set
  - setRowDescriptionProvider
```
public void setRowDescriptionProvider(@Nullable
                                      java.util.function.Function<? super E,java.lang.String> provider)
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    setRowDescriptionProvider in interface DataGrid<E>
    
    Parameters:
    
    provider - the description provider to use or null to remove a previously set provider if any
  - setRowDescriptionProvider
```
public void setRowDescriptionProvider(@Nullable
                                      java.util.function.Function<? super E,java.lang.String> provider,
                                      ContentMode contentMode)
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    setRowDescriptionProvider in interface DataGrid<E>
    
    Parameters:
    
    provider - the description provider to use or null to remove a previously set provider if any
    
    contentMode - the content mode for row tooltips
  - getRowDescription
```
@Nullable
protected java.lang.String getRowDescription(E item)
```
  - addGeneratedColumn
```
public DataGrid.Column<E> addGeneratedColumn(java.lang.String columnId,
                                             java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?> generator)
```
    Description copied from interface: DataGrid
    
    Add a generated column to the DataGrid.
    
    Specified by:
    
    addGeneratedColumn in interface DataGrid<E>
    
    Parameters:
    
    columnId - column identifier as defined in XML descriptor
    
    generator - column generator instance
    
    See Also:
    
    DataGrid.addGeneratedColumn(String, Function, int)
  - addGeneratedColumn
```
public DataGrid.Column<E> addGeneratedColumn(java.lang.String columnId,
                                             java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?> generator,
                                             int index)
```
    Description copied from interface: DataGrid
    
    Add a generated column to the DataGrid.
    
    Specified by:
    
    addGeneratedColumn in interface DataGrid<E>
    
    Parameters:
    
    columnId - column identifier as defined in XML descriptor
    
    generator - column generator instance
    
    index - index of a new generated column
    
    See Also:
    
    DataGrid.addGeneratedColumn(String, Function)
  - createGeneratedColumnValueProvider
```
protected com.vaadin.data.ValueProvider<E,java.lang.Object> createGeneratedColumnValueProvider(java.lang.String columnId,
                                                                                               java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?> generator)
```
  - getColumnGenerator
```
@Nullable
public java.util.function.Function<DataGrid.ColumnGeneratorEvent<E>,?> getColumnGenerator(java.lang.String columnId)
```
    Description copied from interface: DataGrid
    
    Gets the columns generator for the given column id.
    
    Specified by:
    
    getColumnGenerator in interface DataGrid<E>
    
    Parameters:
    
    columnId - the column id for which to return column generator
    
    Returns:
    
    the column generator for given column id
  - copyColumnProperties
```
protected void copyColumnProperties(DataGrid.Column<E> column,
                                    DataGrid.Column<E> existingColumn)
```
  - addColumnCollapsingChangeListener
```
public io.jmix.core.common.event.Subscription addColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new column collapsing change listener.
    
    Specified by:
    
    addColumnCollapsingChangeListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - onColumnVisibilityChanged
```
protected void onColumnVisibilityChanged(com.vaadin.ui.Grid.ColumnVisibilityChangeEvent e)
```
  - internalRemoveColumnCollapsingChangeListener
```
protected void internalRemoveColumnCollapsingChangeListener(java.util.function.Consumer<DataGrid.ColumnCollapsingChangeEvent> listener)
```
  - addColumnResizeListener
```
public io.jmix.core.common.event.Subscription addColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new column resize listener.
    
    Specified by:
    
    addColumnResizeListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - onColumnResize
```
protected void onColumnResize(com.vaadin.ui.Grid.ColumnResizeEvent e)
```
  - internalRemoveColumnResizeListener
```
protected void internalRemoveColumnResizeListener(java.util.function.Consumer<DataGrid.ColumnResizeEvent> listener)
```
  - addSortListener
```
public io.jmix.core.common.event.Subscription addSortListener(java.util.function.Consumer<DataGrid.SortEvent> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new sort order change listener
    
    Specified by:
    
    addSortListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - addColumnReorderListener
```
public io.jmix.core.common.event.Subscription addColumnReorderListener(java.util.function.Consumer<DataGrid.ColumnReorderEvent> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new column reorder listener.
    
    Specified by:
    
    addColumnReorderListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - addSelectionListener
```
public io.jmix.core.common.event.Subscription addSelectionListener(java.util.function.Consumer<DataGrid.SelectionEvent<E>> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new selection listener
    
    Specified by:
    
    addSelectionListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - addItemClickListener
```
public io.jmix.core.common.event.Subscription addItemClickListener(java.util.function.Consumer<DataGrid.ItemClickEvent<E>> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new item click listener
    
    Specified by:
    
    addItemClickListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - addContextClickListener
```
public io.jmix.core.common.event.Subscription addContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)
```
    Description copied from interface: DataGrid
    
    Registers a new context click listener
    
    Specified by:
    
    addContextClickListener in interface DataGrid<E>
    
    Parameters:
    
    listener - the listener to register
  - onContextClick
```
protected void onContextClick(com.vaadin.event.ContextClickEvent e)
```
  - internalRemoveContextClickListener
```
protected void internalRemoveContextClickListener(java.util.function.Consumer<DataGrid.ContextClickEvent> listener)
```
  - addLookupValueChangeListener
```
public io.jmix.core.common.event.Subscription addLookupValueChangeListener(java.util.function.Consumer<LookupComponent.LookupSelectionChangeEvent<E>> listener)
```
    Description copied from interface: LookupComponent.LookupSelectionChangeNotifier
    
    Adds a listener that invoked when lookup selected items set is changed.
    
    Specified by:
    
    addLookupValueChangeListener in interface LookupComponent.LookupSelectionChangeNotifier<E>
    
    Parameters:
    
    listener - a listener to add
    
    Returns:
    
    Subscription
  - getHeaderRow
```
@Nullable
public DataGrid.HeaderRow getHeaderRow(int index)
```
    Description copied from interface: DataGrid
    
    Gets the header row at given index.
    
    Specified by:
    
    getHeaderRow in interface DataGrid<E>
    
    Parameters:
    
    index - 0 based index for row. Counted from top to bottom
    
    Returns:
    
    header row at given index
  - getHeaderRowByGridRow
```
@Nullable
protected DataGrid.HeaderRow getHeaderRowByGridRow(com.vaadin.ui.components.grid.HeaderRow gridRow)
```
  - appendHeaderRow
```
public DataGrid.HeaderRow appendHeaderRow()
```
    Description copied from interface: DataGrid
    
    Adds a new row at the bottom of the header section.
    
    Specified by:
    
    appendHeaderRow in interface DataGrid<E>
    
    Returns:
    
    the new row
    
    See Also:
    
    DataGrid.prependHeaderRow(), DataGrid.addHeaderRowAt(int), DataGrid.removeHeaderRow(HeaderRow), DataGrid.removeHeaderRow(int)
  - prependHeaderRow
```
public DataGrid.HeaderRow prependHeaderRow()
```
    Description copied from interface: DataGrid
    
    Adds a new row at the top of the header section.
    
    Specified by:
    
    prependHeaderRow in interface DataGrid<E>
    
    Returns:
    
    the new row
    
    See Also:
    
    DataGrid.appendHeaderRow(), DataGrid.addHeaderRowAt(int), DataGrid.removeHeaderRow(HeaderRow), DataGrid.removeHeaderRow(int)
  - addHeaderRowAt
```
public DataGrid.HeaderRow addHeaderRowAt(int index)
```
    Description copied from interface: DataGrid
    
    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).
    
    Specified by:
    
    addHeaderRowAt in interface DataGrid<E>
    
    Parameters:
    
    index - the position at which to insert the row
    
    Returns:
    
    the new row
    
    See Also:
    
    DataGrid.appendHeaderRow(), DataGrid.prependHeaderRow(), DataGrid.removeHeaderRow(HeaderRow), DataGrid.removeHeaderRow(int)
  - checkHeaderIndexInRange
```
protected void checkHeaderIndexInRange(int index,
                                       boolean includeBounds)
```
  - addHeaderRowInternal
```
protected DataGrid.HeaderRow addHeaderRowInternal(com.vaadin.ui.components.grid.HeaderRow headerRow)
```
  - removeHeaderRow
```
public void removeHeaderRow(@Nullable
                            DataGrid.HeaderRow headerRow)
```
    Description copied from interface: DataGrid
    
    Removes the given row from the header section.
    
    Specified by:
    
    removeHeaderRow in interface DataGrid<E>
    
    Parameters:
    
    headerRow - the row to be removed
    
    See Also:
    
    DataGrid.removeHeaderRow(int), DataGrid.addHeaderRowAt(int), DataGrid.appendHeaderRow(), DataGrid.prependHeaderRow()
  - removeHeaderRow
```
public void removeHeaderRow(int index)
```
    Description copied from interface: DataGrid
    
    Removes the row at the given position from the header section.
    
    Specified by:
    
    removeHeaderRow in interface DataGrid<E>
    
    Parameters:
    
    index - the position of the row
    
    See Also:
    
    DataGrid.removeHeaderRow(HeaderRow), DataGrid.addHeaderRowAt(int), DataGrid.appendHeaderRow(), DataGrid.prependHeaderRow()
  - getDefaultHeaderRow
```
@Nullable
public DataGrid.HeaderRow getDefaultHeaderRow()
```
    Description copied from interface: DataGrid
    
    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.
    
    Specified by:
    
    getDefaultHeaderRow in interface DataGrid<E>
    
    Returns:
    
    the default row or null if no default row set
  - setDefaultHeaderRow
```
public void setDefaultHeaderRow(DataGrid.HeaderRow headerRow)
```
    Description copied from interface: DataGrid
    
    Sets the default row of the header. The default row is a special header row providing a user interface for sorting columns.
    
    Specified by:
    
    setDefaultHeaderRow in interface DataGrid<E>
    
    Parameters:
    
    headerRow - the new default row, or null for no default row
  - getHeaderRowCount
```
public int getHeaderRowCount()
```
    Description copied from interface: DataGrid
    
    Gets the row count for the header section.
    
    Specified by:
    
    getHeaderRowCount in interface DataGrid<E>
    
    Returns:
    
    row count
  - getFooterRow
```
@Nullable
public DataGrid.FooterRow getFooterRow(int index)
```
    Description copied from interface: DataGrid
    
    Gets the footer row at given index.
    
    Specified by:
    
    getFooterRow in interface DataGrid<E>
    
    Parameters:
    
    index - 0 based index for row. Counted from top to bottom
    
    Returns:
    
    footer row at given index
  - getFooterRowByGridRow
```
@Nullable
protected DataGrid.FooterRow getFooterRowByGridRow(com.vaadin.ui.components.grid.FooterRow gridRow)
```
  - appendFooterRow
```
public DataGrid.FooterRow appendFooterRow()
```
    Description copied from interface: DataGrid
    
    Adds a new row at the bottom of the footer section.
    
    Specified by:
    
    appendFooterRow in interface DataGrid<E>
    
    Returns:
    
    the new row
    
    See Also:
    
    DataGrid.prependFooterRow(), DataGrid.addFooterRowAt(int), DataGrid.removeFooterRow(FooterRow), DataGrid.removeFooterRow(int)
  - prependFooterRow
```
public DataGrid.FooterRow prependFooterRow()
```
    Description copied from interface: DataGrid
    
    Adds a new row at the top of the footer section.
    
    Specified by:
    
    prependFooterRow in interface DataGrid<E>
    
    Returns:
    
    the new row
    
    See Also:
    
    DataGrid.appendFooterRow(), DataGrid.addFooterRowAt(int), DataGrid.removeFooterRow(FooterRow), DataGrid.removeFooterRow(int)
  - addFooterRowAt
```
public DataGrid.FooterRow addFooterRowAt(int index)
```
    Description copied from interface: DataGrid
    
    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).
    
    Specified by:
    
    addFooterRowAt in interface DataGrid<E>
    
    Parameters:
    
    index - the position at which to insert the row
    
    Returns:
    
    the new row
    
    See Also:
    
    DataGrid.appendFooterRow(), DataGrid.prependFooterRow(), DataGrid.removeFooterRow(FooterRow), DataGrid.removeFooterRow(int)
  - calculateFooterIndex
```
protected int calculateFooterIndex(int index)
```
  - addFooterRowInternal
```
protected DataGrid.FooterRow addFooterRowInternal(com.vaadin.ui.components.grid.FooterRow footerRow)
```
  - removeFooterRow
```
public void removeFooterRow(@Nullable
                            DataGrid.FooterRow footerRow)
```
    Description copied from interface: DataGrid
    
    Removes the given row from the footer section.
    
    Specified by:
    
    removeFooterRow in interface DataGrid<E>
    
    Parameters:
    
    footerRow - the row to be removed
    
    See Also:
    
    DataGrid.removeFooterRow(int), DataGrid.addFooterRowAt(int), DataGrid.appendFooterRow(), DataGrid.prependFooterRow()
  - removeFooterRow
```
public void removeFooterRow(int index)
```
    Description copied from interface: DataGrid
    
    Removes the row at the given position from the footer section.
    
    Specified by:
    
    removeFooterRow in interface DataGrid<E>
    
    Parameters:
    
    index - the position of the row
    
    See Also:
    
    DataGrid.removeFooterRow(FooterRow), DataGrid.addFooterRowAt(int), DataGrid.appendFooterRow(), DataGrid.prependFooterRow()
  - getFooterRowCount
```
public int getFooterRowCount()
```
    Description copied from interface: DataGrid
    
    Gets the row count for the footer.
    
    Specified by:
    
    getFooterRowCount in interface DataGrid<E>
    
    Returns:
    
    row count
  - getDetailsGenerator
```
@Nullable
public java.util.function.Function<E,Component> getDetailsGenerator()
```
    Specified by:
    
    getDetailsGenerator in interface DataGrid<E>
    
    Returns:
    
    the current details generator for row details or null if not set
  - setDetailsGenerator
```
public void setDetailsGenerator(@Nullable
                                java.util.function.Function<E,Component> detailsGenerator)
```
    Description copied from interface: DataGrid
    
    Sets a new details generator for row details.
    The currently opened row details will be re-rendered.
    
    Specified by:
    
    setDetailsGenerator in interface DataGrid<E>
    
    Parameters:
    
    detailsGenerator - the details generator to set
  - getRowDetails
```
@Nullable
protected com.vaadin.ui.Component getRowDetails(E item)
```
  - isDetailsVisible
```
public boolean isDetailsVisible(E entity)
```
    Description copied from interface: DataGrid
    
    Checks whether details are visible for the given item.
    
    Specified by:
    
    isDetailsVisible in interface DataGrid<E>
    
    Parameters:
    
    entity - the item for which to check details visibility
    
    Returns:
    
    true if the details are visible
  - setDetailsVisible
```
public void setDetailsVisible(E entity,
                              boolean visible)
```
    Description copied from interface: DataGrid
    
    Shows or hides the details for a specific item.
    
    Specified by:
    
    setDetailsVisible in interface DataGrid<E>
    
    Parameters:
    
    entity - the item for which to set details visibility
    
    visible - true to show the details, or false to hide them
  - getTabIndex
```
public int getTabIndex()
```
    Description copied from interface: Component.Focusable
    
    Gets the tabulator index of the HasTabIndex component.
    
    Specified by:
    
    getTabIndex in interface Component.Focusable
    
    Returns:
    
    tab index set for the HasTabIndex component
  - setTabIndex
```
public void setTabIndex(int tabIndex)
```
    Description copied from interface: Component.Focusable
    
    Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.
    
    Specified by:
    
    setTabIndex in interface Component.Focusable
    
    Parameters:
    
    tabIndex - tab index
  - isAggregatable
```
public boolean isAggregatable()
```
    Specified by:
    
    isAggregatable in interface DataGrid<E>
    
    Returns:
    
    true if DataGrid is aggregatable
  - setAggregatable
```
public void setAggregatable(boolean aggregatable)
```
    Description copied from interface: DataGrid
    
    Set to true if aggregation should be enabled. Default value is false.
    
    Specified by:
    
    setAggregatable in interface DataGrid<E>
    
    Parameters:
    
    aggregatable - aggregatable option
  - getAggregationPosition
```
public DataGrid.AggregationPosition getAggregationPosition()
```
    Specified by:
    
    getAggregationPosition in interface DataGrid<E>
    
    Returns:
    
    return aggregation row position
  - setAggregationPosition
```
public void setAggregationPosition(DataGrid.AggregationPosition position)
```
    Description copied from interface: DataGrid
    
    Sets aggregation row position. Default value is DataGrid.AggregationPosition.TOP.
    
    Specified by:
    
    setAggregationPosition in interface DataGrid<E>
    
    Parameters:
    
    position - position: DataGrid.AggregationPosition.TOP or DataGrid.AggregationPosition.BOTTOM
  - getAggregationResults
```
public java.util.Map<java.lang.String,java.lang.Object> getAggregationResults()
```
    Specified by:
    
    getAggregationResults in interface DataGrid<E>
    
    Returns:
    
    aggregated values for columns
  - setEmptyStateMessage
```
public void setEmptyStateMessage(@Nullable
                                 java.lang.String message)
```
    Description copied from interface: DataGrid
    
    Sets a message to the middle of DataGrid body that should be appeared when DataGrid is empty.
    
    Specified by:
    
    setEmptyStateMessage in interface DataGrid<E>
    
    Parameters:
    
    message - message that appears when DataGrid is empty
  - getEmptyStateMessage
```
@Nullable
public java.lang.String getEmptyStateMessage()
```
    Specified by:
    
    getEmptyStateMessage in interface DataGrid<E>
    
    Returns:
    
    message that should be appeared when DataGrid is empty
  - setEmptyStateLinkMessage
```
public void setEmptyStateLinkMessage(@Nullable
                                     java.lang.String linkMessage)
```
    Description copied from interface: DataGrid
    
    Sets a link message to the middle of DataGrid body that should be appeared when DataGrid is empty.
    
    Specified by:
    
    setEmptyStateLinkMessage in interface DataGrid<E>
    
    Parameters:
    
    linkMessage - message that appears when DataGrid is empty
    
    See Also:
    
    DataGrid.setEmptyStateLinkClickHandler(Consumer)
  - getEmptyStateLinkMessage
```
@Nullable
public java.lang.String getEmptyStateLinkMessage()
```
    Specified by:
    
    getEmptyStateLinkMessage in interface DataGrid<E>
    
    Returns:
    
    link message that should be appeared when DataGrid is empty
  - setEmptyStateLinkClickHandler
```
public void setEmptyStateLinkClickHandler(@Nullable
                                          java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>> handler)
```
    Description copied from interface: DataGrid
    
    Sets click handler for link message. Link message can be shown when DataGrid is empty.
    
    Specified by:
    
    setEmptyStateLinkClickHandler in interface DataGrid<E>
    
    Parameters:
    
    handler - handler to set
    
    See Also:
    
    DataGrid.setEmptyStateLinkMessage(String)
  - getEmptyStateLinkClickHandler
```
@Nullable
public java.util.function.Consumer<DataGrid.EmptyStateClickEvent<E>> getEmptyStateLinkClickHandler()
```
    Specified by:
    
    getEmptyStateLinkClickHandler in interface DataGrid<E>
    
    Returns:
    
    click handler for link message
  - getAggregatableDelegate
```
protected AggregatableDelegate<java.lang.Object> getAggregatableDelegate()
```
  - __aggregate
```
protected java.util.Map<java.lang.String,java.lang.String> __aggregate()
```
  - __aggregateValues
```
protected java.util.Map<java.lang.String,java.lang.Object> __aggregateValues()
```
  - convertAggregationKeyMapToColumnIdKeyMap
```
protected <V> java.util.Map<java.lang.String,V> convertAggregationKeyMapToColumnIdKeyMap(java.util.Map<AggregationInfo,V> aggregationInfoMap)
```
  - getAggregationInfos
```
protected java.util.List<AggregationInfo> getAggregationInfos()
```
  - checkAggregation
```
protected void checkAggregation(AggregationInfo aggregationInfo)
```
  - fillAggregationRow
```
protected void fillAggregationRow(java.util.Map<java.lang.String,java.lang.String> values)
```
  - initAggregationRow
```
protected void initAggregationRow()
```
  - updateAggregationRow
```
protected void updateAggregationRow()
```
  - removeAggregationRow
```
protected void removeAggregationRow()
```
  - getColumnAggregationDescription
```
protected java.lang.String getColumnAggregationDescription(DataGrid.Column<E> column)
```
  - getColumnAggregationDescriptionByType
```
protected java.lang.String getColumnAggregationDescriptionByType(DataGrid.Column<E> column)
```
  - enableCrossFieldValidationHandling
```
protected void enableCrossFieldValidationHandling(boolean enable)
```
  - validateCrossFieldRules
```
@Nullable
protected java.lang.String validateCrossFieldRules(java.util.Map<java.lang.String,java.lang.Object> properties)
```
  - getGeneratedRowStyle
```
@Nullable
protected java.lang.String getGeneratedRowStyle(E item)
```
  - initEmptyState
```
protected void initEmptyState()
```
  - showEmptyStateIfPossible
```
protected void showEmptyStateIfPossible()
```
  - getGeneratedCellStyle
```
@Nullable
protected java.lang.String getGeneratedCellStyle(E item,
                                                           DataGrid.Column<E> column)
```
  - getGeneratedCellDescription
```
@Nullable
protected java.lang.String getGeneratedCellDescription(E item,
                                                                 DataGrid.Column<E> column)
```

Class AbstractDataGrid<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>,E>

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.DataGrid

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

Nested classes/interfaces inherited from interface io.jmix.ui.component.LookupComponent

Field Summary

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

Fields inherited from interface io.jmix.ui.component.DataGrid

Fields inherited from interface io.jmix.ui.component.Component

Constructor Summary

Method Summary

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface io.jmix.ui.component.DataGrid

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

Methods inherited from interface io.jmix.ui.component.ActionsHolder

Methods inherited from interface io.jmix.ui.component.Component

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

Methods inherited from interface io.jmix.ui.component.HasContextHelp

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

Methods inherited from interface io.jmix.ui.component.Component.Focusable

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

Field Detail

HAS_TOP_PANEL_STYLE_NAME

TEXT_SELECTION_ENABLED_STYLE

metadataTools

accessManager

messages

messageTools

screenValidation

actions

iconResolver

aggregations

aggregatableDelegate

uiTestIdsSupport

internalStyles

columns

columnsOrder

columnGenerators

actionList

shortcutsDelegate

actionsPermissions

contextMenu

contextMenuItems

sortable

columnsCollapsingAllowed

textSelectionEnabled

editorCrossFieldValidate

itemClickAction

enterPressAction

selectionMode

componentComposition

topPanel

buttonsPanel

pagination

rowStyleProviders

rowDescriptionProvider

detailsGenerator

columnCollapsingChangeListenerRegistration

columnResizeListenerRegistration

contextClickListenerRegistration

editorCancelListener

editorOpenListener

editorBeforeSaveListener

editorSaveListener

headerRows

footerRows

headerAggregationRow

footerAggregationRow

showIconsForPopupMenuActions

dataBinding

itemDatasources

emptyStateClickEventHandler

Constructor Detail

AbstractDataGrid

Method Detail

createComponentComposition

createComponent