Open topic with navigation

com.hp.lft.sdk.web

## Class RadioGroupDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.web.WebBaseDescription
        - - com.hp.lft.sdk.web.WebElementDescription
          - - com.hp.lft.sdk.web.FormFieldDescription
            - - com.hp.lft.sdk.web.RadioGroupDescription

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

      public class RadioGroupDescription
      extends FormFieldDescription

  The description of a Web RadioGroup test object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String[]` | `getItems()` Returns the items in the radio group.
    `java.lang.Integer` | `getItemsCount()` Returns the number of items in the radio group.
    `java.lang.Integer` | `getSelectedIndex()` Returns the index of the selected item in the radio group (or -1 if none is selected).
    `StringProperty` | `getSelectedItem()` Returns the currently selected item (or null if none is selected).
    `StringProperty` | `getType()` Returns the type of object as defined in the HTML input tag.
    `java.lang.Boolean` | `hasSelectedItem()` Returns whether an item is selected in the radio group.
    `void` | `hasSelectedItem(java.lang.Boolean hasSelectedItem)` Sets whether there is a selected item in the group.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the radio group is enabled.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the radio group is enabled.
    `void` | `setItems(java.lang.String[] items)` Sets the items in the radio group.
    `void` | `setItemsCount(java.lang.Integer count)` Sets the number of items in the radio group.
    `void` | `setSelectedIndex(java.lang.Integer selectedIndex)` Sets the index of the selected item in the radio group (or -1 if none is selected).
    `void` | `setSelectedItem(java.lang.String selectedItem)` Sets the currently selected item (or null if none is selected).
    `void` | `setSelectedItem(StringProperty selectedItem)` Sets the currently selected item (or null if none is selected).
    `void` | `setType(java.lang.String type)` Sets the type of object as defined in the HTML input tag.
    `void` | `setType(StringProperty type)` Sets the type of object as defined in the HTML input tag.

    - ### Methods inherited from class com.hp.lft.sdk.web.WebElementDescription

      `getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath`

    - ### Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription

      `cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible`

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

      `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

    - #### RadioGroupDescription

          public RadioGroupDescription()

      Initializes a new instance of the RadioGroupDescription class.

    - #### RadioGroupDescription

          protected RadioGroupDescription(RadioGroupDescription.Init<?> init)

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

  - ### Method Detail

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the radio group is enabled.
      Parameters:
        `isEnabled` - true, if the object is enabled.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether the radio group is enabled.
      Returns:
        True if enabled.

    - #### setType

          public void setType(StringProperty type)

      Sets the type of object as defined in the HTML input tag.
      Overrides:
        `setType` in class `FormFieldDescription`
      Parameters:
        `type` - a StringProperty(or RegExpProperty) representing the type of object as defined in the HTML input tag.

    - #### setType

          public void setType(java.lang.String type)

      Sets the type of object as defined in the HTML input tag.
      Overrides:
        `setType` in class `FormFieldDescription`
      Parameters:
        `type` - the type of object as defined in the HTML input tag.

    - #### getType

          public StringProperty getType()

      Returns the type of object as defined in the HTML input tag.
      Overrides:
        `getType` in class `FormFieldDescription`
      Returns:
        the type of object as defined in the HTML input tag.

    - #### setSelectedItem

          public void setSelectedItem(StringProperty selectedItem)

      Sets the currently selected item (or null if none is selected).
      Parameters:
        `selectedItem` - a StringProperty(or RegExpProperty) representing the currently selected item(or null if none is selected).

    - #### setSelectedItem

          public void setSelectedItem(java.lang.String selectedItem)

      Sets the currently selected item (or null if none is selected).
      Parameters:
        `selectedItem` - the currently selected item(or null if none is selected).

    - #### getSelectedItem

          public StringProperty getSelectedItem()

      Returns the currently selected item (or null if none is selected).
      Returns:
        the currently selected item (or null if none is selected).

    - #### setSelectedIndex

          public void setSelectedIndex(java.lang.Integer selectedIndex)

      Sets the index of the selected item in the radio group (or -1 if none is selected).
      Parameters:
        `selectedIndex` - the index of the selected item in the radio group (or -1 if none is selected).

    - #### getSelectedIndex

          public java.lang.Integer getSelectedIndex()

      Returns the index of the selected item in the radio group (or -1 if none is selected).
      Returns:
        the index of the selected item in the radio group (or -1 if none is selected).

    - #### setItems

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

      Sets the items in the radio group.
      Parameters:
        `items` - the items in the radio group.

    - #### getItems

          public java.lang.String[] getItems()

      Returns the items in the radio group.
      Returns:
        the items in the radio group.

    - #### setItemsCount

          public void setItemsCount(java.lang.Integer count)

      Sets the number of items in the radio group.
      Parameters:
        `count` - the number of items in the radio group.

    - #### getItemsCount

          public java.lang.Integer getItemsCount()

      Returns the number of items in the radio group.
      Returns:
        the number of items in the radio group.

    - #### hasSelectedItem

          public java.lang.Boolean hasSelectedItem()

      Returns whether an item is selected in the radio group.
      Returns:
        True, if an item is selected.

    - #### hasSelectedItem

          public void hasSelectedItem(java.lang.Boolean hasSelectedItem)

      Sets whether there is a selected item in the group.
      Parameters:
        `hasSelectedItem` - indicates whether an item is selected in the group.