Open topic with navigation

com.hp.lft.sdk.sap.gui

## Interface CheckBox

- All Superinterfaces:
    Element, LocationInfoProvider, SupportsNativeObject, TestObject, TestObjectDescriber, WaitUntilEnabledProvider, EnabledProvider

      public interface CheckBox
      extends Element

  A checkbox control in a SAP GUI for Windows application.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getAttachedText()` Returns the text associated with the checkbox.
    `boolean` | `isChecked()` Indicates whether this check box is selected.
    `boolean` | `isEnabled()` Indicates whether the checkbox can accept user input.
    `void` | `set(boolean state)` Selects or unselects the check box.
    `void` | `setFocus()` Sets focus on the checkbox.

    - ### Methods inherited from interface com.hp.lft.sdk.sap.gui.Element

      `getId, getName, getType`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObject

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

      `describe`

    - ### Methods inherited from interface com.hp.lft.sdk.LocationInfoProvider

      `getAbsoluteLocation, getLocation, getSize`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportsNativeObject

      `getNativeObject`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilEnabledProvider

      `waitUntilEnabled, waitUntilEnabled`

    - ### Methods inherited from interface com.hp.lft.sdk.EnabledProvider

      `isEnabled`

- - ### Method Detail

    - #### getAttachedText

          java.lang.String getAttachedText()
                                    throws GeneralLeanFtException

      Returns the text associated with the checkbox.
      Returns:
        the text associated with the checkbox.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isChecked

          boolean isChecked()
                     throws GeneralLeanFtException

      Indicates whether this check box is selected.
      Returns:
        whether this check box is selected.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isEnabled

          boolean isEnabled()
                     throws GeneralLeanFtException

      Indicates whether the checkbox can accept user input.
      Returns:
        whether the checkbox can accept user input.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### set

          void set(boolean state)
            throws GeneralLeanFtException

      Selects or unselects the check box.
      Parameters:
        `state` - true to select.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setFocus

          void setFocus()
                 throws GeneralLeanFtException

      Sets focus on the checkbox.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.