Package io.jmix.groupgridflowui.kit.vaadin.grid

Interface GridMultiSelectionModel<T>

Type Parameters:
T - the type of items in grid
All Superinterfaces:
GridSelectionModel<T>, com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>, com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>, Serializable
All Known Implementing Classes:
AbstractGridMultiSelectionModel
public interface GridMultiSelectionModel<T> extends GridSelectionModel<T>, com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>
Multiselection model interface for Grid.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    GridMultiSelectionModel.SelectAllCheckboxVisibility
    State for showing the select all checkbox in the grid's default header row for the selection column.

    Nested classes/interfaces inherited from interface com.vaadin.flow.data.selection.SelectionModel

    com.vaadin.flow.data.selection.SelectionModel.Multi<C extends com.vaadin.flow.component.Component,T extends Object>, com.vaadin.flow.data.selection.SelectionModel.Single<C extends com.vaadin.flow.component.Component,T extends Object>

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addClientItemToggleListener(com.vaadin.flow.component.ComponentEventListener<ClientItemToggleEvent<T>> listener)
    Adds a client item toggle listener that will be called when the user toggles the selection state of an item on the client-side.
    com.vaadin.flow.shared.Registration
    addMultiSelectionListener(com.vaadin.flow.data.selection.MultiSelectionListener<Grid<T>,T> listener)
    Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
    com.vaadin.flow.data.selection.MultiSelect<Grid<T>,T>
    asMultiSelect()
    Gets a wrapper to use this multiselection model as a multiselect in Binder.
    GridMultiSelectionModel.SelectAllCheckboxVisibility
    getSelectAllCheckboxVisibility()
    Gets the current mode for the select all checkbox visibility.
    boolean
    isDragSelect()
    Gets whether grid drag select is enabled or not.
    boolean
    isSelectAllCheckboxVisible()
    Returns whether the select all checkbox will be visible with the current setting of setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility) and the type of data set to the Grid (in-memory or lazy).
    boolean
    isSelectionColumnFrozen()
    Gets the the selection column's frozen state.
    void
    setDragSelect(boolean dragSelect)
    If true, grid rows can be selected or deselected by dragging the mouse cursor over grid's selection column.
    void
    setSelectAllCheckboxVisibility(GridMultiSelectionModel.SelectAllCheckboxVisibility selectAllCheckBoxVisibility)
    Sets the select all checkbox visibility mode.
    void
    setSelectionColumnFrozen(boolean frozen)
    Sets the selection column's frozen state.

    Methods inherited from interface io.jmix.groupgridflowui.kit.vaadin.grid.GridSelectionModel

    deselectFromClient, selectFromClient

    Methods inherited from interface com.vaadin.flow.data.selection.SelectionModel

    addSelectionListener, deselectAll, getSelectedItems, isSelected

    Methods inherited from interface com.vaadin.flow.data.selection.SelectionModel.Multi

    deselect, deselectItems, getFirstSelectedItem, select, selectAll, selectItems, updateSelection

  • Method Details

    • asMultiSelect

      com.vaadin.flow.data.selection.MultiSelect<Grid<T>,T> asMultiSelect()
      Gets a wrapper to use this multiselection model as a multiselect in Binder.
      Returns:
      the multiselect wrapper

    • addMultiSelectionListener

      com.vaadin.flow.shared.Registration addMultiSelectionListener(com.vaadin.flow.data.selection.MultiSelectionListener<Grid<T>,T> listener)
      Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
      Parameters:
      listener - the multi selection listener, not null
      Returns:
      a registration for the listener

    • addClientItemToggleListener

      com.vaadin.flow.shared.Registration addClientItemToggleListener(com.vaadin.flow.component.ComponentEventListener<ClientItemToggleEvent<T>> listener)
      Adds a client item toggle listener that will be called when the user toggles the selection state of an item on the client-side.

      This event follows MultiSelectionEvent and provides details about the item that was toggled, its new selection state, and whether the shift key was pressed during the selection. This can be helpful for implementing features like range selection.

      Parameters:
      listener - the client item toggle listener, not null
      Returns:
      a registration for the listener

    • setSelectAllCheckboxVisibility

      void setSelectAllCheckboxVisibility(GridMultiSelectionModel.SelectAllCheckboxVisibility selectAllCheckBoxVisibility)
      Sets the select all checkbox visibility mode.

      The default value is GridMultiSelectionModel.SelectAllCheckboxVisibility.DEFAULT, which means that the checkbox is only visible if the grid's data provider is in-memory.

      The select all checkbox will never be shown if the Grid uses lazy loading with unknown item count, i.e. no items count query provided to it, and even setting GridMultiSelectionModel.SelectAllCheckboxVisibility.VISIBLE won't make it visible.

      Parameters:
      selectAllCheckBoxVisibility - the visiblity mode to use
      See Also:

    • getSelectAllCheckboxVisibility

      GridMultiSelectionModel.SelectAllCheckboxVisibility getSelectAllCheckboxVisibility()
      Gets the current mode for the select all checkbox visibility.
      Returns:
      the select all checkbox visibility mode
      See Also:

    • isSelectAllCheckboxVisible

      boolean isSelectAllCheckboxVisible()
      Returns whether the select all checkbox will be visible with the current setting of setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility) and the type of data set to the Grid (in-memory or lazy).

      The select all checkbox will never be shown if the Grid uses lazy loading with unknown item count, meaning that no count callback has been provided. It will also not be shown if the grid is configured to use conditional selection via Grid.setItemSelectableProvider(SerializablePredicate)

      Returns:
      true if the checkbox will be visible with the current settings
      See Also:

    • setSelectionColumnFrozen

      void setSelectionColumnFrozen(boolean frozen)
      Sets the selection column's frozen state.
      Parameters:
      frozen - whether to freeze or unfreeze the selection column

    • isSelectionColumnFrozen

      boolean isSelectionColumnFrozen()
      Gets the the selection column's frozen state.
      Returns:
      whether the selection column is frozen

    • setDragSelect

      void setDragSelect(boolean dragSelect)
      If true, grid rows can be selected or deselected by dragging the mouse cursor over grid's selection column.
      Parameters:
      dragSelect - true to enable drag select feature, false for disabling it

    • isDragSelect

      boolean isDragSelect()
      Gets whether grid drag select is enabled or not.
      Returns:
      true if drag select feature is enabled, false otherwise