Constructor
new CheckBoxTO()
A Web check box with an ON or OFF state.
Members
displayName
Returns the object display name defined in the Application Model.
Methods
$(selector, objTypeopt) → {*}
Creates a child test object of this test object.
This operation does not cause OpenText Functional Testing for Developers to search for the object in the AUT. OpenText Functional Testing for Developers interacts with the application only when a step runs that performs an operation on the AUT object.
Parameters:
Name | Type | Attributes | Default | Description |
---|
selector | Description
|
string | | | 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. |
objType | Description |
<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, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}
Returns all child objects of this object that match the supplied test object description.
Parameters:
Name | Type | Attributes | Default | Description |
---|
selector | Description
|
string | | | 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>>
$x(xpath, childTypeopt) → {*}
Creates a child test object of this test object based on the specified xpath.
This operation does not cause OpenText Functional Testing for Developers to search for the object in the AUT. OpenText Functional Testing for Developers interacts with the application only when a step runs that performs an operation on the AUT object.
Parameters:
Name | Type | Attributes | Default | Description |
---|
xpath | string | | | The xpath to use as the description for the new child test object. |
childType | Description |
<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', ...
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(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.
PropertiesName | Type | Attributes | Default | Description |
---|
button | MouseButton |
<optional>
|
MouseButton.left
| The mouse button to use for the click. | anchor | Position |
<optional>
|
Position.center
| The position within the object from which the offset is taken. | offset | Object |
<optional>
| | The offset from the anchor position.
PropertiesName | Type | Attributes | Default | Description |
---|
x | number |
<optional>
|
0
| The x-coordinate of the offset. | y | number |
<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(webDoubleClickArgsopt) → {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:
Name | Type | Attributes | Description |
---|
webDoubleClickArgs | Object |
<optional>
| Arguments that define additional behavior for double-click operations.
PropertiesName | Type | Attributes | Default | Description |
---|
location | Location |
<optional>
| | The location to perform the double-click. | interval | number |
<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, dragOptionsopt) → {Promise.<void>}
Drags and drops a test object onto the specified target object according to the specified DragOptions behavior.
Parameters:
Name | Type | Attributes | Description |
---|
target | TestObject
|
Object | | The target object on which this object is dropped. |
dragOptions | Object |
<optional>
| The drag and drop behavior to apply.
PropertiesName | Type | Attributes | Default | Description |
---|
button | MouseButton |
<optional>
|
MouseButton.left
| The mouse button used to drag the object. | dragLocation | Location |
<optional>
| | The point on the source object where the drag operation begins. | dropLocation | Location |
<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>
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>
fireEvent(event) → {Promise.<void>}
Triggers the specified event on this object.
Parameters:
Name | Type | Description |
---|
event | Web.Event
|
Web.MouseEvent | The event object describing the event to trigger.
The event can be any HTML DOM event. For details, see HTML DOM Events in the online W3Schools documentation. |
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:
Name | Type | Description |
---|
attributeName | string | The 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:
Name | Type | Description |
---|
stylePropertyName | string | The 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, 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>
hoverTap(locationopt) → {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:
Name | Type | Attributes | Description |
---|
location | Location |
<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>
isChecked() → {Promise.<boolean>}
Indicates whether the check box is checked. Null if indeterminate.
Returns:
a promise this is fulfilled with an indication of whether the check box is checked. Null if indeterminate.
-
Type
- Promise.<boolean>