co.boorse.seleniumtable

Interface SeleniumTable

All Superinterfaces:

ElementContainer, Iterable<SeleniumTableRow>

public interface SeleniumTable
extends Iterable<SeleniumTableRow>, ElementContainer

Interface describing a table element that we can interact with in selenium.

Method Summary

Modifier and Type	Method and Description
SeleniumTable	body() Gets a table containing the tbody content.
SeleniumTable	foot() Gets a table containing the tfoot content.
SeleniumTableRow	get(int rowIndex) Gets an individual table row by its index in the rows in this table
SeleniumTableCell	get(int rowIndex, int columnIndex) Gets an individual table cell by its row index and column index in the rows in this table
String	getCaption() y Gets the table <caption> if present.
List<SeleniumTableCell>	getColumn(String columnName) Gets the List of all cells under the given column name.
static SeleniumTable	getInstance(org.openqa.selenium.WebElement tableElement) Gets an instance of SeleniumTable with the base table element provided.
boolean	hasCaption() Gets a flag indicating whether or not the table has a <caption> element.
boolean	hasColumn(String columnName) Gets a flag indicating whether or not the provided column name is present in the table.
boolean	hasHeaderRow() Gets a flag indicating whether or not the table has a header row.
boolean	hasTBody() Gets a flag indicating whether or not the table has a tbody element.
boolean	hasTFoot() Gets a flag indicating whether or not the table has a tfoot element.
boolean	hasTHead() Gets a flag indicating whether or not the table has a thead element.
SeleniumTable	head() Gets a table containing the thead content.
SeleniumTableRow	headerRow() Gets the SeleniumTableRow that is the header for this table.
int	rowCount() Gets the total number of rows in this table
List<SeleniumTableRow>	rows() Gets a list of all rows in the table.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface co.boorse.seleniumtable.ElementContainer

getElement

Method Detail

getInstance

static SeleniumTable getInstance(org.openqa.selenium.WebElement tableElement)

Gets an instance of SeleniumTable with the base table element provided.

Parameters:

tableElement - the base table element

Returns:

an instance of SeleniumTable.

get

SeleniumTableRow get(int rowIndex)

Gets an individual table row by its index in the rows in this table

Parameters:

rowIndex - zero-based row index (top to bottom)

Returns:

an instance of SeleniumTableRowImpl

Throws:

IndexOutOfBoundsException - if the row index is out of bounds

get

SeleniumTableCell get(int rowIndex,
                      int columnIndex)

Gets an individual table cell by its row index and column index in the rows in this table

Parameters:

rowIndex - zero-based row index (top to bottom)

columnIndex - zero-based column index (left to right)

Returns:

an instance of SeleniumTableCellImpl

Throws:

IndexOutOfBoundsException - if either index is out of bounds

getColumn

List<SeleniumTableCell> getColumn(String columnName)

Gets the List of all cells under the given column name. A column name corresponds to the text value of a <th> element somewhere in the table.

Parameters:

columnName - the name of the column to get cells for

Returns:

List of SeleniumTableCell

Throws:

UnsupportedOperationException - if there is no header row in the table

IllegalArgumentException - if the provided column name cannot be found in the header row

hasColumn

boolean hasColumn(String columnName)

Gets a flag indicating whether or not the provided column name is present in the table. A column name corresponds to the text value of a <th> element somewhere in the table.

Parameters:

columnName - the name of the column

Returns:

true if the column text is found in a <th> element, otherwise false

rows

List<SeleniumTableRow> rows()

Gets a list of all rows in the table. Note that this method is able to fall back to using the tbody rows which allows us to iterate over the root table object instead of having to call body()) all the time.

Returns:

List of SeleniumTableRow

rowCount

int rowCount()

Gets the total number of rows in this table

Returns:

the row count

head

SeleniumTable head()

Gets a table containing the thead content.

Returns:

SeleniumTable for the head

body

SeleniumTable body()

Gets a table containing the tbody content.

Returns:

SeleniumTable for the body

foot

SeleniumTable foot()

Gets a table containing the tfoot content.

Returns:

SeleniumTable for the foot

hasTBody

boolean hasTBody()

Gets a flag indicating whether or not the table has a tbody element.

Returns:

true if present, otherwise false

hasTHead

boolean hasTHead()

Gets a flag indicating whether or not the table has a thead element.

Returns:

true if present, otherwise false

hasTFoot

boolean hasTFoot()

Gets a flag indicating whether or not the table has a tfoot element.

Returns:

true if present, otherwise false

headerRow

SeleniumTableRow headerRow()

Gets the SeleniumTableRow that is the header for this table.

Returns:

null if no header row, otherwise a SeleniumTableRow

hasHeaderRow

boolean hasHeaderRow()

Gets a flag indicating whether or not the table has a header row.

Returns:

true if a header row is present, otherwise false

getCaption

String getCaption()

y Gets the table <caption> if present.

Returns:

null if no caption element, otherwise a string

hasCaption

boolean hasCaption()

Gets a flag indicating whether or not the table has a <caption> element.

Returns:

true if present, otherwise false