TabStripTO

Web. TabStripTO

TabStripTO

Constructor

new TabStripTO()

A tab strip control in a Web page or application.

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(selector, objType[opt]) → {*}

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:
NameTypeAttributesDefaultDescription
selectorDescription | stringThe 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.
objTypeDescription <optional>
Web.Element() The type of test object to use when supplying a CSS string for the selector.
Returns:
the new child test object with the provided description.
Type
*

$$(selector, dontFilterByType[opt]) → {Promise.<Array.<TestObject>>}

Returns all child objects of this object that match the supplied test object description.
Parameters:
NameTypeAttributesDefaultDescription
selectorDescription | stringa 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.
dontFilterByTypeboolean <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>>

$x(xpath, childType[opt]) → {*}

Creates a child test object of this test object based on the specified xpath. 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:
NameTypeAttributesDefaultDescription
xpathstringThe xpath that will be used as the description for the new child test object.
childTypeDescription <optional>
Web.Element() The test object type for the new child test object.
Returns:
the new child test object with the provided xpath as its description.
Type
*

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>

accessibilityName() → {Promise.<string>}

Returns this object's accessibilityName property.
Returns:
a promise that is fulfilled with this object's accessibilityName property.
Type
Promise.<string>

attributes() → {Promise.<object>}

Returns a copy of the attribute collection that is attached to this object. For example: 'id','class', etc.
Returns:
the object keys are the attribute names and the corresponding values are the attribute values.
Type
Promise.<object>

className() → {Promise.<string>}

Returns the object's CSS class.
Returns:
the object's CSS class.
Type
Promise.<string>

click(args[opt]) → {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:
NameTypeAttributesDescription
argsObject <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>

css() → {Promise.<string>}

Returns the path to this object in CSS format. For example: tr.BPTRow input.
Returns:
a promise that is fulfilled with the path to this object in CSS format.
Type
Promise.<string>

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
*

doubleClick(webDoubleClickArgs[opt]) → {Promise.<void>}

Clicks this object twice according to the specified behavior.
Remark: If you are testing a Web or hybrid mobile application on a Mobile device, this method is equivalent to performing a DoubleTap gesture.
Parameters:
NameTypeAttributesDescription
webDoubleClickArgsObject <optional>
Arguments that define additional behavior for double-click operations.
Properties
NameTypeAttributesDefaultDescription
locationLocation <optional>
The location to perform the double-click.
intervalnumber <optional>
0.2 The number of seconds between the first click and the second click.
Returns:
a promise that is fulfilled when the method is called.
Type
Promise.<void>

dragAndDropOn(target, dragOptions[opt]) → {Promise.<void>}

Drags and drops a test object onto the specified target object according to the specified DragOptions behavior.
Parameters:
NameTypeAttributesDescription
targetTestObject | ObjectThe target object on which this object is dropped.
dragOptionsObject <optional>
The drag and drop behavior to apply.
Properties
NameTypeAttributesDefaultDescription
buttonMouseButton <optional>
MouseButton.left The mouse button used to drag the object.
dragLocationLocation <optional>
The point on the source object where the drag operation begins.
dropLocationLocation <optional>
The point on the target object where the drag and drop operation ends.
Returns:
a promise that is fulfilled when the drop operation ends.
Type
Promise.<void>

waitUntilExists(timeout[opt]) → {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:
NameTypeAttributesDescription
timeoutnumber <optional>
The time (in milliseconds) 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>

exists(timeout[opt]) → {Promise.<boolean>}

Checks whether this object exists in the AUT.
Parameters:
NameTypeAttributesDescription
timeoutnumber <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>

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

Triggers the specified event on this object.
Parameters:
NameTypeDescription
eventWeb.Event | Web.MouseEventThe event object describing the event to trigger. The event can be any HTML DOM event. For details, see: http://www.w3schools.com/jsref/dom_obj_event.asp
Returns:
a promise that is fulfilled with the triggered event.
Type
Promise.<void>

getAttribute(attributeName) → {Promise.<string>}

Returns the value of the specified attribute.
Parameters:
NameTypeDescription
attributeNamestringThe attribute name of the value to retrieve.
Returns:
the value of the specified attribute; null if the attribute does not exist.
Type
Promise.<string>

getComputedStyle(stylePropertyName) → {Promise.<string>}

Returns the value of the specified style.
Parameters:
NameTypeDescription
stylePropertyNamestringThe style name of the value to retrieve.
Returns:
the value of the specified style. Null if the style does not exist.
Type
Promise.<string>

getTextLocations(text, rectangle[opt]) → {Promise.<Object>}

Returns all rectangular areas containing the specified text within this object.
Parameters:
NameTypeAttributesDescription
textstringThe text to search for in the test object.
rectangleObject <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(rectangle[opt]) → {Promise.<string>}

Returns all visible text from this object.
Parameters:
NameTypeAttributesDescription
rectangleObject <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, dontFilterByType[opt]) → {Promise.<number>}

Highlights all children that match the supplied test object description.
Parameters:
NameTypeAttributesDefaultDescription
descriptionA 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.
dontFilterByTypeboolean <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>

hoverTap(location[opt]) → {Promise.<void>}

When hover is supported, places the pointer on this object. Otherwise, taps the object at the specified location. If 'location' is not provided, the tap is performed at the center of the object.
Parameters:
NameTypeAttributesDescription
locationLocation <optional>
The arguments for the hover-tap operation.
Returns:
a promise that is fulfilled when the method is called.
Type
Promise.<void>

id() → {Promise.<string>}

Returns the object's HTML identifier.
Returns:
the object's HTML identifier.
Type
Promise.<string>

innerHTML() → {Promise.<string>}

Returns the HTML code contained between the object's start and end tags.
Returns:
the HTML code contained between the object's start and end tags.
Type
Promise.<string>

innerText() → {Promise.<string>}

Returns the text contained between the object's start and end tags.
Returns:
the text contained between the object's start and end tags.
Type
Promise.<string>

waitUntilVisible(timeout[opt]) → {Promise.<boolean>}

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

Parameters:
NameTypeAttributesDescription
timeoutnumber <optional>
The time (in milliseconds) to wait 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>

isVisible() → {Promise.<boolean>}

Indicates whether the current element is visible.
Returns:
true if the current element is visible, otherwise false.
Type
Promise.<boolean>

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>

longPress(webLongPressArgs[opt]) → {Promise.<void>}

Presses and holds this object according to the specified behavior.
Remark: This method is not supported in Internet Explorer.
Parameters:
NameTypeAttributesDescription
webLongPressArgsObject <optional>
Arguments object that defines the behavior of the longPress operation.
Properties
NameTypeAttributesDefaultDescription
durationnumber <optional>
0.25 The number of seconds to continue pressing.
locationLocation <optional>
The location where the operation is performed.
Returns:
a promise that is fulfilled after pressing the center of the object or the specified location for the number of seconds defined by the user.
Type
Promise.<void>

name() → {Promise.<string>}

Returns the object's name property.
Returns:
the object's name property.
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>

outerHTML() → {Promise.<string>}

Returns the object's HTML code and its content.
Returns:
the object's HTML code and its content.
Type
Promise.<string>

outerText() → {Promise.<string>}

Returns the object's text.
Returns:
the object's text.
Type
Promise.<string>

pan(deltaX[opt], deltaY[opt], webPanArgs[opt]) → {Promise.<void>}

Performs a pan gesture on this object according to the specified distance parameters.
Remark: This method is not supported in Internet Explorer.
Parameters:
NameTypeAttributesDescription
deltaXnumber <optional>
The distance moved on the x-axis.
deltaYnumber <optional>
The distance moved on the y-axis.
webPanArgsObject <optional>
Arguments object that defines the behavior of the pan operation.
Properties
NameTypeAttributesDefaultDescription
locationLocation <optional>
The location at which to perform operation.
durationnumber <optional>
0.5 The number of seconds to perform the pan.
Returns:
a promise that is fulfilled after the pan has occurred.
Type
Promise.<void>

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
*

pinch(scale[opt], pinchArgs[opt]) → {Promise.<void>}

Performs a pinch gesture on this object according to the scale or specified behavior.
Remark: This method is not supported in Internet Explorer.
Parameters:
NameTypeAttributesDescription
scalenumber <optional>
The scale for the pinch gesture. This number is the ratio between the start distance and the end distance between the two touch points used for the pinch.
For example, if you were to touch a screen with your fingers 6 cm apart, and pinch until your fingers were 3 cm apart, the scale would be 0.5.
pinchArgsObject <optional>
Arguments object that defines the behavior of the pinch operation.
Properties
NameTypeAttributesDefaultDescription
locationLocation <optional>
The location at which to perform the operation.
durationnumber <optional>
1 The number of seconds to perform the pinch.
Returns:
a promise that is fulfilled after the pinch has occurred.
Type
Promise.<void>

role() → {Promise.<string>}

Returns this object's role property.
Returns:
a promise that is fulfilled with this object's role property.
Type
Promise.<string>

select(selectValue) → {Promise.<void>}

Selects the specified tab.
Parameters:
NameTypeDescription
selectValuestring | numberThe selection value of the specified tab.
Returns:
a promise that is fulfilled with the selection of the specified tab.
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(options[opt]) → {Promise.<string>}

Captures and returns a Base64 representation of this test object.
Parameters:
NameTypeAttributesDescription
optionsObject <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>

styles() → {Promise.<object>}

Returns a copy of the style collection that is attached to this object.
Returns:
the object keys are the attribute names and the corresponding values are the attribute values.
Type
Promise.<object>

swipe(swipeDirection[opt], webSwipeArgs[opt]) → {Promise.<void>}

Swipes the object in the specified direction or according to the specified behavior.
Remark: This method is not supported in Internet Explorer.
Parameters:
NameTypeAttributesDescription
swipeDirectionSwipeDirection <optional>
The direction of the swipe.
webSwipeArgsobject <optional>
Arguments object that defines the behavior of the swipe operation.
Properties
NameTypeAttributesDefaultDescription
locationLocation <optional>
The location where the operation is performed.
durationnumber <optional>
0.25 The number of seconds to perform the swipe.
distancenumber <optional>
200 The distance (in pixels) to swipe.
Returns:
a promise that is fulfilled after the swipe has occurred.
Type
Promise.<void>

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

An array of strings containing the names of the tabs in the tab strip object.
Returns:
a promise that is fulfilled with an array of strings containing the names of the tabs in the tab strip object.
Type
Promise.<Array.<string>>

tagName() → {Promise.<string>}

Returns the object's HTML tag.
Returns:
the object's HTML tag.
Type
Promise.<string>

title() → {Promise.<string>}

Returns the element's title attribute.
Returns:
the element's title attribute.
Type
Promise.<string>

verifyImageExists(imageToFind, similarity[opt]) → {Promise.<Object>}

Checks whether a snapshot of this object contains the supplied image.
Parameters:
NameTypeAttributesDescription
imageToFindstringA Base64 string representation of the image to look for within the test object's snapshot.
similaritynumber <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, pixelTolerance[opt], rgbTolerance[opt]) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
NameTypeAttributesDescription
expectedImagestringA Base64 string representation of the image to compare to the test object snapshot.
pixelTolerancenumber <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerancenumber <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, pixelTolerance[opt], rgbTolerance[opt]) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
NameTypeAttributesDescription
expectedImagestringA Base64 string representation of the image to compare to the test object snapshot.
maskAreaImagestringA Base64 string representation of the image mask area to use in the image comparison.
pixelTolerancenumber <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerancenumber <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>

xpath() → {Promise.<string>}

Returns the path to this object in XPath format. For example: //TR[@id='LeanFT']/*\/INPUT
Returns:
a promise that is fulfilled with the path to this object in XPath format.
Type
Promise.<string>