Open topic with navigation

com.hp.lft.sdk.winforms

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

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable
  Direct Known Subclasses:
    ButtonDescription, CalendarDescription, CheckBoxDescription, ComboBoxDescription, EditFieldDescription, EditorDescription, LabelDescription, ListBoxDescription, PropertyGridDescription, RadioButtonDescription, ScrollBarDescription, SpinBoxDescription, StatusBarDescription, TabControlDescription, TableDescription, ToolBarDescription, TreeViewDescription, UiObjectDescription, WindowDescription

      public class UiObjectDescriptionBase
      extends DescriptionBase

  The base description of all .Net Window Forms 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()` Constructs a new instance of UiObjectDescriptionBase.
    `protected` | `UiObjectDescriptionBase(UiObjectDescriptionBase.Init<?> init)`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `LocationProperty` | `getAbsoluteLocation()` Returns the object's absolute coordinates in pixels relative to the screen.
    `StringProperty` | `getFullNamePath()` Returns the of this object with all parent objects.
    `StringProperty` | `getFullType()` Returns the full type name of this object.
    `LocationProperty` | `getLocation()` Returns the object's coordinates in pixels relative to the parent window.
    `StringProperty` | `getNativeClass()` Returns object's window class name.
    `StringProperty` | `getObjectName()` Returns the object's name.
    `java.util.Map<java.lang.String,java.lang.Object>` | `getObjectProperties()` Returns the test object properties, including custom properties of a custom control.
    `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.lang.Integer` | `getWindowId()` Returns the object's window identifier.
    `StringProperty` | `getWindowTitleRegExp()` Returns the constant part of the window title.
    `java.lang.Boolean` | `isChildWindow()` Indicates whether the object's window is a child window.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the object is enabled.
    `java.lang.Boolean` | `isFocused()` Indicates whether the object has focus.
    `java.lang.Boolean` | `isOwnedWindow()` Indicates whether the object's window has an owner window.
    `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 in pixels relative to the screen.
    `void` | `setAbsoluteLocation(LocationProperty absLocation)` Sets the object's absolute coordinates in pixels relative to the screen.
    `void` | `setAbsoluteLocation(java.awt.Point absLocation)` Sets the object's absolute coordinates in pixels relative to the screen.
    `void` | `setChildWindow(java.lang.Boolean value)` Sets whether the object's window is a child window.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the object is enabled.
    `void` | `setFocused(java.lang.Boolean isFocused)` Sets whether the object has focus.
    `void` | `setFullNamePath(java.lang.String fullNamePath)` Sets the full hierarchy of this object with all parent objects.
    `void` | `setFullNamePath(StringProperty fullNamePath)` Sets the full hierarchy of this object with all parent objects.
    `void` | `setFullType(java.lang.String fullType)` Sets the full type name of this object.
    `void` | `setFullType(StringProperty fullType)` Sets the full type name of this object.
    `void` | `setLocation(java.lang.Integer x, java.lang.Integer y)` Sets the object's coordinates in pixels relative to the parent window.
    `void` | `setLocation(LocationProperty location)` Sets the object's coordinates in pixels relative to the parent window.
    `void` | `setLocation(java.awt.Point location)` Sets the object's coordinates in pixels relative to the parent window.
    `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` | `setObjectName(java.lang.String objectName)` Sets the object's name.
    `void` | `setObjectName(StringProperty objectName)` Sets the object's name.
    `void` | `setObjectProperties(java.util.Map<java.lang.String,java.lang.Object> objectProperties)` Sets the test object properties, including custom properties of a custom control.
    `void` | `setOwnedWindow(java.lang.Boolean value)` Sets whether the object's window has an owner window.
    `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 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` | `setWindowId(java.lang.Integer windowId)` Sets the object's window identifier.
    `void` | `setWindowTitleRegExp(java.lang.String windowTitleRegExp)` Sets the constant part of the window title.
    `void` | `setWindowTitleRegExp(StringProperty windowTitleRegEx)` 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()

      Constructs a new instance of UiObjectDescriptionBase.

    - #### UiObjectDescriptionBase

          protected UiObjectDescriptionBase(UiObjectDescriptionBase.Init<?> init)

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

    - #### getNativeClass

          public StringProperty getNativeClass()

      Returns 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` - the window ID

    - #### getWindowId

          public java.lang.Integer getWindowId()

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

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the object is enabled.
      Parameters:
        `isEnabled` - true if enabled

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether the object is enabled.
      Returns:
        true if enabled

    - #### setFocused

          public void setFocused(java.lang.Boolean isFocused)

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

    - #### isFocused

          public java.lang.Boolean isFocused()

      Indicates whether the object has focus.
      Returns:
        true if has focus

    - #### setWindowClassRegExp

          public void setWindowClassRegExp(StringProperty windowClassRegExp)

      Sets the permanent part of the MFC window class.
      Parameters:
        `windowClassRegExp` - 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 windowTitleRegEx)

      Sets the constant part of the window title.
      Parameters:
        `windowTitleRegEx` - 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` - true to make visible

    - #### isVisible

          public java.lang.Boolean isVisible()

      Indicates whether the current element is visible.
      Returns:
        true if visible

    - #### setText

          public void setText(StringProperty text)

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

    - #### setText

          public void setText(java.lang.String text)

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

    - #### getText

          public StringProperty getText()

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

    - #### setLocation

          public void setLocation(LocationProperty location)

      Sets the object's coordinates in pixels relative to the parent window.
      Parameters:
        `location` - the coordinates relative to the parent window

    - #### setLocation

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

      Sets the object's coordinates in pixels relative to the parent window.
      Parameters:
        `x` - in pixels
        `y` - in pixels

    - #### setLocation

          public void setLocation(java.awt.Point location)

      Sets the object's coordinates in pixels relative to the parent window.
      Parameters:
        `location` - the coordinates relative to the parent window

    - #### getLocation

          public LocationProperty getLocation()

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

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(LocationProperty absLocation)

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

    - #### setAbsoluteLocation

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

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

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(java.awt.Point absLocation)

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

    - #### getAbsoluteLocation

          public LocationProperty getAbsoluteLocation()

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

    - #### setSize

          public void setSize(SizeProperty size)

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

    - #### setSize

          public void setSize(java.awt.Dimension size)

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

    - #### setSize

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

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

    - #### getSize

          public SizeProperty getSize()

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

    - #### setChildWindow

          public void setChildWindow(java.lang.Boolean value)

      Sets whether the object's window is a child window.
      Parameters:
        `value` - true if a child window

    - #### isChildWindow

          public java.lang.Boolean isChildWindow()

      Indicates whether the object's window is a child window.
      Returns:
        true if a child window

    - #### setOwnedWindow

          public void setOwnedWindow(java.lang.Boolean value)

      Sets whether the object's window has an owner window.
      Parameters:
        `value` - true if has owner window

    - #### isOwnedWindow

          public java.lang.Boolean isOwnedWindow()

      Indicates whether the object's window has an owner window.
      Returns:
        true if has owner window

    - #### setObjectName

          public void setObjectName(java.lang.String objectName)

      Sets the object's name.
      Parameters:
        `objectName` - the object's name

    - #### setObjectName

          public void setObjectName(StringProperty objectName)

      Sets the object's name.
      Parameters:
        `objectName` - the object's name

    - #### getObjectName

          public StringProperty getObjectName()

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

    - #### setFullNamePath

          public void setFullNamePath(java.lang.String fullNamePath)

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

    - #### setFullNamePath

          public void setFullNamePath(StringProperty fullNamePath)

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

    - #### getFullNamePath

          public StringProperty getFullNamePath()

      Returns the of this object with all parent objects.
      Returns:
        the full hierarchy

    - #### setFullType

          public void setFullType(java.lang.String fullType)

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

    - #### setFullType

          public void setFullType(StringProperty fullType)

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

    - #### getFullType

          public StringProperty getFullType()

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

    - #### setObjectProperties

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

      Sets the test object properties, including custom properties of a custom control.
      Parameters:
        `objectProperties` - the test object properties

    - #### getObjectProperties

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

      Returns the test object properties, including custom properties of a custom control.
      Returns:
        the test object properties