Package io.jmix.flowui.component.grid

Class DataGrid<E>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.grid.Grid<T>
io.jmix.flowui.kit.component.grid.JmixGrid<E>
io.jmix.flowui.component.grid.DataGrid<E>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.grid.Grid<E>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.grid.Grid<E>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.grid.Grid<E>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.data.event.SortEvent.SortNotifier<com.vaadin.flow.component.grid.Grid<E>,com.vaadin.flow.component.grid.GridSortOrder<E>>, com.vaadin.flow.data.provider.HasDataGenerators<E>, com.vaadin.flow.data.provider.HasDataView<E,Void,com.vaadin.flow.component.grid.dataview.GridDataView<E>>, com.vaadin.flow.data.provider.HasLazyDataView<E,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<E>>, com.vaadin.flow.data.provider.HasListDataView<E,com.vaadin.flow.component.grid.dataview.GridListDataView<E>>, EnhancedDataGrid<E>, ListDataComponent<E>, LookupComponent<E>, LookupComponent.MultiSelectLookupComponent<E>, HasActions, HasSubParts, SelectionChangeNotifier<com.vaadin.flow.component.grid.Grid<E>,E>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
public class DataGrid<E> extends JmixGrid<E> implements ListDataComponent<E>, LookupComponent.MultiSelectLookupComponent<E>, EnhancedDataGrid<E>, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.grid.Grid

    com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T extends Object>, com.vaadin.flow.component.grid.Grid.Column<T extends Object>, com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder<T extends Object,U extends com.vaadin.flow.data.provider.ArrayUpdater>, com.vaadin.flow.component.grid.Grid.MultiSortPriority, com.vaadin.flow.component.grid.Grid.NestedNullBehavior, com.vaadin.flow.component.grid.Grid.SelectionMode, com.vaadin.flow.component.grid.Grid.UpdateQueue

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface io.jmix.flowui.component.grid.EnhancedDataGrid

    EnhancedDataGrid.AggregationPosition

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

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

    LookupComponent.MultiSelectLookupComponent<T>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.springframework.context.ApplicationContext
    applicationContext
     
    protected boolean
    editorCreated
     
    protected GridDelegate<E,DataGridItems<E>>
    gridDelegate
     

    Fields inherited from class io.jmix.flowui.kit.component.grid.JmixGrid

    actionsSupport

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataGrid()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAggregation(com.vaadin.flow.component.grid.Grid.Column<E> column, AggregationInfo info)
    Add an aggregation info in order to perform aggregation for column.
    com.vaadin.flow.component.grid.Grid.Column<E>
    addColumn(com.vaadin.flow.data.renderer.Renderer<E> renderer)
     
    com.vaadin.flow.component.grid.Grid.Column<E>
    addColumn(com.vaadin.flow.function.ValueProvider<E,?> valueProvider)
     
    com.vaadin.flow.component.grid.Grid.Column<E>
    addColumn(MetaPropertyPath metaPropertyPath)
    Adds column by the meta property path.
    com.vaadin.flow.component.grid.Grid.Column<E>
    addColumn(String key, MetaPropertyPath metaPropertyPath)
    Adds column by the meta property path and specified key.
    com.vaadin.flow.shared.Registration
    addSelectionListener(com.vaadin.flow.data.selection.SelectionListener<com.vaadin.flow.component.grid.Grid<E>,E> listener)
     
    void
    afterPropertiesSet()
     
    protected GridActionsSupport<JmixGrid<E>,E>
    createActionsSupport()
     
    protected GridDelegate<E,DataGridItems<E>>
    createDelegate()
     
    protected DataGridEditor<E>
    createEditor()
     
    void
    deselect(E item)
     
    void
    deselectAll()
    Deselects all selected rows.
    void
    enableMultiSelect()
     
    EnhancedDataGrid.AggregationPosition
    getAggregationPosition()
     
    Map<com.vaadin.flow.component.grid.Grid.Column<E>,Object>
    getAggregationResults()
     
    List<com.vaadin.flow.component.grid.Grid.Column<E>>
    getAllColumns()
    Gets an unmodifiable list of all currently added Grid.Columns.
    com.vaadin.flow.component.grid.Grid.Column<E>
    getColumnByKey(String columnKey)
     
    MetaPropertyPath
    getColumnMetaPropertyPath(com.vaadin.flow.component.grid.Grid.Column<E> column)
     
    List<com.vaadin.flow.component.grid.Grid.Column<E>>
    getColumns()
    Note: If column reordering is enabled with Grid.setColumnReorderingAllowed(boolean) and the user has reordered the columns, the order of the list returned by this method might be incorrect.
    DataGridEditor<E>
    getEditor()
     
    DataGridItems<E>
    getItems()
     
    Set<E>
    getSelectedItems()
    Returns a set of items corresponding to the selected rows of this component.
    E
    getSingleSelectedItem()
    Returns an item corresponding to the selected row of this component.
    protected void
    initComponent()
     
    boolean
    isAggregatable()
     
    boolean
    isEditorCreated()
     
    boolean
    isMultiSelect()
     
    protected void
    onAfterApplyColumnSecurity(AbstractGridDelegate.ColumnSecurityContext<E> context)
     
    protected void
    onDataProviderChange()
     
    void
    removeColumn(com.vaadin.flow.component.grid.Grid.Column<E> column)
     
    void
    select(E item)
    Selects a row of this component for a given item.
    void
    select(Collection<E> items)
    Selects the rows of this component for a given collection of items.
    void
    setAggregatable(boolean aggregatable)
    Set to true if aggregation should be enabled.
    void
    setAggregationPosition(EnhancedDataGrid.AggregationPosition aggregationPosition)
    Sets aggregation row position.
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setColumnPosition(com.vaadin.flow.component.grid.Grid.Column<E> column, int index)
    Moves column to the provided position in the DataGrid.
    com.vaadin.flow.component.grid.dataview.GridDataView<E>
    setItems(com.vaadin.flow.data.provider.DataProvider<E,Void> dataProvider)
     
    void
    setMultiSelect(boolean multiSelect)
     
    com.vaadin.flow.component.grid.GridSelectionModel<E>
    setSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)
     

    Methods inherited from class io.jmix.flowui.kit.component.grid.JmixGrid

    addAction, addAction, getAction, getActions, getActionsSupport, getSubPart, removeAction

    Methods inherited from class com.vaadin.flow.component.grid.Grid

    addCellFocusListener, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnReorderListener, addColumnResizeListener, addColumns, addComponentColumn, addContextMenu, addDataGenerator, addDragEndListener, addDragStartListener, addDropListener, addFirstHeaderRow, addItemClickListener, addItemDoubleClickListener, addSortListener, addThemeVariants, addValueProvider, appendFooterRow, appendHeaderRow, asMultiSelect, asSingleSelect, compareMaybeComparables, configureBeanType, createColumn, createColumnId, createDefaultArrayUpdater, createSortingComparator, getArrayUpdater, getBeanType, getClassNameGenerator, getColumnLayers, getColumnRendering, getDataCommunicator, getDataProvider, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getFooterRows, getGenericDataView, getHeaderRows, getLazyDataView, getListDataView, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectionModel, getSortOrder, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isAllRowsVisible, isColumnReorderingAllowed, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, onAttach, onDetach, onEnabledStateChanged, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeColumnByKey, removeColumnLayer, removeColumns, removeThemeVariants, scrollToEnd, scrollToIndex, scrollToStart, setAllRowsVisible, setClassNameGenerator, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumnReorderingAllowed, setColumns, setDataProvider, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setItemDetailsRenderer, setItems, setItems, setItems, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionModel, setSortableColumns, setTooltipGenerator, setUniqueKeyProperty, setUniqueKeyProvider, sort, updateSelectionModeOnClient

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.BlurNotifier

    addBlurListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.Focusable

    addFocusShortcut, blur, focus, getTabIndex, setTabIndex

    Methods inherited from interface com.vaadin.flow.component.FocusNotifier

    addFocusListener

    Methods inherited from interface io.jmix.flowui.kit.component.HasActions

    removeAction, removeAllActions

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.data.provider.HasLazyDataView

    setItems, setItems

    Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

    setItems, setItems

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

  • Field Details

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext

    • gridDelegate

      protected GridDelegate<E,DataGridItems<E>> gridDelegate

    • editorCreated

      protected boolean editorCreated

  • Constructor Details

    • DataGrid

      public DataGrid()

  • Method Details

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware

    • afterPropertiesSet

      public void afterPropertiesSet()
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

    • initComponent

      protected void initComponent()

    • createDelegate

      protected GridDelegate<E,DataGridItems<E>> createDelegate()

    • setItems

      public com.vaadin.flow.component.grid.dataview.GridDataView<E> setItems(com.vaadin.flow.data.provider.DataProvider<E,Void> dataProvider)
      Specified by:
      setItems in interface com.vaadin.flow.data.provider.HasDataView<E,Void,com.vaadin.flow.component.grid.dataview.GridDataView<E>>
      Overrides:
      setItems in class com.vaadin.flow.component.grid.Grid<E>

    • getSingleSelectedItem

      @Nullable public E getSingleSelectedItem()
      Description copied from interface: ListDataComponent
      Returns an item corresponding to the selected row of this component. If nothing is selected, the method returns null. If multiple selection mode is enabled, returns the first selected instance.
      Specified by:
      getSingleSelectedItem in interface ListDataComponent<E>
      Returns:
      an item corresponding to the selected row of this component

    • getSelectedItems

      public Set<E> getSelectedItems()
      Description copied from interface: ListDataComponent
      Returns a set of items corresponding to the selected rows of this component. If nothing is selected, the method returns a Collections.emptySet().
      Specified by:
      getSelectedItems in interface ListDataComponent<E>
      Specified by:
      getSelectedItems in interface LookupComponent<E>
      Overrides:
      getSelectedItems in class com.vaadin.flow.component.grid.Grid<E>
      Returns:
      a set of item instances corresponding to the selected rows of this component, never null

    • select

      public void select(E item)
      Description copied from interface: ListDataComponent
      Selects a row of this component for a given item.
      Specified by:
      select in interface ListDataComponent<E>
      Overrides:
      select in class com.vaadin.flow.component.grid.Grid<E>
      Parameters:
      item - item instance to select the row

    • select

      public void select(Collection<E> items)
      Description copied from interface: ListDataComponent
      Selects the rows of this component for a given collection of items.
      Specified by:
      select in interface ListDataComponent<E>
      Parameters:
      items - collection of items to select rows

    • deselect

      public void deselect(E item)
      Specified by:
      deselect in interface ListDataComponent<E>
      Overrides:
      deselect in class com.vaadin.flow.component.grid.Grid<E>

    • deselectAll

      public void deselectAll()
      Description copied from interface: ListDataComponent
      Deselects all selected rows.
      Specified by:
      deselectAll in interface ListDataComponent<E>
      Overrides:
      deselectAll in class com.vaadin.flow.component.grid.Grid<E>

    • getItems

      @Nullable public DataGridItems<E> getItems()
      Specified by:
      getItems in interface ListDataComponent<E>
      Returns:
      a data unit that holds component items

    • isMultiSelect

      public boolean isMultiSelect()
      Specified by:
      isMultiSelect in interface ListDataComponent<E>
      Returns:
      true if multiple selection mode is enabled

    • addSelectionListener

      public com.vaadin.flow.shared.Registration addSelectionListener(com.vaadin.flow.data.selection.SelectionListener<com.vaadin.flow.component.grid.Grid<E>,E> listener)
      Specified by:
      addSelectionListener in interface SelectionChangeNotifier<com.vaadin.flow.component.grid.Grid<E>,E>
      Overrides:
      addSelectionListener in class com.vaadin.flow.component.grid.Grid<E>

    • enableMultiSelect

      public void enableMultiSelect()
      Specified by:
      enableMultiSelect in interface LookupComponent.MultiSelectLookupComponent<E>

    • setMultiSelect

      public void setMultiSelect(boolean multiSelect)
      Specified by:
      setMultiSelect in interface LookupComponent.MultiSelectLookupComponent<E>

    • setSelectionMode

      public com.vaadin.flow.component.grid.GridSelectionModel<E> setSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)
      Overrides:
      setSelectionMode in class com.vaadin.flow.component.grid.Grid<E>

    • getColumnMetaPropertyPath

      @Nullable public MetaPropertyPath getColumnMetaPropertyPath(com.vaadin.flow.component.grid.Grid.Column<E> column)
      Specified by:
      getColumnMetaPropertyPath in interface EnhancedDataGrid<E>

    • addColumn

      public com.vaadin.flow.component.grid.Grid.Column<E> addColumn(MetaPropertyPath metaPropertyPath)
      Adds column by the meta property path.
      Specified by:
      addColumn in interface EnhancedDataGrid<E>
      Parameters:
      metaPropertyPath - meta property path to add column
      Returns:
      added column

    • addColumn

      public com.vaadin.flow.component.grid.Grid.Column<E> addColumn(String key, MetaPropertyPath metaPropertyPath)
      Adds column by the meta property path and specified key. The key is used to identify the column, see getColumnByKey(String).
      Specified by:
      addColumn in interface EnhancedDataGrid<E>
      Parameters:
      key - column key
      metaPropertyPath - meta property path to add column
      Returns:
      added column

    • addColumn

      public com.vaadin.flow.component.grid.Grid.Column<E> addColumn(com.vaadin.flow.function.ValueProvider<E,?> valueProvider)
      Overrides:
      addColumn in class com.vaadin.flow.component.grid.Grid<E>

    • addColumn

      public com.vaadin.flow.component.grid.Grid.Column<E> addColumn(com.vaadin.flow.data.renderer.Renderer<E> renderer)
      Overrides:
      addColumn in class com.vaadin.flow.component.grid.Grid<E>

    • isAggregatable

      public boolean isAggregatable()
      Specified by:
      isAggregatable in interface EnhancedDataGrid<E>
      Returns:
      true if DataGrid is aggregatable

    • setAggregatable

      public void setAggregatable(boolean aggregatable)
      Description copied from interface: EnhancedDataGrid
      Set to true if aggregation should be enabled. Default value is false.
      Specified by:
      setAggregatable in interface EnhancedDataGrid<E>
      Parameters:
      aggregatable - whether to aggregate DataGrid columns

    • getAggregationPosition

      public EnhancedDataGrid.AggregationPosition getAggregationPosition()
      Specified by:
      getAggregationPosition in interface EnhancedDataGrid<E>
      Returns:
      return aggregation row position

    • setAggregationPosition

      public void setAggregationPosition(EnhancedDataGrid.AggregationPosition aggregationPosition)
      Description copied from interface: EnhancedDataGrid
      Sets aggregation row position. Default value is EnhancedDataGrid.AggregationPosition.BOTTOM.
      Specified by:
      setAggregationPosition in interface EnhancedDataGrid<E>
      Parameters:
      aggregationPosition - position: EnhancedDataGrid.AggregationPosition.TOP or EnhancedDataGrid.AggregationPosition.BOTTOM

    • addAggregation

      public void addAggregation(com.vaadin.flow.component.grid.Grid.Column<E> column, AggregationInfo info)
      Description copied from interface: EnhancedDataGrid
      Add an aggregation info in order to perform aggregation for column.
      Specified by:
      addAggregation in interface EnhancedDataGrid<E>
      Parameters:
      column - column for aggregation
      info - aggregation info
      See Also:

    • getAggregationResults

      public Map<com.vaadin.flow.component.grid.Grid.Column<E>,Object> getAggregationResults()
      Specified by:
      getAggregationResults in interface EnhancedDataGrid<E>
      Returns:
      aggregated values for columns

    • getColumns

      public List<com.vaadin.flow.component.grid.Grid.Column<E>> getColumns()
      Note: If column reordering is enabled with Grid.setColumnReorderingAllowed(boolean) and the user has reordered the columns, the order of the list returned by this method might be incorrect.
      Overrides:
      getColumns in class com.vaadin.flow.component.grid.Grid<E>
      Returns:
      an unmodifiable list of Grid.Columns that are not hidden by security

    • getAllColumns

      public List<com.vaadin.flow.component.grid.Grid.Column<E>> getAllColumns()
      Gets an unmodifiable list of all currently added Grid.Columns.

      If column reordering is enabled with Grid.setColumnReorderingAllowed(boolean) and the user has reordered the columns, the order of the returned list will be correct.

      Returns:
      a copy of all currently added Grid.Columns including hidden by security

    • getColumnByKey

      @Nullable public com.vaadin.flow.component.grid.Grid.Column<E> getColumnByKey(String columnKey)
      Overrides:
      getColumnByKey in class com.vaadin.flow.component.grid.Grid<E>

    • removeColumn

      public void removeColumn(com.vaadin.flow.component.grid.Grid.Column<E> column)
      Overrides:
      removeColumn in class com.vaadin.flow.component.grid.Grid<E>

    • setColumnPosition

      public void setColumnPosition(com.vaadin.flow.component.grid.Grid.Column<E> column, int index)
      Moves column to the provided position in the DataGrid.
      Parameters:
      column - column to move
      index - new index of column in getAllColumns() list

    • isEditorCreated

      public boolean isEditorCreated()
      Specified by:
      isEditorCreated in interface EnhancedDataGrid<E>

    • onDataProviderChange

      protected void onDataProviderChange()
      Overrides:
      onDataProviderChange in class com.vaadin.flow.component.grid.Grid<E>

    • getEditor

      public DataGridEditor<E> getEditor()
      Overrides:
      getEditor in class com.vaadin.flow.component.grid.Grid<E>

    • createEditor

      protected DataGridEditor<E> createEditor()
      Overrides:
      createEditor in class com.vaadin.flow.component.grid.Grid<E>

    • createActionsSupport

      protected GridActionsSupport<JmixGrid<E>,E> createActionsSupport()
      Overrides:
      createActionsSupport in class JmixGrid<E>

    • onAfterApplyColumnSecurity

      protected void onAfterApplyColumnSecurity(AbstractGridDelegate.ColumnSecurityContext<E> context)