com.goldencode.p2j.admin.client.widget

Class GridHandle<TRowObject>

java.lang.Object

com.goldencode.p2j.admin.client.widget.GridHandle<TRowObject>

public class GridHandle<TRowObject>
extends java.lang.Object

A class providing convenience methods for working with instance of DataGrid.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gwt.view.client.ListDataProvider<TRowObject>	dataProvider Data provider
private com.google.gwt.user.cellview.client.DataGrid	grid The wrapped grid
private java.util.Set<TRowObject>	selected The selected records
private com.google.gwt.view.client.SetSelectionModel<TRowObject>	selectionModel Selection model reference

Constructor Summary

Constructors

Constructor and Description
GridHandle(com.google.gwt.user.cellview.client.DataGrid grid, com.google.gwt.view.client.ListDataProvider<TRowObject> dataProvider, com.google.gwt.view.client.SetSelectionModel<TRowObject> selectionModel) Ctor.

Method Summary

Modifier and Type	Method and Description
void	addRows(java.util.List<TRowObject> rows) Adds rows to the grid's data provider.
void	addRows(java.util.List<TRowObject> rows, com.google.gwt.regexp.shared.RegExp filterExp) Adds rows to the grid's data provider.
void	addRows(TRowObject[] rows) Adds rows to the grid's data provider.
void	addRows(TRowObject[] rows, com.google.gwt.regexp.shared.RegExp filterExp) Adds rows to the grid's data provider.
void	clearGrid() Clears the grid - removes all rows and clears the selection.
void	clearGrid(boolean keepSelection) Clears the grid - removes all rows and clears the selection.
void	clearSelection() Unselects the currently selected rows.
com.google.gwt.view.client.ListDataProvider<TRowObject>	getDataProvider() Returns the data provider.
com.google.gwt.user.cellview.client.DataGrid	getGrid() Returns the wrapped grid.
java.util.Set<TRowObject>	getSelected() Returns the set of selected rows.
TRowObject	getSelectedSingle() Return the single selected row.
com.google.gwt.view.client.SelectionModel<TRowObject>	getSelectionModel() Returns the grid selection model.
private void	restoreSelected() Selects the rows stored by storeSelected().
void	select(TRowObject row) Select the provided row.
void	setRows(TRowObject[] rows) Clears the grid and adds rows to the grid's data provider.
void	setRows(TRowObject[] rows, com.google.gwt.regexp.shared.RegExp filterExp) Clears the grid and adds rows to the grid's data provider.
private void	storeSelected() Stores the currently selected rows.

Methods inherited from class java.lang.Object

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

Field Detail

grid

private com.google.gwt.user.cellview.client.DataGrid grid

The wrapped grid

dataProvider

private com.google.gwt.view.client.ListDataProvider<TRowObject> dataProvider

Data provider

selectionModel

private com.google.gwt.view.client.SetSelectionModel<TRowObject> selectionModel

Selection model reference

selected

private java.util.Set<TRowObject> selected

The selected records

Constructor Detail

GridHandle

public GridHandle(com.google.gwt.user.cellview.client.DataGrid grid,
                  com.google.gwt.view.client.ListDataProvider<TRowObject> dataProvider,
                  com.google.gwt.view.client.SetSelectionModel<TRowObject> selectionModel)

Ctor.

Parameters:

grid - The grid instance to wrap.

dataProvider - The data provider.

selectionModel - The selection model.

Method Detail

getGrid

public com.google.gwt.user.cellview.client.DataGrid getGrid()

Returns the wrapped grid.

Returns:

see above

getDataProvider

public com.google.gwt.view.client.ListDataProvider<TRowObject> getDataProvider()

Returns the data provider.

Returns:

see above

getSelectionModel

public com.google.gwt.view.client.SelectionModel<TRowObject> getSelectionModel()

Returns the grid selection model.

Returns:

see above

clearSelection

public void clearSelection()

Unselects the currently selected rows.

getSelected

public java.util.Set<TRowObject> getSelected()

Returns the set of selected rows.

Returns:

see above

getSelectedSingle

public TRowObject getSelectedSingle()

Return the single selected row. Note that this method can be used only when the selection model is of type SingleSelectionModel.

Returns:

see above

select

public void select(TRowObject row)

Select the provided row. When the row is not present in the grid this method is a no-op.

Parameters:

row - The row to select.

clearGrid

public void clearGrid()

Clears the grid - removes all rows and clears the selection.

clearGrid

public void clearGrid(boolean keepSelection)

Clears the grid - removes all rows and clears the selection.

Parameters:

keepSelection - This flag allows to keep the current selection.

addRows

public void addRows(java.util.List<TRowObject> rows)

Adds rows to the grid's data provider.

Parameters:

rows - The rows to add.

addRows

public void addRows(TRowObject[] rows)

Adds rows to the grid's data provider.

Parameters:

rows - The rows to add.

addRows

public void addRows(java.util.List<TRowObject> rows,
                    com.google.gwt.regexp.shared.RegExp filterExp)

Adds rows to the grid's data provider. Only those rows that satisfy the supplied regular expression are added, all the row columns are tested against the expression.

Parameters:

rows - The rows to add.

filterExp - Regular expression.

addRows

public void addRows(TRowObject[] rows,
                    com.google.gwt.regexp.shared.RegExp filterExp)

Adds rows to the grid's data provider. Only those rows that satisfy the supplied regular expression are added, all the row columns are tested against the expression.

Parameters:

rows - The rows to add.

filterExp - Regular expression.

setRows

public void setRows(TRowObject[] rows)

Clears the grid and adds rows to the grid's data provider. This method keeps the current grid selection.

Parameters:

rows - The rows to set.

setRows

public void setRows(TRowObject[] rows,
                    com.google.gwt.regexp.shared.RegExp filterExp)

Clears the grid and adds rows to the grid's data provider. Only those rows that satisfy the supplied regular expression are added, all the row columns are tested against the expression.

Parameters:

rows - The rows to set.

filterExp - Regular expression.

storeSelected

private void storeSelected()

Stores the currently selected rows.

restoreSelected

private void restoreSelected()

Selects the rows stored by storeSelected().