Open topic with navigation

com.hp.lft.sdk.java

# Interface Table

- All Superinterfaces:
    Clickable, DoubleClickable, EnabledProvider, LocationInfoProvider, SupportsNativeObject, TestObject, TestObjectDescriber, UiObjectBase, VisibleProvider, WaitUntilEnabledProvider, WaitUntilVisibleProvider

      public interface Table
      extends UiObjectBase, TestObject

  A Java table.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `activateCell(int row, int column)` Double-clicks a cell by row and column indexes.
    `void` | `activateCell(int row, String columnHeader)` Double-clicks a cell by row index and column header.
    `void` | `activateColumn(int column)` Double-clicks a column by column index.
    `void` | `activateColumn(String columnHeader)` Double-clicks a column by column header.
    `void` | `activateRow(int row)` Double-clicks a row.
    `void` | `deselectColumns(int... columns)` Unselects the specified columns by column indexes.
    `void` | `deselectColumns(String... columnsHeaders)` Unselects the specified columns by column headers.
    `void` | `deselectColumnsRange(int fromColumn, int toColumn)` Unselects the specified range of columns by column indexes.
    `void` | `deselectColumnsRange(String fromColumnHeader, String toColumnHeader)` Unselects the specified range of columns by column headers.
    `void` | `deselectRows(int... rows)` Unselects rows by row indexes.
    `void` | `deselectRows(TableRow... rows)` Unselects rows by `TableRow`.
    `void` | `deselectRowsRange(int fromRow, int toRow)` Unselects rows by rows indexes.
    `void` | `deselectRowsRange(TableRow fromRow, TableRow toRow)` Unselects rows by `TableRow`.
    `void` | `extendSelectColumns(int... columns)` Selects additional columns in the table.
    `void` | `extendSelectColumns(String... columnHeaders)` Selects additional columns in the table.
    `void` | `extendSelectColumnsRange(int fromColumn, int toColumn)` Selects the specified range of additional columns in the table.
    `void` | `extendSelectColumnsRange(String fromColumnHeader, String toColumnHeader)` Selects the specified range of additional columns in the table.
    `void` | `extendSelectRows(int... rows)` Selects additional rows in the table.
    `void` | `extendSelectRows(TableRow... rows)` Selects additional rows in the table.
    `void` | `extendSelectRowsRange(int fromRow, int toRow)` Selects the specified range of additional rows in the table.
    `void` | `extendSelectRowsRange(TableRow fromRow, TableRow toRow)` Selects the specified range of additional rows in the table.
    `TableCell` | `getCell(int row, String columnHeader)` Returns a cell specified by row index and column header.
    `List<String>` | `getColumnHeaders()` Returns the column headers.
    `List<TableRow>` | `getRows()` Returns the `TableRow` objects in the table.
    `void` | `selectCell(int row, int column)` Clicks a cell by row and column indexes.
    `void` | `selectCell(int row, String columnHeader)` Clicks a cell by row index and column header.
    `void` | `selectCellsRange(int fromRow, int fromColumn, int toRow, int toColumn)` Selects a range of cells by row and column indexes.
    `void` | `selectCellsRange(int fromRow, String fromColumnHeader, int toRow, String toColumnHeader)` Selects a range of cells by row indexes and column headers.
    `void` | `selectColumnHeader(int column)` Clicks on a column header of the table by column index.
    `void` | `selectColumnHeader(int column, MouseButton button)` Clicks on a column header using the specified `MouseButton` by column index.
    `void` | `selectColumnHeader(String columnHeader)` Clicks on a column header by header text.
    `void` | `selectColumnHeader(String columnHeader, MouseButton button)` Clicks on a column header using the specified `MouseButton` by column header.
    `void` | `selectColumns(int... columns)` Selects columns by column indexes.
    `void` | `selectColumns(String... columnHeaders)` Selects columns by column headers.
    `void` | `selectColumnsRange(int fromColumn, int toColumn)` Selects a range of columns by column indexes.
    `void` | `selectColumnsRange(String fromColumnHeader, String toColumnHeader)` Selects a range of columns by column headers.
    `void` | `selectRows(int... rows)` Selects rows by indexes.
    `void` | `selectRows(TableRow... rows)` Selects rows by `TableRow`.
    `void` | `selectRowsRange(int fromRow, int toRow)` Selects a range of rows by indexes.
    `void` | `selectRowsRange(TableRow fromRow, TableRow toRow)` Selects a range of rows by row objects.

    - ### Methods inherited from interface com.hp.lft.sdk.java.UiObjectBase

      `createObject, createObject, fireEvent, getAttachedText, getBackgroundColor, getForegroundColor, getLabel, getNativeClass, getObjectName, getObjectProperty, getPath, getStatics, getTagName, isEnabled, isFocused, isVisible, sendKeys, sendKeys`

    - ### Methods inherited from interface com.hp.lft.sdk.Clickable

      `click, click, click`

    - ### Methods inherited from interface com.hp.lft.sdk.DoubleClickable

      `doubleClick, doubleClick, doubleClick`

    - ### Methods inherited from interface com.hp.lft.sdk.LocationInfoProvider

      `getAbsoluteLocation, getLocation, getSize`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportsNativeObject

      `getNativeObject`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilEnabledProvider

      `waitUntilEnabled, waitUntilEnabled`

    - ### Methods inherited from interface com.hp.lft.sdk.EnabledProvider

      `isEnabled`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilVisibleProvider

      `waitUntilVisible, waitUntilVisible`

    - ### Methods inherited from interface com.hp.lft.sdk.VisibleProvider

      `isVisible`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObject

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

      `describe`

- - ### Method Detail

    - #### getRows

          List<TableRow> getRows()
                                 throws GeneralLeanFtException

      Returns the `TableRow` objects in the table.
      Returns:
        the `TableRow` objects in the table.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getColumnHeaders

          List<String> getColumnHeaders()
                                        throws GeneralLeanFtException

      Returns the column headers.
      Returns:
        the column headers.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### activateCell

          void activateCell(int row,
                          int column)
                            throws GeneralLeanFtException

      Double-clicks a cell by row and column indexes.
      Parameters:
        `row` - 0-based row index.
        `column` - 0-based column index.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### activateCell

          void activateCell(int row,
                          String columnHeader)
                            throws GeneralLeanFtException

      Double-clicks a cell by row index and column header.
      Parameters:
        `row` - 0-based row index.
        `columnHeader` - the column header.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### activateColumn

          void activateColumn(int column)
                              throws GeneralLeanFtException

      Double-clicks a column by column index.
      Important: This method is not supported for SWT tables.
      Parameters:
        `column` - 0-based column index.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### activateColumn

          void activateColumn(String columnHeader)
                              throws GeneralLeanFtException

      Double-clicks a column by column header.
      Important: This method is not supported for SWT tables.
      Parameters:
        `columnHeader` - the column header.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### activateRow

          void activateRow(int row)
                           throws GeneralLeanFtException

      Double-clicks a row.
      Parameters:
        `row` - 0-based row index.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectColumns

          void deselectColumns(int... columns)
                               throws GeneralLeanFtException

      Unselects the specified columns by column indexes.
      Important: This method is not supported for SWT tables.
      Parameters:
        `columns` - 0-based column indexes.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectColumns

          void deselectColumns(String... columnsHeaders)
                               throws GeneralLeanFtException

      Unselects the specified columns by column headers.
      Important: This method is not supported for SWT tables.
      Parameters:
        `columnsHeaders` - the column headers.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectColumnsRange

          void deselectColumnsRange(int fromColumn,
                                  int toColumn)
                                    throws GeneralLeanFtException

      Unselects the specified range of columns by column indexes.
      Important: This method is not supported for SWT tables.
      Parameters:
        `fromColumn` - 0-based index of the first column.
        `toColumn` - 0-based index of the last column.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectColumnsRange

          void deselectColumnsRange(String fromColumnHeader,
                                  String toColumnHeader)
                                    throws GeneralLeanFtException

      Unselects the specified range of columns by column headers.
      Important: This method is not supported for SWT tables.
      Parameters:
        `fromColumnHeader` - header of the first column.
        `toColumnHeader` - header of the last column.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectRows

          void deselectRows(int... rows)
                            throws GeneralLeanFtException

      Unselects rows by row indexes.
      Parameters:
        `rows` - 0-based indexes.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectRows

          void deselectRows(TableRow... rows)
                            throws GeneralLeanFtException

      Unselects rows by `TableRow`.
      Parameters:
        `rows` - the `TableRow` objects.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectRowsRange

          void deselectRowsRange(int fromRow,
                               int toRow)
                                 throws GeneralLeanFtException

      Unselects rows by rows indexes.
      Parameters:
        `fromRow` - 0-based index of the first row.
        `toRow` - 0-based index of the last row.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### deselectRowsRange

          void deselectRowsRange(TableRow fromRow,
                               TableRow toRow)
                                 throws GeneralLeanFtException

      Unselects rows by `TableRow`.
      Parameters:
        `fromRow` - the first `TableRow`.
        `toRow` - the last `TableRow`.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectColumns

          void extendSelectColumns(int... columns)
                                   throws GeneralLeanFtException

      Selects additional columns in the table.
      Parameters:
        `columns` - 0-based indexes of the columns.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectColumns

          void extendSelectColumns(String... columnHeaders)
                                   throws GeneralLeanFtException

      Selects additional columns in the table.
      Parameters:
        `columnHeaders` - the headers of the columns.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectColumnsRange

          void extendSelectColumnsRange(int fromColumn,
                                      int toColumn)
                                        throws GeneralLeanFtException

      Selects the specified range of additional columns in the table.
      Parameters:
        `fromColumn` - 0-based index of the first column in the range of columns you want to select.
        `toColumn` - 0-based index of the last column in the range of columns you want to select.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectColumnsRange

          void extendSelectColumnsRange(String fromColumnHeader,
                                      String toColumnHeader)
                                        throws GeneralLeanFtException

      Selects the specified range of additional columns in the table.
      Parameters:
        `fromColumnHeader` - header of the first column in the range of columns you want to select.
        `toColumnHeader` - header of the last column in the range of columns you want to select.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectRows

          void extendSelectRows(int... rows)
                                throws GeneralLeanFtException

      Selects additional rows in the table.
      Parameters:
        `rows` - 0-based indexes to select.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectRows

          void extendSelectRows(TableRow... rows)
                                throws GeneralLeanFtException

      Selects additional rows in the table.
      Parameters:
        `rows` - the `TableRow` objects.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectRowsRange

          void extendSelectRowsRange(int fromRow,
                                   int toRow)
                                     throws GeneralLeanFtException

      Selects the specified range of additional rows in the table.
      Parameters:
        `fromRow` - 0-based index of the first row.
        `toRow` - 0-based index of the last row.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### extendSelectRowsRange

          void extendSelectRowsRange(TableRow fromRow,
                                   TableRow toRow)
                                     throws GeneralLeanFtException

      Selects the specified range of additional rows in the table.
      Parameters:
        `fromRow` - the first `TableRow`.
        `toRow` - the last `TableRow`.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getCell

          TableCell getCell(int row,
                          String columnHeader)
                            throws GeneralLeanFtException

      Returns a cell specified by row index and column header.
      Parameters:
        `row` - 0-based row index.
        `columnHeader` - the column header.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectCell

          void selectCell(int row,
                        int column)
                          throws GeneralLeanFtException

      Clicks a cell by row and column indexes.
      Parameters:
        `row` - 0-based row index.
        `column` - 0-based column index.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectCell

          void selectCell(int row,
                        String columnHeader)
                          throws GeneralLeanFtException

      Clicks a cell by row index and column header.
      Parameters:
        `row` - 0-based row index.
        `columnHeader` - the column header.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectCellsRange

          void selectCellsRange(int fromRow,
                              int fromColumn,
                              int toRow,
                              int toColumn)
                                throws GeneralLeanFtException

      Selects a range of cells by row and column indexes.
      Important: This method is not supported for SWT tables.
      Parameters:
        `fromRow` - 0-based index of the first row.
        `fromColumn` - 0-based index of the first column.
        `toRow` - 0-based index of the last row.
        `toColumn` - 0-based index of the last column.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectCellsRange

          void selectCellsRange(int fromRow,
                              String fromColumnHeader,
                              int toRow,
                              String toColumnHeader)
                                throws GeneralLeanFtException

      Selects a range of cells by row indexes and column headers.
      Important: This method is not supported for SWT tables.
      Parameters:
        `fromRow` - 0-based index of the first row.
        `fromColumnHeader` - the header of the first column.
        `toRow` - 0-based index of the last row.
        `toColumnHeader` - the header of the last column.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumns

          void selectColumns(int... columns)
                             throws GeneralLeanFtException

      Selects columns by column indexes.
      Parameters:
        `columns` - 0-based indexes of the columns.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumns

          void selectColumns(String... columnHeaders)
                             throws GeneralLeanFtException

      Selects columns by column headers.
      Parameters:
        `columnHeaders` - the headers of the columns.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumnsRange

          void selectColumnsRange(int fromColumn,
                                int toColumn)
                                  throws GeneralLeanFtException

      Selects a range of columns by column indexes.
      Parameters:
        `fromColumn` - 0-based index of the first column.
        `toColumn` - 0-based index of the last column.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumnsRange

          void selectColumnsRange(String fromColumnHeader,
                                String toColumnHeader)
                                  throws GeneralLeanFtException

      Selects a range of columns by column headers.
      Parameters:
        `fromColumnHeader` - header of the first column.
        `toColumnHeader` - header of the last column .
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumnHeader

          void selectColumnHeader(int column,
                                MouseButton button)
                                  throws GeneralLeanFtException

      Clicks on a column header using the specified `MouseButton` by column index.
      Parameters:
        `column` - 0-based index of the column.
        `button` - either the LEFT or RIGHT button value of `MouseButton`.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumnHeader

          void selectColumnHeader(String columnHeader,
                                MouseButton button)
                                  throws GeneralLeanFtException

      Clicks on a column header using the specified `MouseButton` by column header.
      Parameters:
        `columnHeader` - the header of the column.
        `button` - either the LEFT or RIGHT button value of `MouseButton`.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumnHeader

          void selectColumnHeader(int column)
                                  throws GeneralLeanFtException

      Clicks on a column header of the table by column index.
      Parameters:
        `column` - 0-based index.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectColumnHeader

          void selectColumnHeader(String columnHeader)
                                  throws GeneralLeanFtException

      Clicks on a column header by header text.
      Parameters:
        `columnHeader` - the header text.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectRows

          void selectRows(int... rows)
                          throws GeneralLeanFtException

      Selects rows by indexes.
      Parameters:
        `rows` - 0-based indexes.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectRows

          void selectRows(TableRow... rows)
                          throws GeneralLeanFtException

      Selects rows by `TableRow`.
      Parameters:
        `rows` - the `TableRow` objects to select.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectRowsRange

          void selectRowsRange(int fromRow,
                             int toRow)
                               throws GeneralLeanFtException

      Selects a range of rows by indexes.
      Parameters:
        `fromRow` - 0-based index of the first row.
        `toRow` - 0-based index of the last row.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectRowsRange

          void selectRowsRange(TableRow fromRow,
                             TableRow toRow)
                               throws GeneralLeanFtException

      Selects a range of rows by row objects.
      Parameters:
        `fromRow` - the first `TableRow`.
        `toRow` - the last `TableRow`.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution