Open topic with navigation

com.hp.lft.sdk.stdwin

## Class UiObjectDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.stdwin.UiObjectBaseDescription
        - - com.hp.lft.sdk.stdwin.UiObjectWithLayoutInfoDescription
          - - com.hp.lft.sdk.stdwin.UiObjectDescription

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

      public class UiObjectDescription
      extends UiObjectWithLayoutInfoDescription

  The description of a standard Windows UiObject test object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `ScrollProperty` | `getHorizontalScroll()` Returns the scroll properties for the horizontal scroll bar.
    `ScrollProperty` | `getVerticalScroll()` Returns the scroll properties for the horizontal scroll bar.
    `void` | `setHorizontalScroll(ScrollInfo scroll)` Sets the scroll info for the horizontal scroll bar.
    `void` | `setHorizontalScroll(ScrollProperty scroll)` Sets the scroll properties for the horizontal scroll bar.
    `void` | `setVerticalScroll(ScrollInfo scroll)` Sets the scroll info for the vertical scroll bar.
    `void` | `setVerticalScroll(ScrollProperty scroll)` Sets the scroll properties for the vertical scroll bar.

    - ### Methods inherited from class com.hp.lft.sdk.stdwin.UiObjectWithLayoutInfoDescription

      `isRightAligned, isRightToLeftLayout, isRightToLeftReading, setRightAligned, setRightToLeftLayout, setRightToLeftReading`

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

      `getAbsoluteLocation, getAccessibleName, getAttachedText, getLocation, getNativeClass, getSize, getText, getWindowClassRegExp, getWindowExtendedStyle, getWindowExtendedStyleAsLong, getWindowId, getWindowStyle, getWindowStyleAsLong, getWindowTitleRegExp, isEnabled, isFocused, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAccessibleName, setAccessibleName, setAttachedText, setAttachedText, setEnabled, setFocused, setLocation, setLocation, setLocation, setNativeClass, setNativeClass, setSize, setSize, setSize, setText, setText, setVisible, setWindowClassRegExp, setWindowClassRegExp, setWindowExtendedStyle, setWindowExtendedStyle, setWindowId, setWindowStyle, setWindowStyle, 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

    - #### UiObjectDescription

          public UiObjectDescription()

      Initializes a new instance of the UiObjectDescription class.

    - #### UiObjectDescription

          protected UiObjectDescription(UiObjectDescription.Init<?> init)

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

  - ### Method Detail

    - #### setHorizontalScroll

          public void setHorizontalScroll(ScrollProperty scroll)

      Sets the scroll properties for the horizontal scroll bar. Possible values: `ScrollProperty`
      Parameters:
        `scroll` - the horizontal scroll bar properties. Possible values: `ScrollProperty`

    - #### setHorizontalScroll

          public void setHorizontalScroll(ScrollInfo scroll)

      Sets the scroll info for the horizontal scroll bar. Possible values: `ScrollInfo`
      Parameters:
        `scroll` - the horizontal scroll bar information. Possible values: `ScrollInfo`

    - #### getHorizontalScroll

          public ScrollProperty getHorizontalScroll()

      Returns the scroll properties for the horizontal scroll bar. Possible values: `ScrollProperty`
      Returns:
        the scroll properties for the horizontal scroll bar. Possible values: `ScrollProperty`

    - #### setVerticalScroll

          public void setVerticalScroll(ScrollProperty scroll)

      Sets the scroll properties for the vertical scroll bar. Possible values: `ScrollProperty`
      Parameters:
        `scroll` - the vertical scroll bar properties. `ScrollProperty`

    - #### setVerticalScroll

          public void setVerticalScroll(ScrollInfo scroll)

      Sets the scroll info for the vertical scroll bar. Possible values: `ScrollInfo`
      Parameters:
        `scroll` - the vertical scroll bar information. Possible values: `ScrollInfo`

    - #### getVerticalScroll

          public ScrollProperty getVerticalScroll()

      Returns the scroll properties for the horizontal scroll bar. `ScrollProperty`
      Returns:
        the scroll properties for the horizontal scroll bar. `ScrollProperty`