Package com.flowingcode.vaadin.addons.gridhelpers

Class CheckboxColumn<T>

java.lang.Object

com.flowingcode.vaadin.addons.gridhelpers.CheckboxColumn<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable

public final class CheckboxColumn<T>
extends Object
implements Serializable

A grid column where boolean value is rendered as a Checkbox.

By default select all checkbox is visible when grid uses an InMemoryDataProvider, or it's hidden when a BackEndDataProvider is used.

When select all checkbox is visible, CheckboxColumn must be explicitly refreshed if grid dataprovider changes after column creation using CheckboxColumn.refresh() method.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckboxColumn.CheckboxColumnConfiguration<T>
static enum	CheckboxColumn.CheckboxPosition

Method Summary

Modifier and Type	Method	Description
Set<T>	getSelectedItems()	Returns the items whose corresponding checkbox is checked.
void	refresh()	Refreshes select all checkbox status to reflect the underlying data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

refresh

public void refresh()

Refreshes select all checkbox status to reflect the underlying data.

This method must be invoked when grid's dataprovider changes.

getSelectedItems

public Set<T> getSelectedItems()

Returns the items whose corresponding checkbox is checked.

Returns:

selected items.