Open topic with navigation

com.hp.lft.sdk.winforms

## Interface UltraWinGrid

- All Superinterfaces:
    CustomGrid

      public interface UltraWinGrid
      extends CustomGrid

  An Infragistics UltraWinGrid object.

- - ### 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` | `activateCell(java.lang.String rowPath, java.lang.String columnHeader)` Double-clicks the specified cell in this grid.
    `void` | `activateColumn(int bandLevel, java.lang.String columnHeader)` Double-clicks the specified column header in this grid.
    `void` | `activateRow(java.lang.String rowPath)` Double-clicks the specified row header in this grid.
    `void` | `addRow(java.lang.String addButtonName)` Adds a new row to the table band using the Add button for the corresponding band.
    `void` | `addRow(java.lang.String addButtonName, java.lang.String newRowPath)` Adds a new row to the table band using the Add button for the corresponding band.
    `void` | `collapseRow(int row)` Collapses the specified row.
    `void` | `collapseRow(java.lang.String rowPath)` Collapses the specified row.
    `void` | `expandRow(int row)` Expands the specified row.
    `void` | `expandRow(java.lang.String rowPath)` Expands the specified row.
    `TableCell` | `getCell(int row, int column)` Returns the specified cell.
    `TableCell` | `getCell(int row, java.lang.String columnHeader)` Returns the specified cell.
    `TableCell` | `getCell(java.lang.String rowPath, java.lang.String columnHeader)` Returns the specified cell.
    `int` | `getColumnCount()` Returns the number of columns in the current band.
    `int` | `getRowCount()` Returns the number of rows in the current band.
    `void` | `makeCellVisible(int row, java.lang.String columnHeader)` Scrolls the specified cell into view.
    `void` | `makeCellVisible(java.lang.String rowPath, java.lang.String columnHeader)` Scrolls the specified cell into view.
    `void` | `openSummaryDialog(int bandLevel, java.lang.String columnHeader)` Opens the summary dialog box for the specified column.
    `void` | `selectCell(int row, java.lang.String columnHeader)` Selects (clicks) the specified cell in this grid.
    `void` | `selectCell(java.lang.String rowPath, java.lang.String columnHeader)` Clicks the specified row header in this grid.
    `void` | `selectColumn(int bandLevel, java.lang.String columnHeader)` Clicks the specified row header in this grid.
    `void` | `selectRow(java.lang.String rowPath)` Clicks the specified row header in this grid.
    `void` | `setFilter(int bandLevel, java.lang.String columnHeader, java.lang.String filter)` Applies the filter to the specified column.
    `void` | `sort(int bandLevel, java.lang.String columnHeader)` Sorts the table by the specified column, ascending.
    `void` | `sortDescending(int bandLevel, java.lang.String columnHeader)` Sorts the 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.

    - #### activateCell

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

      Double-clicks the specified cell in this grid.
      Parameters:
        `rowPath` - in format "n1;n2;...;nX" where n is the row number in each band level.
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateColumn

          void activateColumn(int bandLevel,
                              java.lang.String columnHeader)
                       throws GeneralLeanFtException

      Double-clicks the specified column header in this grid.
      Parameters:
        `bandLevel` - 0-based band level
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateRow

          void activateRow(java.lang.String rowPath)
                    throws GeneralLeanFtException

      Double-clicks the specified row header in this grid.
      Parameters:
        `rowPath` - in format "n1;n2;...nX" where n is the row number in each band level.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### addRow

          void addRow(java.lang.String addButtonName)
               throws GeneralLeanFtException

      Adds a new row to the table band using the Add button for the corresponding band.
      Parameters:
        `addButtonName` - the name of the Add button corresponding to the band to add a row to
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### addRow

          void addRow(java.lang.String addButtonName,
                      java.lang.String newRowPath)
               throws GeneralLeanFtException

      Adds a new row to the table band using the Add button for the corresponding band.
      Parameters:
        `addButtonName` - the name of the Add button corresponding to the band to add a row to
        `newRowPath` - the band path where the row is added in format "n1;n2;...;nX" where n is the row number in each band level.
      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.

    - #### collapseRow

          void collapseRow(java.lang.String rowPath)
                    throws GeneralLeanFtException

      Collapses the specified row.
      Parameters:
        `rowPath` - in format "n1;n2;...;nX" where n is the row number in each band level
      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.

    - #### expandRow

          void expandRow(java.lang.String rowPath)
                  throws GeneralLeanFtException

      Expands the specified row.
      Parameters:
        `rowPath` - in format "n1;n2;...;nX" where n is the row number in each band level
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getCell

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

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

    - #### getCell

                                                      TableCell getCell(java.lang.String rowPath,
                            java.lang.String columnHeader)
                     throws GeneralLeanFtException

      Returns the specified cell.
      Parameters:
        `rowPath` - in format "n1;n2;...;nX" where n is the row number in each band level.
        `columnHeader` - the column caption
      Returns:
        the cell
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getCell

                                                      TableCell getCell(int row,
                            int column)
                     throws GeneralLeanFtException

      Returns the specified cell.
      Parameters:
        `row` - 0-based row number
        `column` - 0-based column index
      Returns:
        the cell
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### makeCellVisible

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

      Scrolls the specified cell into view.
      Parameters:
        `rowPath` - in format "n1;n2;...;nX" where n is the row number in each band level.
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### openSummaryDialog

          void openSummaryDialog(int bandLevel,
                                 java.lang.String columnHeader)
                          throws GeneralLeanFtException

      Opens the summary dialog box for the specified column.
      Parameters:
        `bandLevel` - the band level you want to open the dialog box for
        `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.

    - #### selectCell

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

      Clicks the specified row header in this grid.
      Parameters:
        `rowPath` - in format "n1;n2;...;nX" where n is the row number in each band level
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectColumn

          void selectColumn(int bandLevel,
                            java.lang.String columnHeader)
                     throws GeneralLeanFtException

      Clicks the specified row header in this grid.
      Parameters:
        `bandLevel` - 0-based band level
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRow

          void selectRow(java.lang.String rowPath)
                  throws GeneralLeanFtException

      Clicks the specified row header in this grid.
      Parameters:
        `rowPath` - in format "n1;n2;...;nX" where n is the row number in each band level
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setFilter

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

      Applies the filter to the specified column.
      Parameters:
        `bandLevel` - 0-based band level
        `columnHeader` - the column caption
        `filter` - a value in the column to be used as the filter
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### sort

          void sort(int bandLevel,
                    java.lang.String columnHeader)
             throws GeneralLeanFtException

      Sorts the table by the specified column, ascending.
      Parameters:
        `bandLevel` - 0-based band level
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### sortDescending

          void sortDescending(int bandLevel,
                              java.lang.String columnHeader)
                       throws GeneralLeanFtException

      Sorts the table by the specified column, descending.
      Parameters:
        `bandLevel` - 0-based band level
        `columnHeader` - the column caption
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getRowCount

          int getRowCount()
                   throws GeneralLeanFtException

      Returns the number of rows in the current band.
      Returns:
        the row count
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getColumnCount

          int getColumnCount()
                      throws GeneralLeanFtException

      Returns the number of columns in the current band.
      Returns:
        the column count
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.