Open topic with navigation

com.hp.lft.sdk.web

## Class GridBaseDescription

Note: Supported in LeanFT versions 14.51 and later.

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.web.WebBaseDescription
        - - com.hp.lft.sdk.web.WebElementDescription
          - - com.hp.lft.sdk.web.GridBaseDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable
  Direct Known Subclasses:
    AgGridDescription, UiGridDescription

      public abstract class GridBaseDescription
      extends WebElementDescription

  The base description of a Web Grid test object.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `GridBaseDescription.Init<T extends GridBaseDescription.Init<T>>` Helper class for GridBaseDescription.Builder.

    - ### Nested classes/interfaces inherited from class com.hp.lft.sdk.web.WebElementDescription

      `WebElementDescription.Builder`

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `` | `GridBaseDescription()` Initializes a new instance of the GridBaseDescription class.
    `protected` | `GridBaseDescription(GridBaseDescription.Init<?> init)` Initializes a new instance of the GridBaseDescription class using the Builder pattern.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String[]` | `getColumnHeaders()` Returns the collection of column headers.
    `Integer` | `getColumnsCount()` Returns the number of columns in the table.
    `Integer` | `getRowsCount()` Returns the number of rows in the table including the header.
    `void` | `setColumnHeaders(String[] columnHeaders)` Sets a collection of column headers.
    `void` | `setColumnsCount(Integer columnsCount)` Sets the number of columns in the table.
    `void` | `setRowsCount(Integer rowsCount)` Sets the number of rows in the table including the header.

    - ### Methods inherited from class com.hp.lft.sdk.web.WebElementDescription

      `getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath`

    - ### Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription

      `cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase

      `getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

    - ### Methods inherited from class java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface com.hp.lft.sdk.CloneableObject

      `clone`

- - ### Constructor Detail

    - #### GridBaseDescription

          public GridBaseDescription()

      Initializes a new instance of the GridBaseDescription class.

    - #### GridBaseDescription

          protected GridBaseDescription(GridBaseDescription.Init<?> init)

      Initializes a new instance of the GridBaseDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setRowsCount

          public void setRowsCount(Integer rowsCount)

      Sets the number of rows in the table including the header.
      Parameters:
        `rowsCount` - the number of rows in the table including the header.

    - #### getRowsCount

          public Integer getRowsCount()

      Returns the number of rows in the table including the header.
      Returns:
        the number of rows in the table including the header.

    - #### setColumnsCount

          public void setColumnsCount(Integer columnsCount)

      Sets the number of columns in the table.
      Parameters:
        `columnsCount` - the number of columns in the table.

    - #### getColumnsCount

          public Integer getColumnsCount()

      Returns the number of columns in the table.
      Returns:
        the number of columns in the table.

    - #### setColumnHeaders

          public void setColumnHeaders(String[] columnHeaders)

      Sets a collection of column headers.
      Parameters:
        `columnHeaders` - a collection of column headers.

    - #### getColumnHeaders

          public String[] getColumnHeaders()

      Returns the collection of column headers.
      Returns:
        the collection of column headers.