Open topic with navigation

com.hp.lft.sdk.wpf

## Class UiObjectDescriptionBase

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.wpf.UiObjectDescriptionBase

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable
  Direct Known Subclasses:
    ButtonDescription, CalendarDescription, CheckBoxDescription, ComboBoxDescription, EditFieldDescription, ImageDescription, LinkDescription, ListDescription, MenuDescription, ProgressBarDescription, RadioButtonDescription, ScrollBarDescription, SliderDescription, StatusBarDescription, TableDescription, TabStripDescription, ToolBarDescription, TreeViewDescription, UiObjectDescription, WindowDescription

      public class UiObjectDescriptionBase
      extends DescriptionBase

  The base description of all WPF test objects.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `UiObjectDescriptionBase.Init<T extends UiObjectDescriptionBase.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
    --- | ---
    `` | `UiObjectDescriptionBase()` Initializes a new instance of the UiObjectDescriptionBase class.
    `protected` | `UiObjectDescriptionBase(UiObjectDescriptionBase.Init<?> init)`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Boolean` | `canFocus()` Indicates whether the object can receive the focus.
    `LocationProperty` | `getAbsoluteLocation()` Returns the object's absolute coordinates relative to the screen (in pixels).
    `StringProperty` | `getAttachedText()` Returns the attached text associated with the object.
    `StringProperty` | `getFullNamePath()` Returns the full hierarchy of ObjectName with all parent objects.
    `StringProperty` | `getFullType()` Returns the full type name of the object.
    `LocationProperty` | `getLocation()` Returns the object's coordinates relative to the parent window (in pixels).
    `StringProperty` | `getNativeClass()` Returns the object's window class name.
    `StringProperty` | `getObjectName()` Returns the object's name as set by the developer.
    `java.util.Map<java.lang.String,java.lang.Object>` | `getObjectProperties()` Returns the concrete test object properties, including custom properties created by the developer of the control.
    `SizeProperty` | `getSize()` Returns the test object's size (in pixels).
    `StringProperty` | `getText()` Returns the text associated with the object.
    `StringProperty` | `getWindowTitleRegExp()` Returns the constant part of the window title.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the object is enabled.
    `java.lang.Boolean` | `isFocused()` Indicates whether the object has the focus.
    `java.lang.Boolean` | `isVisible()` Indicates whether the current element 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` | `setAttachedText(java.lang.String attachedText)` Sets the attached text associated with the object.
    `void` | `setAttachedText(StringProperty attachedText)` Sets the attached text associated with the object.
    `void` | `setCanFocus(java.lang.Boolean canFocus)` Sets whether the object can receive the focus.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the object is enable.
    `void` | `setFocused(java.lang.Boolean isFocused)` Sets whether the object has the focus.
    `void` | `setFullNamePath(java.lang.String fullNamePath)` Sets the full hierarchy of ObjectName with all parent objects.
    `void` | `setFullNamePath(StringProperty fullNamePath)` Sets the full hierarchy of ObjectName with all parent objects.
    `void` | `setFullType(java.lang.String fullType)` Sets the full type name of the object.
    `void` | `setFullType(StringProperty fullType)` Sets the full type name of the object.
    `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 object's window class name.
    `void` | `setNativeClass(StringProperty nativeClass)` Sets the object's window class name.
    `void` | `setObjectName(java.lang.String objectName)` Sets the object's name as set by the developer.
    `void` | `setObjectName(StringProperty objectName)` Sets the object's window class name.
    `void` | `setObjectProperties(java.util.Map<java.lang.String,java.lang.Object> objectProperties)` Sets the concrete test object properties, including custom properties created by the developer of the control.
    `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` | `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

    - #### UiObjectDescriptionBase

          public UiObjectDescriptionBase()

      Initializes a new instance of the UiObjectDescriptionBase class.

    - #### UiObjectDescriptionBase

          protected UiObjectDescriptionBase(UiObjectDescriptionBase.Init<?> init)

  - ### Method Detail

    - #### setNativeClass

          public void setNativeClass(java.lang.String nativeClass)

      Sets object's window class name.
      Parameters:
        `nativeClass` - 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 the object's window class name.

    - #### getNativeClass

          public StringProperty getNativeClass()

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

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the object is enable.
      Parameters:
        `isEnabled` - whether the object is enable

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether the object is enabled.
      Returns:
        true, if the current element is enabled.

    - #### setFocused

          public void setFocused(java.lang.Boolean isFocused)

      Sets whether the object has the focus.
      Parameters:
        `isFocused` - whether the object has the focus.

    - #### isFocused

          public java.lang.Boolean isFocused()

      Indicates whether the object has the focus.
      Returns:
        true, if the current element is focused.

    - #### setWindowTitleRegExp

          public void setWindowTitleRegExp(StringProperty windowTitleRegExp)

      Sets the constant part of the window title.
      Parameters:
        `windowTitleRegExp` - 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 the current element is visible.
      Returns:
        true, if the current element is visible.

    - #### setCanFocus

          public void setCanFocus(java.lang.Boolean canFocus)

      Sets whether the object can receive the focus.
      Parameters:
        `canFocus` - whether the object can receive the focus.

    - #### canFocus

          public java.lang.Boolean canFocus()

      Indicates whether the object can receive the focus.
      Returns:
        true, if the object can receive the focus.

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

    - #### setAttachedText

          public void setAttachedText(StringProperty attachedText)

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

    - #### setAttachedText

          public void setAttachedText(java.lang.String attachedText)

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

    - #### getAttachedText

          public StringProperty getAttachedText()

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

    - #### 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 always 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 always 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 always 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).

    - #### setObjectName

          public void setObjectName(java.lang.String objectName)

      Sets the object's name as set by the developer.
      Parameters:
        `objectName` - the object's name as set by the developer.

    - #### setObjectName

          public void setObjectName(StringProperty objectName)

      Sets the object's window class name.
      Parameters:
        `objectName` - the object's name as set by the developer.

    - #### getObjectName

          public StringProperty getObjectName()

      Returns the object's name as set by the developer.
      Returns:
        the object's name as set by the developer.

    - #### setFullNamePath

          public void setFullNamePath(java.lang.String fullNamePath)

      Sets the full hierarchy of ObjectName with all parent objects.
      Parameters:
        `fullNamePath` - the full hierarchy of ObjectName with all parent objects.

    - #### setFullNamePath

          public void setFullNamePath(StringProperty fullNamePath)

      Sets the full hierarchy of ObjectName with all parent objects.
      Parameters:
        `fullNamePath` - the full hierarchy of ObjectName with all parent objects.

    - #### getFullNamePath

          public StringProperty getFullNamePath()

      Returns the full hierarchy of ObjectName with all parent objects.
      Returns:
        the full hierarchy of ObjectName with all parent objects.

    - #### setFullType

          public void setFullType(java.lang.String fullType)

      Sets the full type name of the object.
      Parameters:
        `fullType` - the full type name of the object.

    - #### setFullType

          public void setFullType(StringProperty fullType)

      Sets the full type name of the object.
      Parameters:
        `fullType` - the full type name of the object.

    - #### getFullType

          public StringProperty getFullType()

      Returns the full type name of the object.
      Returns:
        the full type name of the object.

    - #### setObjectProperties

          public void setObjectProperties(java.util.Map<java.lang.String,java.lang.Object> objectProperties)

      Sets the concrete test object properties, including custom properties created by the developer of the control.
      Parameters:
        `objectProperties` - concrete test object properties, including custom properties.

    - #### getObjectProperties

          public java.util.Map<java.lang.String,java.lang.Object> getObjectProperties()

      Returns the concrete test object properties, including custom properties created by the developer of the control.
      Returns:
        the concrete test object properties, including custom properties created by the developer of the control.