org.gwt.advanced.client.ui.widget

Class TreeGrid

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.HTMLTable

com.google.gwt.user.client.ui.FlexTable

org.gwt.advanced.client.ui.widget.AdvancedFlexTable

org.gwt.advanced.client.ui.widget.SimpleGrid

org.gwt.advanced.client.ui.widget.EditableGrid<Editable>

org.gwt.advanced.client.ui.widget.TreeGrid

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesTableEvents, Iterable<com.google.gwt.user.client.ui.Widget>, AdvancedWidget, ExpandCellEventProducer, Resizable, SourcesTableDoubleClickEvents

public class TreeGrid
extends EditableGrid<Editable>
implements ExpandCellEventProducer

This class is a tree grid widget implentation that is able to display composite data models as a tree of rows.

Remarkable feature of this grid is that it can render pageable subtrees.

Since:

1.4.0

Author:

Sergey Skladchikov

Nested Class Summary

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

SimpleGrid.ResizeListener, SimpleGrid.ResizeTimer

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

AdvancedFlexTable.AdvancedWidgetIterator, AdvancedFlexTable.ClickTimer, AdvancedFlexTable.RowsScrollPanel

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.FlexTable

com.google.gwt.user.client.ui.FlexTable.FlexCellFormatter

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.HTMLTable

com.google.gwt.user.client.ui.HTMLTable.Cell, com.google.gwt.user.client.ui.HTMLTable.CellFormatter, com.google.gwt.user.client.ui.HTMLTable.ColumnFormatter, com.google.gwt.user.client.ui.HTMLTable.RowFormatter

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TreeGrid(String[] headers, Class[] columnWidgetClasses) Creates a tree grid with resizable columns by default.
TreeGrid(String[] headers, Class[] columnWidgetClasses, boolean resizable) Creates a tree grid with resizable columns.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExpandableCellListener(ExpandableCellListener listener) This method adds an expandable cell listener.
void	addRow() This method adds a new empty row into the grid.
protected void	collapseCell(TreeCell cell) This method collapses the specified cell.
protected void	deleteRow(EditableModelEvent event) This method removes the row from the subgrid by it's model row number.
protected void	drawCell(EditableModelEvent event) This method draws a concrete cell.
protected void	drawColumn(int column) This method draws a column getting data from the data model If the data model is not specified it does nothing.
protected void	drawContent(TreeGridRow parent) This method safely draws the subtree specified by its parent row.
protected void	drawRow(EditableModelEvent event) Draws a grid row on add row event.
protected void	expandCell(TreeCell cell) This method expands the specified cell.
void	fireExpandCell(ExpandableCell cell) This method fires the expand cell event.
protected List<ExpandableCellListener>	getExpandableCellListeners() Getter for property 'expandableCellListeners'.
TreeGridRow	getGridRow(int parentIndex, int rowIndex) Gets a tree grid row by parent and child row indexes.
GridRow	getGridRowByRowNumber(int row) Gets a grid row by a row number in the displayed page.
TreeGridRow[]	getGridRows(int parentIndex) Gets a list of tree grid rows by the parent index.
int	getRowByModelRow(EditableModelEvent event) Gets a grid row number on the displayed page by a model row number.
protected List<Object>	getSubtreeColumnData(TreeGridRow parent, int column, int count) This method gets a list of column data values of the specified subtree recursively.
protected TreeCell	getTreeCell(int row) This renderer returns a tree cell for the specified row.
com.google.gwt.user.client.ui.Widget	getWidget(int row, int column) This method returns a widget placed in the cell.
protected void	increaseRowNumbers(int startRow, int step) This method increases row numbers in the cells.
protected void	moveLeft() This method moves the selected row to the left position decreasing its level and changing the row parent to the super parent row.
protected void	moveRight() This method moves the selected row to the right position increasing its level and changing the row parent to the nearest parent row having this new level.
void	removeExpandableCellListener(ExpandableCellListener listener) Removes expandable cell listener.
protected void	removeRow() This method removes the currently selected row or several rows if the multi row selection mode enabled.
protected void	removeSubtree(EditableModelEvent event) This method cleans the subtree in the grid on remove subtree event received from the data model.
protected void	sortOnClient(TreeGridRow parent) This method performs client sorting of the subtree.
protected void	synchronizeDataModel() This method invokes the data model handler to synchronize the model and persistence storage or redraws content if the model is not lazily loadable.
protected void	synchronizeView(EditableModelEvent event) This method draws a content on the specified model event.
protected void	updateModel(GridCell cell, Object newValue) This method updates the model with the new value of the cell on finish edit event.

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

activateCell, addEditCellListener, addGridDecorator, addGridListener, addInvisibleColumn, addListeners, addRow, addSelectRowListener, deselectCell, detectCurrentSortColumn, display, drawContent, drawHeaders, dropSelection, fireAfterDrawEvent, fireBeforeDrawEvent, fireFinishEdit, fireSort, fireStartEdit, getActiveCell, getBodyElement, getCellComparator, getColumnByModelColumn, getColumnWidgetClasses, getCurrentColumn, getCurrentGridRow, getCurrentGridRows, getCurrentRow, getCurrentRows, getCurrentSortColumn, getDecorators, getDefaultSelectedRow, getEditCellListeners, getGridCellFactory, getGridColumn, getGridColumn, getGridColumns, getGridPanel, getGridRenderer, getGridRow, getGridRows, getHeaderCell, getHeaders, getInvisibleColumns, getModel, getModelColumn, getModelRow, getOriginalWidget, getReadOnlyColumns, getRowDrawHandler, getSelectionModel, getSelectRowListeners, getSortableHeaders, getSortColumn, hasActiveCell, isAscending, isClientSortEnabled, isLocked, isMultiRowModeEnabled, isReadOnly, isSelected, isSortable, isSorted, isVisible, refreshAll, removeColumn, removeContent, removeEditCellListener, removeGridDecorator, removeGridListener, removeInvisibleColumn, removeSelectRowListener, runDecorators, selectRow, selectRows, setAscending, setCellComparator, setCurrentCell, setCurrentRow, setDefaultSelectedRow, setFocus, setGridCellfactory, setGridPanel, setGridRenderer, setLocked, setModel, setMultiRowModeEnabled, setReadOnly, setRowDrawHandler, setSelectionModel, setSortable, setSortColumn, sortOnClient

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

addCell, addClickHandler, addDoubleClickListener, addHeaderCells, checkCellBounds, checkRowBounds, clear, clear, clearCell, createCell, enableVerticalScrolling, getBodyTable, getCellCount, getCellForEvent, getCellFormatter, getCellPadding, getCellSpacing, getColumnFormatter, getDOMCellCount, getDOMCellCount, getDOMRowCount, getDOMRowCount, getEventTargetCell, getFlexCellFormatter, getFooterTable, getFooterTdElement, getFooterWidgets, getHeaderTable, getHeaderWidgets, getHTML, getRowCount, getRowFormatter, getScrollPanel, getTableHeight, getTableWidth, getText, getTFootElement, getTHeadElement, getThElement, getThElementWidth, insertCell, insertCells, insertHeaderCell, insertRow, internalClearCell, isCellPresent, isColumnResizingAllowed, isResizable, makeResizable, onBrowserEvent, prepareCell, prepareColumn, prepareFooterCell, prepareHeaderCell, prepareRow, prepareScrolling, remove, removeAllRows, removeCell, removeCells, removeDoubleClickListener, removeFooterWidget, removeHeaderWidget, removeRow, resize, setBodyHeight, setBodyWidth, setBorderWidth, setCellPadding, setCellSpacing, setColumnResizingAllowed, setColumnWidth, setFooterWidget, setHeaderHeight, setHeaderWidget, setHeaderWidth, setHTML, setResizable, setText, setWidget, wrapContent

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

addFooterCells, fireClickEvent, fireDoubleClickEvent, getCellClicked, getCellElement, getClickCount, getClickTimer, getDoubleClickListeners, getHandlerManager, isScrollable, iterator, setCellClicked, setCellFormatter, setClickCount, setClickTimer, setColumnFormatter, setDoubleClikcListeners, setHandlerManager, setRowFormatter, setScrollable

Methods inherited from class com.google.gwt.user.client.ui.HTMLTable

addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addTableListener, onEnsureDebugId, removeTableListener, setHTML, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, add, adopt, adopt, disown, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

TreeGrid

public TreeGrid(String[] headers,
        Class[] columnWidgetClasses)

Creates a tree grid with resizable columns by default.

Parameters:

headers - is a list of header names.

columnWidgetClasses - is a list of appropriate cell classes.

TreeGrid

public TreeGrid(String[] headers,
        Class[] columnWidgetClasses,
        boolean resizable)

Creates a tree grid with resizable columns.

Parameters:

headers - is a list of header names.

columnWidgetClasses - is a list of appropriate cell classes.

resizable - is a resizability flag. if it's true th grid will allow resize columns by a mouse otherwise it won't.

Method Detail

addExpandableCellListener

public void addExpandableCellListener(ExpandableCellListener listener)

This method adds an expandable cell listener.

Specified by:

addExpandableCellListener in interface ExpandCellEventProducer

Parameters:

listener - a listener instance.

removeExpandableCellListener

public void removeExpandableCellListener(ExpandableCellListener listener)

Removes expandable cell listener.

Specified by:

removeExpandableCellListener in interface ExpandCellEventProducer

Parameters:

listener - is a listener to remove.

fireExpandCell

public void fireExpandCell(ExpandableCell cell)

This method fires the expand cell event.

Specified by:

fireExpandCell in interface ExpandCellEventProducer

Parameters:

cell - is an expanded / collapsed cell.

getWidget

public com.google.gwt.user.client.ui.Widget getWidget(int row,
                                             int column)

This method returns a widget placed in the cell.

If the widget is an expandable cell it returns cell child widget.

Overrides:

getWidget in class EditableGrid<Editable>

Parameters:

row - is a row number.

column - is a column number.

Returns:

is a cell widget.

getGridRow

public TreeGridRow getGridRow(int parentIndex,
                     int rowIndex)

Gets a tree grid row by parent and child row indexes.

Parameters:

parentIndex - is a parent row index.

rowIndex - is a row index.

Returns:

a tree grid row instance.

getGridRows

public TreeGridRow[] getGridRows(int parentIndex)

Gets a list of tree grid rows by the parent index.

Parameters:

parentIndex - is a parent row index.

Returns:

a list of tree grid rows.

getGridRowByRowNumber

public GridRow getGridRowByRowNumber(int row)

Gets a grid row by a row number in the displayed page.

Overrides:

getGridRowByRowNumber in class EditableGrid<Editable>

Parameters:

row - is a row number.

Returns:

a grid row of the data model.

addRow

public void addRow()

This method adds a new empty row into the grid.

Grid cells must provide correct results to allow the grid to support this feature.

Overrides:

addRow in class EditableGrid<Editable>

drawCell

protected void drawCell(EditableModelEvent event)

This method draws a concrete cell.

If the cell has already been drawn the method renders it again.

Overrides:

drawCell in class EditableGrid<Editable>

Parameters:

event - is an event on which cell must be drawn.

drawColumn

protected void drawColumn(int column)

This method draws a column getting data from the data model

If the data model is not specified it does nothing.

Overrides:

drawColumn in class EditableGrid<Editable>

Parameters:

column - is a column number.

getSubtreeColumnData

protected List<Object> getSubtreeColumnData(TreeGridRow parent,
                                int column,
                                int count)

This method gets a list of column data values of the specified subtree recursively.

Note that it returns only those subtrees which currently expanded if you use lazily loadable models. So if you don't want to expand them on the view simply synchronize the model subtree.

Parameters:

parent - is a parent row of the subtree.

column - is a column number.

count - is a current count of column cell displayed above.

Returns:

a list of data values.

drawRow

protected void drawRow(EditableModelEvent event)

Draws a grid row on add row event.

Overrides:

drawRow in class EditableGrid<Editable>

Parameters:

event - is a model event containing a row number value.

removeRow

protected void removeRow()

This method removes the currently selected row or several rows if the multi row selection mode enabled.

Overrides:

removeRow in class EditableGrid<Editable>

deleteRow

protected void deleteRow(EditableModelEvent event)

This method removes the row from the subgrid by it's model row number.

Overrides:

deleteRow in class EditableGrid<Editable>

Parameters:

event - is a model event containing a row number value and parent row.

getRowByModelRow

public int getRowByModelRow(EditableModelEvent event)

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

Overrides:

getRowByModelRow in class EditableGrid<Editable>

Parameters:

event - is a model event containing a row number value.

Returns:

a grid row number.

moveLeft

protected void moveLeft()

This method moves the selected row to the left position decreasing its level and changing the row parent to the super parent row.

moveRight

protected void moveRight()

This method moves the selected row to the right position increasing its level and changing the row parent to the nearest parent row having this new level.

synchronizeView

protected void synchronizeView(EditableModelEvent event)

This method draws a content on the specified model event.

Overrides:

synchronizeView in class EditableGrid<Editable>

Parameters:

event - is a model event.

synchronizeDataModel

protected void synchronizeDataModel()

This method invokes the data model handler to synchronize the model and persistence storage or redraws content if the model is not lazily loadable.

Overrides:

synchronizeDataModel in class EditableGrid<Editable>

getTreeCell

protected TreeCell getTreeCell(int row)

This renderer returns a tree cell for the specified row.

If the tree cell is in the invisible column this method creates a fake instance of the cell with the null value.

Parameters:

row - is a row number.

Returns:

a tree cell link or null if there is no such row or the model applied to this grid doesn't implement Composite.

increaseRowNumbers

protected void increaseRowNumbers(int startRow,
                      int step)

This method increases row numbers in the cells.

Overrides:

increaseRowNumbers in class EditableGrid<Editable>

Parameters:

startRow - is a start row number.

step - is an increase step.

sortOnClient

protected void sortOnClient(TreeGridRow parent)

This method performs client sorting of the subtree.

Parameters:

parent - is a parent row.

updateModel

protected void updateModel(GridCell cell,
               Object newValue)

This method updates the model with the new value of the cell on finish edit event.

Overrides:

updateModel in class EditableGrid<Editable>

Parameters:

cell - is a cell that produced the event.

newValue - is a new value of the cell.

drawContent

protected void drawContent(TreeGridRow parent)

This method safely draws the subtree specified by its parent row.

If the parent is expanded and contains rendered subrows, they will be removed.

Parameters:

parent - is a parent row of the subtree.

expandCell

protected void expandCell(TreeCell cell)

This method expands the specified cell.

Parameters:

cell - is a cell to expand.

collapseCell

protected void collapseCell(TreeCell cell)

This method collapses the specified cell.

Parameters:

cell - is a cell to collapse.

removeSubtree

protected void removeSubtree(EditableModelEvent event)

This method cleans the subtree in the grid on remove subtree event received from the data model.

Parameters:

event - is an event to be handled.

getExpandableCellListeners

protected List<ExpandableCellListener> getExpandableCellListeners()

Getter for property 'expandableCellListeners'.

Returns:

Value for property 'expandableCellListeners'.