We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.grid.
Interface GridMultiSelectionModel<T>
-
Type Parameters:
T- the type of items in gridAll Superinterfaces:
GridSelectionModel<T>, SelectionModel<Grid<T>,T>, SelectionModel.Multi<Grid<T>,T>, Serializable
All Known Implementing Classes:
public interface GridMultiSelectionModel<T> extends GridSelectionModel<T>, SelectionModel.Multi<Grid<T>,T>Multiselection model interface for Grid.
Author:
Vaadin Ltd
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static classGridMultiSelectionModel.SelectAllCheckboxVisibilityState 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
SelectionModel.Multi<C extends Component,T>, SelectionModel.Single<C extends Component,T>
-
-
Method Summary
All Methods Modifier and Type Method and Description RegistrationaddMultiSelectionListener(MultiSelectionListener<Grid<T>,T> listener)Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
MultiSelect<Grid<T>,T>asMultiSelect()Gets a wrapper to use this multiselection model as a multiselect in
Binder.GridMultiSelectionModel.SelectAllCheckboxVisibilitygetSelectAllCheckboxVisibility()Gets the current mode for the select all checkbox visibility.
booleanisSelectAllCheckboxVisible()Returns whether the select all checkbox will be visible with the current setting of
setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility).booleanisSelectionColumnFrozen()Gets the the selection column's frozen state.
voidsetSelectAllCheckboxVisibility(GridMultiSelectionModel.SelectAllCheckboxVisibility selectAllCheckBoxVisibility)Sets the select all checkbox visibility mode.
voidsetSelectionColumnFrozen(boolean frozen)Sets the selection column's frozen state.
-
Methods inherited from interface com.vaadin.flow.component.grid.GridSelectionModel
deselectFromClient, selectFromClient
-
Methods inherited from interface com.vaadin.flow.data.selection.SelectionModel.Multi
deselect, deselectItems, getFirstSelectedItem, select, selectAll, selectItems, updateSelection
-
Methods inherited from interface com.vaadin.flow.data.selection.SelectionModel
addSelectionListener, deselectAll, getSelectedItems, isSelected
-
-
-
-
Method Detail
-
asMultiSelect
MultiSelect<Grid<T>,T> asMultiSelect()Gets a wrapper to use this multiselection model as a multiselect in
Binder.Returns:
the multiselect wrapper
-
addMultiSelectionListener
Registration addMultiSelectionListener(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, notnullReturns:
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.Parameters:
selectAllCheckBoxVisibility- the visiblity mode to useSee Also:
-
getSelectAllCheckboxVisibility
GridMultiSelectionModel.SelectAllCheckboxVisibility getSelectAllCheckboxVisibility()Gets the current mode for the select all checkbox visibility.
Returns:
the select all checkbox visibility mode
See Also:
GridMultiSelectionModel.SelectAllCheckboxVisibility,isSelectAllCheckboxVisible()
-
isSelectAllCheckboxVisible
boolean isSelectAllCheckboxVisible()Returns whether the select all checkbox will be visible with the current setting of
setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility).Returns:
trueif the checkbox will be visible with the current settingsSee Also:
GridMultiSelectionModel.SelectAllCheckboxVisibility,setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility)
-
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
-
-