org.gwt.advanced.client.datamodel

Class GridRowSelectDataModel

java.lang.Object

org.gwt.advanced.client.datamodel.GridRowSelectDataModel

public class GridRowSelectDataModel
extends Object

This model is defined to store selected grid rows.

Any grid that provides rows selection functionality uses the model by default and provides useful access methods to control selections.

Since:

1.4.7

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GridRowSelectDataModel.SelectedRow This is an internal representation of the selections.

Constructor Summary

Constructors

Constructor and Description
GridRowSelectDataModel()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, GridRow row) Adds a new selected row in the model.
void	clear() Drops selection.
int	firstIndex() Gets the first selected row number (in order they were selected by a user).
GridRow	firstRow() Gets the first selected row (in order they were selected by a user).
GridRow[]	getGridRows() Gets a list of selected grid rows.
int[]	getIndexes() Gets a list of selected row numbers.
void	remove(int index) Removes selected row from the model by grid row number.
void	replace(int oldIndex, int newIndex, GridRow newRow) This method relaces the specified row with the new one.
int	size() Gets the number of selected rows.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridRowSelectDataModel

public GridRowSelectDataModel()

Method Detail

add

public void add(int index,
       GridRow row)

Adds a new selected row in the model.

Parameters:

index - is a row number in the grid.

row - is a selected grid row.

firstIndex

public int firstIndex()

Gets the first selected row number (in order they were selected by a user).

Returns -1 if there are no rows selected.

Returns:

a row number that was selected first.

firstRow

public GridRow firstRow()

Gets the first selected row (in order they were selected by a user).

Returns null if there are no rows selected.

Returns:

a grid row that was selected first.

getIndexes

public int[] getIndexes()

Gets a list of selected row numbers.

Returns:

a list of selected row numbers.

getGridRows

public GridRow[] getGridRows()

Gets a list of selected grid rows.

Returns:

a list of selected grid rows.

remove

public void remove(int index)

Removes selected row from the model by grid row number.

Parameters:

index - a row number that was deselected.

clear

public void clear()

Drops selection.

size

public int size()

Gets the number of selected rows.

Returns:

size of selection.

replace

public void replace(int oldIndex,
           int newIndex,
           GridRow newRow)

This method relaces the specified row with the new one.

Parameters:

oldIndex - is a number of the row to be replaced.

newIndex - is a new row number.

newRow - is a new model row.