Share this page

com.hp.lft.sdk.sap.gui

## Class CheckBoxDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.sap.gui.ElementDescription
        - - com.hp.lft.sdk.sap.gui.CheckBoxDescription

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

      public class CheckBoxDescription
      extends ElementDescription

  Description of a SAP GUI for Windows checkbox.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getAttachedText()` Returns the text associated with the object.
    `java.lang.Boolean` | `isChecked()` Indicates whether the checkbox is checked.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the object can accept user input.
    `void` | `setAttachedText(java.lang.String text)` Sets the text associated with the object.
    `void` | `setAttachedText(StringProperty text)` Sets the text associated with the object.
    `void` | `setChecked(java.lang.Boolean isChecked)` Sets whether the checkbox is checked.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the object can accept user input.

    - ### Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription

      `getAbsoluteLocation, getId, getLocation, getName, getSize, getType, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setId, setId, setLocation, setLocation, setLocation, setName, setName, setSize, setSize, setSize, setType`

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

    - #### CheckBoxDescription

          public CheckBoxDescription()

      Initializes a new instance of the CheckBoxDescription class.

    - #### CheckBoxDescription

          protected CheckBoxDescription(CheckBoxDescription.Init<?> init)

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

  - ### Method Detail

    - #### setAttachedText

          public void setAttachedText(StringProperty text)

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

    - #### setAttachedText

          public void setAttachedText(java.lang.String text)

      Sets the text associated with the object.
      Parameters:
        `text` - the text associated with the object.

    - #### getAttachedText

          public StringProperty getAttachedText()

      Returns the text associated with the object.
      Returns:
        the text associated with the object.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the object can accept user input.
      Parameters:
        `isEnabled` - true if enabled.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether the object can accept user input.
      Returns:
        true if enabled.

    - #### setChecked

          public void setChecked(java.lang.Boolean isChecked)

      Sets whether the checkbox is checked.
      Parameters:
        `isChecked` - whether the checkbox is checked.

    - #### isChecked

          public java.lang.Boolean isChecked()

      Indicates whether the checkbox is checked.
      Returns:
        whether the checkbox is checked.

Tips to improve your search results... UFT Developer Java SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: