Open topic with navigation

com.hp.lft.sdk.sap.gui

## Interface TabControl

- All Superinterfaces:
    Element, LocationInfoProvider, SupportsNativeObject, TestObject, TestObjectDescriber, WaitUntilEnabledProvider, EnabledProvider

      public interface TabControl
      extends Element

  A tab strip control in a SAP GUI for Windows application.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getSelectedTab()` Returns the name of the selected tab.
    `java.util.List<java.lang.String>` | `getTabs()` Returns the list of tabs in the tab strip.
    `java.lang.String` | `getText()` Returns the text associated with tab strip.
    `java.lang.String` | `getTooltip()` Returns tab strip's tooltip.
    `boolean` | `isEnabled()` Indicates whether tab strip can accept user input.
    `void` | `select(int tabIndex)` Selects the specified tab by index.
    `void` | `select(java.lang.String tab)` Selects the specified tab from the tab strip.
    `void` | `setFocus()` Sets the focus to the tab strip.

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

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

      `waitUntilEnabled, waitUntilEnabled`

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

      `isEnabled`

- - ### Method Detail

    - #### isEnabled

          boolean isEnabled()
                     throws GeneralLeanFtException

      Indicates whether tab strip can accept user input.
      Returns:
        true if enabled.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getText

          java.lang.String getText()
                            throws GeneralLeanFtException

      Returns the text associated with tab strip.
      Returns:
        the text.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getTooltip

          java.lang.String getTooltip()
                               throws GeneralLeanFtException

      Returns tab strip's tooltip.
      Returns:
        the tooltip.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getTabs

          java.util.List<java.lang.String> getTabs()
                                            throws GeneralLeanFtException

      Returns the list of tabs in the tab strip.
      Returns:
        the list of tabs.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSelectedTab

          java.lang.String getSelectedTab()
                                   throws GeneralLeanFtException

      Returns the name of the selected tab.
      Returns:
        the name of the selected tab.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(java.lang.String tab)
               throws GeneralLeanFtException

      Selects the specified tab from the tab strip.
      Parameters:
        `tab` - the name of the tab.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(int tabIndex)
               throws GeneralLeanFtException

      Selects the specified tab by index.
      Parameters:
        `tabIndex` - 1-based.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setFocus

          void setFocus()
                 throws GeneralLeanFtException

      Sets the focus to the tab strip. Invoke this method before methods that operate on the strip.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.