Class ListBoxDescription

All Implemented Interfaces:
CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable
Direct Known Subclasses:
ListBoxDescription

public class ListBoxDescription extends FormFieldDescription
The description of a Web ListBox test object.
  • Constructor Details

    • ListBoxDescription

      public ListBoxDescription()
      Initializes a new instance of the ListBoxDescription class.
    • ListBoxDescription

      protected ListBoxDescription(ListBoxDescription.Init<?> init)
      Initializes a new instance of the ListBoxDescription class using the Builder pattern.
      Parameters:
      init - the Builder pattern.
  • Method Details

    • setValue

      public void setValue(StringProperty value)
      Sets the current text in the edit field.
      Parameters:
      value - a StringProperty (or RegExpProperty) representing the current text in the edit field.
    • setValue

      public void setValue(String value)
      Sets the current text in the edit field.
      Parameters:
      value - the current text in the edit field.
    • getValue

      public StringProperty getValue()
      Returns the object's current text.
      Returns:
      the object's current text.
    • setDefaultValue

      public void setDefaultValue(StringProperty defaultValue)
      Sets the initial text value, which is set when the object is reset.
      Parameters:
      defaultValue - a StringProperty (or RegExpProperty) representing the initial text value, which is set when the object is reset.
    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      Sets the initial text value, which is set when the object is reset.
      Parameters:
      defaultValue - the initial text value, which is set when the object is reset.
    • getDefaultValue

      public StringProperty getDefaultValue()
      Returns the initial text value, which is set when the object is reset.
      Returns:
      the initial text value, which is set when the object is reset.
    • setEnabled

      public void setEnabled(Boolean isEnabled)
      Sets whether the list box is enabled.
      Parameters:
      isEnabled - true if the list box is enabled.
    • isEnabled

      public Boolean isEnabled()
      Indicates whether the list box is enabled.
      Returns:
      true if enabled.
    • setMultiple

      public void setMultiple(Boolean isMultiple)
      Sets whether the user can select multiple items.
      Parameters:
      isMultiple - true if the user can select multiple items.
    • isMultiple

      public Boolean isMultiple()
      Indicates whether the user can select multiple items.
      Returns:
      true if the user can select multiple items.
    • setVisibleItemsCount

      public void setVisibleItemsCount(Integer visibleItemsCount)
      Sets the number of items that are displayed in the list box.
      Parameters:
      visibleItemsCount - the number of items that are displayed in the list box.
    • getVisibleItemsCount

      public Integer getVisibleItemsCount()
      Returns the number of items that are displayed in the list box.
      Returns:
      the number of items that are displayed in the list box.
    • setItems

      public void setItems(String[] items)
      Sets the items in the list.
      Parameters:
      items - the items in the list.
    • getItems

      public String[] getItems()
      Returns the collection of items in the list.

      Note: When weblist items are loaded dynamically, it is possible that only a partial list of the items will be returned.

      Returns:
      the collection of items in the list.
    • setSelectedItems

      public void setSelectedItems(String[] items)
      Sets the selected items in the list.
      Parameters:
      items - the selected items in the list.
    • getSelectedItems

      public String[] getSelectedItems()
      Returns the collection of selected items in the list.
      Returns:
      the collection of selected items in the list.
    • setItemsCount

      public void setItemsCount(Integer count)
      Sets the number of items in the list.
      Parameters:
      count - the number of items in the list.
    • getItemsCount

      public Integer getItemsCount()
      Returns the number of items in the list.
      Returns:
      the number of items in the list.
    • setFirstItem

      public void setFirstItem(StringProperty firstItem)
      Sets the first item in the list of items in the list.
      Parameters:
      firstItem - a StringProperty (or RegExpProperty) representing the first item in the list of items in the list.
    • setFirstItem

      public void setFirstItem(String firstItem)
      Sets the first item in the list of items in the list.
      Parameters:
      firstItem - the first item in the list of items in the list.
    • getFirstItem

      public StringProperty getFirstItem()
      Returns the first item in the list of items in the list.
      Returns:
      the first item in the list of items in the list.