AgGrid (DollarX - Java version 0.63 API)

java.lang.Object
- com.github.loyada.jdollarx.singlebrowser.AgGrid

```
public class AgGrid
extends Object
```
Custom class to validate the presence of an AgGrid, and interact with it, since it can be tricky. It supports virtualized and non-virtualized tables. It should be used like other custom matchers in the package.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AgGrid.AgGridBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`AgGrid.AgGridBuilder`

Field Summary

Fields
Modifier and Type Field and Description

static Path CELL

static String COL_ID

static Path HEADER_CELL

static Path HEADER_TXT

static Path ROW

Fields
Modifier and Type	Field and Description
`static Path`	`CELL`
`static String`	`COL_ID`
`static Path`	`HEADER_CELL`
`static Path`	`HEADER_TXT`
`static Path`	`ROW`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clickMenuOfHeader(String headerText)` Click on the menu of a the column with the given header
`void`	`clickOnSort(String headerText)` Click on the 'sort' column with the given header
`Path`	`ensureVisibilityOfCellInColumn(String columnTitle, ElementProperty cellContent)` Find a specific cell under a column, without knowing the row, ensure it is displayed, and return its Path
`Path`	`ensureVisibilityOfRowWithIndex(int n)` Scroll until the row with the given index is visible, and return a Path element that matches it.
`Path`	`ensureVisibilityOfRowWithIndexAndColumn(int index, String columnTitle)` Scroll until the row with the given index, as well as the given column, is visible.
`int`	`findRowIndex(Map<String,ElementProperty> row)` Find internal index of row within table.
`void`	`findTableInBrowser()`
`static AgGrid.AgGridBuilder`	`getBuilder()`
`int`	`getRowIndex(Path row)` assuming the row is already present in the DOM, get its internal index in the table.
`int`	`getRowIndexOfCell(Path cell)` assuming the row is already present in the DOM, get its internal index in the table.
`Path`	`getVisibleHeaderPath(String headerText)` Make sure the given column header is visible, and returns a Path element to access it.
`boolean`	`isVirtualized()`
`void`	`overrideTimeoutDuringOperation(int millisecs)` Override the default timeout threshold for finding elements while scrolling the table.
`void`	`overrideTimeoutWhenDone(int millisecs)` Override the default timeout threshold it reverts to when table operations are done.
`void`	`setFinalTimeout()`
`void`	`setScrollStep(int size)` Override the default step size of scrolling when moving through a grid
`String`	`toString()`

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

- Field Detail
  - COL_ID
```
public static final String COL_ID
```
    See Also:
    
    Constant Field Values
  - HEADER_CELL
```
public static final Path HEADER_CELL
```
  - HEADER_TXT
```
public static final Path HEADER_TXT
```
  - ROW
```
public static final Path ROW
```
  - CELL
```
public static final Path CELL
```
- Method Detail
  - getBuilder
```
public static AgGrid.AgGridBuilder getBuilder()
```
  - isVirtualized
```
public boolean isVirtualized()
```
  - setScrollStep
```
public void setScrollStep(int size)
```
    Override the default step size of scrolling when moving through a grid
    
    Parameters:
    
    size - step size in pixels
  - overrideTimeoutDuringOperation
```
public void overrideTimeoutDuringOperation(int millisecs)
```
    Override the default timeout threshold for finding elements while scrolling the table. The default is 5 milliseconds
    
    Parameters:
    
    millisecs - - the timeout in milliseconds
  - overrideTimeoutWhenDone
```
public void overrideTimeoutWhenDone(int millisecs)
```
    Override the default timeout threshold it reverts to when table operations are done. The default is 5000 milliseconds
    
    Parameters:
    
    millisecs - - the timeout in milliseconds
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clickMenuOfHeader
```
public void clickMenuOfHeader(String headerText)
```
    Click on the menu of a the column with the given header
    
    Parameters:
    
    headerText - - the header text
  - clickOnSort
```
public void clickOnSort(String headerText)
```
    Click on the 'sort' column with the given header
    
    Parameters:
    
    headerText - - the header text
  - getVisibleHeaderPath
```
public Path getVisibleHeaderPath(String headerText)
```
    Make sure the given column header is visible, and returns a Path element to access it. This is useful to perform direct operations on that element or access other DOM elements contained in the header.
    
    Parameters:
    
    headerText - - the header text
    
    Returns:
    
    the Path element to access the column header
  - setFinalTimeout
```
public void setFinalTimeout()
```
  - ensureVisibilityOfRowWithIndex
```
public Path ensureVisibilityOfRowWithIndex(int n)
```
    Scroll until the row with the given index is visible, and return a Path element that matches it. Useful for performing operations or accessing fields in the wanted row.
    
    Parameters:
    
    n - the number of row in the table, as visible to the user
    
    Returns:
    
    a Path element that allows to access the row
  - ensureVisibilityOfRowWithIndexAndColumn
```
public Path ensureVisibilityOfRowWithIndexAndColumn(int index,
                                                    String columnTitle)
```
    Scroll until the row with the given index, as well as the given column, is visible. It return a Path element that matches the wanted cell in row. Useful for performing operations or accessing fields in the wanted cell (for example: edit it)
    
    Parameters:
    
    index - the number of row in the table, as visible to the user
    
    columnTitle - the header title of the wanted cell in the row
    
    Returns:
    
    the Path element to access the wanted cell in the wanted row
  - getRowIndex
```
public int getRowIndex(Path row)
```
    assuming the row is already present in the DOM, get its internal index in the table.
    
    Parameters:
    
    row - the row we are interested in. Should be the value returned from findRowInBrowser() or ensureVisibilityOfRowWithIndex()
    
    Returns:
    
    the internal index of the row in the table
  - getRowIndexOfCell
```
public int getRowIndexOfCell(Path cell)
```
    assuming the row is already present in the DOM, get its internal index in the table.
    
    Parameters:
    
    cell - - the cell in the row we are interested in. Should be the return value of ensureVisibilityOfRowWithIndexAndColumn()
    
    Returns:
    
    the internal index of the row in the table
  - findRowIndex
```
public int findRowIndex(Map<String,ElementProperty> row)
```
    Find internal index of row within table. This method typically will make sure the row is also visible if it exists, in case the user needs to interact with it, but in some cases ensureVisiblityOfRow will be required.
    
    Parameters:
    
    row - - the definition of the row content
    
    Returns:
    
    the internal index of the row, if it was found
  - ensureVisibilityOfCellInColumn
```
public Path ensureVisibilityOfCellInColumn(String columnTitle,
                                           ElementProperty cellContent)
```
    Find a specific cell under a column, without knowing the row, ensure it is displayed, and return its Path
    
    Parameters:
    
    columnTitle - the title of the column to look under
    
    cellContent - a property that describes the content of the expect cell
    
    Returns:
    
    the Path of the found cell. allows to interact with it
  - findTableInBrowser
```
public void findTableInBrowser()
```

Class AgGrid

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COL_ID

HEADER_CELL

HEADER_TXT

ROW

CELL

Method Detail

getBuilder

isVirtualized

setScrollStep

overrideTimeoutDuringOperation

overrideTimeoutWhenDone

toString

clickMenuOfHeader

clickOnSort

getVisibleHeaderPath

setFinalTimeout

ensureVisibilityOfRowWithIndex

ensureVisibilityOfRowWithIndexAndColumn

getRowIndex

getRowIndexOfCell

findRowIndex

ensureVisibilityOfCellInColumn

findTableInBrowser