com.whitestein.lsps.test.web.components

Class LspsTable

java.lang.Object

com.whitestein.lsps.test.web.components.UIFinder

com.whitestein.lsps.test.web.components.UIComponent

com.whitestein.lsps.test.web.components.LspsTable

public class LspsTable
extends UIComponent

Client-side Table image.

Author:

mvy

Field Summary

Fields inherited from class com.whitestein.lsps.test.web.components.UIComponent

element

Fields inherited from class com.whitestein.lsps.test.web.components.UIFinder

context

Constructor Summary

Constructors

Constructor and Description
LspsTable(VerticalLayoutElement element)

Method Summary

Modifier and Type	Method and Description
LspsTableColumn	findSortColumn() If the table is sorted by a column, returns the column in question.
UIComponent	getCell(int row, int col) Returns the cell component for given row and column.
LspsTableColumn	getColumn(int column) Returns the table column component.
String[]	getColumnCaptions() Returns the currently shown column captions.
int	getColumnCount() Returns the number of columns this table has.
Pager	getPager() Returns the pager for this table.
int	getVisibleRowCount() Returns the number of rows the table is currently showing.
String	toString()

Methods inherited from class com.whitestein.lsps.test.web.components.UIComponent

as, findAll, getErrorMessage, getHint, getId, getModelingId, isValid, isVisible, toHTML, toInnerHTML

Methods inherited from class com.whitestein.lsps.test.web.components.UIFinder

$, clickButton, contains, find, getDriver, waitForVaadin

Methods inherited from class java.lang.Object

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

Constructor Detail

LspsTable

public LspsTable(VerticalLayoutElement element)

Method Detail

getCell

public UIComponent getCell(int row,
                           int col)

Returns the cell component for given row and column.

Warning - on both paged and lazy tables the row 0 does not necessarily represent the first row retrieved from the data source.

There is currently no way to retrieve information about row count.

Parameters:

row - the 0-based row index.

col - the 0-based column index.

Returns:

the component, not null

Throws:

NoSuchElementException - if either row or col is out of bounds (the table does not contain such cell).

getColumn

public LspsTableColumn getColumn(int column)

Returns the table column component.

Only visible columns are retrieved - it is impossible to retrieve invisible columns.

Parameters:

column - the 0-based column index.

Returns:

table column.

Throws:

NoSuchElementException - if the column index is out of bounds (equal or higher than the getColumnCount())

getColumnCount

public int getColumnCount()

Returns the number of columns this table has. Only visible columns are counted towards this count.

Returns:

the column count, 0 or greater.

getVisibleRowCount

public int getVisibleRowCount()

Returns the number of rows the table is currently showing. For paged table, this is never higher than the current page length.

Returns:

shown row count, 0 or greater.

toString

public String toString()

Overrides:

toString in class UIComponent

findSortColumn

public LspsTableColumn findSortColumn()

If the table is sorted by a column, returns the column in question. If not, returns null.

Returns:

the column the table is currently sorted by, or null if the table is not sorted.

getPager

public Pager getPager()

Returns the pager for this table.

Returns:

the pager for this table. Returns null if this is not a table with paging.

getColumnCaptions

public String[] getColumnCaptions()

Returns the currently shown column captions.

Returns:

the column captions, may be empty if the table has no visible columns.