org.gwt.advanced.client.datamodel

Class TreeGridRow

java.lang.Object

org.gwt.advanced.client.datamodel.GridRow

org.gwt.advanced.client.datamodel.TreeGridRow

All Implemented Interfaces:

IndexedEntity, Pageable

Direct Known Subclasses:

LazyTreeGridRow

public class TreeGridRow
extends GridRow
implements Pageable

This is a tree index implementation for the tree grid data models.

Since:

1.4.0

Author:

Sergey Skladchikov

Constructor Summary

Constructors

Modifier	Constructor and Description
	TreeGridRow() Always throws UnsupportedOperationException.
protected	TreeGridRow(Composite model) Creates an instnace of this class and initilizes the internal fields.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCurrentPageNumber() This method gets a current page number.
int	getDisplayedPages() This method gets the number of pages links to be displayed.
int	getEndPage() This method returns an end page number.
int	getLevel() Gets a level number of this row trying to iterate through all the parents.
protected GridDataModel	getModel() Getter for property 'model'.
protected Pageable	getPageable() Getter for property 'pageable'.
int	getPageSize() This method returns a page size.
TreeGridRow	getParent() Getter for property 'parent'.
int	getStartPage() This method returns a start page number.
int	getTotalPagesNumber() This method returns a number of existing pages.
boolean	isExpanded() Getter for property 'expanded'.
boolean	isPagerEnabled() Getter for property 'pagerEnabled'.
void	setCurrentPageNumber(int currentPageNumber) This method sets the current page number.
void	setDisplayedPages(int displayedPages) This method sets the number of pages links to be displayed.
void	setExpanded(boolean expanded) Setter for property 'expanded'.
protected void	setModel(Composite model) Setter for property 'model'.
protected void	setPageable(Pageable pageable) Setter for property 'pageable'.
void	setPagerEnabled(boolean pagerEnabled) Setter for property 'pagerEnabled'.
void	setPageSize(int pageSize) This method sets a page size.
void	setParent(TreeGridRow parent) Setter for property 'parent'.

Methods inherited from class org.gwt.advanced.client.datamodel.GridRow

add, add, equals, generateUniqueString, get, getData, getDelegate, getIdentifier, getIndex, hashCode, remove, set, setData, setIdentifier, setIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeGridRow

public TreeGridRow()

Always throws UnsupportedOperationException.

TreeGridRow

protected TreeGridRow(Composite model)

Creates an instnace of this class and initilizes the internal fields.

Parameters:

model - is a grid data model that contains this row.

Method Detail

getParent

public TreeGridRow getParent()

Getter for property 'parent'.

Returns:

Value for property 'parent'.

setParent

public void setParent(TreeGridRow parent)

Setter for property 'parent'.

Parameters:

parent - Value to set for property 'parent'.

getLevel

public int getLevel()

Gets a level number of this row trying to iterate through all the parents.

Returns:

a level number. 0 if it's a root row.

isExpanded

public boolean isExpanded()

Getter for property 'expanded'.

Returns:

Value for property 'expanded'.

setExpanded

public void setExpanded(boolean expanded)

Setter for property 'expanded'.

Parameters:

expanded - Value to set for property 'expanded'.

isPagerEnabled

public boolean isPagerEnabled()

Getter for property 'pagerEnabled'.

Returns:

Value for property 'pagerEnabled'.

setPagerEnabled

public void setPagerEnabled(boolean pagerEnabled)

Setter for property 'pagerEnabled'.

Parameters:

pagerEnabled - Value to set for property 'pagerEnabled'.

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.

getPageSize

public int getPageSize()

This method returns a page size.

Specified by:

getPageSize in interface Pageable

Returns:

a page size (number of displayable rows).

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.

getCurrentPageNumber

public int getCurrentPageNumber()

This method gets a current page number.

Specified by:

getCurrentPageNumber in interface Pageable

Returns:

a current page number.

setPageSize

public void setPageSize(int pageSize)

This method sets a page size.

Specified by:

setPageSize in interface Pageable

Parameters:

pageSize - is a page size.

getModel

protected GridDataModel getModel()

Getter for property 'model'.

Returns:

Value for property 'model'.

setModel

protected void setModel(Composite model)

Setter for property 'model'.

Parameters:

model - Value to set for property 'model'.

getPageable

protected Pageable getPageable()

Getter for property 'pageable'.

Returns:

Value for property 'pageable'.

setPageable

protected void setPageable(Pageable pageable)

Setter for property 'pageable'.

Parameters:

pageable - Value to set for property 'pageable'.