org.gwt.advanced.client.ui.widget

Class DefaultGridRenderer

java.lang.Object

org.gwt.advanced.client.ui.widget.DefaultGridRenderer

All Implemented Interfaces:

GridRenderer

Direct Known Subclasses:

HierarchicalGridRenderer, TreeGridRenderer

public class DefaultGridRenderer
extends Object
implements GridRenderer

This is default grid renderer implementation that is applied by grid if there is no custom one specified.

Since:

1.3.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultGridRenderer.DrawRowCommand This command displays one row.

Constructor Summary

Constructors

Constructor and Description
DefaultGridRenderer(EditableGrid grid) Creates an instance of this class and initializes the grid cell factory.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decorateCell(int row, int column, String style) This method decorates the cell with styles.
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.
protected String	formatDate(Date date) This method formates the specified date.
protected String	formatString(Object data) This method formats the object and returns its textual representation If the object is null the method gets an empty string.
protected GridCellFactory	getCellFactory() Getter for property 'cellFactory'.
EditableGrid	getGrid() Getter for property 'grid'.
protected String	getListBoxText(com.google.gwt.user.client.ui.ListBox listBox) This method returns a text for the inactive label.
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.
protected com.google.gwt.user.client.Element	getTBodyElement() This method returns a tbody element of the grid.
protected com.google.gwt.user.client.Element	getTHeadElement() This method retuns the thead element of the grid.
protected void	setCellText(String text, int row, int column, String style) This method sets the cell value in textual format.
protected void	setCellWidget(com.google.gwt.user.client.ui.Widget widget, int row, int column, String style) Sets the widget into the specified cell and decorates this cell with the specified style.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGridRenderer

public DefaultGridRenderer(EditableGrid grid)

Creates an instance of this class and initializes the grid cell factory.

Parameters:

grid - is a target grid.

Method Detail

drawHeaders

public void drawHeaders(Object[] headers)

This method renders column headers.

Specified by:

drawHeaders in interface GridRenderer

Parameters:

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

drawContent

public void drawContent(GridDataModel model)

This method renders grid content.

Specified by:

drawContent in interface GridRenderer

Parameters:

model - is a model to be applied.

drawRow

public void drawRow(Object[] data,
           int row)

This method renders a particular row.

Specified by:

drawRow in interface GridRenderer

Parameters:

data - is a row data array.

row - is a row number.

drawCell

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

This method draws a particular cell.

Specified by:

drawCell in interface GridRenderer

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

public int getModelRow(int row)

This method converts grid row number to model row number.

Specified by:

getModelRow in interface GridRenderer

Parameters:

row - is a row number.

Returns:

a row number.

getRowByModelRow

public int getRowByModelRow(int modelRow)

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

Specified by:

getRowByModelRow in interface GridRenderer

Parameters:

modelRow - is a model row number.

Returns:

a grid row number.

drawColumn

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

This method draws a column.

Specified by:

drawColumn in interface GridRenderer

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.

getGrid

public EditableGrid getGrid()

Getter for property 'grid'.

Returns:

Value for property 'grid'.

setCellText

protected void setCellText(String text,
               int row,
               int column,
               String style)

This method sets the cell value in textual format.

It also decorates the cell with the specified style.

Parameters:

text - is a text of the cell value.

row - is a row number.

column - is a column number.

style - is a style name.

setCellWidget

protected void setCellWidget(com.google.gwt.user.client.ui.Widget widget,
                 int row,
                 int column,
                 String style)

Sets the widget into the specified cell and decorates this cell with the specified style.

Parameters:

widget - is a widget to set.

row - is a row number.

column - is a column number.

style - is a cell style.

decorateCell

protected void decorateCell(int row,
                int column,
                String style)

This method decorates the cell with styles.

Parameters:

row - is a row number.

column - is a column number.

style - is a style name.

formatDate

protected String formatDate(Date date)

This method formates the specified date.

Parameters:

date - is a date to be formatted.

Returns:

a date string.

formatString

protected String formatString(Object data)

This method formats the object and returns its textual representation

If the object is null the method gets an empty string.

Parameters:

data - is an object to be formatted.

Returns:

a textual representation of the object.

getListBoxText

protected String getListBoxText(com.google.gwt.user.client.ui.ListBox listBox)

This method returns a text for the inactive label.

Parameters:

listBox - is a list box.

Returns:

a label text.

getCellFactory

protected GridCellFactory getCellFactory()

Getter for property 'cellFactory'.

Returns:

Value for property 'cellFactory'.

getTHeadElement

protected com.google.gwt.user.client.Element getTHeadElement()

This method retuns the thead element of the grid.

Returns:

a thead element.

getTBodyElement

protected com.google.gwt.user.client.Element getTBodyElement()

This method returns a tbody element of the grid.

Returns:

a tbody element.