SeleniumWTableWebElement (wcomponents-test-lib 1.5.1 API)

java.lang.Object
- com.github.bordertech.wcomponents.test.selenium.element.SeleniumWComponentWebElement
- - com.github.bordertech.wcomponents.test.selenium.element.SeleniumWTableWebElement

All Implemented Interfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement
```
public class SeleniumWTableWebElement
extends SeleniumWComponentWebElement
```
Selenium WebElement class representing a WTable.

Since:

1.2.0

Author:

Joshua Barclay

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ROWS_PER_PAGE_TABLE_ATTRIBUTE` The attribute on the table tag that records how many rows per page.
`static String`	`SELECTOR_CELL_CONTENT` The CSS Selector to find the cell content.
`static String`	`SELECTOR_COLUMN_HEADER` The CSS Selector to find a particular column header.
`static String`	`SELECTOR_COLUMN_HEADER_TEXT` The CSS Selector to find a particular column header's text.
`static String`	`SELECTOR_FIRST_PAGE_BUTTON` The CSS Selector to find the first page button.
`static String`	`SELECTOR_FIRST_ROW_INDEX_OF_PAGE` The CSS Selector to find the first row index of page.
`static String`	`SELECTOR_LAST_PAGE_BUTTON` The CSS Selector to find the last page button.
`static String`	`SELECTOR_LAST_ROW_INDEX_OF_PAGE` The CSS Selector to find the last row index of page.
`static String`	`SELECTOR_NEXT_PAGE_BUTTON` The CSS Selector to find the next page button.
`static String`	`SELECTOR_PAGE_SELECT` The CSS Selector for the page select.
`static String`	`SELECTOR_PREVIOUS_PAGE_BUTTON` The CSS Selector to find the previous page button.
`static String`	`SELECTOR_ROWS_PER_PAGE_SELECT` The CSS Selector for the rows per page select.
`static String`	`SELECTOR_TABLE_CAPTION` The CSS Selector for the table caption.
`static String`	`SELECTOR_TOTAL_ROWS` The CSS Selector to find the last result of page.
`static String`	`TABLE_CHILD_TAG_NAME` The incorrect tag name that might be selected - the name of the child table element.
`static String`	`TABLE_DIV_CLASS` The div class representing the table.
`static String`	`TABLE_HEADER_TAG_NAME` The tag name for the header.
`static String`	`TABLE_TAG_NAME` The table itself is a 'table' entity, but the element containing all the controls is the wrapper div.

Constructor Summary

Constructors
Constructor and Description
`SeleniumWTableWebElement(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver)` Default constructor for this element.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SeleniumSimpleSelectWebElement`	`findSeleniumSimpleSelectWebElement(org.openqa.selenium.By by)`
`SeleniumWComponentWebElement`	`getCellContent(int rowIndex, int columnIndex)` Get the content of the cell.
`String`	`getCellText(int rowIndex, int columnIndex)` Get the text of the cell.
`int`	`getCurrentPage()`
`SeleniumWComponentWebElement`	`getFirstPageButton()`
`int`	`getFirstRowIndexOfPage()`
`SeleniumWComponentWebElement`	`getHeaderForColumn(int columnIndex)` Get the TH element for the given column index.
`String`	`getHeaderTextForColumn(int columnIndex)` Get the header text for the given column index.
`SeleniumWComponentWebElement`	`getLastPageButton()`
`int`	`getLastRowIndexOfPage()`
`SeleniumWComponentWebElement`	`getNextPageButton()`
`SeleniumSimpleSelectWebElement`	`getPageSelect()`
`SeleniumWComponentWebElement`	`getPreviousPageButton()`
`int`	`getRowsPerPage()`
`SeleniumSimpleSelectWebElement`	`getRowsPerPageSelect()`
`SeleniumWComponentWebElement`	`getTable()`
`String`	`getTableCaption()`
`SeleniumWComponentWebElement`	`getTableHeader()`
`int`	`getTotalPages()`
`int`	`getTotalRows()`

Methods inherited from class com.github.bordertech.wcomponents.test.selenium.element.SeleniumWComponentWebElement
clear, click, clickElementNoWait, clickNoWait, findElement, findElementImmediate, findElements, findElementsImmediate, getActiveId, getAttribute, getCssValue, getDriver, getElement, getLocation, getRect, getScreenshotAs, getSize, getTagName, getText, getUserContextForSession, isDisplayed, isEnabled, isHidden, isSelected, sendKeys, sendKeys, submit, waitForPageReady, wrapElement

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TABLE_TAG_NAME
```
public static final String TABLE_TAG_NAME
```
    The table itself is a 'table' entity, but the element containing all the controls is the wrapper div.
    
    See Also:
    
    Constant Field Values
  - TABLE_CHILD_TAG_NAME
```
public static final String TABLE_CHILD_TAG_NAME
```
    The incorrect tag name that might be selected - the name of the child table element.
    
    See Also:
    
    Constant Field Values
  - TABLE_HEADER_TAG_NAME
```
public static final String TABLE_HEADER_TAG_NAME
```
    The tag name for the header.
    
    See Also:
    
    Constant Field Values
  - TABLE_DIV_CLASS
```
public static final String TABLE_DIV_CLASS
```
    The div class representing the table.
    
    See Also:
    
    Constant Field Values
  - ROWS_PER_PAGE_TABLE_ATTRIBUTE
```
public static final String ROWS_PER_PAGE_TABLE_ATTRIBUTE
```
    The attribute on the table tag that records how many rows per page.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_TABLE_CAPTION
```
public static final String SELECTOR_TABLE_CAPTION
```
    The CSS Selector for the table caption.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_FIRST_ROW_INDEX_OF_PAGE
```
public static final String SELECTOR_FIRST_ROW_INDEX_OF_PAGE
```
    The CSS Selector to find the first row index of page.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_LAST_ROW_INDEX_OF_PAGE
```
public static final String SELECTOR_LAST_ROW_INDEX_OF_PAGE
```
    The CSS Selector to find the last row index of page.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_TOTAL_ROWS
```
public static final String SELECTOR_TOTAL_ROWS
```
    The CSS Selector to find the last result of page.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_FIRST_PAGE_BUTTON
```
public static final String SELECTOR_FIRST_PAGE_BUTTON
```
    The CSS Selector to find the first page button.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_PREVIOUS_PAGE_BUTTON
```
public static final String SELECTOR_PREVIOUS_PAGE_BUTTON
```
    The CSS Selector to find the previous page button.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_NEXT_PAGE_BUTTON
```
public static final String SELECTOR_NEXT_PAGE_BUTTON
```
    The CSS Selector to find the next page button.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_LAST_PAGE_BUTTON
```
public static final String SELECTOR_LAST_PAGE_BUTTON
```
    The CSS Selector to find the last page button.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_PAGE_SELECT
```
public static final String SELECTOR_PAGE_SELECT
```
    The CSS Selector for the page select.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_ROWS_PER_PAGE_SELECT
```
public static final String SELECTOR_ROWS_PER_PAGE_SELECT
```
    The CSS Selector for the rows per page select.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_COLUMN_HEADER
```
public static final String SELECTOR_COLUMN_HEADER
```
    The CSS Selector to find a particular column header.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_COLUMN_HEADER_TEXT
```
public static final String SELECTOR_COLUMN_HEADER_TEXT
```
    The CSS Selector to find a particular column header's text.
    
    See Also:
    
    Constant Field Values
  - SELECTOR_CELL_CONTENT
```
public static final String SELECTOR_CELL_CONTENT
```
    The CSS Selector to find the cell content.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SeleniumWTableWebElement
```
public SeleniumWTableWebElement(org.openqa.selenium.WebElement element,
                                org.openqa.selenium.WebDriver driver)
```
    Default constructor for this element.
    
    Parameters:
    
    element - the WebElement
    
    driver - the driver.
- Method Detail
  - getFirstRowIndexOfPage
```
public int getFirstRowIndexOfPage()
```
    Returns:
    
    the index of the first row displayed on the current page.
  - getLastRowIndexOfPage
```
public int getLastRowIndexOfPage()
```
    Returns:
    
    the index of the last row displayed on the current page.
  - getTotalRows
```
public int getTotalRows()
```
    Returns:
    
    the total number of rows in the table..
  - getTable
```
public SeleniumWComponentWebElement getTable()
```
    Returns:
    
    the actual table element within the elements that make up an advanced WComponent table.
  - getFirstPageButton
```
public SeleniumWComponentWebElement getFirstPageButton()
```
    Returns:
    
    the first page button for pagination.
  - getPreviousPageButton
```
public SeleniumWComponentWebElement getPreviousPageButton()
```
    Returns:
    
    the previous page button for pagination.
  - getNextPageButton
```
public SeleniumWComponentWebElement getNextPageButton()
```
    Returns:
    
    the next page button for pagination.
  - getLastPageButton
```
public SeleniumWComponentWebElement getLastPageButton()
```
    Returns:
    
    the last page button for pagination.
  - getPageSelect
```
public SeleniumSimpleSelectWebElement getPageSelect()
```
    Returns:
    
    the page select.
  - getRowsPerPageSelect
```
public SeleniumSimpleSelectWebElement getRowsPerPageSelect()
```
    Returns:
    
    the page select.
  - getCurrentPage
```
public int getCurrentPage()
```
    Returns:
    
    the current page of the paginated data.
  - getTotalPages
```
public int getTotalPages()
```
    Returns:
    
    the total number of pages.
  - getRowsPerPage
```
public int getRowsPerPage()
```
    Returns:
    
    the number of rows per page.
  - getTableCaption
```
public String getTableCaption()
```
    Returns:
    
    the table caption.
  - getTableHeader
```
public SeleniumWComponentWebElement getTableHeader()
```
    Returns:
    
    the table header.
  - getHeaderForColumn
```
public SeleniumWComponentWebElement getHeaderForColumn(int columnIndex)
```
    Get the TH element for the given column index.
    
    Parameters:
    
    columnIndex - the column index.
    
    Returns:
    
    the TH element.
  - getHeaderTextForColumn
```
public String getHeaderTextForColumn(int columnIndex)
```
    Get the header text for the given column index.
    
    Parameters:
    
    columnIndex - the column index.
    
    Returns:
    
    the header text.
  - getCellContent
```
public SeleniumWComponentWebElement getCellContent(int rowIndex,
                                                   int columnIndex)
```
    Get the content of the cell.
    
    Parameters:
    
    rowIndex - the row index, 0-based.
    
    columnIndex - the column index, 0-based.
    
    Returns:
    
    the cell's content.
  - getCellText
```
public String getCellText(int rowIndex,
                          int columnIndex)
```
    Get the text of the cell.
    
    Parameters:
    
    rowIndex - the row index, 0-based.
    
    columnIndex - the column index, 0-based.
    
    Returns:
    
    the text of the cell.
  - findSeleniumSimpleSelectWebElement
```
public SeleniumSimpleSelectWebElement findSeleniumSimpleSelectWebElement(org.openqa.selenium.By by)
```
    Parameters:
    
    by - the by to find the component.
    
    Returns:
    
    the SeleniumSimpleSelectWebElement.

Class SeleniumWTableWebElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.github.bordertech.wcomponents.test.selenium.element.SeleniumWComponentWebElement

Methods inherited from class java.lang.Object

Field Detail

TABLE_TAG_NAME

TABLE_CHILD_TAG_NAME

TABLE_HEADER_TAG_NAME

TABLE_DIV_CLASS

ROWS_PER_PAGE_TABLE_ATTRIBUTE

SELECTOR_TABLE_CAPTION

SELECTOR_FIRST_ROW_INDEX_OF_PAGE

SELECTOR_LAST_ROW_INDEX_OF_PAGE

SELECTOR_TOTAL_ROWS

SELECTOR_FIRST_PAGE_BUTTON

SELECTOR_PREVIOUS_PAGE_BUTTON

SELECTOR_NEXT_PAGE_BUTTON

SELECTOR_LAST_PAGE_BUTTON

SELECTOR_PAGE_SELECT

SELECTOR_ROWS_PER_PAGE_SELECT

SELECTOR_COLUMN_HEADER

SELECTOR_COLUMN_HEADER_TEXT

SELECTOR_CELL_CONTENT

Constructor Detail

SeleniumWTableWebElement

Method Detail

getFirstRowIndexOfPage

getLastRowIndexOfPage

getTotalRows

getTable

getFirstPageButton

getPreviousPageButton

getNextPageButton

getLastPageButton

getPageSelect

getRowsPerPageSelect

getCurrentPage

getTotalPages

getRowsPerPage

getTableCaption

getTableHeader

getHeaderForColumn

getHeaderTextForColumn

getCellContent

getCellText

findSeleniumSimpleSelectWebElement