We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.grid.testbench.
Class GridElement
- java.lang.Object
-
- com.vaadin.testbench.TestBenchElement
-
- com.vaadin.flow.component.grid.testbench.GridElement
-
All Implemented Interfaces:
CanCompareScreenshots, HasCallFunction, HasDriver, HasElementQuery, HasPropertySettersGetters, HasSearchContext, HasTestBenchCommandExecutor, org.openqa.selenium.internal.WrapsElement, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement
public class GridElement extends TestBenchElementA TestBench element representing a
<vaadin-grid>element.
-
-
Constructor Summary
Constructors Constructor and Description GridElement()
-
Method Summary
All Methods Modifier and Type Method and Description voiddeselect(int rowIndex)Deselects the row with the given index.
protected voidgeneratedColumnIdsIfNeeded()List<GridColumnElement>getAllColumns()Gets all columns defined for the grid, including any selection checkbox column.
GridTHTDElementgetCell(int rowIndex, GridColumnElement column)Gets the grid cell for the given row and column.
GridTHTDElementgetCell(int rowIndex, int colIndex)Gets the grid cell for the given row and column index.
GridTHTDElementgetCell(String contents)Finds the first cell inside the rendered range with a text content matching the given string.
GridColumnElementgetColumn(String headerText)Gets the column with the given header text.
intgetFirstVisibleRowIndex()Gets the index of the first row which is at least partially visible.
TestBenchElementgetFooterCell(int columnIndex)Gets the footer cell for the given visible column index.
GridTHTDElementgetHeaderCell(int columnIndex)Gets the header cell for the given visible column index.
intgetPageSize()Gets the page size used when fetching data.
GridTRElementgetRow(int rowIndex)Gets the
trelement for the given row index.intgetRowCount()Gets the total number of rows.
List<GridColumnElement>getVisibleColumns()Gets the currently visible columns in the grid, including any selection checkbox column.
voidscrollToRow(int row)Scrolls to the row with the given index.
voidselect(int rowIndex)Selects the row with the given index.
-
Methods inherited from class com.vaadin.testbench.TestBenchElement
callFunction, clear, click, click, compareScreen, compareScreen, compareScreen, contextClick, dispatchEvent, doubleClick, equals, executeScript, findElement, findElements, focus, getAttribute, getCapabilities, getClassNames, getCommandExecutor, getContext, getCssValue, getDriver, getLocation, getProperty, getPropertyBoolean, getPropertyDouble, getPropertyElement, getPropertyElements, getPropertyInteger, getPropertyString, getRect, getScreenshotAs, getSize, getTagName, getText, getWrappedElement, hasAttribute, hasClassName, hashCode, init, init, isChrome, isDisplayed, isEnabled, isFirefox, isIE, isSelected, scroll, scrollIntoView, scrollLeft, sendKeys, setProperty, setProperty, setProperty, setProperty, submit, waitForVaadin, waitUntil, waitUntil, wrap, wrapElement, wrapElements
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.testbench.HasElementQuery
$, $
-
-
-
-
Method Detail
-
scrollToRow
public void scrollToRow(int row)Scrolls to the row with the given index.
Parameters:
row- the row to scroll to
-
getPageSize
public int getPageSize()Gets the page size used when fetching data.
Returns:
the page size
-
getFirstVisibleRowIndex
public int getFirstVisibleRowIndex()Gets the index of the first row which is at least partially visible.
Returns:
the index of the first visible row
-
getRowCount
public int getRowCount()Gets the total number of rows.
Returns:
the number of rows
-
getCell
public GridTHTDElement getCell(int rowIndex, int colIndex)Gets the grid cell for the given row and column index.
For the column index, only visible columns are taken into account.
Automatically scrolls the given row into view
Parameters:
rowIndex- the row indexcolIndex- the column indexReturns:
the grid cell for the given coordinates
-
getCell
public GridTHTDElement getCell(int rowIndex, GridColumnElement column)Gets the grid cell for the given row and column.
Automatically scrolls the given row into view
Parameters:
rowIndex- the row indexcolumn- the column element for the columnReturns:
the grid cell for the given coordinates
-
getCell
public GridTHTDElement getCell(String contents) throws org.openqa.selenium.NoSuchElementExceptionFinds the first cell inside the rendered range with a text content matching the given string.
Parameters:
contents- the string to look forReturns:
a grid cell containing the given string
Throws:
org.openqa.selenium.NoSuchElementException- if no cell with the given string was found
-
getRow
public GridTRElement getRow(int rowIndex)Gets the
trelement for the given row index.Parameters:
rowIndex- the row indexReturns:
the tr element for the row
-
getAllColumns
public List<GridColumnElement> getAllColumns()Gets all columns defined for the grid, including any selection checkbox column.
Returns:
a list of grid column elements which can be used to refer to the given column
-
generatedColumnIdsIfNeeded
protected void generatedColumnIdsIfNeeded()
-
getVisibleColumns
public List<GridColumnElement> getVisibleColumns()Gets the currently visible columns in the grid, including any selection checkbox column.
Returns:
a list of grid column elements which can be used to refer to the given column
-
getColumn
public GridColumnElement getColumn(String headerText) throws org.openqa.selenium.NoSuchElementExceptionGets the column with the given header text.
If multiple columns are found with the same header text, returns the first column.
Parameters:
headerText- the text in the headerReturns:
the grid column element for the given column
Throws:
org.openqa.selenium.NoSuchElementException- if no column was found
-
getHeaderCell
public GridTHTDElement getHeaderCell(int columnIndex)Gets the header cell for the given visible column index.
Parameters:
columnIndex- the index of the columnReturns:
a cell element for the header cell
-
getFooterCell
public TestBenchElement getFooterCell(int columnIndex)Gets the footer cell for the given visible column index.
Parameters:
columnIndex- the index of the columnReturns:
a cell element for the footer cell
-
select
public void select(int rowIndex)Selects the row with the given index.
Parameters:
rowIndex- the row to select
-
deselect
public void deselect(int rowIndex)Deselects the row with the given index.
Parameters:
rowIndex- the row to deselect
-
-