OpenText™ Functional Testing for Developers JavaScript SDK

SAPGUI. GridTO

GridTO

Constructor

new GridTO()

A Grid 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 a 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.
Returns:
a promise that is fulfilled with the object's absolute coordinates.
Type
Promise.<Point>

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

Double-clicks a cell by row index and column name.
Parameters:
Name Type Description
row number The row index.
columnIndexOrName number | string The name of the column or the column index.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

callFTMethod(methodName) → {Promise.<void>|Promise.<any>}

Calls a method or property of an OpenText Functional Testing test object.
Parameters:
Name Type Description
methodName string The name of the method or property to call (additional arguments required by the method or property can be passed after this parameter).
Returns:
  • If the called method or property has no return value
    Type
    Promise.<void>
  • Returns a promise that contains the return value of the called method of property
    Type
    Promise.<any>

cells(rowopt, colopt) → {Promise.<(Array.<Array.<GridCell>>|Array.<GridCell>|GridCell)>}

Returns either a specific cell or a promise of all cells in the grid (when called without arguments), all the cells in a row (when called with row only).
Parameters:
Name Type Attributes Description
row number <optional>
 The row index of the specific cell.
col number <optional>
 The column index in the row, specified by the row parameter.
Returns:
a promise that is fulfilled with either all the cells in the table (when called without arguments), all the cells in a row (when called with row only), or with the specified cell.
Type
Promise.<(Array.<Array.<GridCell>>|Array.<GridCell>|GridCell)>

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
*

deselectColumn(…columns) → {Promise.<void>}

Unselects the specified columns by column names or indices.
Parameters:
Name Type Attributes Description
columns number | string <repeatable>
 You can pass as many items as you like, each item is the column number or column name.
Returns:
a promise that is fulfilled when the operation is performed.
Type
Promise.<void>

deselectRow(…rows) → {Promise.<void>}

Unselects the specified rows.
Parameters:
Name Type Attributes Description
rows number <repeatable>
 You can pass as many items as you like, each item is the row number.
Returns:
a promise that is fulfilled when the operation is performed.
Type
Promise.<void>

deselectRowRange(indexFrom, indexTo) → {Promise.<void>}

Unselects the specified rows.
Parameters:
Name Type Description
indexFrom number The index of the first row in the range.
indexTo number The index of the last row in the range.
Returns:
a promise that is fulfilled when the operation is performed.
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>

firstVisibleRow() → {Promise.<Array.<SAPGUI.GridCell>>}

The array of cells of the first row visible in a scrolled area.
Returns:
a promise that is fulfilled with the array of cells of the first row visible in a scrolled area.
Type
Promise.<Array.<SAPGUI.GridCell>>

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>

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>

isEnabled() → {Promise.<boolean>}

Indicates whether the object can accept user input.
Returns:
a promise that is fulfilled with the enabled status of the object.
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>

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
*

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

Selects a cell by row index and column name.
Parameters:
Name Type Description
row number The row index.
columnIndexOrName number | string The name of the column or the column index.
Returns:
a promise that is fulfilled when the operation is performed.
Type
Promise.<void>

selectColumn(…columns) → {Promise.<void>}

Selects the specified columns by column names or indices.
Parameters:
Name Type Attributes Description
columns number | string <repeatable>
 You can pass as many items as you like, each item is the column number or column name.
Returns:
a promise that is fulfilled when the operation is performed.
Type
Promise.<void>

selectionMode() → {Promise.<SAPGUI.GridSelectionMode>}

The possible selections in the grid.
Returns:
a promise that is fulfilled with the possible selections in the grid.
Type
Promise.<SAPGUI.GridSelectionMode>

selectRow(…rows) → {Promise.<void>}

Selects the specified rows in the object.
Parameters:
Name Type Attributes Description
rows number <repeatable>
 You can pass as many items as you like, each item is the row number.
Returns:
a promise that is fulfilled when the operation is performed.
Type
Promise.<void>

selectRowRange(indexFrom, indexTo) → {Promise.<void>}

Selects the specified row range.
Parameters:
Name Type Description
indexFrom number The index of the first row in the range.
indexTo number The index of the last row in the range.
Returns:
a promise that is fulfilled when the operation is performed.
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
Name Type Attributes Default Description
format string <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>

title() → {Promise.<string>}

The title of the object.
Returns:
a promise that is fulfilled with the title of the object.
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>

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>