Package com.vaadin.flow.component.grid

Enum Class GridMultiSelectionModel.SelectAllCheckboxVisibility

java.lang.Object
java.lang.Enum<GridMultiSelectionModel.SelectAllCheckboxVisibility>
com.vaadin.flow.component.grid.GridMultiSelectionModel.SelectAllCheckboxVisibility
All Implemented Interfaces:
Serializable, Comparable<GridMultiSelectionModel.SelectAllCheckboxVisibility>, Constable
Enclosing interface:
GridMultiSelectionModel<T>
public static enum GridMultiSelectionModel.SelectAllCheckboxVisibility extends Enum<GridMultiSelectionModel.SelectAllCheckboxVisibility>
State for showing the select all checkbox in the grid's default header row for the selection column.

Default value is DEFAULT, which means that the select all checkbox is only visible for in-memory data.

  • Enum Constant Details

    • VISIBLE

      public static final GridMultiSelectionModel.SelectAllCheckboxVisibility VISIBLE
      Shows the select all checkbox for in-memory data, and for lazy data with a known item count, for example when a count callback is provided. For lazy data with unknown item count, the checkbox is never shown.

      For lazy data, selecting all fetches all rows from the backend into application memory!

    • HIDDEN

      public static final GridMultiSelectionModel.SelectAllCheckboxVisibility HIDDEN
      Never shows the select all checkbox, regardless of whether the data is in-memory or lazy.

    • DEFAULT

      public static final GridMultiSelectionModel.SelectAllCheckboxVisibility DEFAULT
      By default, the visibility of the select all checkbox depends on how the Grid's items are fetched:
      • Visible, if the data is in-memory
      • Hidden, if the data is NOT in-memory (lazy)

  • Method Details

    • values

      public static GridMultiSelectionModel.SelectAllCheckboxVisibility[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GridMultiSelectionModel.SelectAllCheckboxVisibility valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null