Open topic with navigation

com.hp.lft.sdk.oracle

# Class ButtonDescription

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

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

      public class ButtonDescription
      extends UiObjectBaseDescription

  The description of an Oracle button.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getClassPath()` Returns the Oracle class hierarchy of the object's Oracle class.
    `StringProperty` | `getLabel()` Returns the text displayed on the object.
    `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.
    `StringProperty` | `getTooltipText()` Returns the text displayed in the object's tooltip.
    `Boolean` | `isEnabled()` Indicates whether the object is enable.
    `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` | `setLabel(String label)` Sets the text displayed on the object.
    `void` | `setLabel(StringProperty label)` Sets the text displayed on the object.
    `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` | `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

    - #### ButtonDescription

          public ButtonDescription()

      Initializes a new instance of the ButtonDescription class.

    - #### ButtonDescription

          protected ButtonDescription(ButtonDescription.Init<?> init)

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

  - ### Method Detail

    - #### setLabel

          public void setLabel(String label)

      Sets the text displayed on the object.
      Parameters:
        `label` - the text displayed on the object.

    - #### setLabel

          public void setLabel(StringProperty label)

      Sets the text displayed on the object.
      Parameters:
        `label` - a `StringProperty` or `RegExpProperty`.

    - #### getLabel

          public StringProperty getLabel()

      Returns the text displayed on the object.
      Returns:
        the text displayed on the object.

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