TreeViewTableTO

Supported on UFT Developer versions 15.0.1 and later

Java. TreeViewTableTO

TreeViewTableTO

Constructor

new TreeViewTableTO()

A Java TreeViewTable test object

Note: The TreeViewTable test object is supported only on JavaFX.

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(description) → {*}

Creates a child test object of this test object. This operation does not cause LeanFT to search for the object in the AUT. LeanFT interacts with the application only when a step runs that performs an operation on the AUT object.

Parameters:

Name Type Description
description Description The description of the test object. Can be a full test object description or a string. If a string is provided, it is interpreted as a CSS selector with a default test object type of WebElement.

Returns:

the new child test object with the provided description.
Type
*

$$(description, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}

Returns all child objects of this object that match the supplied test object description.

Parameters:

Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are returned.
dontFilterByType boolean <optional>
false Set this parameter to true to avoid limiting the returned objects to a specific test object type.

Returns:

a promise that is fulfilled with an array of test objects that match the supplied description.
Type
Promise.<Array.<TestObject>>

absoluteLocation() → {Promise.<Point>}

Returns the object's absolute coordinates relative to the screen (in pixels), format: {x,y}.
Remark: 0,0 is always the top-left corner of the (primary) monitor.

Returns:

a promise that is fulfilled with the object's absolute coordinates.
Type
Promise.<Point>

activate(nodePath) → {Promise.<void>}

Activates a node or row in the tree view table.

Parameters:

Name Type Description
nodePath string The full path of the node to activate within the tree. Tip: Use the Java.TreeViewTableTO#buildNodePath method to build the node path string to be used as the nodeOrPath argument for this method.

Returns:

a promise that is fulfilled when the activate operation ends.
Type
Promise.<void>

activateCell(row, columnOrIndex) → {Promise.<void>}

Double-clicks a cell by row and column indices or column header.

Parameters:

Name Type Description
row number 0-based row number.
columnOrIndex string | number The column header or 0-based column index.

Returns:

a promise that is fulfilled when the activateCell operation ends.
Type
Promise.<void>

activateColumn(columnOrIndex) → {Promise.<void>}

Double-clicks a column by column indices or header.

Parameters:

Name Type Description
columnOrIndex string | number The column header or 0-based column index.

Returns:

a promise that is fulfilled when the activateColumn operation ends.
Type
Promise.<void>

attachedText() → {Promise.<string>}

Returns the object's attached text.

Returns:

a promise that is fulfilled with the object's attached text.
Type
Promise.<string>

backgroundColor() → {Promise.<string>}

Returns the object's background color.

Returns:

a promise that is fulfilled with the object's background color.
Type
Promise.<string>

buildNodePath(…nodePathParts) → {string}

Returns the path of a node in the tree.

Parameters:

Name Type Attributes Description
nodePathParts string | number <repeatable>
The tree node path parts can be: text or 0-based numeric index. For a full path, separate items with commas.

Returns:

The path of a node in the tree.
Type
string

cells(rowIndexopt, columnOrIndexopt) → {Promise.<(Array.<Array.<TableCell>>|Array.<TableCell>|TableCell)>}

Returns a promise for all the cells in a table (when called without arguments), all the cells in a row (when called with row only), or a specified cell.

Parameters:

Name Type Attributes Description
rowIndex number <optional>
The row index of the specific cell.
columnOrIndex string | number <optional>
The column header or 0-based column index in the row.

Returns:

a promise that is fulfilled with all the cells in the table (when called without arguments), all the cells in the row (when called with row only), or the specified cell.
Type
Promise.<(Array.<Array.<TableCell>>|Array.<TableCell>|TableCell)>

click(argsopt) → {Promise.<void>}

Clicks on this object using the definitions from the supplied args object. If you do not provide the args object, the click is performed in the center of the object using the left mouse button.

Parameters:

Name Type Attributes Description
args Object <optional>
The arguments for the click operation.
Properties
NameTypeAttributesDefaultDescription
buttonMouseButton <optional>
MouseButton.left The mouse button to use for the click.
anchorPosition <optional>
Position.center The position within the object from which the offset is taken.
offsetObject <optional>
The offset from the anchor position.
Properties
NameTypeAttributesDefaultDescription
xnumber <optional>
0 The x-coordinate of the offset.
ynumber <optional>
0 The y-coordinate of the offset.

Returns:

a promise that is fulfilled when the click operation ends.
Type
Promise.<void>

collapse(arg) → {Promise.<void>}

Collapses expandable nodes in the tree by node paths.

Parameters:

Name Type Description
arg string | number Can be the full path of the node to activate within the tree or a 0-based index of the node or row. Tip: Use the Java.TreeViewTableTO#buildNodePath method to build the node path strings to be used as the argument for this method.

Returns:

a promise that is fulfilled when the collapse operation ends.
Type
Promise.<void>

columnHeaders() → {Promise.<Array.<string>>}

Returns the column headers.

Returns:

a promise that is fulfilled with the column headers.
Type
Promise.<Array.<string>>

columnsCount() → {Promise.<number>}

Returns the number of columns in the table.

Returns:

a promise that is fulfilled with the number of columns in the table.
Type
Promise.<number>

createObject(className, …argsopt) → {Promise.<Object>}

Creates a native object wrapping an instance of a Java object within your application.

Parameters:

Name Type Attributes Description
className string The java class name.
args Object <optional>
<repeatable>
Any arguments required for the object's constructor.

Returns:

a promise that is fulfilled with a native object wrapping an instance of a Java object within your application.
Type
Promise.<Object>

description() → {*}

Returns the description for this test object. The test object must be obtained using the $ method, otherwise, this method returns null.

Returns:

the description for this test object.
Type
*

deselect(…nodePaths) → {Promise.<void>}

Clears the selection of nodes in the tree by node paths.

Parameters:

Name Type Attributes Description
nodePaths string <repeatable>
The paths of the nodes to deselect. Tip: Use the Java.TreeViewTableTO#buildNodePath method to build the node path strings to be used as arguments for this method.

Returns:

a promise that is fulfilled when the deselect operation ends.
Type
Promise.<void>

deselectColumn(columnOrIndex) → {Promise.<void>}

Unselects column by column index or header.
Important: This method is not supported for SWT tables.

Parameters:

Name Type Description
columnOrIndex string | number The header or 0-based index of the column.

Returns:

a promise that is fulfilled when the deselectColumn operation ends.
Type
Promise.<void>

deselectColumnsRange(fromColumnOrIndex, toColumnOrIndex) → {Promise.<void>}

Unselects a range of columns by column indices or headers.
Important: This method is not supported for SWT tables.

Parameters:

Name Type Description
fromColumnOrIndex string | number The header or 0-based index of the first column.
toColumnOrIndex string | number The header or 0-based index of the last column.

Returns:

a promise that is fulfilled when the deselectColumnsRange operation ends.
Type
Promise.<void>

deselectRange(fromNodePath, toNodePath) → {Promise.<void>}

Clears the selection of the specified range of nodes in a tree. Tip: Use the Java.TreeViewTableTO#buildNodePath method to build the node path strings to be used as the fromNodePath and toNodePath arguments for this method.

Parameters:

Name Type Description
fromNodePath string 0-based index or the full path of the first node in the range.
toNodePath string 0-based index or the full path of the last node in the range.

Returns:

a promise that is fulfilled when the deselectRange operation ends.
Type
Promise.<void>

deselectRowsRange(fromRow, toRow) → {Promise.<void>}

Unselects a range of rows by row indices.

Parameters:

Name Type Description
fromRow number 0-based index of the first row.
toRow number 0-based index of the last row.

Returns:

a promise that is fulfilled when the deselectRowsRange operation ends.
Type
Promise.<void>

doubleClick(argsopt) → {Promise.<void>}

Clicks on this object using the definitions from the supplied args object. If you do not provide the args object, the double-click is performed in the center of the object using the left mouse button.

Parameters:

Name Type Attributes Description
args Object <optional>
The arguments for the double-click operation.
Properties
NameTypeAttributesDefaultDescription
buttonMouseButton <optional>
MouseButton.left The mouse button to use for the double-click.
anchorPosition <optional>
Position.center The anchor location within the object.
offsetObject <optional>
The offset from the anchor position.
Properties
NameTypeAttributesDefaultDescription
xnumber <optional>
0 The x-coordinate of the offset.
ynumber <optional>
0 The y-coordinate of the offset.

Returns:

a promise that is fulfilled when the double-click operation ends.
Type
Promise.<void>

exists(timeoutopt) → {Promise.<boolean>}

Checks whether this object exists in the AUT.

Parameters:

Name Type Attributes Description
timeout number <optional>
The time (in seconds) to wait for this object before returning a result of true or false.
By default, uses the object synchronization timeout defined in the runtime engine settings.

Returns:

a promise that is fulfilled with a boolean indicating whether the object exists.
Type
Promise.<boolean>

expand(arg) → {Promise.<void>}

Expands expandable nodes in the tree by node paths.

Parameters:

Name Type Description
arg string | number Can be the full path of the node to activate within the tree or a 0-based index of the node or row. Tip: Use the Java.TreeViewTableTO#buildNodePath method to build the node path strings to be used as the nodePaths argument for this method.

Returns:

a promise that is fulfilled when the expand operation ends.
Type
Promise.<void>

extendSelect(…nodePaths) → {Promise.<void>}

Selects additional nodes in the tree.

Parameters:

Name Type Attributes Description
nodePaths string <repeatable>
The paths of the nodes to add to the selection. Tip: Use the Java.TreeViewTableTO#buildNodePath method to build the node path strings.

Returns:

a promise that is fulfilled when the extendSelect operation ends.
Type
Promise.<void>

fireEvent(eventInfo) → {Promise.<void>}

Triggers an event on the test object.
Important: This method is not supported for SWT controls.

Parameters:

Name Type Description
eventInfo Java.UiEventInfo | Java.MouseEventInfo | Java.KeyboardEventInfo The event info describing the event to trigger.

Returns:

a promise that is fulfilled when the fireEvent operation ends.
Type
Promise.<void>

fireEventByClass(className, eventId, …eventArgsopt) → {Promise.<void>}

Triggers an event by class on the test object.
Important: This method is not supported for SWT controls.

Parameters:

Name Type Attributes Description
className string The name of the Java class representing the event to be activated.
eventId string The event ID number or the final field string that represents the event ID.
eventArgs string | boolean | number <optional>
<repeatable>
Any parameters of the event's constructor except the source and EventID.

Returns:

a promise that is fulfilled when the fireEventByClass operation ends.
Type
Promise.<void>

foregroundColor() → {Promise.<string>}

Returns the object's foreground color.

Returns:

a promise that is fulfilled with the object's foreground color.
Type
Promise.<string>

getNode(index) → {string}

Returns the value of the specified node.

Parameters:

Name Type Description
index number The 0-based index of the node or row you want to retrieve.

Returns:

The value of the specified node.
Type
string

getObjectProperty(propName)

Returns the value of a test object property.

Parameters:

Name Type Description
propName The name of the test object property.

Returns:

Promise | Promise a promise that is fulfilled with the value of a test object property. This can be any property of this control, including custom properties declared in a custom control.

getStatics(className) → {Promise.<Object>}

Get a native object wrapping a Java class capable of accessing static members (methods and fields) of the specified Java class.

Parameters:

Name Type Description
className string The java class name whose static members you want to access.

Returns:

a promise that is fulfilled with a native object wrapping a Java class capable of accessing static members within your application.
Type
Promise.<Object>

getTextLocations(text, rectangleopt) → {Promise.<Object>}

Returns all rectangular areas containing the specified text within this object.

Parameters:

Name Type Attributes Description
text string The text to search for in the test object.
rectangle Object <optional>
The rectangular area in the test object to search for the text.

Returns:

a promise that is fulfilled with an array of rectangles containing all rectangular areas containing the specified text within this object.
Type
Promise.<Object>

getVisibleText(rectangleopt) → {Promise.<string>}

Returns all visible text from this object.

Parameters:

Name Type Attributes Description
rectangle Object <optional>
The rectangular area in the test object to return the text from.

Returns:

a promise that is fulfilled with all the visible text from this object.
Type
Promise.<string>

highlight() → {Promise.<void>}

Highlights this object in the AUT.
Remark: This may be useful when debugging a test.

Returns:

a promise that is fulfilled when the highlighting operation ends.
Type
Promise.<void>

highlightMatches(description, dontFilterByTypeopt) → {Promise.<number>}

Highlights all children that match the supplied test object description.

Parameters:

Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are highlighted.
dontFilterByType boolean <optional>
false Set this parameter to true to avoid limiting the highlighted objects to a specific test object type.

Returns:

a promise that is fulfilled with the number of matches that are found and highlighted.
Type
Promise.<number>

isEnabled() → {Promise.<boolean>}

Checks if the object is enabled.

Returns:

a promise that is fulfilled with a boolean value indicating if the object is enabled or not.
Type
Promise.<boolean>

isFocused() → {Promise.<boolean>}

Checks if the object is focused.

Returns:

a promise that is fulfilled with a boolean value indicating if the object is focused or not.
Type
Promise.<boolean>

isVisible() → {Promise.<boolean>}

Checks if the object is visible.

Returns:

a promise that is fulfilled with a boolean value indicating if the object is visible or not.
Type
Promise.<boolean>

isWrapped() → {Promise.<boolean>}

Checks if the object is wrapped. E.g.: If an edit field is part of an editable combobox, then the edit field is wrapped inside the combobox.

Returns:

a promise that is fulfilled with a boolean value indicating if the object is wrapped or not.
Type
Promise.<boolean>

label() → {Promise.<string>}

Returns the object's label.

Returns:

a promise that is fulfilled with the object's label.
Type
Promise.<string>

location() → {Promise.<Point>}

Returns the object's coordinates relative to the parent window (in pixels), format: {x,y}.

Returns:

a promise that is fulfilled with the object's relative coordinates.
Type
Promise.<Point>

nativeClass() → {Promise.<string>}

Returns the object's class name.

Returns:

a promise that is fulfilled with the object's class name.
Type
Promise.<string>

nativeObject() → {Promise.<Object>}

Returns the native application object that is represented by this test object instance, enabling you to access the native properties and methods provided by that object.

Returns:

a promise that is fulfilled with the native application object that is represented by this test object instance.
Type
Promise.<Object>

objectName() → {Promise.<string>}

Returns the object's object name.

Returns:

a promise that is fulfilled with the object's object name.
Type
Promise.<string>

parent() → {*}

Returns the parent test object of this test object. The child object must be obtained using the $ method, otherwise, this method returns null.

Returns:

the parent test object of this test object.
Type
*

path() → {Promise.<string>}

Returns the object's hierarchy (object ancestors).

Returns:

a promise that is fulfilled with the object's hierarchy (object ancestors).
Type
Promise.<string>

rowsCount() → {Promise.<number>}

Returns the number of rows in the table.

Returns:

a promise that is fulfilled with the number of rowsCount in the table.
Type
Promise.<number>

select(…nodePaths) → {Promise.<void>}

Selects the specified nodes in the tree by node paths.

Parameters:

Name Type Attributes Description
nodePaths string <repeatable>
The full path of the nodes to select in the tree.

Returns:

a promise that is fulfilled when the select operation ends.
Type
Promise.<void>

selectCell(row, columnOrIndex) → {Promise.<void>}

Clicks a cell by row and column indices or column header.

Parameters:

Name Type Description
row number 0-based row number.
columnOrIndex string | number The column header or 0-based column index.

Returns:

a promise that is fulfilled when the selectCell operation ends.
Type
Promise.<void>

selectCellRange(fromRow, fromColumnOrIndex, toRow, toColumnOrIndex) → {Promise.<void>}

Selects a range of cells in a table by rows and column indices or column headers. Important: This method is not supported for SWT tables.

Parameters:

Name Type Description
fromRow number 0-based index of the first row.
fromColumnOrIndex string | number The header or 0-based index of the first column.
toRow number 0-based index of the last row.
toColumnOrIndex string | number The header or 0-based index of the last column.

Returns:

a promise that is fulfilled when the selectCellRange operation ends.
Type
Promise.<void>

selectColumn(columnOrIndex) → {Promise.<void>}

Selects column by column index or column header.

Parameters:

Name Type Description
columnOrIndex string | number The header or 0-based index of the column.

Returns:

a promise that is fulfilled when the selectColumn operation ends.
Type
Promise.<void>

selectColumnsRange(fromColumnOrIndex, toColumnOrIndex) → {Promise.<void>}

Selects a range of columns by column headers or column indices.

Parameters:

Name Type Description
fromColumnOrIndex string | number The header or 0-based index of the first column.
toColumnOrIndex string | number The header or 0-based index of the last column.

Returns:

a promise that is fulfilled when the selectColumnsRange operation ends.
Type
Promise.<void>

selectedNodes() → {Promise.<Array.<string>>}

Returns the selected nodes or rows in the tree table.

Returns:

a promise that is fulfilled with the selected nodes or rows in the tree table.
Type
Promise.<Array.<string>>

selectRange(fromNodePath, toNodePath) → {Promise.<void>}

Selects the specified range of nodes in the tree. Tip: Use the Java.TreeViewTableTO#buildNodePath method to build the node path strings to be used as the fromNodePath and toNodePath arguments for this method.

Parameters:

Name Type Description
fromNodePath string 0-based index or the full path of the first node in the range.
toNodePath string 0-based index or the full path of the last node in the range.

Returns:

a promise that is fulfilled when the selectRange operation ends.
Type
Promise.<void>

selectRowsRange(fromRow, toRow) → {Promise.<void>}

Selects a range of rows by row indices.

Parameters:

Name Type Description
fromRow number 0-based index of the first row.
toRow number 0-based index of the last row.

Returns:

a promise that is fulfilled when the selectRowsRange operation ends.
Type
Promise.<void>

sendKeys(inputopt, modifiersopt) → {Promise.<void>}

Send keyboard keys to an object.

Parameters:

Name Type Attributes Default Description
input string <optional>
The string to send to the object. Use Keys for special keys.
modifiers KeyModifier <optional>
KeyModifier.none The modifier keys. Use KeyModifier for this parameter.

Returns:

a promise that is fulfilled when the sendKeys operation ends.
Type
Promise.<void>

size() → {Promise.<Size>}

Returns the object's size (in pixels).

Returns:

a promise that is fulfilled with the object's size.
Type
Promise.<Size>

snapshot(optionsopt) → {Promise.<string>}

Captures and returns a Base64 representation of this test object.

Parameters:

Name Type Attributes Description
options Object <optional>
An options object that defines the image capture preferences.
Properties
NameTypeAttributesDefaultDescription
formatstring <optional>
"png" The format of the image. Possible values: png, bmp.

Returns:

a promise that is fulfilled with the Base64 string of the test object's image.
Type
Promise.<string>

tagName() → {Promise.<string>}

Returns the object's tag name.

Returns:

a promise that is fulfilled with the object's tag name.
Type
Promise.<string>

verifyImageExists(imageToFind, similarityopt) → {Promise.<Object>}

Checks whether a snapshot of this object contains the supplied image.

Parameters:

Name Type Attributes Description
imageToFind string A Base64 string representation of the image to look for within the test object's snapshot.
similarity number <optional>
The minimum similarity between the two images (as a percentage), above which the find is considered a match. Default = 100.

Returns:

a promise that is fulfilled with an object representing the point where the image was located, or null if it was not found.
Type
Promise.<Object>

verifyImageMatch(expectedImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.

Parameters:

Name Type Attributes Description
expectedImage string A Base64 string representation of the image to compare to the test object snapshot.
pixelTolerance number <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance number <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.

Returns:

a promise that is fulfilled with a boolean representing the comparison result.
Type
Promise.<boolean>

verifyImageMatchWithMask(expectedImage, maskAreaImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.

Parameters:

Name Type Attributes Description
expectedImage string A Base64 string representation of the image to compare to the test object snapshot.
maskAreaImage string A Base64 string representation of the image mask area to use in the image comparison.
pixelTolerance number <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance number <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.

Returns:

a promise that is fulfilled with a boolean representing the comparison result.
Type
Promise.<boolean>

waitUntilEnabled(timeoutopt) → {Promise.<boolean>}

Waits until the test object becomes enabled or the timeout elapses. This method is useful for synchronizing your test with your application.

Parameters:

Name Type Attributes Description
timeout number <optional>
The length of time to wait (in milliseconds) for the test object to become enabled.

Returns:

a promise fulfilled with true if test object becomes enabled before the timeout is reached; otherwise, false.
Type
Promise.<boolean>

waitUntilExists(timeoutopt) → {Promise.<boolean>}

Waits until this test object exists or until the specified timeout elapses. This method is useful for synchronizing your test with your application.

Parameters:

Name Type Attributes Description
timeout number <optional>
The time (in seconds) to wait for this object to exist.
By default, uses the object synchronization timeout defined in the runtime engine settings.

Returns:

a promise that is fulfilled with a boolean indicating whether the object exists.
Type
Promise.<boolean>

waitUntilVisible(timeoutopt) → {Promise.<boolean>}

Waits until the test object becomes visible or the timeout elapses. This method is useful for synchronizing your test with your application.

Parameters:

Name Type Attributes Description
timeout number <optional>
The length of time to wait (in milliseconds) for the test object to become visible.

Returns:

a promise fulfilled with true if test object becomes visible before the timeout is reached; otherwise, false.
Type
Promise.<boolean>