org.gwt.advanced.client.datamodel

Interface Composite

All Superinterfaces:

Editable, GridDataModel, Pageable

All Known Implementing Classes:

LazyTreeGridDataModel, TreeGridDataModel

public interface Composite
extends Editable

This interface describes tree grid data model.

Since:

1.4.0

Author:

Sergey Skladchikov

Method Summary

Methods

Modifier and Type	Method and Description
int	addRow(TreeGridRow parent, Object[] child) Adds a child row.
void	clearRemovedRows(TreeGridRow parent) Cleans the list of removed rows.
int	getCurrentPageNumber(TreeGridRow parent) This method gets a current page number in the subtree.
int	getDisplayedPages(TreeGridRow parent) This method gets the number of pages links to be displayed in the subtree.
int	getEndPage(TreeGridRow parent) This method returns an end page number in the subtree.
int	getEndRow(TreeGridRow parent) Returns an end row number of the subgrid.
int	getExpandableColumn() Gets an index of the expandable column.
int	getPageSize(TreeGridRow parent) Gets a page size of the subtree.
Object[][]	getRemovedRows(TreeGridRow parent) Gets an array of removed rows data.
TreeGridRow	getRow(TreeGridRow parent, int index) Gets a grid row of the subtree by index.
TreeGridRow[]	getRows(TreeGridRow parent) Gets a list of child rows.
int	getStartPage(TreeGridRow parent) This method returns a start page number in the subtree.
int	getStartRow(TreeGridRow parent) Returns a subgrid start row number.
int	getTotalPagesNumber(TreeGridRow parent) This method returns a number of existing pages in the subtree.
int	getTotalRowCount(TreeGridRow parent) This method gets a total row count for the specified subtree.
boolean	isSubtreePagingEnabled(TreeGridRow parent) Checks whether subtree paging is enabled.
void	removeAll(TreeGridRow parent) Removes all the children of the specified row.
void	removeRow(TreeGridRow parent, int row) Removes the child row.
void	setCurrentPageNumber(TreeGridRow parent, int currentPageNumber) This method sets the current page number in the subtree.
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	setPageSize(TreeGridRow parent, int size) Sets a page size value.
void	setParent(TreeGridRow parent, TreeGridRow child) Links the child row to the parent.
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.
void	setSubtreePagingEnabled(TreeGridRow parent, boolean enabled) Sets subtree paging enabled or disabled.
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	updateRow(TreeGridRow parent, int rowNumber, Object[] row) This method updates a row with the specified data set.

Methods inherited from interface org.gwt.advanced.client.datamodel.Editable

addColumn, addColumn, addListener, addRow, clearRemovedRows, getColumnNames, getColumns, getGridColumn, getHandler, getRemovedRows, getRow, getRows, getTotalColumnCount, removeAll, removeColumn, removeColumn, removeListener, removeRow, setColumNames, setHandler, setSortColumn, update, update, updateColumn, updateColumn, updateRow

Methods inherited from interface org.gwt.advanced.client.datamodel.GridDataModel

getData, getEndRow, getRowData, getSortColumn, getStartRow, getTotalRowCount, isAscending, isEmpty, setAscending, setSortColumn

Methods inherited from interface org.gwt.advanced.client.datamodel.Pageable

getCurrentPageNumber, getDisplayedPages, getEndPage, getPageSize, getStartPage, getTotalPagesNumber, setCurrentPageNumber, setDisplayedPages, setPageSize

Method Detail

getTotalRowCount

int getTotalRowCount(TreeGridRow parent)

This method gets a total row count for the specified subtree.

Parameters:

parent - is a parent row.

Returns:

a total row count value.

getRows

TreeGridRow[] getRows(TreeGridRow parent)

Gets a list of child rows.

Parameters:

parent - is a parent row that has children.

Returns:

child rows data

addRow

int addRow(TreeGridRow parent,
         Object[] child)

Adds a child row.

Parameters:

parent - is a parent row.

child - row data.

Returns:

a new row index.

update

void update(TreeGridRow parent,
          Object[][] children)

Adds a list of child rows.

Parameters:

parent - is a parent row.

children - is child rows data.

update

void update(TreeGridRow parent,
          int row,
          int column,
          Object data)

Updates the specified cell of the subtree with a new value.

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

void removeRow(TreeGridRow parent,
             int row)

Removes the child row.

Parameters:

parent - is a parent row.

row - is a row number to remove.

removeAll

void removeAll(TreeGridRow parent)

Removes all the children of the specified row.

Parameters:

parent - is a parent row.

setCurrentPageNumber

void setCurrentPageNumber(TreeGridRow parent,
                        int currentPageNumber)

This method sets the current page number in the subtree.

Parameters:

parent - is a parent row.

currentPageNumber - is a current page number.

getTotalPagesNumber

int getTotalPagesNumber(TreeGridRow parent)

This method returns a number of existing pages in the subtree.

Parameters:

parent - is a parent row.

Returns:

a total pages number.

getStartPage

int getStartPage(TreeGridRow parent)

This method returns a start page number in the subtree.

Parameters:

parent - is a parent row.

Returns:

is a start page number.

getEndPage

int getEndPage(TreeGridRow parent)

This method returns an end page number in the subtree.

Parameters:

parent - is a parent row.

Returns:

is an end page number.

getDisplayedPages

int getDisplayedPages(TreeGridRow parent)

This method gets the number of pages links to be displayed in the subtree.

Parameters:

parent - is a parent row.

Returns:

is a number of pages.

setDisplayedPages

void setDisplayedPages(TreeGridRow parent,
                     int displayedPages)

This method sets the number of pages links to be displayed in the subtree.

Parameters:

parent - is a parent row.

displayedPages - is a number of pages.

getCurrentPageNumber

int getCurrentPageNumber(TreeGridRow parent)

This method gets a current page number in the subtree.

Parameters:

parent - is a parent row.

Returns:

a current page number.

getPageSize

int getPageSize(TreeGridRow parent)

Gets a page size of the subtree.

Parameters:

parent - is a parent row.

Returns:

a page size.

setPageSize

void setPageSize(TreeGridRow parent,
               int size)

Sets a page size value.

Parameters:

parent - is a parent row.

size - is a page size.

setSubtreePagingEnabled

void setSubtreePagingEnabled(TreeGridRow parent,
                           boolean enabled)

Sets subtree paging enabled or disabled.

Parameters:

parent - is a parent row.

enabled - is a flag value, true enables paging.

isSubtreePagingEnabled

boolean isSubtreePagingEnabled(TreeGridRow parent)

Checks whether subtree paging is enabled.

Parameters:

parent - is a parent row.

Returns:

true if paging is enabled.

getRemovedRows

Object[][] getRemovedRows(TreeGridRow parent)

Gets an array of removed rows data.

Parameters:

parent - is a parent row.

Returns:

an array or removed rows.

clearRemovedRows

void clearRemovedRows(TreeGridRow parent)

Cleans the list of removed rows.

Parameters:

parent - is a parent row.

getRow

TreeGridRow getRow(TreeGridRow parent,
                 int index)

Gets a grid row of the subtree by index.

Parameters:

parent - is a parent row.

index - is an index value.

Returns:

a grid row.

setExpandableColumn

void setExpandableColumn(int index)

Sets the expandable column using its index.

Parameters:

index - is an index value.

getExpandableColumn

int getExpandableColumn()

Gets an index of the expandable column.

Returns:

an expandable column index value.

setExpandableColumn

void setExpandableColumn(String name)

Sets the exapandbale column by its name.

Parameters:

name - is a name pf the expandable column.

setSortColumn

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.

Parameters:

parent - is a parent row of the subtree.

column - is a column number.

comparator - is a comparator instance.

setParent

void setParent(TreeGridRow parent,
             TreeGridRow child)

Links the child row to the parent.

Both rows must exist in the model.

Parameters:

parent - is a parent row

child - is a child row to be linked to.

getStartRow

int getStartRow(TreeGridRow parent)

Returns a subgrid start row number.

Parameters:

parent - is a parent row of the subgrid.

Returns:

a start row number.

getEndRow

int getEndRow(TreeGridRow parent)

Returns an end row number of the subgrid.

Parameters:

parent - is a parent row of the subgrid.

Returns:

an end row number.

updateRow

void updateRow(TreeGridRow parent,
             int rowNumber,
             Object[] row)
               throws IllegalArgumentException

This method updates a row with the specified data set.

Parameters:

parent - is a parent grid row.

rowNumber - is a row number.

row - is row data.

Throws:

IllegalArgumentException - if the row number is invalid.