Open topic with navigation

com.hp.lft.sdk.sap.gui

## Interface TableBase<T extends TableCellBase>

- All Superinterfaces:
    Element, LocationInfoProvider, SupportsNativeObject, TestObject, TestObjectDescriber, WaitUntilEnabledProvider, EnabledProvider
  All Known Subinterfaces:
    APOGrid, Grid, Table

      public interface TableBase<T extends TableCellBase>
      extends Element

  The base interface for table, grid and APO grid controls in a SAP GUI for Windows application.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `activateCell(int row, int columnIndex)` Double-clicks the specified cell.
    `void` | `activateCell(int row, java.lang.String column)` Double-clicks the specified cell.
    `void` | `deselectColumn(int... columnIndices)` Unselects the specified columns.
    `void` | `deselectColumn(java.lang.String... columns)` Unselects the specified columns.
    `void` | `deselectRow(int... rowIndices)` Unselects the specified rows.
    `void` | `deselectRowRange(int indexFrom, int indexTo)` Unselects the specified rows.
    `java.util.List<TableRow<T>>` | `findAllRowsWithCellTextInColumn(java.lang.String text, int columnIndex)` Finds all rows with this text in the specified column.
    `java.util.List<TableRow<T>>` | `findAllRowsWithCellTextInColumn(java.lang.String text, java.lang.String column)` Finds all rows with the specified text in the specified column.
    `TableRow<T>` | `findRowWithCellTextInColumn(java.lang.String text, int columnIndex)` Finds the first row with this text.
    `TableRow<T>` | `findRowWithCellTextInColumn(java.lang.String text, int columnIndex, int startFromRow)` Finds the first row with this text.
    `TableRow<T>` | `findRowWithCellTextInColumn(java.lang.String text, java.lang.String column)` Finds the first row with this text.
    `TableRow<T>` | `findRowWithCellTextInColumn(java.lang.String text, java.lang.String column, int startFromRow)` Finds the first row with this text.
    `java.util.List<TableRow<T>>` | `getRows()` Returns the list of rows in the test object.
    `java.lang.String` | `getTitle()` Returns the title of the object.
    `boolean` | `isEnabled()` Indicates whether the object can accept user input.
    `void` | `selectCell(int row, int columnIndex)` Selects the specified cell.
    `void` | `selectCell(int row, java.lang.String column)` Selects the specified cell.
    `void` | `selectColumn(int... columnIndices)` Selects the specified columns.
    `void` | `selectColumn(java.lang.String... columns)` Selects the specified columns.
    `void` | `selectRow(int... rowIndices)` Selects the specified rows.
    `void` | `selectRowRange(int indexFrom, int indexTo)` Selects the specified row range.

    - ### Methods inherited from interface com.hp.lft.sdk.sap.gui.Element

      `getId, getName, getType`

    - ### 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`

    - ### 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`

- - ### Method Detail

    - #### getTitle

          java.lang.String getTitle()
                             throws GeneralLeanFtException

      Returns the title of the object.
      Returns:
        the title.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isEnabled

          boolean isEnabled()
                     throws GeneralLeanFtException

      Indicates whether the object can accept user input.
      Returns:
        true if enabled.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getRows

          java.util.List<TableRow<T>> getRows()
                                       throws GeneralLeanFtException

      Returns the list of rows in the test object.
      Returns:
        the list of rows.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateCell

          void activateCell(int row,
                            java.lang.String column)
                     throws GeneralLeanFtException

      Double-clicks the specified cell.
      Parameters:
        `row` - the 1-based row index.
        `column` - the column name.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateCell

          void activateCell(int row,
                            int columnIndex)
                     throws GeneralLeanFtException

      Double-clicks the specified cell.
      Parameters:
        `row` - the 1-based row index.
        `columnIndex` - the 1-based column index.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectCell

          void selectCell(int row,
                          java.lang.String column)
                   throws GeneralLeanFtException

      Selects the specified cell.
      Parameters:
        `row` - the 1-based row index.
        `column` - the name of the column.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectCell

          void selectCell(int row,
                          int columnIndex)
                   throws GeneralLeanFtException

      Selects the specified cell.
      Parameters:
        `row` - the 1-based row index.
        `columnIndex` - the 1-based column index.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRow

          void selectRow(int... rowIndices)
                  throws GeneralLeanFtException

      Selects the specified rows.
      Parameters:
        `rowIndices` - the 1-based row indexes.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRowRange

          void selectRowRange(int indexFrom,
                              int indexTo)
                       throws GeneralLeanFtException

      Selects the specified row range.
      Parameters:
        `indexTo` - the 1-based index of the start row.
        `indexFrom` - the 1-based index of the end row.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectColumn

          void selectColumn(java.lang.String... columns)
                     throws GeneralLeanFtException

      Selects the specified columns.
      Parameters:
        `columns` - the names of the columns.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectColumn

          void selectColumn(int... columnIndices)
                     throws GeneralLeanFtException

      Selects the specified columns.
      Parameters:
        `columnIndices` - the 1-based column indexes.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselectRow

          void deselectRow(int... rowIndices)
                    throws GeneralLeanFtException

      Unselects the specified rows.
      Parameters:
        `rowIndices` - the 1-based row indexes.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselectRowRange

          void deselectRowRange(int indexFrom,
                                int indexTo)
                         throws GeneralLeanFtException

      Unselects the specified rows.
      Parameters:
        `indexTo` - the 1-based index of the start row.
        `indexFrom` - the 1-based index of the end row.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselectColumn

          void deselectColumn(java.lang.String... columns)
                       throws GeneralLeanFtException

      Unselects the specified columns.
      Parameters:
        `columns` - the names of the columns.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselectColumn

          void deselectColumn(int... columnIndices)
                       throws GeneralLeanFtException

      Unselects the specified columns.
      Parameters:
        `columnIndices` - the 1-based column indexes.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### findRowWithCellTextInColumn

                                                      TableRow<T> findRowWithCellTextInColumn(java.lang.String text,
                                                  java.lang.String column)
                                           throws GeneralLeanFtException

      Finds the first row with this text.
      Parameters:
        `text` - the text to find.
        `column` - the name of the column to search.
      Returns:
        the row.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### findRowWithCellTextInColumn

                                                      TableRow<T> findRowWithCellTextInColumn(java.lang.String text,
                                                  int columnIndex)
                                           throws GeneralLeanFtException

      Finds the first row with this text.
      Parameters:
        `text` - the text to find.
        `columnIndex` - the 1-based column index.
      Returns:
        the row.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### findRowWithCellTextInColumn

                                                      TableRow<T> findRowWithCellTextInColumn(java.lang.String text,
                                                  java.lang.String column,
                                                  int startFromRow)
                                           throws GeneralLeanFtException

      Finds the first row with this text.
      Parameters:
        `text` - the text to find.
        `column` - the name of the column to search.
        `startFromRow` - the 1-based index of the row from which to search.
      Returns:
        the row.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### findRowWithCellTextInColumn

                                                      TableRow<T> findRowWithCellTextInColumn(java.lang.String text,
                                                  int columnIndex,
                                                  int startFromRow)
                                           throws GeneralLeanFtException

      Finds the first row with this text.
      Parameters:
        `text` - the text to find.
        `columnIndex` - the 1-based index of the column to search.
        `startFromRow` - the 1-based index of the row from which to search.
      Returns:
        the row.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### findAllRowsWithCellTextInColumn

          java.util.List<TableRow<T>> findAllRowsWithCellTextInColumn(java.lang.String text,
                                                                      int columnIndex)
                                                               throws GeneralLeanFtException

      Finds all rows with this text in the specified column.
      Parameters:
        `text` - the text to find.
        `columnIndex` - the 1-based index of the column to search.
      Returns:
        the rows.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### findAllRowsWithCellTextInColumn

          java.util.List<TableRow<T>> findAllRowsWithCellTextInColumn(java.lang.String text,
                                                                      java.lang.String column)
                                                               throws GeneralLeanFtException

      Finds all rows with the specified text in the specified column.
      Parameters:
        `text` - the text to find.
        `column` - the name of the column to search.
      Returns:
        the rows.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.