Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class TabControlDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.sap.gui.ElementDescription
        - - com.hp.lft.sdk.sap.gui.TabControlDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable

      public class TabControlDescription
      extends ElementDescription

  Description of a SAP GUI for Windows tab strip.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `TabControlDescription.Builder` This class can be used to construct an instance of the TabControlDescription class using the builder pattern.
    `protected static class` | `TabControlDescription.Init<T extends TabControlDescription.Init<T>>` Helper class for TabControlDescription.Builder.

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getSelectedTab()` Returns the selected tab.
    `java.lang.String[]` | `getTabs()` Returns the list of the tabs in the tab object.
    `java.lang.Integer` | `getTabsCount()` Returns the number of tabs contained in the tab object.
    `StringProperty` | `getText()` Returns the text associated with the tab object.
    `StringProperty` | `getTooltip()` Returns the value of the tab object's tooltip.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the tab object can accept user input.
    `void` | `setEnabled(java.lang.Boolean enabled)` Sets whether the tab object can accept user input.
    `void` | `setSelectedTab(java.lang.String tab)` Selects the specified tab in the tab control.
    `void` | `setSelectedTab(StringProperty tab)` Selects the specified tab in the tab object.
    `void` | `setTabs(java.lang.String[] tabs)` Sets the list of tabs in the tab object.
    `void` | `setTabsCount(java.lang.Integer number)` Sets the number of tabs contained in the tab object.
    `void` | `setText(java.lang.String text)` Sets the text associated with the tab object.
    `void` | `setText(StringProperty text)` Sets the text associated with the tab object.
    `void` | `setTooltip(java.lang.String tooltip)` Sets the value of the tab object's tooltip.
    `void` | `setTooltip(StringProperty tooltip)` Sets the value of the tab object's tooltip.

    - ### Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription

      `getAbsoluteLocation, getId, getLocation, getName, getSize, getType, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setId, setId, setLocation, setLocation, setLocation, setName, setName, setSize, setSize, setSize, setType`

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

      `cloneTo, 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

    - #### TabControlDescription

          public TabControlDescription()

      Initializes a new instance of the TabControlDescription class.

    - #### TabControlDescription

          protected TabControlDescription(TabControlDescription.Init<?> init)

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

  - ### Method Detail

    - #### setSelectedTab

          public void setSelectedTab(java.lang.String tab)

      Selects the specified tab in the tab control.
      Parameters:
        `tab` - the tab.

    - #### setSelectedTab

          public void setSelectedTab(StringProperty tab)

      Selects the specified tab in the tab object.
      Parameters:
        `tab` - a `StringProperty` or `RegExpProperty`.

    - #### getSelectedTab

          public StringProperty getSelectedTab()

      Returns the selected tab.
      Returns:
        the selected tab.

    - #### setTooltip

          public void setTooltip(StringProperty tooltip)

      Sets the value of the tab object's tooltip.
      Parameters:
        `tooltip` - a `StringProperty` or `RegExpProperty`.

    - #### setTooltip

          public void setTooltip(java.lang.String tooltip)

      Sets the value of the tab object's tooltip.
      Parameters:
        `tooltip` - the tooltip.

    - #### getTooltip

          public StringProperty getTooltip()

      Returns the value of the tab object's tooltip.
      Returns:
        the tooltip.

    - #### setText

          public void setText(StringProperty text)

      Sets the text associated with the tab object.
      Parameters:
        `text` - a `StringProperty` or `RegExpProperty`.

    - #### setText

          public void setText(java.lang.String text)

      Sets the text associated with the tab object.
      Parameters:
        `text` - the text.

    - #### getText

          public StringProperty getText()

      Returns the text associated with the tab object.
      Returns:
        the text.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean enabled)

      Sets whether the tab object can accept user input.
      Parameters:
        `enabled` - true to set as enabled.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether the tab object can accept user input.
      Returns:
        true if enabled.

    - #### setTabs

          public void setTabs(java.lang.String[] tabs)

      Sets the list of tabs in the tab object.
      Parameters:
        `tabs` - the list of tabs.

    - #### getTabs

          public java.lang.String[] getTabs()

      Returns the list of the tabs in the tab object.
      Returns:
        the list of tabs.

    - #### setTabsCount

          public void setTabsCount(java.lang.Integer number)

      Sets the number of tabs contained in the tab object.
      Parameters:
        `number` - the number of tabs.

    - #### getTabsCount

          public java.lang.Integer getTabsCount()

      Returns the number of tabs contained in the tab object.
      Returns:
        the number of tabs.