Open topic with navigation

com.hp.lft.sdk.oracle

# Class RadioGroupDescription

Note: Supported in LeanFT versions 14.52 and later.

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.oracle.UiObjectBaseDescription
        - - com.hp.lft.sdk.oracle.RadioGroupDescription

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

      public class RadioGroupDescription
      extends UiObjectBaseDescription

  The description of an Oracle option (radio button) group.

- - ### Nested Class Summary

    Nested Classes
    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

    Constructors
    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

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getCaption()` Returns the caption of the object.
    `StringProperty` | `getClassPath()` Returns the Oracle class hierarchy of the object's Oracle class.
    `StringProperty` | `getObjectDescription()` Returns the accessibility description of the object as specified by the server.
    `StringProperty` | `getObjectName()` Returns internal name of the object supplied by the application server.
    `Integer` | `getSelectedIndex()` Returns the index of the selected item (0-based).
    `StringProperty` | `getSelectedItem()` Returns the value of the selected item.
    `StringProperty` | `getTooltipText()` Returns the text displayed in the object's tooltip.
    `Boolean` | `isEnabled()` Indicates whether the object is enable.
    `void` | `setCaption(String caption)` Sets the caption of the object.
    `void` | `setCaption(StringProperty caption)` Sets the caption of the object.
    `void` | `setClassPath(String classPath)` Sets the Oracle class hierarchy of the object's Oracle class.
    `void` | `setClassPath(StringProperty classPath)` Sets the Oracle class hierarchy of the object's Oracle class.
    `void` | `setEnabled(Boolean isEnabled)` Sets whether the object is enable.
    `void` | `setObjectDescription(String objectDescription)` Sets the accessibility description of the object as specified by the server.
    `void` | `setObjectDescription(StringProperty objectDescription)` Sets the accessibility description of the object as specified by the server.
    `void` | `setObjectName(String objectName)` Sets the internal name of the object supplied by the application server.
    `void` | `setObjectName(StringProperty objectName)` Sets the internal name of the object supplied by the application server.
    `void` | `setSelectedIndex(Integer selectedIndex)` Sets the index of the selected item.
    `void` | `setSelectedItem(String selectedItem)` Sets the value of the selected item.
    `void` | `setSelectedItem(StringProperty selectedItem)` Sets the value of the selected item.
    `void` | `setTooltipText(String tooltipText)` Sets the text displayed in the object's tooltip.
    `void` | `setTooltipText(StringProperty tooltipText)` Sets the text displayed in the object's tooltip.

    - ### Methods inherited from class com.hp.lft.sdk.oracle.UiObjectBaseDescription

      `getAbsoluteLocation, getLocation, getObjectType, getSize, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setLocation, setLocation, setLocation, setObjectType, setObjectType, setSize, setSize, setSize`

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

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

    - #### setSelectedIndex

          public void setSelectedIndex(Integer selectedIndex)

      Sets the index of the selected item.
      Parameters:
        `selectedIndex` - the index of the selected item.

    - #### getSelectedIndex

          public Integer getSelectedIndex()

      Returns the index of the selected item (0-based).
      Returns:
        the index of the selected item (0-based).
        Note: If no item is selected, -1 is returned.

    - #### setSelectedItem

          public void setSelectedItem(String selectedItem)

      Sets the value of the selected item.
      Parameters:
        `selectedItem` - the value of the selected item.

    - #### setSelectedItem

          public void setSelectedItem(StringProperty selectedItem)

      Sets the value of the selected item.
      Parameters:
        `selectedItem` - a `StringProperty` or `RegExpProperty`.

    - #### getSelectedItem

          public StringProperty getSelectedItem()

      Returns the value of the selected item.
      Returns:
        the value of the selected item.

    - #### setClassPath

          public void setClassPath(String classPath)

      Sets the Oracle class hierarchy of the object's Oracle class.
      Parameters:
        `classPath` - the Oracle class hierarchy of the object's Oracle class.

    - #### setClassPath

          public void setClassPath(StringProperty classPath)

      Sets the Oracle class hierarchy of the object's Oracle class.
      Parameters:
        `classPath` - a `StringProperty` or `RegExpProperty`.

    - #### getClassPath

          public StringProperty getClassPath()

      Returns the Oracle class hierarchy of the object's Oracle class.
      Returns:
        the Oracle class hierarchy of the object's Oracle class.

    - #### setEnabled

          public void setEnabled(Boolean isEnabled)

      Sets whether the object is enable.
      Parameters:
        `isEnabled` - true to set as enabled.

    - #### isEnabled

          public Boolean isEnabled()

      Indicates whether the object is enable.
      Returns:
        true if enabled.

    - #### setObjectDescription

          public void setObjectDescription(String objectDescription)

      Sets the accessibility description of the object as specified by the server.
      Parameters:
        `objectDescription` - the accessibility description of the object as specified by the server.

    - #### setObjectDescription

          public void setObjectDescription(StringProperty objectDescription)

      Sets the accessibility description of the object as specified by the server.
      Parameters:
        `objectDescription` - a `StringProperty` or `RegExpProperty`.

    - #### getObjectDescription

          public StringProperty getObjectDescription()

      Returns the accessibility description of the object as specified by the server.
      Returns:
        the accessibility description of the object as specified by the server.

    - #### setObjectName

          public void setObjectName(String objectName)

      Sets the internal name of the object supplied by the application server.
      Parameters:
        `objectName` - the internal name of the object supplied by the application server.

    - #### setObjectName

          public void setObjectName(StringProperty objectName)

      Sets the internal name of the object supplied by the application server.
      Parameters:
        `objectName` - a `StringProperty` or `RegExpProperty`.

    - #### getObjectName

          public StringProperty getObjectName()

      Returns internal name of the object supplied by the application server.
      Returns:
        internal name of the object supplied by the application server.

    - #### setTooltipText

          public void setTooltipText(String tooltipText)

      Sets the text displayed in the object's tooltip.
      Parameters:
        `tooltipText` - the text displayed in the object's tooltip.

    - #### setTooltipText

          public void setTooltipText(StringProperty tooltipText)

      Sets the text displayed in the object's tooltip.
      Parameters:
        `tooltipText` - a `StringProperty` or `RegExpProperty`.

    - #### getTooltipText

          public StringProperty getTooltipText()

      Returns the text displayed in the object's tooltip.
      Returns:
        the text displayed in the object's tooltip.

    - #### setCaption

          public void setCaption(String caption)

      Sets the caption of the object.
      Parameters:
        `caption` - the caption of the object.

    - #### setCaption

          public void setCaption(StringProperty caption)

      Sets the caption of the object.
      Parameters:
        `caption` - a `StringProperty` or `RegExpProperty`.

    - #### getCaption

          public StringProperty getCaption()

      Returns the caption of the object.
      Returns:
        the caption of the object.