com.hp.lft.sdk.winforms

Interface XtraGrid

  • All Superinterfaces:
    CustomGrid

    public interface XtraGrid
extends CustomGrid
    A DevExpress XtraGrid control.

    • Method Summary

      Modifier and TypeMethod and Description
      voidactivateCell(int row, java.lang.String columnHeader)
      Double-clicks the specified cell in this grid.
      voidactivateColumn(int column)
      Double-clicks the specified column header in this grid.
      voidactivateColumn(java.lang.String columnHeader)
      Double-clicks the specified column header in this grid.
      TableCellgetCell(int row, int column)
      Returns a cell in the grid.
      TableCellgetCell(int row, java.lang.String columnHeader)
      Returns a cell in the grid.
      intgetColumnCount()
      Returns the number of columns in the current view.
      intgetRowCount()
      Returns the number of rows in the current view.
      voidgroupRows(int column)
      Groups table rows according to the specified column.
      voidgroupRows(java.lang.String columnHeader)
      Groups table rows according to the specified column.
      voidmakeCellVisible(int row, java.lang.String columnHeader)
      Scrolls the specified cell into view.
      voidselectCell(int row, java.lang.String columnHeader)
      Selects (clicks) the specified cell in this grid.
      voidselectColumn(int column)
      Clicks the specified column header in this grid.
      voidselectColumn(java.lang.String columnHeader)
      Clicks the specified column header in this grid.
      voidsetFilter(int column, java.lang.String filter)
      Applies the specified filter string to the specified column.
      voidsetFilter(java.lang.String columnHeader, java.lang.String filter)
      Applies the specified filter string to the specified column.
      voidsetView(<any>... viewPath)
      Expands the parent rows of the specified view and makes it the current view.
      A SetView statement without parameters must be used before the first operation on an XtraGrid table.
      voidsort(int column)
      Sorts this table by the specified column, ascending.
      voidsort(java.lang.String columnHeader)
      Sorts this table by the specified column, ascending.
      voidsortDescending(int column)
      Sorts this table by the specified column, descending.
      voidsortDescending(java.lang.String columnHeader)
      Sorts this table by the specified column, descending.
      voidungroupRows(int column)
      Ungroups table rows according to the specified column
      voidungroupRows(java.lang.String columnHeader)
      Ungroups table rows according to the specified column

    • 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.

      • activateColumn

        void activateColumn(int column)
             throws GeneralLeanFtException
        Double-clicks the specified column header in this grid.
        Parameters:
        column - 0-based column index
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • activateColumn

        void activateColumn(java.lang.String columnHeader)
             throws GeneralLeanFtException
        Double-clicks the specified column header in this grid.
        Parameters:
        columnHeader - the column caption.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • getCell

                                                    TableCell 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.

      • groupRows

        void groupRows(int column)
        throws GeneralLeanFtException
        Groups table rows according to the specified column.
        Parameters:
        column - 0-based column index
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • groupRows

        void groupRows(java.lang.String columnHeader)
        throws GeneralLeanFtException
        Groups table rows according to the specified column.
        Parameters:
        columnHeader - the column caption
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • ungroupRows

        void ungroupRows(int column)
          throws GeneralLeanFtException
        Ungroups table rows according to the specified column
        Parameters:
        column - 0-based column index
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • ungroupRows

        void ungroupRows(java.lang.String columnHeader)
          throws GeneralLeanFtException
        Ungroups table rows according to the specified column
        Parameters:
        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
        Clicks the specified column header in this grid.
        Parameters:
        column - 0-based column index
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • selectColumn

        void selectColumn(java.lang.String columnHeader)
           throws GeneralLeanFtException
        Clicks the specified column header in this 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 - a value in the column to be used as the filter
        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 - a value in the column to be used as the filter
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • setView

        void setView(<any>... viewPath)
      throws GeneralLeanFtException
        Expands the parent rows of the specified view and makes it the current view.
        A SetView statement without parameters must be used before the first operation on an XtraGrid table. If your test contains steps on more than one XtraGrid table, ensure that you add a SetView without parameters statement before the first step on each grid.
        Parameters:
        viewPath - the hierarchical path of the view to display expressed using tuples in format: (0-based row number, relation name)
        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.