org.gwt.advanced.client.ui.widget

Class TreeGridRenderer

java.lang.Object

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

org.gwt.advanced.client.ui.widget.TreeGridRenderer

All Implemented Interfaces:

GridRenderer

public class TreeGridRenderer
extends DefaultGridRenderer

This class renders tree grid content.

The TreeGrid uses this implementation by default.

Since:

1.4.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TreeGridRenderer.DrawTreeRowCommand This is a draw command that is used to draw one or more tree rows.

Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.DefaultGridRenderer

DefaultGridRenderer.DrawRowCommand

Constructor Summary

Constructors

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

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	drawContent(GridDataModel gridModel) This method renders grid content.
protected boolean	drawPager(TreeCell cell) This method renders a pager associated with the parent row.
protected int	drawRow(TreeGridRow row, int rowNumber) This method draws tree grid rows recusrsively.
protected void	drawSubtree(TreeCell parent) Draws a subtree that belongs to the specified parent.
protected Stack<TreeGridRow>	getCurrentRows() Getter for property 'currentRows'.
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.
int	getRowByModelRow(TreeGridRow parent, int modelRow) This method gets a row number in the grid for the specified model row number.
protected Map<Integer,TreeGridRow>	getRowMapping() Getter for property 'rowMapping'.
protected void	remapIndexes(int startRow, int step) This method remaps indexes in the rows mapping.
protected int	removeSubtree(TreeCell parent) Removes a subtree that belongs to the specified parent.

Methods inherited from class org.gwt.advanced.client.ui.widget.DefaultGridRenderer

decorateCell, drawColumn, drawHeaders, drawRow, formatDate, formatString, getCellFactory, getGrid, getListBoxText, getTBodyElement, getTHeadElement, setCellText, setCellWidget

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeGridRenderer

public TreeGridRenderer(EditableGrid grid)

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

Parameters:

grid - is a target grid.

Method Detail

drawContent

public void drawContent(GridDataModel gridModel)

This method renders grid content.

Specified by:

drawContent in interface GridRenderer

Overrides:

drawContent in class DefaultGridRenderer

Parameters:

gridModel - is a model to be applied.

drawCell

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

This method draws a particular cell.

Specified by:

drawCell in interface GridRenderer

Overrides:

drawCell in class DefaultGridRenderer

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

Overrides:

getModelRow in class DefaultGridRenderer

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

Overrides:

getRowByModelRow in class DefaultGridRenderer

Parameters:

modelRow - is a model row number.

Returns:

a grid row number.

getRowByModelRow

public int getRowByModelRow(TreeGridRow parent,
                   int modelRow)

This method gets a row number in the grid for the specified model row number.

Parameters:

parent - is a parent row.

modelRow - is a model row number (in the subtree).

Returns:

a grid row number.

drawRow

protected int drawRow(TreeGridRow row,
          int rowNumber)

This method draws tree grid rows recusrsively.

If the specified row has children and it is expanded subrows will be rendered as well.

Parameters:

row - is a row to be rendered.

rowNumber - is a row number (index) in the grid.

Returns:

the next row number.

drawPager

protected boolean drawPager(TreeCell cell)

This method renders a pager associated with the parent row.

Parameters:

cell - is a parent expandable cell.

Returns:

true if the pager has been displayed.

drawSubtree

protected void drawSubtree(TreeCell parent)

Draws a subtree that belongs to the specified parent.

Parameters:

parent - is a parent cell.

remapIndexes

protected void remapIndexes(int startRow,
                int step)

This method remaps indexes in the rows mapping.

Parameters:

startRow - is a grid row number to start remaping from.

step - is a row number increasing / decreasing step.

removeSubtree

protected int removeSubtree(TreeCell parent)

Removes a subtree that belongs to the specified parent.

Parameters:

parent - is a parent cell.

Returns:

number of removed rows in the grid.

getCurrentRows

protected Stack<TreeGridRow> getCurrentRows()

Getter for property 'currentRows'.

Returns:

Value for property 'currentRows'.

getRowMapping

protected Map<Integer,TreeGridRow> getRowMapping()

Getter for property 'rowMapping'.

Returns:

Value for property 'rowMapping'.