org.gwt.advanced.client.ui

Interface GridRenderer

All Known Implementing Classes:

DefaultGridRenderer, HierarchicalGridRenderer, TreeGridRenderer

public interface GridRenderer

This is an interface that describes cell renderers.

All renderers applied by the grids must implement it.
If you like to develop your own renderer you can implement this interface but it will be better if you extend DefaultGridRenderer or HierarchicalGridRenderer.

Since:

1.3.0

Author:

Sergey Skladchikov

Method Summary

Methods

Modifier and Type	Method and Description
void	drawCell(Object data, int row, int column, boolean active) This method draws a particular cell.
void	drawColumn(Object[] data, int column, boolean overwrite) This method draws a column.
void	drawContent(GridDataModel model) This method renders grid content.
void	drawHeaders(Object[] headers) This method renders column headers.
void	drawRow(Object[] data, int row) This method renders a particular row.
int	getModelRow(int row) This method converts grid row number to model row number.
int	getRowByModelRow(int modelRow) Gets a grid row number on the displayed page by a model row number.

Method Detail

drawHeaders

void drawHeaders(Object[] headers)

This method renders column headers.

Parameters:

headers - is a list of header values to be rendered.

drawContent

void drawContent(GridDataModel model)

This method renders grid content.

Parameters:

model - is a model to be applied.

drawRow

void drawRow(Object[] data,
           int row)

This method renders a particular row.

Parameters:

data - is a row data array.

row - is a row number.

drawCell

void drawCell(Object data,
            int row,
            int column,
            boolean active)

This method draws a particular cell.

Parameters:

data - is a cell data.

row - is a row number.

column - is a column number.

active - is a falg that indicates that the cell must be active.

getModelRow

int getModelRow(int row)

This method converts grid row number to model row number.

Parameters:

row - is a row number.

Returns:

a row number.

getRowByModelRow

int getRowByModelRow(int modelRow)

Gets a grid row number on the displayed page by a model row number.

Parameters:

modelRow - is a model row number.

Returns:

a grid row number.

drawColumn

void drawColumn(Object[] data,
              int column,
              boolean overwrite)

This method draws a column.

Parameters:

data - is a column data to draw.

column - is a column number

overwrite - is a flag that means whether it's required to overwrite the column cells.