org.gwt.advanced.client.datamodel

Interface GridDataModel

All Superinterfaces:

Pageable

All Known Subinterfaces:

Composite, Editable, Hierarchical

All Known Implementing Classes:

EditableGridDataModel, HierarchicalGridDataModel, LazyGridDataModel, LazyHierarchicalGridDataModel, LazyTreeGridDataModel, LazyTreeGridDataModel.DelegateLazyGridDataModel, SimpleGridDataModel, TreeGridDataModel, TreeGridDataModel.DelegateEditableGridDataModel

public interface GridDataModel
extends Pageable

This is an advanced grid data model interface.

The grid uses it to obtain data and define paging and sorting settings.

Since:

1.0.0

Author:

Sergey Skladchikov

Method Summary

Methods

Modifier and Type	Method and Description
Object[][]	getData() This method returns all the data contained in the model.
int	getEndRow() This method returns an end row number.
Object[]	getRowData(int rowNumber) This method returns row data by the specified row number.
int	getSortColumn() This method returns a sorted column number.
int	getStartRow() This method returns a start row number.
int	getTotalRowCount() This method returns total row count value.
boolean	isAscending() This method defines sorting direction.
boolean	isEmpty() This method checks whether the data model is empty.
void	setAscending(boolean ascending) This method sets sort direction.
void	setSortColumn(int sortColumn) This method sets a number of sort column.

Methods inherited from interface org.gwt.advanced.client.datamodel.Pageable

getCurrentPageNumber, getDisplayedPages, getEndPage, getPageSize, getStartPage, getTotalPagesNumber, setCurrentPageNumber, setDisplayedPages, setPageSize

Method Detail

getTotalRowCount

int getTotalRowCount()

This method returns total row count value.

Returns:

a total rows number.

getStartRow

int getStartRow()

This method returns a start row number.

Returns:

a start row number.

getEndRow

int getEndRow()

This method returns an end row number.

Returns:

an end row number.

getSortColumn

int getSortColumn()

This method returns a sorted column number.

Returns:

a sortable column number.

isAscending

boolean isAscending()

This method defines sorting direction.

It returns true if direction is ascending.

Returns:

false if sorting is descending.

getRowData

Object[] getRowData(int rowNumber)

This method returns row data by the specified row number.

Parameters:

rowNumber - is a number of row to be returned.

Returns:

row data.

setSortColumn

void setSortColumn(int sortColumn)

This method sets a number of sort column.

Parameters:

sortColumn - a number of sort column.

setAscending

void setAscending(boolean ascending)

This method sets sort direction.

Parameters:

ascending - sort direction.

isEmpty

boolean isEmpty()

This method checks whether the data model is empty.

Returns:

true if the model is empty.

getData

Object[][] getData()

This method returns all the data contained in the model.

Returns:

data