SwingTable (ATS-UIEngine 4.0.3 API)

Field Summary
- Fields inherited from class com.axway.ats.uiengine.elements.UiElement
  log, properties

Constructor Summary

Constructors
Constructor and Description

SwingTable(UiDriver uiDriver, UiElementProperties properties)

Constructors
Constructor and Description
`SwingTable(UiDriver uiDriver, UiElementProperties properties)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clickCell(int row, int column)` Click table cell
`void`	`clickHeader(int columnIndex)` Click table header by column index
`void`	`clickHeader(String columnName)` Click table header by column name
`void`	`doubleClickCell(int row, int column)` Double click table cell
`void`	`drag(int row, int column)` Simulates a user dragging a cell from this table
`void`	`drop(int row, int column)` Simulates a user dropping an item into a specific table cell
`Color`	`getCellBackgroundColor(int row, int column)` Returns the table cell background `Color`
`Color[][]`	`getCellBackgroundColors()` Gets table cell backgrounds (as `Color`) of all table cells.
`Color`	`getCellForegroundColor(int row, int column)` Returns the table cell foreground `Color`
`List<Integer[]>`	`getCellIndexesByValue(String value, boolean isRegEx)` Get table cell coordinates by cell value
`int`	`getColumnCount()` Get table column count
`String`	`getFieldValue(int row, int column)` Get table field value
`int`	`getRowCount()` Get table row count
`int[]`	`getSelectedRows()` Get selected rows in the table
`void`	`rightClickCell(int row, int column)` Right click on table cell
`void`	`selectCell(int row, int column)` Select table cell
`void`	`selectCells(int[][] cells)` Select table cells
`void`	`selectRow(int... rows)` Select table rows
`void`	`setFieldValue(String value, int row, int column)` Set table field value
`void`	`verifyFieldValue(String expectedValue, int row, int column)` Verify the field value is as specified
`void`	`verifyFieldValueRegex(String expectedValueRegex, int row, int column)` Verify the field value matches the specified java regular expression
`void`	`verifyNotFieldValue(String notExpectedValue, int row, int column)` Verify the field value is NOT as specified

Methods inherited from class com.axway.ats.uiengine.elements.UiElement
checkTypeAndRules, getElementProperties, getElementProperty, getPropertyNamesToUseForMatch, getUiDriver, logAction, toString

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

- Constructor Detail
  - SwingTable
```
public SwingTable(UiDriver uiDriver,
                  UiElementProperties properties)
```
- Method Detail
  - setFieldValue
```
public void setFieldValue(String value,
                          int row,
                          int column)
```
    Set table field value
    
    Specified by:
    
    setFieldValue in class UiTable
    
    Parameters:
    
    value - the value to set
    
    row - the row number
    
    column - the column number
    
    Throws:
    
    VerificationException - if the element doesn't exist
  - getFieldValue
```
public String getFieldValue(int row,
                            int column)
```
    Get table field value
    
    Specified by:
    
    getFieldValue in class UiTable
    
    Parameters:
    
    row - the row number
    
    column - the column number
    
    Returns:
    
    Throws:
    
    VerificationException - if the element doesn't exist
  - getRowCount
```
public int getRowCount()
```
    Get table row count
    
    Specified by:
    
    getRowCount in class UiTable
    
    Returns:
    
    how many rows this table has
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - getColumnCount
```
public int getColumnCount()
```
    Get table column count
    
    Specified by:
    
    getColumnCount in class UiTable
    
    Returns:
    
    how many columns this table has
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - verifyFieldValue
```
public void verifyFieldValue(String expectedValue,
                             int row,
                             int column)
```
    Verify the field value is as specified
    
    Specified by:
    
    verifyFieldValue in class UiTable
    
    Parameters:
    
    expectedValue -
    
    row - the field row starting at 0
    
    column - the field column starting at 0
    
    Throws:
    
    VerificationException - if the element doesn't exist
    
    VerifyEqualityException - if the verification fails
  - verifyNotFieldValue
```
public void verifyNotFieldValue(String notExpectedValue,
                                int row,
                                int column)
```
    Verify the field value is NOT as specified
    
    Specified by:
    
    verifyNotFieldValue in class UiTable
    
    Parameters:
    
    notExpectedValue -
    
    row - the field row starting at 0
    
    column - the field column starting at 0
    
    Throws:
    
    VerificationException - if the element doesn't exist
    
    VerifyNotEqualityException - if the verification fails
  - verifyFieldValueRegex
```
public void verifyFieldValueRegex(String expectedValueRegex,
                                  int row,
                                  int column)
```
    Verify the field value matches the specified java regular expression
    
    Specified by:
    
    verifyFieldValueRegex in class UiTable
    
    Parameters:
    
    expectedValueRegex - a java regular expression
    
    row - the field row starting at 0
    
    column - the field column starting at 0
    
    Throws:
    
    VerificationException - if the element doesn't exist
    
    VerifyEqualityException - if the verification fails
  - clickCell
```
public void clickCell(int row,
                      int column)
```
    Click table cell
    
    Parameters:
    
    row - the row number
    
    column - the column number
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - doubleClickCell
```
public void doubleClickCell(int row,
                            int column)
```
    Double click table cell
    
    Parameters:
    
    row - the row number
    
    column - the column number
    
    Throws:
    
    VerificationException - if the element doesn't exist
  - rightClickCell
```
public void rightClickCell(int row,
                           int column)
```
    Right click on table cell
    
    Parameters:
    
    row - the row number
    
    column - the column number
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - getCellIndexesByValue
```
public List<Integer[]> getCellIndexesByValue(String value,
                                             boolean isRegEx)
```
    Get table cell coordinates by cell value
    
    Parameters:
    
    value - cell value to search for
    
    isRegEx - if the value is a regular expression
    
    Returns:
    
    an ArrayList with cell coordinates(indexes) represented by arrays [ row, column ] which contains the searched value
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - selectCell
```
public void selectCell(int row,
                       int column)
```
    Select table cell
    
    Parameters:
    
    row - the row number
    
    column - the column number
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - selectCells
```
public void selectCells(int[][] cells)
```
    Select table cells
    
    Parameters:
    
    cells - the cells coordinates (eg. new int[][]{ { 1, 1 }, { 1, 2 }, { 2, 2 } )
    
    Throws:
    
    VerificationException - if the element doesn't exist
  - selectRow
```
public void selectRow(int... rows)
```
    Select table rows
    
    Parameters:
    
    rows - row numbers to select
    
    Throws:
    
    VerificationException - if the element doesn't exist
  - getSelectedRows
```
public int[] getSelectedRows()
```
    Get selected rows in the table
    
    Returns:
    
    an array with the selected rows
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - clickHeader
```
public void clickHeader(int columnIndex)
```
    Click table header by column index
    
    Parameters:
    
    columnIndex - the column index
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - clickHeader
```
public void clickHeader(String columnName)
```
    Click table header by column name
    
    Parameters:
    
    columnName - the column name
    
    Throws:
    
    VerificationException - if the table element doesn't exist
  - drag
```
public void drag(int row,
                 int column)
```
    Simulates a user dragging a cell from this table
    
    Parameters:
    
    row - the row number
    
    column - the column number
  - drop
```
public void drop(int row,
                 int column)
```
    Simulates a user dropping an item into a specific table cell
    
    Parameters:
    
    row - the row number
    
    column - the column number
  - getCellBackgroundColor
```
public Color getCellBackgroundColor(int row,
                                    int column)
```
    Returns the table cell background Color
    
    Parameters:
    
    row - the row number
    
    column - the column number
  - getCellBackgroundColors
```
public Color[][] getCellBackgroundColors()
```
    Gets table cell backgrounds (as Color) of all table cells.
    
    Returns:
    
    array of java.awt.Color objects one for each cell. First index is table row and second is the column in this row.
  - getCellForegroundColor
```
public Color getCellForegroundColor(int row,
                                    int column)
```
    Returns the table cell foreground Color
    
    Parameters:
    
    row - the row number
    
    column - the column number

Class SwingTable

Field Summary

Fields inherited from class com.axway.ats.uiengine.elements.UiElement

Constructor Summary

Method Summary

Methods inherited from class com.axway.ats.uiengine.elements.UiElement

Methods inherited from class java.lang.Object

Constructor Detail

SwingTable

Method Detail

setFieldValue

getFieldValue

getRowCount

getColumnCount

verifyFieldValue

verifyNotFieldValue

verifyFieldValueRegex

clickCell

doubleClickCell

rightClickCell

getCellIndexesByValue

selectCell

selectCells

selectRow

getSelectedRows

clickHeader

clickHeader

drag

drop

getCellBackgroundColor

getCellBackgroundColors

getCellForegroundColor