Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class ComboBoxDescription

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

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

      public class ComboBoxDescription
      extends ElementDescription

  Description of a SAP GUI for Windows combo box.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String[]` | `getItems()` Returns the list of items in the control.
    `java.lang.Integer` | `getItemsCount()` Gets the number of items contained in the combo box.
    `StringProperty` | `getSelectedItem()` Returns the selected item in the combo box.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the object can accept user input.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the object can accept user input.
    `void` | `setItems(java.lang.String[] items)` Sets the list of items in the control.
    `void` | `setItemsCount(java.lang.Integer itemsCount)` Sets the number of items contained in the combo box.
    `void` | `setSelectedItem(java.lang.String item)` Sets the selected item in the combo box.
    `void` | `setSelectedItem(StringProperty item)` Sets the selected item in the combo box.

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

    - #### ComboBoxDescription

          public ComboBoxDescription()

      Initializes a new instance of the ComboBoxDescription class.

    - #### ComboBoxDescription

          protected ComboBoxDescription(ComboBoxDescription.Init<?> init)

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

  - ### Method Detail

    - #### setSelectedItem

          public void setSelectedItem(java.lang.String item)

      Sets the selected item in the combo box.
      Parameters:
        `item` - the selected item.

    - #### setSelectedItem

          public void setSelectedItem(StringProperty item)

      Sets the selected item in the combo box.
      Parameters:
        `item` - a `StringProperty` or `RegExpProperty`.

    - #### getSelectedItem

          public StringProperty getSelectedItem()

      Returns the selected item in the combo box.
      Returns:
        the selected item.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the object can accept user input.
      Parameters:
        `isEnabled` - true if enabled.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

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

    - #### setItems

          public void setItems(java.lang.String[] items)

      Sets the list of items in the control.
      Parameters:
        `items` - the list of items.

    - #### getItems

          public java.lang.String[] getItems()

      Returns the list of items in the control.
      Returns:
        the list of items.

    - #### setItemsCount

          public void setItemsCount(java.lang.Integer itemsCount)

      Sets the number of items contained in the combo box.
      Parameters:
        `itemsCount` - the number of items.

    - #### getItemsCount

          public java.lang.Integer getItemsCount()

      Gets the number of items contained in the combo box.
      Returns:
        the number of items.