Open topic with navigation

com.hp.lft.sdk.wpf

## Class ListDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.wpf.UiObjectDescriptionBase
        - - com.hp.lft.sdk.wpf.ListDescription

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

      public class ListDescription
      extends UiObjectDescriptionBase

  The description of a WPF List test object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getHelpText()` Returns the help text associated with this object.
    `java.lang.String[]` | `getItems()` Returns the list of all items in the list object.
    `StringProperty` | `getName()` Returns the name of this object.
    `StringProperty` | `getParentText()` Returns the text associated with the parent object of this object.
    `java.lang.String[]` | `getSelectedItems()` Returns the list of items that are selected in the list object.
    `java.lang.Boolean` | `isSelectMultiple()` Indicates whether the container allows more than one child element to be selected concurrently.
    `void` | `setHelpText(java.lang.String helpText)` Sets the help text associated with this object.
    `void` | `setHelpText(StringProperty helpText)` Sets the help text associated with this object.
    `void` | `setItems(java.lang.String[] items)` Sets the list of all items in the list object.
    `void` | `setName(java.lang.String name)` Sets the name of the object.
    `void` | `setName(StringProperty name)` Sets the name of the object.
    `void` | `setParentText(java.lang.String parentText)` Sets the text associated with the parent object of this object.
    `void` | `setParentText(StringProperty parentText)` Sets the text associated with the parent object of this object.
    `void` | `setSelectedItems(java.lang.String[] items)` Sets the list of items that are selected in the list object.
    `void` | `setSelectMultiple(java.lang.Boolean isSelectMultiple)` Sets whether the container allows more than one child element to be selected concurrently.

    - ### Methods inherited from class com.hp.lft.sdk.wpf.UiObjectDescriptionBase

      `canFocus, getAbsoluteLocation, getAttachedText, getFullNamePath, getFullType, getLocation, getNativeClass, getObjectName, getObjectProperties, getSize, getText, getWindowTitleRegExp, isEnabled, isFocused, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttachedText, setAttachedText, setCanFocus, setEnabled, setFocused, setFullNamePath, setFullNamePath, setFullType, setFullType, setLocation, setLocation, setLocation, setNativeClass, setNativeClass, setObjectName, setObjectName, setObjectProperties, setSize, setSize, setSize, setText, setText, setVisible, setWindowTitleRegExp, setWindowTitleRegExp`

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

    - #### ListDescription

          public ListDescription()

      Initializes a new instance of the ListDescription class.

    - #### ListDescription

          protected ListDescription(ListDescription.Init<?> init)

  - ### Method Detail

    - #### setSelectMultiple

          public void setSelectMultiple(java.lang.Boolean isSelectMultiple)

      Sets whether the container allows more than one child element to be selected concurrently.
      Parameters:
        `isSelectMultiple` - whether the container allows more than one child element to be selected concurrently.

    - #### isSelectMultiple

          public java.lang.Boolean isSelectMultiple()

      Indicates whether the container allows more than one child element to be selected concurrently.
      Returns:
        true, if the container allows more than one child element to be selected concurrently.

    - #### setParentText

          public void setParentText(java.lang.String parentText)

      Sets the text associated with the parent object of this object.
      Parameters:
        `parentText` - the text to associate with the parent object

    - #### setParentText

          public void setParentText(StringProperty parentText)

      Sets the text associated with the parent object of this object.
      Parameters:
        `parentText` - a StringProperty or RegExpProperty

    - #### getParentText

          public StringProperty getParentText()

      Returns the text associated with the parent object of this object.
      Returns:
        parentText the text associated with the parent

    - #### setName

          public void setName(java.lang.String name)

      Sets the name of the object.
      Parameters:
        `name` - the name of this object

    - #### setName

          public void setName(StringProperty name)

      Sets the name of the object.
      Parameters:
        `name` - a StringProperty(or RegExpProperty) representing the text associated with the name of the object.

    - #### getName

          public StringProperty getName()

      Returns the name of this object.
      Returns:
        name the name of the object.

    - #### setHelpText

          public void setHelpText(java.lang.String helpText)

      Sets the help text associated with this object.
      Parameters:
        `helpText` - the help text associated with the this object

    - #### setHelpText

          public void setHelpText(StringProperty helpText)

      Sets the help text associated with this object.
      Parameters:
        `helpText` - a `StringProperty` or `RegExpProperty`

    - #### getHelpText

          public StringProperty getHelpText()

      Returns the help text associated with this object.
      Returns:
        helpText the help text

    - #### setItems

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

      Sets the list of all items in the list object.
      Parameters:
        `items` - the list of all items in the list object.

    - #### getItems

          public java.lang.String[] getItems()

      Returns the list of all items in the list object.
      Returns:
        the list of all items in the list object.

    - #### setSelectedItems

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

      Sets the list of items that are selected in the list object.
      Parameters:
        `items` - the list of items that are selected in the list object.

    - #### getSelectedItems

          public java.lang.String[] getSelectedItems()

      Returns the list of items that are selected in the list object.
      Returns:
        the list of items that are selected in the list object.