Package de.bmiag.tapir.htmlbasic.api

Interface Table<RowType extends TableRow>

Type Parameters:

RowType - type of the table's rows

All Superinterfaces:

Displayable, TapirElement, TypeArgumentAware

All Known Implementing Classes:

DefaultSeleniumTable

public interface Table<RowType extends TableRow>
extends TapirElement, Displayable, TypeArgumentAware

Defines a table. This interface provides methods in order to access a table.

Since:

2.0.0

Author:

Oliver Libutzki <[email protected]>

Method Summary

Modifier and Type	Method	Description
RowType	findSingleVisibleRow(java.util.function.Predicate<? super RowType> rowSearchCriteria)	Returns a single visible TableRow by searching for the row which fulfills the selections criteria.
java.util.List<RowType>	findVisibleRows(java.util.function.Predicate<? super RowType> rowSearchCriteria)	Returns visible TableRows by searching for rows which fulfills the selections criteria.
java.util.List<RowType>	getVisibleRows()	Returns all visible TableRows.

Methods inherited from interface de.bmiag.tapir.ui.api.Displayable

isDisplayed

Methods inherited from interface de.bmiag.tapir.ui.api.TypeArgumentAware

setTypeArguments

Method Detail

getVisibleRows

java.util.List<RowType> getVisibleRows()

Returns all visible TableRows. The rows are ordered by their occurrence on the website.

Returns:

all visible rows of the table

Since:

2.0.0

findSingleVisibleRow

RowType findSingleVisibleRow(java.util.function.Predicate<? super RowType> rowSearchCriteria)

Returns a single visible TableRow by searching for the row which fulfills the selections criteria. Xtend-Usage:

 
 findSingleVisibleRow[column1.text == "Value1" && column2.text == "Value2"]
  

Java-Usage:

 
 findSingleVisibleRow(row -> row.getColumn1().getText().equals("Value1") && row.getColumn2().getText().equals("Value2"))
  

If more than one row matches the criteria the first occurrence is returned. If no row has been found a NoSuchElementException is thrown.

Parameters:

rowSearchCriteria - Criteria which has to be fulfilled

Returns:

the first row which matches the rowSearchCriteria

Throws:

java.util.NoSuchElementException - This exception is thrown if no rows exists that matches the rowSearchCriteria.

Since:

2.0.0

findVisibleRows

java.util.List<RowType> findVisibleRows(java.util.function.Predicate<? super RowType> rowSearchCriteria)

Returns visible TableRows by searching for rows which fulfills the selections criteria. Xtend-Usage:

 
 findVisibleRows[column1.text == "Value1" && column2.text == "Value2"]
  

Java-Usage:

 
 findVisibleRows(row -> row.getColumn1().getText().equals("Value1") && row.getColumn2().getText().equals("Value2"))
  

Parameters:

rowSearchCriteria - Criteria which has to be fulfilled

Returns:

all rows which match the rowSearchCriteria

Since:

2.0.0