TreeGridDataModel (Advanced GWT Components 2.0.9 API)

java.lang.Object
- org.gwt.advanced.client.datamodel.TreeGridDataModel

All Implemented Interfaces:

Composite, Editable, GridDataModel, Pageable

Direct Known Subclasses:

LazyTreeGridDataModel
```
public class TreeGridDataModel
extends Object
implements Composite
```
This is a data model for the tree grid.

Since:

1.4.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`TreeGridDataModel.DelegateEditableGridDataModel` This class extends original editable model to support `TreeGridRow`s creation.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TreeGridDataModel(DataModelCallbackHandler<Editable> handler)` Creates an instance of this class and loads data using the specified handler.
	`TreeGridDataModel(Object[][] data)` Creates an instance of this class and initializes internal fields.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addColumn(int beforeColumn, Object[] column)` This method adds a column into the model.
`void`	`addColumn(int beforeColumn, String name, Object[] column)` This method adds a column into the model.
`void`	`addListener(EditableModelListener listener)` This method registers the specified listener to receive model events.
`void`	`addRow(int beforeRow, Object[] row)` This method adds a row into the model.
`int`	`addRow(TreeGridRow parent, Object[] child)` Adds a child row.
`void`	`clearRemovedRows()` This method clears removed rows from the model history
`void`	`clearRemovedRows(TreeGridRow parent)` Cleans the list of removed rows.
`protected void`	`fireRowEvent(EditableModelEvent.EventType eventType, TreeGridRow parent, int row)` This method fires the `CompositeModelEvent`.
`protected List<TreeGridRow>`	`getChildrenList(TreeGridRow parent)` Gets a list of children of the specified parent or creates if it doesn't exist.
`String[]`	`getColumnNames()` This method gets a list of column names.
`GridColumn[]`	`getColumns()` Gets an array of all model columns.
`int`	`getCurrentPageNumber()` This method gets a current page number.
`int`	`getCurrentPageNumber(TreeGridRow parent)` This method gets a current page number in the subtree.
`Object[][]`	`getData()` This method returns all the data contained in the model.
`protected EditableGridDataModel`	`getDelegate()` Getter for property 'delegate'.
`int`	`getDisplayedPages()` This method gets the number of pages links to be displayed.
`int`	`getDisplayedPages(TreeGridRow parent)` This method gets the number of pages links to be displayed in the subtree.
`int`	`getEndPage()` This method returns an end page number.
`int`	`getEndPage(TreeGridRow parent)` This method returns an end page number in the subtree.
`int`	`getEndRow()` This method returns an end row number.
`int`	`getEndRow(TreeGridRow parent)` Returns an end row number of the subgrid.
`int`	`getExpandableColumn()` Gets an index of the expandable column.
`GridColumn`	`getGridColumn(int index)` Gets a grid column by index.
`DataModelCallbackHandler<Editable>`	`getHandler()` This method returns a callback handler instance.
`int`	`getPageSize()` This method returns a page size.
`int`	`getPageSize(TreeGridRow parent)` Gets a page size of the subtree.
`protected Map<TreeGridRow,Boolean>`	`getPagingFlags()` Getter for property 'pagingFlags'.
`Object[][]`	`getRemovedRows()` This method returns removed rows.
`Object[][]`	`getRemovedRows(TreeGridRow parent)` Gets an array of removed rows data.
`protected List<TreeGridRow>`	`getRemovedRowsList(TreeGridRow parent)` Gets a list of removed rows for the specified parent row or creates a new one if it doesn't exist.
`protected Map<TreeGridRow,List<TreeGridRow>>`	`getRemovedRowsMap()`
`protected TreeGridRow[]`	`getRootRows()` Gets a list of root rows.
`GridRow`	`getRow(int index)` Gets a grid row by index.
`TreeGridRow`	`getRow(TreeGridRow parent, int index)` Gets a grid row of the subtree by index.
`Object[]`	`getRowData(int rowNumber)` This method returns row data by the specified row number.
`GridRow[]`	`getRows()` This method returns all rows of the model.
`TreeGridRow[]`	`getRows(TreeGridRow parent)` Gets a list of child rows.
`int`	`getSortColumn()` This method returns a sorted column number.
`int`	`getStartPage()` This method returns a start page number.
`int`	`getStartPage(TreeGridRow parent)` This method returns a start page number in the subtree.
`int`	`getStartRow()` This method returns a start row number.
`int`	`getStartRow(TreeGridRow parent)` Returns a subgrid start row number.
`protected Map<TreeGridRow,List<TreeGridRow>>`	`getSubRows()` Getter for property 'subRows'.
`protected Composite`	`getThisModel()` This method returns this instance.
`int`	`getTotalColumnCount()` This method returns a total row count.
`int`	`getTotalPagesNumber()` This method returns a number of existing pages.
`int`	`getTotalPagesNumber(TreeGridRow parent)` This method returns a number of existing pages in the subtree.
`int`	`getTotalRowCount()` This method returns total row count value.
`int`	`getTotalRowCount(TreeGridRow parent)` This method gets a total row count for the specified subtree.
`boolean`	`isAscending()` This method defines sorting direction.
`boolean`	`isEmpty()` This method checks whether the data model is empty.
`boolean`	`isSubtreePagingEnabled(TreeGridRow parent)` Checks whether subtree paging is enabled.
`protected void`	`remapIndexes(TreeGridRow parent)` This method remaps indexes in the subtree.
`void`	`removeAll()` This method removes all rows from the model.
`void`	`removeAll(TreeGridRow parent)` Removes all the children of the specified row.
`void`	`removeColumn(int columnNumber)` This method removes a column from the model.
`void`	`removeColumn(String name)` This method removes a column from the model.
`void`	`removeListener(EditableModelListener listener)` This method unregisters the specified listener to stop model events receiving.
`void`	`removeRow(int rowNumber)` This method removes a row from the model.
`void`	`removeRow(TreeGridRow parent, int row)` Removes the child row.
`void`	`setAscending(boolean ascending)` This method sets sort direction.
`void`	`setColumNames(String[] names)` This method sets a list of column names This list must be in the same order like the data array columns (see `Editable.update(Object[][])` for details.
`void`	`setCurrentPageNumber(int currentPageNumber)` This method sets the current page number.
`void`	`setCurrentPageNumber(TreeGridRow parent, int currentPageNumber)` This method sets the current page number in the subtree.
`protected void`	`setDelegate(EditableGridDataModel delegate)` Setter for property 'delegate'.
`void`	`setDisplayedPages(int displayedPages)` This method sets the number of pages links to be displayed.
`void`	`setDisplayedPages(TreeGridRow parent, int displayedPages)` This method sets the number of pages links to be displayed in the subtree.
`void`	`setExpandableColumn(int index)` Sets the expandable column using its index.
`void`	`setExpandableColumn(String name)` Sets the exapandbale column by its name.
`void`	`setHandler(DataModelCallbackHandler<Editable> handler)` This method sets a callback handler.
`void`	`setPageSize(int pageSize)` This method sets a page size.
`void`	`setPageSize(TreeGridRow parent, int size)` Sets a page size value.
`protected void`	`setPagingFlags(Map<TreeGridRow,Boolean> pagingFlags)` Setter for property 'pagingFlags'.
`void`	`setParent(TreeGridRow parent, TreeGridRow child)` Links the child row to the parent.
`void`	`setSortColumn(int sortColumn)` This method sets a number of sort column.
`void`	`setSortColumn(int sortColumn, Comparator<Object> comparator)` This method sets a sort column and uses the specified comparator.
`void`	`setSortColumn(TreeGridRow parent, int column, Comparator<Object> comparator)` This method sets the sort column of the model and sorts the data in the subtree using the specified comparator.
`protected void`	`setSubRows(Map<TreeGridRow,List<TreeGridRow>> subRows)` Setter for property 'subRows'.
`void`	`setSubtreePagingEnabled(TreeGridRow parent, boolean enabled)` Sets subtree paging enabled or disabled.
`void`	`update(int row, int column, Object data)` This method updates the specified cell with the value.
`void`	`update(Object[][] data)` This method updates data in the model using the specified value.
`void`	`update(TreeGridRow parent, int row, int column, Object data)` Updates the specified cell of the subtree with a new value.
`void`	`update(TreeGridRow parent, Object[][] children)` Adds a list of child rows.
`void`	`updateColumn(int columnNumber, Object[] column)` This method updates a column with the specified data set.
`void`	`updateColumn(String name, Object[] column)` This method updates a column with the specified data set.
`void`	`updateRow(int rowNumber, Object[] row)` This method updates a row with the specified data set.
`void`	`updateRow(TreeGridRow parent, int rowNumber, Object[] row)` This method updates a row with the specified data set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TreeGridDataModel
```
public TreeGridDataModel(Object[][] data)
```
    Creates an instance of this class and initializes internal fields.
    
    Parameters:
    data - is a data array to be placed into the model.
  - TreeGridDataModel
```
protected TreeGridDataModel(DataModelCallbackHandler<Editable> handler)
```
    Creates an instance of this class and loads data using the specified handler.
    
    Parameters:
    handler - is a handler instance to load data.
- Method Detail
  - getTotalRowCount
```
public int getTotalRowCount(TreeGridRow parent)
```
    This method gets a total row count for the specified subtree.
    
    Specified by:
    
    getTotalRowCount in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    a total row count value.
  - getRows
```
public TreeGridRow[] getRows(TreeGridRow parent)
```
    Gets a list of child rows.
    
    Specified by:
    
    getRows in interface Composite
    
    Parameters:
    parent - is a parent row that has children.
    
    Returns:
    child rows data
  - addRow
```
public int addRow(TreeGridRow parent,
         Object[] child)
```
    Adds a child row.
    
    Specified by:
    
    addRow in interface Composite
    
    Parameters:
    parent - is a parent row.
    child - row data.
    
    Returns:
    a new row index.
  - update
```
public void update(TreeGridRow parent,
          Object[][] children)
```
    Adds a list of child rows.
    
    Specified by:
    
    update in interface Composite
    
    Parameters:
    parent - is a parent row.
    children - is child rows data.
  - update
```
public void update(TreeGridRow parent,
          int row,
          int column,
          Object data)
```
    Updates the specified cell of the subtree with a new value.
    
    Specified by:
    
    update in interface Composite
    
    Parameters:
    parent - is a parent row of the subtree.
    row - is a row number in the subtree.
    column - is a coulmn number.
    data - is a new value of the cell.
  - removeRow
```
public void removeRow(TreeGridRow parent,
             int row)
```
    Removes the child row.
    
    Specified by:
    
    removeRow in interface Composite
    
    Parameters:
    parent - is a parent row.
    row - is a row number to remove.
  - removeAll
```
public void removeAll(TreeGridRow parent)
```
    Removes all the children of the specified row.
    
    Specified by:
    
    removeAll in interface Composite
    
    Parameters:
    parent - is a parent row.
  - setCurrentPageNumber
```
public void setCurrentPageNumber(TreeGridRow parent,
                        int currentPageNumber)
                          throws IllegalArgumentException
```
    This method sets the current page number in the subtree.
    
    Specified by:
    
    setCurrentPageNumber in interface Composite
    
    Parameters:
    parent - is a parent row.
    currentPageNumber - is a current page number.
    
    Throws:
    
    IllegalArgumentException
  - getTotalPagesNumber
```
public int getTotalPagesNumber(TreeGridRow parent)
```
    This method returns a number of existing pages in the subtree.
    
    Specified by:
    
    getTotalPagesNumber in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    a total pages number.
  - getStartPage
```
public int getStartPage(TreeGridRow parent)
```
    This method returns a start page number in the subtree.
    
    Specified by:
    
    getStartPage in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    is a start page number.
  - getEndPage
```
public int getEndPage(TreeGridRow parent)
```
    This method returns an end page number in the subtree.
    
    Specified by:
    
    getEndPage in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    is an end page number.
  - getDisplayedPages
```
public int getDisplayedPages(TreeGridRow parent)
```
    This method gets the number of pages links to be displayed in the subtree.
    
    Specified by:
    
    getDisplayedPages in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    is a number of pages.
  - setDisplayedPages
```
public void setDisplayedPages(TreeGridRow parent,
                     int displayedPages)
```
    This method sets the number of pages links to be displayed in the subtree.
    
    Specified by:
    
    setDisplayedPages in interface Composite
    
    Parameters:
    parent - is a parent row.
    displayedPages - is a number of pages.
  - getCurrentPageNumber
```
public int getCurrentPageNumber(TreeGridRow parent)
```
    This method gets a current page number in the subtree.
    
    Specified by:
    
    getCurrentPageNumber in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    a current page number.
  - getPageSize
```
public int getPageSize(TreeGridRow parent)
```
    Gets a page size of the subtree.
    
    Specified by:
    
    getPageSize in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    a page size.
  - setPageSize
```
public void setPageSize(TreeGridRow parent,
               int size)
```
    Sets a page size value.
    
    Specified by:
    
    setPageSize in interface Composite
    
    Parameters:
    parent - is a parent row.
    size - is a page size.
  - setSubtreePagingEnabled
```
public void setSubtreePagingEnabled(TreeGridRow parent,
                           boolean enabled)
```
    Sets subtree paging enabled or disabled.
    
    Specified by:
    
    setSubtreePagingEnabled in interface Composite
    
    Parameters:
    parent - is a parent row.
    enabled - is a flag value, true enables paging.
  - isSubtreePagingEnabled
```
public boolean isSubtreePagingEnabled(TreeGridRow parent)
```
    Checks whether subtree paging is enabled.
    
    Specified by:
    
    isSubtreePagingEnabled in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    true if paging is enabled.
  - getRemovedRows
```
public Object[][] getRemovedRows(TreeGridRow parent)
```
    Gets an array of removed rows data.
    
    Specified by:
    
    getRemovedRows in interface Composite
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    an array or removed rows.
  - clearRemovedRows
```
public void clearRemovedRows(TreeGridRow parent)
```
    Cleans the list of removed rows.
    
    Specified by:
    
    clearRemovedRows in interface Composite
    
    Parameters:
    parent - is a parent row.
  - getRow
```
public TreeGridRow getRow(TreeGridRow parent,
                 int index)
```
    Gets a grid row of the subtree by index.
    
    Specified by:
    
    getRow in interface Composite
    
    Parameters:
    parent - is a parent row.
    index - is an index value.
    
    Returns:
    a grid row.
  - setExpandableColumn
```
public void setExpandableColumn(int index)
```
    Sets the expandable column using its index.
    
    Specified by:
    
    setExpandableColumn in interface Composite
    
    Parameters:
    index - is an index value.
  - getExpandableColumn
```
public int getExpandableColumn()
```
    Gets an index of the expandable column.
    
    Specified by:
    
    getExpandableColumn in interface Composite
    
    Returns:
    an expandable column index value.
  - setExpandableColumn
```
public void setExpandableColumn(String name)
```
    Sets the exapandbale column by its name.
    
    Specified by:
    
    setExpandableColumn in interface Composite
    
    Parameters:
    name - is a name pf the expandable column.
  - setSortColumn
```
public void setSortColumn(TreeGridRow parent,
                 int column,
                 Comparator<Object> comparator)
```
    This method sets the sort column of the model and sorts the data in the subtree using the specified comparator.
    
    Specified by:
    
    setSortColumn in interface Composite
    
    Parameters:
    parent - is a parent row of the subtree.
    column - is a column number.
    comparator - is a comparator instance.
  - setParent
```
public void setParent(TreeGridRow parent,
             TreeGridRow child)
```
    Links the child row to the parent.
    Both rows must exist in the model.
    
    Specified by:
    
    setParent in interface Composite
    
    Parameters:
    parent - is a parent row
    child - is a child row to be linked to.
  - getStartRow
```
public int getStartRow(TreeGridRow parent)
```
    Returns a subgrid start row number.
    
    Specified by:
    
    getStartRow in interface Composite
    
    Parameters:
    parent - is a parent row of the subgrid.
    
    Returns:
    a start row number.
  - getEndRow
```
public int getEndRow(TreeGridRow parent)
```
    Returns an end row number of the subgrid.
    
    Specified by:
    
    getEndRow in interface Composite
    
    Parameters:
    parent - is a parent row of the subgrid.
    
    Returns:
    an end row number.
  - updateRow
```
public void updateRow(TreeGridRow parent,
             int rowNumber,
             Object[] row)
               throws IllegalArgumentException
```
    This method updates a row with the specified data set.
    
    Specified by:
    
    updateRow in interface Composite
    
    Parameters:
    parent - is a parent grid row.
    rowNumber - is a row number.
    row - is row data.
    
    Throws:
    
    IllegalArgumentException - if the row number is invalid.
  - addRow
```
public void addRow(int beforeRow,
          Object[] row)
            throws IllegalArgumentException
```
    This method adds a row into the model.
    
    Specified by:
    
    addRow in interface Editable
    
    Parameters:
    beforeRow - is a row number.
    row - is row data.
    
    Throws:
    
    IllegalArgumentException - if the row number is invalid.
  - updateRow
```
public void updateRow(int rowNumber,
             Object[] row)
               throws IllegalArgumentException
```
    This method updates a row with the specified data set.
    
    Specified by:
    
    updateRow in interface Editable
    
    Parameters:
    rowNumber - is a row number.
    row - is row data.
    
    Throws:
    
    IllegalArgumentException - if the row number is invalid.
  - removeRow
```
public void removeRow(int rowNumber)
               throws IllegalArgumentException
```
    This method removes a row from the model.
    
    Specified by:
    
    removeRow in interface Editable
    
    Parameters:
    rowNumber - is a row number.
    
    Throws:
    
    IllegalArgumentException - if the row number is invalid.
  - addColumn
```
public void addColumn(int beforeColumn,
             Object[] column)
               throws IllegalArgumentException
```
    This method adds a column into the model.
    
    Specified by:
    
    addColumn in interface Editable
    
    Parameters:
    beforeColumn - a column number.
    column - a column data set.
    
    Throws:
    
    IllegalArgumentException - if the column number is invalid.
  - addColumn
```
public void addColumn(int beforeColumn,
             String name,
             Object[] column)
               throws IllegalArgumentException
```
    This method adds a column into the model.
    
    Specified by:
    
    addColumn in interface Editable
    
    Parameters:
    beforeColumn - a column number.
    name - a column name.
    column - a column data set.
    
    Throws:
    
    IllegalArgumentException - if the column number is invalid.
  - updateColumn
```
public void updateColumn(int columnNumber,
                Object[] column)
                  throws IllegalArgumentException
```
    This method updates a column with the specified data set.
    
    Specified by:
    
    updateColumn in interface Editable
    
    Parameters:
    columnNumber - a column number.
    column - a column data set.
    
    Throws:
    
    IllegalArgumentException - if the column number is invalid.
  - updateColumn
```
public void updateColumn(String name,
                Object[] column)
```
    This method updates a column with the specified data set.
    
    Specified by:
    
    updateColumn in interface Editable
    
    Parameters:
    name - a column name.
    column - a column data set.
  - removeColumn
```
public void removeColumn(int columnNumber)
                  throws IllegalArgumentException
```
    This method removes a column from the model.
    
    Specified by:
    
    removeColumn in interface Editable
    
    Parameters:
    columnNumber - a column number.
    
    Throws:
    
    IllegalArgumentException - if the column number is invalid.
  - removeColumn
```
public void removeColumn(String name)
```
    This method removes a column from the model.
    
    Specified by:
    
    removeColumn in interface Editable
    
    Parameters:
    name - a column name.
  - removeAll
```
public void removeAll()
```
    This method removes all rows from the model.
    
    Specified by:
    
    removeAll in interface Editable
  - update
```
public void update(int row,
          int column,
          Object data)
            throws IllegalArgumentException
```
    This method updates the specified cell with the value.
    
    Specified by:
    
    update in interface Editable
    
    Parameters:
    row - is a row number.
    column - is a column number.
    data - is a data to be applied.
    
    Throws:
    
    IllegalArgumentException - if row and / or column number is invalid.
  - setSortColumn
```
public void setSortColumn(int sortColumn,
                 Comparator<Object> comparator)
```
    This method sets a sort column and uses the specified comparator.
    
    Specified by:
    
    setSortColumn in interface Editable
    
    Parameters:
    sortColumn - is a sort column.
    comparator - is a column comparator.
  - getHandler
```
public DataModelCallbackHandler<Editable> getHandler()
```
    This method returns a callback handler instance.
    
    Specified by:
    
    getHandler in interface Editable
    
    Returns:
    a callback handler.
  - update
```
public void update(Object[][] data)
```
    This method updates data in the model using the specified value.
    
    Specified by:
    
    update in interface Editable
    
    Parameters:
    data - is a data to be placed.
  - setHandler
```
public void setHandler(DataModelCallbackHandler<Editable> handler)
```
    This method sets a callback handler.
    
    Specified by:
    
    setHandler in interface Editable
    
    Parameters:
    handler - a callback handler.
  - getTotalColumnCount
```
public int getTotalColumnCount()
```
    This method returns a total row count.
    
    Specified by:
    
    getTotalColumnCount in interface Editable
    
    Returns:
    a total row count.
  - getRemovedRows
```
public Object[][] getRemovedRows()
```
    This method returns removed rows.
    
    Specified by:
    
    getRemovedRows in interface Editable
    
    Returns:
    a list of removed rows.
  - clearRemovedRows
```
public void clearRemovedRows()
```
    This method clears removed rows from the model history
    
    Specified by:
    
    clearRemovedRows in interface Editable
  - getRows
```
public GridRow[] getRows()
```
    This method returns all rows of the model.
    
    Specified by:
    
    getRows in interface Editable
    
    Returns:
    a grid row array.
  - getColumns
```
public GridColumn[] getColumns()
```
    Gets an array of all model columns.
    
    Specified by:
    
    getColumns in interface Editable
    
    Returns:
    a columns array.
  - getRow
```
public GridRow getRow(int index)
```
    Gets a grid row by index.
    
    Specified by:
    
    getRow in interface Editable
    
    Parameters:
    index - is an index value.
    
    Returns:
    a grid row.
  - getGridColumn
```
public GridColumn getGridColumn(int index)
```
    Gets a grid column by index.
    
    Specified by:
    
    getGridColumn in interface Editable
    
    Parameters:
    index - is an index value.
    
    Returns:
    a grid column.
  - getColumnNames
```
public String[] getColumnNames()
```
    This method gets a list of column names.
    Size of this list must be equal to the size of the model data array.
    
    Specified by:
    
    getColumnNames in interface Editable
    
    Returns:
    is a list of column names.
  - setColumNames
```
public void setColumNames(String[] names)
```
    This method sets a list of column names
    This list must be in the same order like the data array columns (see Editable.update(Object[][]) for details.
    
    Specified by:
    
    setColumNames in interface Editable
    
    Parameters:
    names - is a list of column names.
  - addListener
```
public void addListener(EditableModelListener listener)
```
    This method registers the specified listener to receive model events.
    
    Specified by:
    
    addListener in interface Editable
    
    Parameters:
    listener - is a model listener to register.
  - removeListener
```
public void removeListener(EditableModelListener listener)
```
    This method unregisters the specified listener to stop model events receiving.
    
    Specified by:
    
    removeListener in interface Editable
    
    Parameters:
    listener - is a model listener to be removed.
  - getTotalRowCount
```
public int getTotalRowCount()
```
    This method returns total row count value.
    
    Specified by:
    
    getTotalRowCount in interface GridDataModel
    
    Returns:
    a total rows number.
  - getStartRow
```
public int getStartRow()
```
    This method returns a start row number.
    
    Specified by:
    
    getStartRow in interface GridDataModel
    
    Returns:
    a start row number.
  - getEndRow
```
public int getEndRow()
```
    This method returns an end row number.
    
    Specified by:
    
    getEndRow in interface GridDataModel
    
    Returns:
    an end row number.
  - getSortColumn
```
public int getSortColumn()
```
    This method returns a sorted column number.
    
    Specified by:
    
    getSortColumn in interface GridDataModel
    
    Returns:
    a sortable column number.
  - isAscending
```
public boolean isAscending()
```
    This method defines sorting direction.
    It returns true if direction is ascending.
    
    Specified by:
    
    isAscending in interface GridDataModel
    
    Returns:
    false if sorting is descending.
  - getRowData
```
public Object[] getRowData(int rowNumber)
```
    This method returns row data by the specified row number.
    
    Specified by:
    
    getRowData in interface GridDataModel
    
    Parameters:
    rowNumber - is a number of row to be returned.
    
    Returns:
    row data.
  - setSortColumn
```
public void setSortColumn(int sortColumn)
```
    This method sets a number of sort column.
    
    Specified by:
    
    setSortColumn in interface GridDataModel
    
    Parameters:
    sortColumn - a number of sort column.
  - setAscending
```
public void setAscending(boolean ascending)
```
    This method sets sort direction.
    
    Specified by:
    
    setAscending in interface GridDataModel
    
    Parameters:
    ascending - sort direction.
  - isEmpty
```
public boolean isEmpty()
```
    This method checks whether the data model is empty.
    
    Specified by:
    
    isEmpty in interface GridDataModel
    
    Returns:
    true if the model is empty.
  - getData
```
public Object[][] getData()
```
    This method returns all the data contained in the model.
    
    Specified by:
    
    getData in interface GridDataModel
    
    Returns:
    data
  - setPageSize
```
public void setPageSize(int pageSize)
```
    This method sets a page size.
    
    Specified by:
    
    setPageSize in interface Pageable
    
    Parameters:
    pageSize - is a page size.
  - setCurrentPageNumber
```
public void setCurrentPageNumber(int currentPageNumber)
                          throws IllegalArgumentException
```
    This method sets the current page number.
    
    Specified by:
    
    setCurrentPageNumber in interface Pageable
    
    Parameters:
    currentPageNumber - is a current page number.
    
    Throws:
    
    IllegalArgumentException - if current page number less then zero or greater then actual number of pages.
  - getTotalPagesNumber
```
public int getTotalPagesNumber()
```
    This method returns a number of existing pages.
    
    Specified by:
    
    getTotalPagesNumber in interface Pageable
    
    Returns:
    a total pages number.
  - getStartPage
```
public int getStartPage()
```
    This method returns a start page number.
    
    Specified by:
    
    getStartPage in interface Pageable
    
    Returns:
    is a start page number.
  - getEndPage
```
public int getEndPage()
```
    This method returns an end page number.
    
    Specified by:
    
    getEndPage in interface Pageable
    
    Returns:
    is an end page number.
  - getDisplayedPages
```
public int getDisplayedPages()
```
    This method gets the number of pages links to be displayed.
    
    Specified by:
    
    getDisplayedPages in interface Pageable
    
    Returns:
    is a number of pages.
  - setDisplayedPages
```
public void setDisplayedPages(int displayedPages)
```
    This method sets the number of pages links to be displayed.
    
    Specified by:
    
    setDisplayedPages in interface Pageable
    
    Parameters:
    displayedPages - is a number of pages.
  - getPageSize
```
public int getPageSize()
```
    This method returns a page size.
    
    Specified by:
    
    getPageSize in interface Pageable
    
    Returns:
    a page size (number of displayable rows).
  - getCurrentPageNumber
```
public int getCurrentPageNumber()
```
    This method gets a current page number.
    
    Specified by:
    
    getCurrentPageNumber in interface Pageable
    
    Returns:
    a current page number.
  - remapIndexes
```
protected void remapIndexes(TreeGridRow parent)
```
    This method remaps indexes in the subtree.
    
    Parameters:
    parent - is a parent row.
  - getRootRows
```
protected TreeGridRow[] getRootRows()
```
    Gets a list of root rows.
    
    Returns:
    a list of root rows.
  - getChildrenList
```
protected List<TreeGridRow> getChildrenList(TreeGridRow parent)
```
    Gets a list of children of the specified parent or creates if it doesn't exist.
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    a list of children.
  - getRemovedRowsList
```
protected List<TreeGridRow> getRemovedRowsList(TreeGridRow parent)
```
    Gets a list of removed rows for the specified parent row or creates a new one if it doesn't exist.
    
    Parameters:
    parent - is a parent row.
    
    Returns:
    a list of removed rows.
  - getSubRows
```
protected Map<TreeGridRow,List<TreeGridRow>> getSubRows()
```
    Getter for property 'subRows'.
    
    Returns:
    Value for property 'subRows'.
  - setSubRows
```
protected void setSubRows(Map<TreeGridRow,List<TreeGridRow>> subRows)
```
    Setter for property 'subRows'.
    
    Parameters:
    subRows - Value to set for property 'subRows'.
  - getPagingFlags
```
protected Map<TreeGridRow,Boolean> getPagingFlags()
```
    Getter for property 'pagingFlags'.
    
    Returns:
    Value for property 'pagingFlags'.
  - setPagingFlags
```
protected void setPagingFlags(Map<TreeGridRow,Boolean> pagingFlags)
```
    Setter for property 'pagingFlags'.
    
    Parameters:
    pagingFlags - Value to set for property 'pagingFlags'.
  - getRemovedRowsMap
```
protected Map<TreeGridRow,List<TreeGridRow>> getRemovedRowsMap()
```
  - getDelegate
```
protected EditableGridDataModel getDelegate()
```
    Getter for property 'delegate'.
    
    Returns:
    Value for property 'delegate'.
  - setDelegate
```
protected void setDelegate(EditableGridDataModel delegate)
```
    Setter for property 'delegate'.
    
    Parameters:
    delegate - Value to set for property 'delegate'.
  - getThisModel
```
protected Composite getThisModel()
```
    This method returns this instance.
    It's required for the internal classes.
    
    Returns:
    is a composite instance (this).
  - fireRowEvent
```
protected void fireRowEvent(EditableModelEvent.EventType eventType,
                TreeGridRow parent,
                int row)
```
    This method fires the CompositeModelEvent.
    
    Parameters:
    eventType - is a concrete event type.
    parent - is a parent row.
    row - is a number of the row that produced this event.

Class TreeGridDataModel

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreeGridDataModel

TreeGridDataModel

Method Detail

getTotalRowCount

getRows

addRow

update

update

removeRow

removeAll

setCurrentPageNumber

getTotalPagesNumber

getStartPage

getEndPage

getDisplayedPages

setDisplayedPages

getCurrentPageNumber

getPageSize

setPageSize

setSubtreePagingEnabled

isSubtreePagingEnabled

getRemovedRows

clearRemovedRows

getRow

setExpandableColumn

getExpandableColumn

setExpandableColumn

setSortColumn

setParent

getStartRow

getEndRow

updateRow

addRow

updateRow

removeRow

addColumn

addColumn

updateColumn

updateColumn

removeColumn

removeColumn

removeAll

update

setSortColumn

getHandler

update

setHandler

getTotalColumnCount

getRemovedRows

clearRemovedRows

getRows

getColumns

getRow

getGridColumn

getColumnNames

setColumNames

addListener

removeListener

getTotalRowCount

getStartRow

getEndRow

getSortColumn

isAscending

getRowData

setSortColumn

setAscending

isEmpty

getData

setPageSize

setCurrentPageNumber

getTotalPagesNumber

getStartPage

getEndPage

getDisplayedPages