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.uiapro.UiObjectBaseDescription

All Implemented Interfaces:
CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable
Direct Known Subclasses:
AppBarDescription, ButtonDescription, CalendarDescription, CheckBoxDescription, ComboBoxDescription, DocumentDescription, EditDescription, GridDescription, GridItemDescription, GroupDescription, HeaderDescription, HeaderItemDescription, ImageDescription, LinkDescription, ListDescription, ListItemDescription, MenuBarDescription, MenuDescription, MenuItemDescription, PaneDescription, ProgressBarDescription, RadioButtonDescription, ScrollBarDescription, SemanticZoomDescription, SeparatorDescription, SliderDescription, SpinnerDescription, SplitButtonDescription, StatusBarDescription, TabControlDescription, TabItemDescription, TableDescription, TextDescription, ThumbDescription, TitleBarDescription, ToolBarDescription, ToolTipDescription, TreeViewDescription, TreeViewItemDescription, UiObjectDescription, WindowDescription
```
public class UiObjectBaseDescription
extends DescriptionBase
```
The base description of all UIAPro test objects.

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

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

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)

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

Method Summary

Modifier and Type	Method and Description
`Integer`	`getAbsX()`
`Integer`	`getAbsY()`
`StringProperty`	`getAcceleratorKey()`
`StringProperty`	`getAccessKey()`
`StringProperty`	`getAutomationId()`
`StringProperty`	`getControlType()`
`StringProperty`	`getFrameworkId()`
`Integer`	`getHandle()`
`Integer`	`getHeight()`
`StringProperty`	`getName()` Returns the object's name.
`StringProperty`	`getNativeClass()` Returns the object's window class name.
`StringProperty`	`getPath()`
`Integer`	`getProcessId()`
`StringProperty`	`getProcessName()`
`StringProperty`	`getStatus()`
`String[]`	`getSupportedPatterns()`
`Integer`	`getWidth()`
`Integer`	`getX()`
`Integer`	`getY()`
`Boolean`	`hasKeyBoardFocus()`
`Boolean`	`isEnabled()`
`Boolean`	`isKeyboardFocusable()`
`Boolean`	`isOffScreen()`
`Boolean`	`isPassword()`
`void`	`setAbsX(Integer absX)` Set the object's absolute x-coordinate (left) relative to the parent object (in pixels).
`void`	`setAbsY(Integer absY)` Set the object's absolute y-coordinate (top) relative to the parent object (in pixels).
`void`	`setAcceleratorKey(String acceleratorKey)` Set the sequence of key combinations that invoke an action associated with the element.
`void`	`setAcceleratorKey(StringProperty acceleratorKey)` Set the sequence of key combinations that invoke an action associated with the element.
`void`	`setAccessKey(String accessKey)` Set the character that is used to activate the object.
`void`	`setAccessKey(StringProperty accessKey)` Set the character that is used to activate the object.
`void`	`setAutomationId(String automationId)` Set the ID for an object that is unique among siblings within its container.
`void`	`setAutomationId(StringProperty automationId)` Set the ID for an object that is unique among siblings within its container.
`void`	`setControlType(String controlType)` Set the UIAPro type for the object.
`void`	`setControlType(StringProperty controlType)` Set the UIAPro type for the object.
`void`	`setEnabled(Boolean isEnabled)` Set Indicates whether the object is enabled.
`void`	`setFrameworkId(String frameworkId)` Set the name of the UI framework, such as Win32, WinForm, or DirectUI.
`void`	`setFrameworkId(StringProperty frameworkId)` Set the name of the UI framework, such as Win32, WinForm, or DirectUI.
`void`	`setHandle(Integer handle)` Set the run-time object's window handle.
`void`	`setHeight(Integer height)` Set the object's height (in pixels).
`void`	`setKeyBoardFocus(Boolean hasKeyboardFocus)` Set Indicates whether the object has keyboard focus.
`void`	`setKeyboardFocusable(Boolean isKeyboardFocusable)` Set Indicates whether the object can accept keyboard focus.
`void`	`setName(String name)` Set the object's name.
`void`	`setName(StringProperty name)` Set the object's name.
`void`	`setNativeClass(String nativeClass)` Set the object's window class name.
`void`	`setNativeClass(StringProperty nativeClass)` Set the object's window class name.
`void`	`setOffScreen(Boolean isOffScreen)` Set Indicates whether the object is Offscreen.
`void`	`setPassword(Boolean isPassword)` Set Indicates whether the object contains protected content or a password.
`void`	`setPath(String path)` Set the path in the application's object hierarchy, separated by semicolons.
`void`	`setPath(StringProperty path)` Set the path in the application's object hierarchy, separated by semicolons.
`void`	`setProcessId(Integer processId)` Set the UIAutomation object process id.
`void`	`setProcessName(String processName)` Set the UIAutomation object process name.
`void`	`setProcessName(StringProperty processName)` Set the UIAutomation object process name.
`void`	`setStatus(String status)` Set Describes the status of the current object.
`void`	`setStatus(StringProperty status)` Set Describes the status of the current object.
`void`	`setSupportedPatterns(String[] supportePatterns)` Set the list of patterns supported for the test object.
`void`	`setWidth(Integer width)` Set the object's width (in pixels).
`void`	`setX(Integer x)` Set the object's x-coordinate (left) relative to the parent object (in pixels).
`void`	`setY(Integer y)` Set the object's y-coordinate (top) relative to the parent object (in pixels).

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)
```
- Method Detail
  - getX
```
public Integer getX()
```
    Returns:
    The object's x-coordinate (left) relative to the parent object (in pixels).
  - setX
```
public void setX(Integer x)
```
    Set the object's x-coordinate (left) relative to the parent object (in pixels).
    Parameters:
    x - the object's x-coordinate (left)
  - getY
```
public Integer getY()
```
    Returns:
    The object's y-coordinate (top) relative to the parent object (in pixels).
  - setY
```
public void setY(Integer y)
```
    Set the object's y-coordinate (top) relative to the parent object (in pixels).
    Parameters:
    y - the object's y-coordinate (left)
  - getAbsX
```
public Integer getAbsX()
```
    Returns:
    The object's absolute x-coordinate (left) relative to the parent object (in pixels).
  - setAbsX
```
public void setAbsX(Integer absX)
```
    Set the object's absolute x-coordinate (left) relative to the parent object (in pixels).
    Parameters:
    absX - the object's absolut x-coordinate (left)
  - getAbsY
```
public Integer getAbsY()
```
    Returns:
    The object's absolute y-coordinate (top) relative to the parent object (in pixels).
  - setAbsY
```
public void setAbsY(Integer absY)
```
    Set the object's absolute y-coordinate (top) relative to the parent object (in pixels).
    Parameters:
    absY - the object's absolut y-coordinate (left)
  - getWidth
```
public Integer getWidth()
```
    Returns:
    The object's width (in pixels).
  - setWidth
```
public void setWidth(Integer width)
```
    Set the object's width (in pixels).
    Parameters:
    width - the object's width (in pixels)
  - getHeight
```
public Integer getHeight()
```
    Returns:
    The object's height (in pixels).
  - setHeight
```
public void setHeight(Integer height)
```
    Set the object's height (in pixels).
    Parameters:
    height - the object's height (in pixels).
  - getProcessName
```
public StringProperty getProcessName()
```
    Returns:
    The UIAutomation object process name.
  - setProcessName
```
public void setProcessName(StringProperty processName)
```
    Set the UIAutomation object process name.
    Parameters:
    processName - the UIAutomation object process name.
  - setProcessName
```
public void setProcessName(String processName)
```
    Set the UIAutomation object process name.
    Parameters:
    processName - the UIAutomation object process name.
  - getProcessId
```
public Integer getProcessId()
```
    Returns:
    The UIAutomation object process id.
  - setProcessId
```
public void setProcessId(Integer processId)
```
    Set the UIAutomation object process id.
    Parameters:
    processId - the UIAutomation object process id.
  - hasKeyBoardFocus
```
public Boolean hasKeyBoardFocus()
```
    Returns:
    Indicates whether the object has keyboard focus.
  - setKeyBoardFocus
```
public void setKeyBoardFocus(Boolean hasKeyboardFocus)
```
    Set Indicates whether the object has keyboard focus.
    Parameters:
    hasKeyboardFocus - Indicates whether the object has keyboard focus.
  - getHandle
```
public Integer getHandle()
```
    Returns:
    The run-time object's window handle.
  - setHandle
```
public void setHandle(Integer handle)
```
    Set the run-time object's window handle.
    Parameters:
    handle - the run-time object's window handle.
  - isEnabled
```
public Boolean isEnabled()
```
    Returns:
    Indicates whether the object is enabled.
  - setEnabled
```
public void setEnabled(Boolean isEnabled)
```
    Set Indicates whether the object is enabled.
    Parameters:
    isEnabled - Indicates whether the object is enabled.
  - isKeyboardFocusable
```
public Boolean isKeyboardFocusable()
```
    Returns:
    Indicates whether the object can accept keyboard focus.
  - setKeyboardFocusable
```
public void setKeyboardFocusable(Boolean isKeyboardFocusable)
```
    Set Indicates whether the object can accept keyboard focus.
    Parameters:
    isKeyboardFocusable - Indicates whether the object can accept keyboard focus.
  - isOffScreen
```
public Boolean isOffScreen()
```
    Returns:
    Indicates whether the object is Offscreen.
  - setOffScreen
```
public void setOffScreen(Boolean isOffScreen)
```
    Set Indicates whether the object is Offscreen.
    Parameters:
    isOffScreen - Indicates whether the object is Offscreen.
  - isPassword
```
public Boolean isPassword()
```
    Returns:
    Indicates whether the object contains protected content or a password.
  - setPassword
```
public void setPassword(Boolean isPassword)
```
    Set Indicates whether the object contains protected content or a password.
    Parameters:
    isPassword - Indicates whether the object contains protected content or a password.
  - getStatus
```
public StringProperty getStatus()
```
    Returns:
    Describes the status of the current object. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected".
  - setStatus
```
public void setStatus(StringProperty status)
```
    Set Describes the status of the current object. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected".
    Parameters:
    status - Describes the status of the current object.
  - setStatus
```
public void setStatus(String status)
```
    Set Describes the status of the current object. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected".
    Parameters:
    status - Describes the status of the current object.
  - getAcceleratorKey
```
public StringProperty getAcceleratorKey()
```
    Returns:
    The sequence of key combinations that invoke an action associated with the element.
  - setAcceleratorKey
```
public void setAcceleratorKey(StringProperty acceleratorKey)
```
    Set the sequence of key combinations that invoke an action associated with the element.
    Parameters:
    acceleratorKey - the sequence of key combinations that invoke an action associated with the element.
  - setAcceleratorKey
```
public void setAcceleratorKey(String acceleratorKey)
```
    Set the sequence of key combinations that invoke an action associated with the element.
    Parameters:
    acceleratorKey - the sequence of key combinations that invoke an action associated with the element.
  - getAccessKey
```
public StringProperty getAccessKey()
```
    Returns:
    The character that is used to activate the object.
  - setAccessKey
```
public void setAccessKey(StringProperty accessKey)
```
    Set the character that is used to activate the object.
    Parameters:
    accessKey - the character that is used to activate the object.
  - setAccessKey
```
public void setAccessKey(String accessKey)
```
    Set the character that is used to activate the object.
    Parameters:
    accessKey - the character that is used to activate the object.
  - getAutomationId
```
public StringProperty getAutomationId()
```
    Returns:
    The ID for an object that is unique among siblings within its container.
  - setAutomationId
```
public void setAutomationId(StringProperty automationId)
```
    Set the ID for an object that is unique among siblings within its container.
    Parameters:
    automationId - the ID for an object that is unique among siblings within its container.
  - setAutomationId
```
public void setAutomationId(String automationId)
```
    Set the ID for an object that is unique among siblings within its container.
    Parameters:
    automationId - the ID for an object that is unique among siblings within its container.
  - getControlType
```
public StringProperty getControlType()
```
    Returns:
    The UIAPro type for the object.
  - setControlType
```
public void setControlType(StringProperty controlType)
```
    Set the UIAPro type for the object.
    Parameters:
    controlType - the UIAPro type for the object.
  - setControlType
```
public void setControlType(String controlType)
```
    Set the UIAPro type for the object.
    Parameters:
    controlType - the UIAPro type for the object.
  - getFrameworkId
```
public StringProperty getFrameworkId()
```
    Returns:
    The name of the UI framework, such as Win32, WinForm, or DirectUI.
  - setFrameworkId
```
public void setFrameworkId(StringProperty frameworkId)
```
    Set the name of the UI framework, such as Win32, WinForm, or DirectUI.
    Parameters:
    frameworkId - the name of the UI framework.
  - setFrameworkId
```
public void setFrameworkId(String frameworkId)
```
    Set the name of the UI framework, such as Win32, WinForm, or DirectUI.
    Parameters:
    frameworkId - the name of the UI framework.
  - getSupportedPatterns
```
public String[] getSupportedPatterns()
```
    Returns:
    The list of patterns supported for the test object.
  - setSupportedPatterns
```
public void setSupportedPatterns(String[] supportePatterns)
```
    Set the list of patterns supported for the test object.
    Parameters:
    supportePatterns - the list of patterns supported for the test object.
  - getPath
```
public StringProperty getPath()
```
    Returns:
    The path in the application's object hierarchy, separated by semicolons. Objects in the path are represented by their name or automationId property values.
  - setPath
```
public void setPath(StringProperty path)
```
    Set the path in the application's object hierarchy, separated by semicolons. Objects in the path are represented by their name or automationId property values.
    Parameters:
    path - the path in the application's object hierarchy.
  - setPath
```
public void setPath(String path)
```
    Set the path in the application's object hierarchy, separated by semicolons. Objects in the path are represented by their name or automationId property values.
    Parameters:
    path - the path in the application's object hierarchy.
  - getNativeClass
```
public StringProperty getNativeClass()
```
    Returns the object's window class name.
    Returns:
    the object's window class name.
  - setNativeClass
```
public void setNativeClass(StringProperty nativeClass)
```
    Set the object's window class name.
    Parameters:
    nativeClass - the object's window class name.
  - setNativeClass
```
public void setNativeClass(String nativeClass)
```
    Set the object's window class name.
    Parameters:
    nativeClass - the object's window class name.
  - getName
```
public StringProperty getName()
```
    Returns the object's name.
    Returns:
    the object's name.
  - setName
```
public void setName(StringProperty name)
```
    Set the object's name.
    Parameters:
    name - the object's name.
  - setName
```
public void setName(String name)
```
    Set the object's name.
    Parameters:
    name - the object's name.

Class UiObjectBaseDescription

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.hp.lft.sdk.DescriptionBase

Methods inherited from class com.hp.lft.sdk.PropertiesDescription

Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

Methods inherited from class java.lang.Object

Methods inherited from interface com.hp.lft.sdk.CloneableObject

Constructor Detail

UiObjectBaseDescription

UiObjectBaseDescription

Method Detail

getX

setX

getY

setY

getAbsX

setAbsX

getAbsY

setAbsY

getWidth

setWidth

getHeight

setHeight

getProcessName

setProcessName

setProcessName

getProcessId

setProcessId

hasKeyBoardFocus

setKeyBoardFocus

getHandle

setHandle

isEnabled

setEnabled

isKeyboardFocusable

setKeyboardFocusable

isOffScreen

setOffScreen

isPassword

setPassword

getStatus

setStatus

setStatus

getAcceleratorKey

setAcceleratorKey

setAcceleratorKey

getAccessKey

setAccessKey

setAccessKey

getAutomationId

setAutomationId

setAutomationId

getControlType

setControlType

setControlType

getFrameworkId

setFrameworkId

setFrameworkId

getSupportedPatterns

setSupportedPatterns

getPath

setPath

setPath

getNativeClass

setNativeClass

setNativeClass

getName

setName

setName

Send Help Center Feedback