Open topic with navigation

com.hp.lft.sdk.winforms

## Interface ComponentOneGrid

- All Superinterfaces:
    CustomGrid
  All Known Subinterfaces:
    C1FlexGrid, C1TrueDbGrid

      public interface ComponentOneGrid
      extends CustomGrid

  Base interface for ComponentOne C1FlexGrid control and ComponentOne C1TrueDBGrid control.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `activateCell(int row, java.lang.String columnHeader)` Double-clicks the specified cell in this grid.
    `void` | `collapseRow(int row)` Collapses the specified row.
    `void` | `expandRow(int row)` Expands the specified row.
    `C1TableCell` | `getCell(int row, java.lang.String columnHeader)` Returns a cell in the grid.
    `java.util.List<TableRow<C1TableCell>>` | `getRows()` Returns the rows.
    `void` | `makeCellVisible(int row, java.lang.String columnHeader)` Scrolls the specified cell into view.
    `void` | `openCellElement(int row, int column)` Selects the specified cell and opens a cell's pop-up cell element.
    `void` | `openCellElement(int row, java.lang.String columnHeader)` Selects the specified cell and opens a cell's pop-up cell element.
    `void` | `selectCell(int row, java.lang.String columnHeader)` Selects (clicks) the specified cell in this grid.
    `void` | `selectColumn(int column)` Selects (clicks) the specified column header in the grid.
    `void` | `selectColumn(java.lang.String columnHeader)` Selects (clicks) the specified column header in the grid.
    `void` | `setFilter(int column, java.lang.String filter)` Applies the specified filter string to the specified column.
    `void` | `setFilter(java.lang.String columnHeader, java.lang.String filter)` Applies the specified filter string to the specified column.
    `void` | `sort(int column)` Sorts this table by the specified column (ascending).
    `void` | `sort(java.lang.String columnHeader)` Sorts this table by the specified column (ascending).
    `void` | `sortDescending(int column)` Sorts this table by the specified column (descending).
    `void` | `sortDescending(java.lang.String columnHeader)` Sorts this table by the specified column (descending).

    - ### Methods inherited from interface com.hp.lft.sdk.winforms.CustomGrid

      `getTableTestObject`

- - ### Method Detail

    - #### activateCell

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

      Double-clicks the specified cell in this grid.
      Parameters:
        `row` - 0-based row number.
        `columnHeader` - the column caption.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### makeCellVisible

          void makeCellVisible(int row,
                               java.lang.String columnHeader)
                        throws GeneralLeanFtException

      Scrolls the specified cell into view.
      Parameters:
        `row` - 0-based row number.
        `columnHeader` - the column caption.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### collapseRow

          void collapseRow(int row)
                    throws GeneralLeanFtException

      Collapses the specified row.
      Parameters:
        `row` - 0-based row number
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### expandRow

          void expandRow(int row)
                  throws GeneralLeanFtException

      Expands the specified row.
      Parameters:
        `row` - 0-based row number
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### openCellElement

          void openCellElement(int row,
                               int column)
                        throws GeneralLeanFtException

      Selects the specified cell and opens a cell's pop-up cell element.
      Parameters:
        `row` - 0-based row number
        `column` - 0-based column index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### openCellElement

          void openCellElement(int row,
                               java.lang.String columnHeader)
                        throws GeneralLeanFtException

      Selects the specified cell and opens a cell's pop-up cell element.
      Parameters:
        `row` - 0-based row number
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectCell

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

      Selects (clicks) the specified cell in this grid.
      Parameters:
        `row` - 0-based row number.
        `columnHeader` - the column caption.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectColumn

          void selectColumn(int column)
                     throws GeneralLeanFtException

      Selects (clicks) the specified column header in the grid.
      Parameters:
        `column` - 0-based column index.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectColumn

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

      Selects (clicks) the specified column header in the grid.
      Parameters:
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setFilter

          void setFilter(int column,
                         java.lang.String filter)
                  throws GeneralLeanFtException

      Applies the specified filter string to the specified column.
      Parameters:
        `column` - 0-based column index.
        `filter` - the filter name.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setFilter

          void setFilter(java.lang.String columnHeader,
                         java.lang.String filter)
                  throws GeneralLeanFtException

      Applies the specified filter string to the specified column.
      Parameters:
        `columnHeader` - the column caption
        `filter` - the filter
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### sort

          void sort(int column)
             throws GeneralLeanFtException

      Sorts this table by the specified column (ascending).
      Parameters:
        `column` - 0-based column index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### sort

          void sort(java.lang.String columnHeader)
             throws GeneralLeanFtException

      Sorts this table by the specified column (ascending).
      Parameters:
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### sortDescending

          void sortDescending(int column)
                       throws GeneralLeanFtException

      Sorts this table by the specified column (descending).
      Parameters:
        `column` - 0-based column index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### sortDescending

          void sortDescending(java.lang.String columnHeader)
                       throws GeneralLeanFtException

      Sorts this table by the specified column (descending).
      Parameters:
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getCell

          C1TableCell getCell(int row,
          		     java.lang.String columnHeader)
          	throws GeneralLeanFtException

      Returns a cell in the grid.
      Parameters:
        `row` - 0-based row number
        `columnHeader` - the column caption
      Returns:
        the cell
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getRows

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

      Returns the rows.
      Returns:
        the rows
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.