Open topic with navigation

com.hp.lft.sdk.stdwin

## Class UiObjectBaseDescription

- 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

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable
  Direct Known Subclasses:
    ScrollBarDescription, SpinBoxDescription, StatusBarDescription, UiObjectWithLayoutInfoDescription

      public abstract class UiObjectBaseDescription
      extends DescriptionBase

  The description of a standard Windows UiObjectBase abstract type.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `UiObjectBaseDescription.Init<T extends UiObjectBaseDescription.Init<T>>`

    - ### Nested classes/interfaces inherited from class com.hp.lft.sdk.DescriptionBase

      `DescriptionBase.Builder`

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `LocationProperty` | `getAbsoluteLocation()` Returns the object's absolute coordinates relative to the screen (in pixels).
    `StringProperty` | `getAccessibleName()` Returns the object's name.
    `StringProperty` | `getAttachedText()` Returns the static text that is attached to this control.
    `LocationProperty` | `getLocation()` Returns the object's coordinates relative to the parent window (in pixels).
    `StringProperty` | `getNativeClass()` Returns the object's window class name.
    `SizeProperty` | `getSize()` Returns the test object's size (in pixels).
    `StringProperty` | `getText()` Returns the text associated with the object.
    `StringProperty` | `getWindowClassRegExp()` Returns the permanent part of the MFC window class.
    `java.util.EnumSet<WindowExtendedStyles>` | `getWindowExtendedStyle()` Returns the extended window style of the object.
    `java.lang.Long` | `getWindowExtendedStyleAsLong()` Returns the extended window style of the object as long.
    `java.lang.Integer` | `getWindowId()` Returns the object's window identifier.
    `java.util.EnumSet<WindowStyles>` | `getWindowStyle()` Returns the window style of the object.
    `java.lang.Long` | `getWindowStyleAsLong()` Returns the window style of the object as long.
    `StringProperty` | `getWindowTitleRegExp()` Returns the constant part of the window title.
    `java.lang.Boolean` | `isEnabled()` Indicates whether this object is enabled.
    `java.lang.Boolean` | `isFocused()` Indicates whether this object is in focus.
    `java.lang.Boolean` | `isVisible()` Indicates whether this object is visible.
    `void` | `setAbsoluteLocation(java.lang.Integer absX, java.lang.Integer absY)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `void` | `setAbsoluteLocation(LocationProperty absLocation)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `void` | `setAbsoluteLocation(java.awt.Point absLocation)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `void` | `setAccessibleName(java.lang.String accessibleName)` Sets the object's name.
    `void` | `setAccessibleName(StringProperty accessibleName)` Sets the object's name.
    `void` | `setAttachedText(java.lang.String attachedText)` Sets the static text that is attached to this object.
    `void` | `setAttachedText(StringProperty attachedText)` Sets the static text that is attached to this object.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether this object is enabled.
    `void` | `setFocused(java.lang.Boolean isFocused)` Sets whether this object is in focus.
    `void` | `setLocation(java.lang.Integer x, java.lang.Integer y)` Sets the object's coordinates relative to the parent window (in pixels).
    `void` | `setLocation(LocationProperty location)` Sets the object's coordinates relative to the parent window (in pixels).
    `void` | `setLocation(java.awt.Point location)` Sets the object's coordinates relative to the parent window (in pixels).
    `void` | `setNativeClass(java.lang.String nativeClass)` Sets the object's window class name.
    `void` | `setNativeClass(StringProperty nativeClass)` Sets the object's window class name.
    `void` | `setSize(java.awt.Dimension size)` Sets the test object's size (in pixels).
    `void` | `setSize(java.lang.Integer width, java.lang.Integer height)` Sets the test object's size (in pixels).
    `void` | `setSize(SizeProperty size)` Sets the test object's size (in pixels).
    `void` | `setText(java.lang.String text)` Sets the text associated with the object.
    `void` | `setText(StringProperty text)` Sets the text associated with the object.
    `void` | `setVisible(java.lang.Boolean isVisible)` Sets the visibility state of the test object.
    `void` | `setWindowClassRegExp(java.lang.String windowClassRegExp)` Sets the permanent part of the MFC window class.
    `void` | `setWindowClassRegExp(StringProperty windowClassRegExp)` Sets the permanent part of the MFC window class.
    `void` | `setWindowExtendedStyle(java.util.EnumSet<WindowExtendedStyles> windowExtendedStyle)` Sets the extended window style of the object.
    `void` | `setWindowExtendedStyle(java.lang.Long windowExtendedStyle)` Sets the extended window style of the object as long.
    `void` | `setWindowId(java.lang.Integer windowId)` Sets the object's window identifier.
    `void` | `setWindowStyle(java.util.EnumSet<WindowStyles> windowStyles)` Sets window style of the object.
    `void` | `setWindowStyle(java.lang.Long windowStyles)` Sets window style of the object as long.
    `void` | `setWindowTitleRegExp(java.lang.String windowTitleRegExp)` Sets the constant part of the window title.
    `void` | `setWindowTitleRegExp(StringProperty windowTitleRegExp)` Sets the constant part of the window title.

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

    - #### UiObjectBaseDescription

          public UiObjectBaseDescription()

      Initializes a new instance of the UiObjectBaseDescription class.

    - #### UiObjectBaseDescription

          protected UiObjectBaseDescription(UiObjectBaseDescription.Init<?> init)

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

  - ### Method Detail

    - #### setNativeClass

          public void setNativeClass(java.lang.String nativeClass)

      Sets the object's window class name.
      Parameters:
        `nativeClass` - the object's window class name.

    - #### setNativeClass

          public void setNativeClass(StringProperty nativeClass)

      Sets the object's window class name.
      Parameters:
        `nativeClass` - a StringProperty (or RegExpProperty) representing the object's window class name.

    - #### getNativeClass

          public StringProperty getNativeClass()

      Returns the object's window class name.
      Returns:
        the object's window class name.

    - #### setWindowId

          public void setWindowId(java.lang.Integer windowId)

      Sets the object's window identifier.
      Parameters:
        `windowId` - then window ID for this object.

    - #### getWindowId

          public java.lang.Integer getWindowId()

      Returns the object's window identifier.
      Returns:
        the object's window identifier.

    - #### setAccessibleName

          public void setAccessibleName(java.lang.String accessibleName)

      Sets the object's name. The name is available for windowless objects only.
      Parameters:
        `accessibleName` - the object's name. The name is available for windowless objects only.

    - #### setAccessibleName

          public void setAccessibleName(StringProperty accessibleName)

      Sets the object's name. The name is available for windowless objects only.
      Parameters:
        `accessibleName` - the object's name as a StringProperty (or RegExProperty). The name is available for windowless objects only.

    - #### getAccessibleName

          public StringProperty getAccessibleName()

      Returns the object's name. The name is available for windowless objects only.
      Returns:
        the object's name. The name is available for windowless objects only.

    - #### setAttachedText

          public void setAttachedText(java.lang.String attachedText)

      Sets the static text that is attached to this object.
      Parameters:
        `attachedText` - the static text that is attached to this object.

    - #### setAttachedText

          public void setAttachedText(StringProperty attachedText)

      Sets the static text that is attached to this object.
      Parameters:
        `attachedText` - a StringProperty (or RegExpProperty) with the static text attached to this object.

    - #### getAttachedText

          public StringProperty getAttachedText()

      Returns the static text that is attached to this control.
      Returns:
        the static text that is attached to this control.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether this object is enabled.
      Parameters:
        `isEnabled` - sets whether this object is enabled.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether this object is enabled.
      Returns:
        true when enabled.

    - #### setFocused

          public void setFocused(java.lang.Boolean isFocused)

      Sets whether this object is in focus.
      Parameters:
        `isFocused` - sets whether this object has focus.

    - #### isFocused

          public java.lang.Boolean isFocused()

      Indicates whether this object is in focus.
      Returns:
        true when this object is in focus.

    - #### setWindowClassRegExp

          public void setWindowClassRegExp(StringProperty windowClassRegExp)

      Sets the permanent part of the MFC window class.
      Parameters:
        `windowClassRegExp` - a StringProperty (or RegExpProperty) representing the permanent part of the MFC window class.

    - #### setWindowClassRegExp

          public void setWindowClassRegExp(java.lang.String windowClassRegExp)

      Sets the permanent part of the MFC window class.
      Parameters:
        `windowClassRegExp` - the permanent part of the MFC window class.

    - #### getWindowClassRegExp

          public StringProperty getWindowClassRegExp()

      Returns the permanent part of the MFC window class.
      Returns:
        the permanent part of the MFC window class.

    - #### setWindowTitleRegExp

          public void setWindowTitleRegExp(StringProperty windowTitleRegExp)

      Sets the constant part of the window title.
      Parameters:
        `windowTitleRegExp` - a StringProperty (or RegExpProperty) representing the constant part of the window title.

    - #### setWindowTitleRegExp

          public void setWindowTitleRegExp(java.lang.String windowTitleRegExp)

      Sets the constant part of the window title.
      Parameters:
        `windowTitleRegExp` - constant part of the window title.

    - #### getWindowTitleRegExp

          public StringProperty getWindowTitleRegExp()

      Returns the constant part of the window title.
      Returns:
        the constant part of the window title.

    - #### setVisible

          public void setVisible(java.lang.Boolean isVisible)

      Sets the visibility state of the test object.
      Parameters:
        `isVisible` - the visibility state of the test object.

    - #### isVisible

          public java.lang.Boolean isVisible()

      Indicates whether this object is visible.
      Returns:
        true when visible.

    - #### setText

          public void setText(StringProperty text)

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

    - #### setText

          public void setText(java.lang.String text)

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

    - #### getText

          public StringProperty getText()

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

    - #### getWindowExtendedStyle

          public java.util.EnumSet<WindowExtendedStyles> getWindowExtendedStyle()

      Returns the extended window style of the object.
      Returns:
        the extended window style of the object.

    - #### setWindowExtendedStyle

          public void setWindowExtendedStyle(java.util.EnumSet<WindowExtendedStyles> windowExtendedStyle)

      Sets the extended window style of the object.
      Parameters:
        `windowExtendedStyle` - the extended window style of the object.

    - #### getWindowExtendedStyleAsLong

          public java.lang.Long getWindowExtendedStyleAsLong()

      Returns the extended window style of the object as long.
      Returns:
        the extended window style of the object as long.

    - #### setWindowExtendedStyle

          public void setWindowExtendedStyle(java.lang.Long windowExtendedStyle)

      Sets the extended window style of the object as long.
      Parameters:
        `windowExtendedStyle` - the extended window style of the object as long.

    - #### getWindowStyle

          public java.util.EnumSet<WindowStyles> getWindowStyle()

      Returns the window style of the object.
      Returns:
        the window style of the object.

    - #### setWindowStyle

          public void setWindowStyle(java.util.EnumSet<WindowStyles> windowStyles)

      Sets window style of the object.
      Parameters:
        `windowStyles` - window style of the object.

    - #### getWindowStyleAsLong

          public java.lang.Long getWindowStyleAsLong()

      Returns the window style of the object as long.
      Returns:
        the window style of the object as long.

    - #### setWindowStyle

          public void setWindowStyle(java.lang.Long windowStyles)

      Sets window style of the object as long.
      Parameters:
        `windowStyles` - window style of the object as long.

    - #### setLocation

          public void setLocation(LocationProperty location)

      Sets the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `location` - a LocationProperty representing the object's coordinates relative to the parent window (in pixels).

    - #### setLocation

          public void setLocation(java.lang.Integer x,
                                  java.lang.Integer y)

      Sets the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `x` - the X coordinate of the test object location.
        `y` - the Y coordinate of the test object location.

    - #### setLocation

          public void setLocation(java.awt.Point location)

      Sets the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `location` - a Point representing the object's coordinates relative to the parent window (in pixels).

    - #### getLocation

          public LocationProperty getLocation()

      Returns the object's coordinates relative to the parent window (in pixels).
      Returns:
        the object's coordinates relative to the parent window (in pixels).

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(LocationProperty absLocation)

      Sets the object's absolute coordinates relative to the screen (in pixels). 0,0 is the top-left corner of the (primary) monitor.
      Parameters:
        `absLocation` - a LocationProperty representing the object's absolute coordinates relative to the screen (in pixels).

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(java.lang.Integer absX,
                                          java.lang.Integer absY)

      Sets the object's absolute coordinates relative to the screen (in pixels). 0,0 is the top-left corner of the (primary) monitor.
      Parameters:
        `absX` - the absolute X coordinate of the test object location.
        `absY` - the absolute Y coordinate of the test object location.

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(java.awt.Point absLocation)

      Sets the object's absolute coordinates relative to the screen (in pixels). 0,0 is the top-left corner of the (primary) monitor.
      Parameters:
        `absLocation` - a Point representing the object's absolute coordinates relative to the screen (in pixels).

    - #### getAbsoluteLocation

          public LocationProperty getAbsoluteLocation()

      Returns the object's absolute coordinates relative to the screen (in pixels).
      Returns:
        the object's absolute coordinates relative to the screen (in pixels).

    - #### setSize

          public void setSize(SizeProperty size)

      Sets the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).

    - #### setSize

          public void setSize(java.awt.Dimension size)

      Sets the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).

    - #### setSize

          public void setSize(java.lang.Integer width,
                              java.lang.Integer height)

      Sets the test object's size (in pixels).
      Parameters:
        `width` - the width of the test object (in pixels).
        `height` - the height of the test object (in pixels).

    - #### getSize

          public SizeProperty getSize()

      Returns the test object's size (in pixels).
      Returns:
        the test object's size (in pixels).