Open topic with navigation

com.hp.lft.sdk.sap.gui

## Interface APOGrid

- All Superinterfaces:
    Element, LocationInfoProvider, SupportsNativeObject, TableBase<APOGridCell>, TestObject, TestObjectDescriber, WaitUntilEnabledProvider, EnabledProvider

      public interface APOGrid
      extends TableBase<APOGridCell>

  An APO grid control in a SAP GUI for Windows application.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `clearSelection()` Clears the selected rows or columns.
    `void` | `deselectCell(int rowIndex, int columnIndex)` Unselects the specified cell.
    `void` | `deselectCell(int rowIndex, java.lang.String column)` Unselects the specified cell.
    `void` | `selectColumnMenuItem(int columnIndex, java.lang.String menuItem)` Right-clicks the specified column and selects the specified menu item, by column index.
    `void` | `selectColumnMenuItem(java.lang.String column, java.lang.String menuItem)` Right-clicks the specified column and selects the specified menu item, by column name.

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

      `activateCell, activateCell, deselectColumn, deselectColumn, deselectRow, deselectRowRange, findAllRowsWithCellTextInColumn, findAllRowsWithCellTextInColumn, findRowWithCellTextInColumn, findRowWithCellTextInColumn, findRowWithCellTextInColumn, findRowWithCellTextInColumn, getRows, getTitle, isEnabled, selectCell, selectCell, selectColumn, selectColumn, selectRow, selectRowRange`

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

    - #### clearSelection

          void clearSelection()
                       throws GeneralLeanFtException

      Clears the selected rows or columns.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselectCell

          void deselectCell(int rowIndex,
                            java.lang.String column)
                     throws GeneralLeanFtException

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

    - #### deselectCell

          void deselectCell(int rowIndex,
                            int columnIndex)
                     throws GeneralLeanFtException

      Unselects the specified cell.
      Parameters:
        `rowIndex` - 1-based.
        `columnIndex` - 1-based.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectColumnMenuItem

          void selectColumnMenuItem(java.lang.String column,
                                    java.lang.String menuItem)
                             throws GeneralLeanFtException

      Right-clicks the specified column and selects the specified menu item, by column name.
      Parameters:
        `column` - the name of the column.
        `menuItem` - the name of the menu item.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectColumnMenuItem

          void selectColumnMenuItem(int columnIndex,
                                    java.lang.String menuItem)
                             throws GeneralLeanFtException

      Right-clicks the specified column and selects the specified menu item, by column index.
      Parameters:
        `columnIndex` - 1-based.
        `menuItem` - the name of the menu item.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.