Package com.vaadin.flow.component.grid

Class AbstractGridMultiSelectionModel<T>

java.lang.Object

com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T>

com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel<T>

Type Parameters:

T - the grid type

All Implemented Interfaces:

GridMultiSelectionModel<T>, GridSelectionModel<T>, com.vaadin.flow.data.provider.DataGenerator<T>, com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>, com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>, Serializable

public abstract class AbstractGridMultiSelectionModel<T>
extends Grid.AbstractGridExtension<T>
implements GridMultiSelectionModel<T>

Abstract implementation of a GridMultiSelectionModel.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

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

GridMultiSelectionModel.SelectAllCheckboxVisibility

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>

Constructor Summary

Constructors

Constructor	Description
AbstractGridMultiSelectionModel(Grid<T> grid)	Constructor for passing a reference of the grid to this implementation.

Method Summary

Modifier and Type	Method	Description
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.shared.Registration	addSelectionListener(com.vaadin.flow.data.selection.SelectionListener<Grid<T>,T> listener)
com.vaadin.flow.data.selection.MultiSelect<Grid<T>,T>	asMultiSelect()	Gets a wrapper to use this multiselection model as a multiselect in Binder.
void	deselect(T item)
void	deselectAll()
void	deselectFromClient(T item)	Handles the deselection of an item that originates from the client.
protected abstract void	fireSelectionEvent(com.vaadin.flow.data.selection.SelectionEvent<Grid<T>,T> event)	Method for handling the firing of selection events.
void	generateData(T item, elemental.json.JsonObject jsonObject)
Optional<T>	getFirstSelectedItem()
GridMultiSelectionModel.SelectAllCheckboxVisibility	getSelectAllCheckboxVisibility()	Gets the current mode for the select all checkbox visibility.
protected Set<Object>	getSelectedItemIds()	Returns an unmodifiable view of the selected item ids.
Set<T>	getSelectedItems()
boolean	isSelectAllCheckboxVisible()	Returns whether the select all checkbox will be visible with the current setting of GridMultiSelectionModel.setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility) and the type of data set to the Grid (in-memory or lazy).
boolean	isSelected(T item)
boolean	isSelectionColumnFrozen()	Gets the the selection column's frozen state.
protected void	remove()	Remove this extension from its target.
void	select(T item)
void	selectAll()
void	selectFromClient(T item)	Handles the selection of an item that originates from the client.
void	setSelectAllCheckboxVisibility(GridMultiSelectionModel.SelectAllCheckboxVisibility selectAllCheckBoxVisibility)	Sets the select all checkbox visibility mode.
void	setSelectionColumnFrozen(boolean frozen)	Sets the selection column's frozen state.
void	updateSelection(Set<T> addedItems, Set<T> removedItems)

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

extend, getGrid, refresh

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.data.provider.DataGenerator

destroyAllData, destroyData, refreshData

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

deselectItems, selectItems

Constructor Detail

AbstractGridMultiSelectionModel

public AbstractGridMultiSelectionModel(Grid<T> grid)

Constructor for passing a reference of the grid to this implementation.

Parameters:

grid - reference to the grid for which this selection model is created

Method Detail

remove

protected void remove()

Description copied from class: Grid.AbstractGridExtension

Remove this extension from its target.

Overrides:

remove in class Grid.AbstractGridExtension<T>

selectFromClient

public void selectFromClient(T item)

Description copied from interface: GridSelectionModel

Handles the selection of an item that originates from the client.

Specified by:

selectFromClient in interface GridSelectionModel<T>

Parameters:

item - the item being selected

deselectFromClient

public void deselectFromClient(T item)

Description copied from interface: GridSelectionModel

Handles the deselection of an item that originates from the client.

Specified by:

deselectFromClient in interface GridSelectionModel<T>

Parameters:

item - the item being deselected

getSelectedItems

public Set<T> getSelectedItems()

Specified by:

getSelectedItems in interface com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>

getSelectedItemIds

protected Set<Object> getSelectedItemIds()

Returns an unmodifiable view of the selected item ids.

Exposed to be overridden within subclasses.

The returned Set may be a direct view of the internal data structures of this class. A defensive copy should be made by callers when iterating over this Set and modifying the selection during iteration to avoid ConcurrentModificationExceptions.

Returns:

An unmodifiable view of the selected item ids. Updates in the selection may or may not be directly reflected in the Set.

getFirstSelectedItem

public Optional<T> getFirstSelectedItem()

Specified by:

getFirstSelectedItem in interface com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>

Specified by:

getFirstSelectedItem in interface com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>

select

public void select(T item)

Specified by:

select in interface com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>

Specified by:

select in interface com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>

deselect

public void deselect(T item)

Specified by:

deselect in interface com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>

Specified by:

deselect in interface com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>

selectAll

public void selectAll()

Specified by:

selectAll in interface com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>

deselectAll

public void deselectAll()

Specified by:

deselectAll in interface com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>

updateSelection

public void updateSelection(Set<T> addedItems,
                            Set<T> removedItems)

Specified by:

updateSelection in interface com.vaadin.flow.data.selection.SelectionModel.Multi<Grid<T>,T>

isSelected

public boolean isSelected(T item)

Specified by:

isSelected in interface com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>

asMultiSelect

public com.vaadin.flow.data.selection.MultiSelect<Grid<T>,T> asMultiSelect()

Description copied from interface: GridMultiSelectionModel

Gets a wrapper to use this multiselection model as a multiselect in Binder.

Specified by:

asMultiSelect in interface GridMultiSelectionModel<T>

Returns:

the multiselect wrapper

addSelectionListener

public com.vaadin.flow.shared.Registration addSelectionListener(com.vaadin.flow.data.selection.SelectionListener<Grid<T>,T> listener)

Specified by:

addSelectionListener in interface com.vaadin.flow.data.selection.SelectionModel<Grid<T>,T>

addMultiSelectionListener

public com.vaadin.flow.shared.Registration addMultiSelectionListener(com.vaadin.flow.data.selection.MultiSelectionListener<Grid<T>,T> listener)

Description copied from interface: GridMultiSelectionModel

Adds a selection listener that will be called when the selection is changed either by the user or programmatically.

Specified by:

addMultiSelectionListener in interface GridMultiSelectionModel<T>

Parameters:

listener - the multi selection listener, not null

Returns:

a registration for the listener

setSelectAllCheckboxVisibility

public void setSelectAllCheckboxVisibility(GridMultiSelectionModel.SelectAllCheckboxVisibility selectAllCheckBoxVisibility)

Description copied from interface: GridMultiSelectionModel

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.

Specified by:

setSelectAllCheckboxVisibility in interface GridMultiSelectionModel<T>

Parameters:

selectAllCheckBoxVisibility - the visiblity mode to use

See Also:

GridMultiSelectionModel.SelectAllCheckboxVisibility

getSelectAllCheckboxVisibility

public GridMultiSelectionModel.SelectAllCheckboxVisibility getSelectAllCheckboxVisibility()

Description copied from interface: GridMultiSelectionModel

Gets the current mode for the select all checkbox visibility.

Specified by:

getSelectAllCheckboxVisibility in interface GridMultiSelectionModel<T>

Returns:

the select all checkbox visibility mode

See Also:

GridMultiSelectionModel.SelectAllCheckboxVisibility, GridMultiSelectionModel.isSelectAllCheckboxVisible()

isSelectAllCheckboxVisible

public boolean isSelectAllCheckboxVisible()

Description copied from interface: GridMultiSelectionModel

Returns whether the select all checkbox will be visible with the current setting of GridMultiSelectionModel.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.

Specified by:

isSelectAllCheckboxVisible in interface GridMultiSelectionModel<T>

Returns:

true if the checkbox will be visible with the current settings

See Also:

GridMultiSelectionModel.SelectAllCheckboxVisibility, GridMultiSelectionModel.setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility)

generateData

public void generateData(T item,
                         elemental.json.JsonObject jsonObject)

Specified by:

generateData in interface com.vaadin.flow.data.provider.DataGenerator<T>

setSelectionColumnFrozen

public void setSelectionColumnFrozen(boolean frozen)

Description copied from interface: GridMultiSelectionModel

Sets the selection column's frozen state.

Specified by:

setSelectionColumnFrozen in interface GridMultiSelectionModel<T>

Parameters:

frozen - whether to freeze or unfreeze the selection column

isSelectionColumnFrozen

public boolean isSelectionColumnFrozen()

Description copied from interface: GridMultiSelectionModel

Gets the the selection column's frozen state.

Specified by:

isSelectionColumnFrozen in interface GridMultiSelectionModel<T>

Returns:

whether the selection column is frozen

fireSelectionEvent

protected abstract void fireSelectionEvent(com.vaadin.flow.data.selection.SelectionEvent<Grid<T>,T> event)

Method for handling the firing of selection events.

Parameters:

event - the selection event to fire