Open topic with navigation

com.hp.lft.sdk.powerbuilder

## Interface TabControl

- All Superinterfaces:
    Clickable, DoubleClickable, EnabledProvider, LocationInfoProvider, SupportDragAndDrop, SupportSendKeys, TestObject, TestObjectDescriber, UiObjectBase, UiObjectWithLayoutInfo, VisibleProvider, WaitUntilEnabledProvider, WaitUntilVisibleProvider

      public interface TabControl
      extends UiObjectWithLayoutInfo, TestObject

  A power builder tab control in a dialog box.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Tab` | `getSelectedTab()` Returns the selected tab in the tab control.
    `Tab` | `getTab(String name)` Returns the tab with the specified name.
    `List<Tab>` | `getTabs()` Returns all tabs in the tab control.
    `void` | `select(int tabIndex)` Selects the specified tab by tab index.
    `void` | `select(int tabIndex, MouseButton button)` Selects the specified tab by tab index.
    `void` | `select(String tab)` Selects the specified tab by tab name.
    `void` | `select(String tab, MouseButton button)` Selects the specified tab by tab name.
    `void` | `select(Tab tab)` Selects the specified tab.
    `void` | `select(Tab tab, MouseButton button)` Selects the specified tab in the tab control.

    - ### Methods inherited from interface com.hp.lft.sdk.powerbuilder.UiObjectWithLayoutInfo

      `isRightAligned, isRightToLeftLayout, isRightToLeftReading`

    - ### Methods inherited from interface com.hp.lft.sdk.powerbuilder.UiObjectBase

      `getAttachedText, getObjectName, getText, getWindowClassRegExp, getWindowExtendedStyle, getWindowId, getWindowStyle`

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

      `getHandle, getNativeClass, getWindowTitleRegExp, isFocused, mouseMove`

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

      `click, click, click`

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

      `doubleClick, doubleClick, doubleClick`

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

      `getAbsoluteLocation, getLocation, getSize`

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

      `sendKeys, sendKeys`

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

      `dragAndDropOn, dragAndDropOn`

    - ### 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.WaitUntilVisibleProvider

      `waitUntilVisible, waitUntilVisible`

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

      `isVisible`

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

- - ### Method Detail

    - #### getTabs

          List<Tab> getTabs()
                     throws GeneralLeanFtException

      Returns all tabs in the tab control.
      Returns:
        all tabs in the tab control.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getSelectedTab

          Tab getSelectedTab()
                      throws GeneralLeanFtException

      Returns the selected tab in the tab control.
      Returns:
        the selected tab in the tab control.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### select

          void select(Tab tab,
                      MouseButton button)
               throws GeneralLeanFtException

      Selects the specified tab in the tab control.
      Parameters:
        `tab` - the specified tab to select from the tab control.
        `button` - the mouse button used to select the list item. Possible values: `MouseButton`
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### select

          void select(String tab,
                      MouseButton button)
               throws GeneralLeanFtException

      Selects the specified tab by tab name.
      Parameters:
        `tab` - the specified tab to select from the tab control.
        `button` - the mouse button used to select the list item. Possible values: `MouseButton`
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### select

          void select(int tabIndex,
                      MouseButton button)
               throws GeneralLeanFtException

      Selects the specified tab by tab index.
      Parameters:
        `tabIndex` - the index of tab to select from the tab control.
        `button` - the mouse button used to select the list item. Possible values: `MouseButton`
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### select

          void select(Tab tab)
               throws GeneralLeanFtException

      Selects the specified tab.
      Parameters:
        `tab` - the tab to select from the tab control.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### select

          void select(String tab)
               throws GeneralLeanFtException

      Selects the specified tab by tab name.
      Parameters:
        `tab` - the tab to select from the tab control.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### select

          void select(int tabIndex)
               throws GeneralLeanFtException

      Selects the specified tab by tab index.
      Parameters:
        `tabIndex` - the index of tab to select from the tab control.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getTab

          Tab getTab(String name)
              throws GeneralLeanFtException

      Returns the tab with the specified name.
      Parameters:
        `name` - the name of the tab control item to return.
      Returns:
        the tab with the specified name.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution