com.vaadin.flow.component.grid.
Enum GridMultiSelectionModel.SelectAllCheckboxVisibility
- java.lang.Object
-
- java.lang.Enum<GridMultiSelectionModel.SelectAllCheckboxVisibility>
-
- com.vaadin.flow.component.grid.GridMultiSelectionModel.SelectAllCheckboxVisibility
-
All Implemented Interfaces:
Serializable
,Comparable<GridMultiSelectionModel.SelectAllCheckboxVisibility>
Enclosing interface:
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 is only visible if an in-memory data is used.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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)
HIDDEN
Never shows the select all checkbox, regardless of data is in-memory or not (lazy).
VISIBLE
Shows the select all checkbox, if in-memory data is used.
-
Method Summary
All Methods Modifier and Type Method Description static GridMultiSelectionModel.SelectAllCheckboxVisibility
valueOf​(String name)
Returns the enum constant of this type with the specified name.
static GridMultiSelectionModel.SelectAllCheckboxVisibility[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
VISIBLE
public static final GridMultiSelectionModel.SelectAllCheckboxVisibility VISIBLE
Shows the select all checkbox, if in-memory data is used.
For lazy data, the checkbox is only shown when a count callback has been provided. For lazy data with unknown count, the checkbox will never be shown.
For lazy data, selecting all will result in to all rows being fetched from backend to application memory!
-
HIDDEN
public static final GridMultiSelectionModel.SelectAllCheckboxVisibility HIDDEN
Never shows the select all checkbox, regardless of data is in-memory or not (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 Detail
-
values
public static GridMultiSelectionModel.SelectAllCheckboxVisibility[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (GridMultiSelectionModel.SelectAllCheckboxVisibility c : GridMultiSelectionModel.SelectAllCheckboxVisibility.values()) System.out.println(c);
Returns:
an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static GridMultiSelectionModel.SelectAllCheckboxVisibility valueOf​(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
-