Constructor
new LabelTO()
A LabelTO object,
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 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 | 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.
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>
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
- *
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:
| 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>
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>
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.
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>
iconName() → {Promise.<string>}
The name of the icon used in the label.
Returns:
a promise that is fulfilled with the name of the icon used in the label.
- Type
- Promise.<string>
id() → {Promise.<string>}
The object's unique identifier in text format.
Returns:
a promise that is fulfilled with the object's unique identifier in text format.
- Type
- Promise.<string>
isHighlighted() → {Promise.<boolean>}
Indicates whether the label is highlighted.
Returns:
a promise that is fulfilled with an indication whether the label is highlighted or not.
- Type
- Promise.<boolean>
isNumerical() → {Promise.<boolean>}
Indicates whether the label is a numerical field.
Returns:
a promise that is fulfilled with an indication whether the label is a numerical field.
- 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>
maxLength() → {Promise.<number>}
The maximum number of characters that can be displayed in the label.
Returns:
a promise that is fulfilled with the maximum number of characters that can be displayed in the label.
- Type
- Promise.<number>
name() → {Promise.<string>}
The name of the object.
Returns:
a promise that is fulfilled with the name of the object.
- 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>
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
- *
relativeId() → {Promise.<string>}
The object's unique identifier relative to the parent window ID, in text format.
Returns:
a promise that is fulfilled with the object's unique identifier relative to the parent window ID, in text format.
- Type
- Promise.<string>
setCursorPosition(position) → {Promise.<void>}
Sets the position of the cursor within the static text label.
Parameters:
| Name | Type | Description |
|---|---|---|
position | number | The 0-based character position. |
Returns:
a promise that is fulfilled when the operation ends.
- Type
- Promise.<void>
setFocus() → {Promise.<void>}
Sets the focus on the static text label.
Returns:
a promise that is fulfilled when the 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
|
Returns:
a promise that is fulfilled with the Base64 string of the test object's image.
- Type
- Promise.<string>
text() → {Promise.<string>}
The value of the label, either the text string or the icon name.
Returns:
a promise that is fulfilled with the value of the label, either the text string or the icon name.
- Type
- Promise.<string>
type() → {Promise.<SAPGUI.ComponentType>}
The SAPGUI component type of this object.
Returns:
a promise that is fulfilled with the SAPGUI component type.
- Type
- Promise.<SAPGUI.ComponentType>
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>
