Open topic with navigation

com.hp.lft.sdk.winforms

## 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.winforms.UiObjectDescriptionBase
        - - com.hp.lft.sdk.winforms.CheckBoxDescription

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

      public class CheckBoxDescription
      extends UiObjectDescriptionBase

  The description of .Net windows forms a CheckBox test object.

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `CheckBoxDescription()` Constructs a new instance of CheckBoxDescription.
    `protected` | `CheckBoxDescription(CheckBoxDescription.Init<?> init)`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `CheckedState` | `getState()` Returns the CheckBox state.
    `java.lang.Boolean` | `isChecked()` Indicates whether the check box is checked.
    `java.lang.Boolean` | `isThreeState()` Indicates whether the CheckBox is able to display three check states.
    `void` | `setChecked(java.lang.Boolean isChecked)` Sets whether the check box is checked.
    `void` | `setState(CheckedState state)` Sets the CheckBox state.
    `void` | `setThreeState(java.lang.Boolean isThreeState)` Sets whether the CheckBox is able to display three check states.

    - ### Methods inherited from class com.hp.lft.sdk.winforms.UiObjectDescriptionBase

      `getAbsoluteLocation, getFullNamePath, getFullType, getLocation, getNativeClass, getObjectName, getObjectProperties, getSize, getText, getWindowClassRegExp, getWindowId, getWindowTitleRegExp, isChildWindow, isEnabled, isFocused, isOwnedWindow, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setChildWindow, setEnabled, setFocused, setFullNamePath, setFullNamePath, setFullType, setFullType, setLocation, setLocation, setLocation, setNativeClass, setNativeClass, setObjectName, setObjectName, setObjectProperties, setOwnedWindow, setSize, setSize, setSize, setText, setText, setVisible, setWindowClassRegExp, setWindowClassRegExp, setWindowId, setWindowTitleRegExp, setWindowTitleRegExp`

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

      Constructs a new instance of CheckBoxDescription.

    - #### CheckBoxDescription

          protected CheckBoxDescription(CheckBoxDescription.Init<?> init)

  - ### Method Detail

    - #### getState

          public CheckedState getState()

      Returns the CheckBox state.
      Returns:
        the CheckBox state

    - #### setState

          public void setState(CheckedState state)

      Sets the CheckBox state.
      Parameters:
        `state` - the CheckBox state

    - #### setChecked

          public void setChecked(java.lang.Boolean isChecked)

      Sets whether the check box is checked.
      Parameters:
        `isChecked` - whether the check box is checked

    - #### isChecked

          public java.lang.Boolean isChecked()

      Indicates whether the check box is checked.
      Returns:
        true if checked

    - #### setThreeState

          public void setThreeState(java.lang.Boolean isThreeState)

      Sets whether the CheckBox is able to display three check states.
      Parameters:
        `isThreeState` - the CheckBox is able to display three check states

    - #### isThreeState

          public java.lang.Boolean isThreeState()

      Indicates whether the CheckBox is able to display three check states.
      Returns:
        true if able to display three check states