com.sencha.gxt.widget.core.client.grid

Class CheckBoxSelectionModel<M>

java.lang.Object

com.sencha.gxt.widget.core.client.selection.AbstractStoreSelectionModel<M>

com.sencha.gxt.widget.core.client.grid.GridSelectionModel<M>

com.sencha.gxt.widget.core.client.grid.CheckBoxSelectionModel<M>

Type Parameters:

M - the model data type

All Implemented Interfaces:

SelectionChangedEvent.HasSelectionChangedHandlers<M>, StoreSelectionModel<M>

public class CheckBoxSelectionModel<M>
extends GridSelectionModel<M>

A grid selection model. To use, add the column config to the column model using getColumn() and assign as the grid's selection model via Grid.setSelectionModel(GridSelectionModel).

This selection mode defaults to SelectionMode.MULTI and also supports SelectionMode.SIMPLE. With SIMPLE, the control and shift keys do not need to be pressed for multiple selections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CheckBoxSelectionModel.CheckBoxColumnAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.grid.GridSelectionModel

GridSelectionModel.SelectionModelCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected ColumnConfig<M,M>	config

Fields inherited from class com.sencha.gxt.widget.core.client.grid.GridSelectionModel

deselectOnSimpleClick, enableNavKeys, grid, keyNav, listStore

Fields inherited from class com.sencha.gxt.widget.core.client.selection.AbstractStoreSelectionModel

fireSelectionChangeOnClick, lastSelected, locked, mouseDown, selected, selectionMode, store

Constructor Summary

Constructors

Constructor and Description
CheckBoxSelectionModel() Creates a CheckBoxSelectionModel that will operate on the row itself.
CheckBoxSelectionModel(CheckBoxSelectionModel.CheckBoxColumnAppearance appearance) Creates a CheckBoxSelectionModel with a custom appearance instance.
CheckBoxSelectionModel(ValueProvider<M,M> valueProvider) Creates a CheckBoxSelectionModel with a custom ValueProvider instance.
CheckBoxSelectionModel(ValueProvider<M,M> valueProvider, CheckBoxSelectionModel.CheckBoxColumnAppearance appearance) Creates a CheckBoxSelectionModel with a custom ValueProvider and appearance.

Method Summary

Modifier and Type	Method and Description
void	bindGrid(Grid<M> grid) Binds the given grid to this selection model.
CheckBoxSelectionModel.CheckBoxColumnAppearance	getAppearance() Returns the check box column appearance.
ColumnConfig<M,M>	getColumn() Returns the column config.
protected void	handleHeaderClick(HeaderClickEvent event)
boolean	isSelectAllChecked() Returns true if the header checkbox is rendered and selected.
boolean	isShowSelectAll() Returns true if this column header contains a checkbox that the user can interact with.
protected ColumnConfig<M,M>	newColumnConfig(ValueProvider<M,M> valueProvider)
protected void	onAdd(List<? extends M> models)
protected void	onClear(StoreClearEvent<M> event)
protected void	onRefresh(RefreshEvent event)
protected void	onRemove(M model)
protected void	onRowClick(RowClickEvent event) Handles a row click event.
protected void	onRowMouseDown(RowMouseDownEvent event) Handles a row mouse down event.
protected void	onSelectChange(M model, boolean select)
protected void	render(Context context, M value, SafeHtmlBuilder sb)
protected void	setChecked(boolean checked)
void	setSelectAllChecked(boolean select) Sets the select all checkbox in the grid header and selects / deselects all rows.
void	setShowSelectAll(boolean showSelectAll) True to show the select all checkbox in the grid header, false to hide it and prevent select all behavior.
protected void	updateHeaderCheckBox()

Methods inherited from class com.sencha.gxt.widget.core.client.grid.GridSelectionModel

bind, getGrid, hasNext, hasPrevious, isSelectable, onKeyDown, onKeyLeft, onKeyPress, onKeyRight, onKeyUp, onLastFocusChanged, onRecordChange, onUpdate, selectNext, selectPrevious

Methods inherited from class com.sencha.gxt.widget.core.client.selection.AbstractStoreSelectionModel

addBeforeSelectionHandler, addSelectionChangedHandler, addSelectionHandler, deselect, deselect, deselect, deselect, deselect, deselectAll, doDeselect, doMultiSelect, doSelect, doSingleSelect, ensureHandlers, fireEvent, fireSelectionChange, getLastFocused, getSelectedItem, getSelectedItems, getSelection, getSelectionMode, isLocked, isSelected, refresh, select, select, select, select, select, selectAll, setLastFocused, setLocked, setSelection, setSelectionMode

Methods inherited from class java.lang.Object

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

Field Detail

config

protected ColumnConfig<M,M> config

Constructor Detail

CheckBoxSelectionModel

public CheckBoxSelectionModel()

Creates a CheckBoxSelectionModel that will operate on the row itself. To customize the row it is acting on, use a constructor that lets you specify a ValueProvider, to customize how each row is drawn, use a constructor that lets you specify an appearance instance.

CheckBoxSelectionModel

public CheckBoxSelectionModel(ValueProvider<M,M> valueProvider)

Creates a CheckBoxSelectionModel with a custom ValueProvider instance.

Parameters:

valueProvider - the ValueProvider to use when constructing a ColumnConfig

CheckBoxSelectionModel

public CheckBoxSelectionModel(CheckBoxSelectionModel.CheckBoxColumnAppearance appearance)

Creates a CheckBoxSelectionModel with a custom appearance instance.

Parameters:

appearance - the appearance that should be used to render and update the checkbox

CheckBoxSelectionModel

public CheckBoxSelectionModel(ValueProvider<M,M> valueProvider,
                              CheckBoxSelectionModel.CheckBoxColumnAppearance appearance)

Creates a CheckBoxSelectionModel with a custom ValueProvider and appearance.

Parameters:

valueProvider - the ValueProvider to use when constructing a ColumnConfig

appearance - the appearance that should be used to render and update the checkbox

Method Detail

getAppearance

public CheckBoxSelectionModel.CheckBoxColumnAppearance getAppearance()

Returns the check box column appearance.

Returns:

appearance

bindGrid

public void bindGrid(Grid<M> grid)

Description copied from class: GridSelectionModel

Binds the given grid to this selection model.

Overrides:

bindGrid in class GridSelectionModel<M>

Parameters:

grid - the grid to bind to this selection model

getColumn

public ColumnConfig<M,M> getColumn()

Returns the column config.

Returns:

the column config

isSelectAllChecked

public boolean isSelectAllChecked()

Returns true if the header checkbox is rendered and selected.

Returns:

true if selected

isShowSelectAll

public boolean isShowSelectAll()

Returns true if this column header contains a checkbox that the user can interact with.

Returns:

true if the column header should contain a checkbox to select all items

setSelectAllChecked

public void setSelectAllChecked(boolean select)

Sets the select all checkbox in the grid header and selects / deselects all rows. If the header checkbox is not visible (setShowSelectAll(boolean)), this will only update the visible row checkboxes.

Parameters:

select - true to select all

setShowSelectAll

public void setShowSelectAll(boolean showSelectAll)

True to show the select all checkbox in the grid header, false to hide it and prevent select all behavior. Defaults to true.

Must either be called before the grid header is rendered, or calling code must force the header to be rerendered (for example, via GridView.refresh(boolean), passing true to get the header to refresh).

Parameters:

showSelectAll - true to show a header checkbox, false to hide it

handleHeaderClick

protected void handleHeaderClick(HeaderClickEvent event)

onRowClick

protected void onRowClick(RowClickEvent event)

Description copied from class: GridSelectionModel

Handles a row click event. The row click event is responsible for adding to a selection in multiple selection mode.

Overrides:

onRowClick in class GridSelectionModel<M>

Parameters:

event - the row click event

onRowMouseDown

protected void onRowMouseDown(RowMouseDownEvent event)

Description copied from class: GridSelectionModel

Handles a row mouse down event. The row mouse down event is responsible for initiating a selection.

Overrides:

onRowMouseDown in class GridSelectionModel<M>

Parameters:

event - the row mouse down event

newColumnConfig

protected ColumnConfig<M,M> newColumnConfig(ValueProvider<M,M> valueProvider)

onAdd

protected void onAdd(List<? extends M> models)

Overrides:

onAdd in class AbstractStoreSelectionModel<M>

onClear

protected void onClear(StoreClearEvent<M> event)

Overrides:

onClear in class AbstractStoreSelectionModel<M>

onRefresh

protected void onRefresh(RefreshEvent event)

onRemove

protected void onRemove(M model)

Overrides:

onRemove in class AbstractStoreSelectionModel<M>

onSelectChange

protected void onSelectChange(M model,
                              boolean select)

Overrides:

onSelectChange in class GridSelectionModel<M>

render

protected void render(Context context,
                      M value,
                      SafeHtmlBuilder sb)

setChecked

protected void setChecked(boolean checked)

updateHeaderCheckBox

protected void updateHeaderCheckBox()