com.whitestein.lsps.test.web.components

Class LspsTableColumn

java.lang.Object

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

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

com.whitestein.lsps.test.web.components.LspsTableColumn

public class LspsTableColumn
extends UIComponent

Represents a table column. Acquire instances via LspsTable.getColumn(int).

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
int	index The index of the column, 0-based.
LspsTable	table Owner table, not null.

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
LspsTableColumn(TableHeaderElement element, int index, LspsTable table)

Method Summary

Modifier and Type	Method and Description
void	click() Clicks the table header.
String	getCaption() Returns the column caption.
UIComponent	getCell(int row) Returns the cell component for this column, for given row.
boolean	isSorted() Checks if the table is sorted by this column, either ascendant or descendant.
boolean	isSortedAsc() Returns true if the table is currently sorted by this column, ascendant.
boolean	isSortedDesc() Returns true if the table is currently sorted by this column, descendant.
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

Field Detail

table

public final LspsTable table

Owner table, not null.

index

public final int index

The index of the column, 0-based.

Constructor Detail

LspsTableColumn

public LspsTableColumn(TableHeaderElement element,
                       int index,
                       LspsTable table)

Method Detail

getCaption

public String getCaption()

Returns the column caption.

Returns:

the column caption.

toString

public String toString()

Overrides:

toString in class UIComponent

isSortedAsc

public boolean isSortedAsc()

Returns true if the table is currently sorted by this column, ascendant.

Returns:

true if the table is currently sorted by this column, ascendant, false if the table is not sorted at all, sorted by some other column or is sorted by this column, descendant.

isSortedDesc

public boolean isSortedDesc()

Returns true if the table is currently sorted by this column, descendant.

Returns:

true if the table is currently sorted by this column, descendant, false if the table is not sorted at all, sorted by some other column or is sorted by this column, ascendant.

isSorted

public boolean isSorted()

Checks if the table is sorted by this column, either ascendant or descendant.

Returns:

true if this column has sorting indicator, false if the table is currently unsorted, or is sorted by some other column.

getCell

public UIComponent getCell(int row)

Returns the cell component for this column, for given row.

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.

Returns:

the component, not null

Throws:

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

click

public void click()

Clicks the table header. If this column is sortable, the table is sorted by this column.