org.gwt.advanced.client.ui.widget

Class HierarchicalGrid

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.HierarchicalGrid

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 HierarchicalGrid
extends EditableGrid<Editable>
implements ExpandCellEventProducer

This is a hierarchical grid implementation.

Since:

1.0.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

Modifier and Type	Field and Description
static String	SUBGRID_ROW_STYLE subgrid row style name

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
HierarchicalGrid(String[] headers, Class[] columnWidgetClasses) Creates a new instance of this class.
HierarchicalGrid(String[] headers, Class[] columnWidgetClasses, boolean resizable) Creates a new instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExpandableCellListener(ExpandableCellListener listener) This method adds an expandable cell listener.
void	addGridPanelFactory(int column, GridPanelFactory factory) This method adds a grid panel factory for subgrids.
protected void	collapseCell(int parentRow, int parentColumn) This method collapses the cell and removes an appropriate subgrid row.
protected void	deleteSubgrid(EditableModelEvent event) This method draws a subgrid on remove subgrid event.
protected void	drawSubgrid(EditableModelEvent event) This method draws a subgrid on add subgrid event.
protected void	enableEvents(boolean enabled) Enables / disables the event manager.
protected void	expandCell(int parentRow, int parentColumn) This method expands the cell and adds a subgrid row below the current row.
void	fireExpandCell(ExpandableCell cell) This method fires the expand cell event.
protected Set<ExpandableCellListener>	getExpandableCellListeners() Getter for property 'expandableCellListeners'.
GridPanel	getGridPanel(int parentRow, int parentColumn) This method looks for a subgrid panel and returns it if the specified cell has been a least one time expanded.
protected Map<GridDataModel,GridPanel>	getGridPanelCache() Getter for property 'gridPanelCache'.
protected Map<Integer,GridPanelFactory>	getGridPanelFactories() Getter for property 'gridPanelFactories'.
protected int	getGridRowNumber(int parentRow, int parentColumn) This method calculates a correct row number of the subgrid 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.
boolean	isExpandable(int column) This method checks the column for expandability.
protected void	removeColumn(int column) This method removes the specified column from the grid Note that it doesn't remove the column from the data model.
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.
void	resize() This method resizes the grid making it fit as much space as possible.
void	selectRows(int toRow) This method selects the rows between the currently selected row and the specified one including both of them into the selection.
void	setColumnWidth(int column, int size) This method sets column size in pixels.
void	setWidget(int row, int column, com.google.gwt.user.client.ui.Widget widget) This method sets a widget for the cell If the cell already contains an expandable cell widget, it adds it into this widget.

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

activateCell, addEditCellListener, addGridDecorator, addGridListener, addInvisibleColumn, addListeners, addRow, addRow, addSelectRowListener, deleteRow, deselectCell, detectCurrentSortColumn, display, drawCell, drawColumn, drawContent, drawHeaders, drawRow, 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, getGridRowByRowNumber, getGridRows, getHeaderCell, getHeaders, getInvisibleColumns, getModel, getModelColumn, getModelRow, getOriginalWidget, getReadOnlyColumns, getRowByModelRow, getRowDrawHandler, getSelectionModel, getSelectRowListeners, getSortableHeaders, getSortColumn, hasActiveCell, isAscending, isClientSortEnabled, isLocked, isMultiRowModeEnabled, isReadOnly, isSelected, isSortable, isSorted, isVisible, refreshAll, removeContent, removeEditCellListener, removeGridDecorator, removeGridListener, removeInvisibleColumn, removeSelectRowListener, runDecorators, selectRow, setAscending, setCellComparator, setCurrentCell, setCurrentRow, setDefaultSelectedRow, setFocus, setGridCellfactory, setGridPanel, setGridRenderer, setLocked, setModel, setMultiRowModeEnabled, setReadOnly, setRowDrawHandler, setSelectionModel, setSortable, setSortColumn, sortOnClient, synchronizeDataModel, synchronizeView, updateModel

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, setBodyHeight, setBodyWidth, setBorderWidth, setCellPadding, setCellSpacing, setColumnResizingAllowed, setFooterWidget, setHeaderHeight, setHeaderWidget, setHeaderWidth, setHTML, setResizable, setText, 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

Field Detail

SUBGRID_ROW_STYLE

public static final String SUBGRID_ROW_STYLE

subgrid row style name

See Also:

Constant Field Values

Constructor Detail

HierarchicalGrid

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

Creates a new instance of this class.

Parameters:

headers - is a list of header labels (including invisible).

columnWidgetClasses - is a list of column widget classes.

HierarchicalGrid

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

Creates a new instance of this class.

Parameters:

headers - is a list of header labels (including invisible).

columnWidgetClasses - is a list of column widget classes.

resizable - is a column resizability flag value.

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.

addGridPanelFactory

public void addGridPanelFactory(int column,
                       GridPanelFactory factory)

This method adds a grid panel factory for subgrids.

Parameters:

column - is a column number.

factory - is a factory instance.

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.

setWidget

public void setWidget(int row,
             int column,
             com.google.gwt.user.client.ui.Widget widget)

This method sets a widget for the cell

If the cell already contains an expandable cell widget, it adds it into this widget.

Overrides:

setWidget in class SimpleGrid

Parameters:

row - is a row number.

column - is a column number.

widget - is a widget to be placed in the cell.

getGridPanel

public GridPanel getGridPanel(int parentRow,
                     int parentColumn)

This method looks for a subgrid panel and returns it if the specified cell has been a least one time expanded.

Parameters:

parentRow - is a parent cell parentRow.

parentColumn - is a parent cell parentColumn.

Returns:

a subgrid panel.

resize

public void resize()

This method resizes the grid making it fit as much space as possible.

Specified by:

resize in interface Resizable

Overrides:

resize in class SimpleGrid

setColumnWidth

public void setColumnWidth(int column,
                  int size)

This method sets column size in pixels.

Overrides:

setColumnWidth in class SimpleGrid

Parameters:

column - is a column number.

size - is a size value in pixels.

selectRows

public void selectRows(int toRow)

This method selects the rows between the currently selected row and the specified one including both of them into the selection.

The method works only if the multiple rows selection mode is enabled.

Overrides:

selectRows in class EditableGrid<Editable>

Parameters:

toRow - is a right border (a row number that will the end of selection).

removeColumn

protected void removeColumn(int column)

This method removes the specified column from the grid

Note that it doesn't remove the column from the data model.

Overrides:

removeColumn in class EditableGrid<Editable>

Parameters:

column - is a column number to remove.

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>

expandCell

protected void expandCell(int parentRow,
              int parentColumn)

This method expands the cell and adds a subgrid row below the current row.

Parameters:

parentRow - is a row number.

parentColumn - is a column number.

drawSubgrid

protected void drawSubgrid(EditableModelEvent event)

This method draws a subgrid on add subgrid event.

Parameters:

event - is a model event to be handled.

collapseCell

protected void collapseCell(int parentRow,
                int parentColumn)

This method collapses the cell and removes an appropriate subgrid row.

Parameters:

parentRow - is a row number..

parentColumn - is a column number.

deleteSubgrid

protected void deleteSubgrid(EditableModelEvent event)

This method draws a subgrid on remove subgrid event.

Parameters:

event - is a model event to be handled.

getGridRowNumber

protected int getGridRowNumber(int parentRow,
                   int parentColumn)

This method calculates a correct row number of the subgrid row.

Parameters:

parentRow - is a row number of the expanded / collapsed cell.

parentColumn - is a column number of the expanded / collapsed cell.

Returns:

a row number.

isExpandable

public boolean isExpandable(int column)

This method checks the column for expandability.

Parameters:

column - is a column number.

Returns:

true if the column is expandable.

getExpandableCellListeners

protected Set<ExpandableCellListener> getExpandableCellListeners()

Getter for property 'expandableCellListeners'.

Returns:

Value for property 'expandableCellListeners'.

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.

getGridPanelCache

protected Map<GridDataModel,GridPanel> getGridPanelCache()

Getter for property 'gridPanelCache'.

Returns:

Value for property 'gridPanelCache'.

getGridPanelFactories

protected Map<Integer,GridPanelFactory> getGridPanelFactories()

Getter for property 'gridPanelFactories'.

Returns:

Value for property 'gridPanelFactories'.

enableEvents

protected void enableEvents(boolean enabled)

Enables / disables the event manager.

Parameters:

enabled - is a flag that means whether the manager must be enabled.