Page

Web. Page

new Page(props[opt]) → {Page}

The description of a Web Page test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes the description using the supplied property bag.
Returns:
the description object that was initialized.
Type
Page

Methods

absoluteLocation(location[opt]) → {Point|Description}

The object's absolute coordinates relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

index(value[opt]) → {number|Description}

The 0-based index of this object, relative to all other objects with an otherwise identical description.
Parameters:
NameTypeAttributesDescription
valuenumber <optional>
When provided, this method acts as a setter and sets the index to the specified value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored index; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

size(size[opt]) → {Size|Description}

The object's size (in pixels).
Parameters:
NameTypeAttributesDescription
sizeSize <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

text(text[opt]) → {string|Description}

The inner text of the body element.
Parameters:
NameTypeAttributesDescription
textstring <optional>
When provided, this method acts as a setter and sets the text value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

title(title[opt]) → {string|Description}

The browser's title.
Parameters:
NameTypeAttributesDescription
titlestring <optional>
When provided, this method acts as a setter and sets the title to the specified value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored title value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

url(url[opt]) → {string|Description}

The URL of the HTML page.
Parameters:
NameTypeAttributesDescription
urlstring <optional>
When provided, this method acts as a setter and sets the URL value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored URL value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

vri(value[opt])

Sets a VisualRelation definition.
The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
Parameters:
NameTypeAttributesDescription
valueArray.<Object> <optional>
Array that contains multiple VRI definitions for this test object.
Properties
NameTypeAttributesDefaultDescription
anchorObjectThe related test object.
horizontalHorizontal <optional>
The horizontal relation definition.
hInlineboolean <optional>
false The horizontal inline definition.
verticalVertical <optional>
The vertical relation definition.
vInlinestring <optional>
false The vertical inline definition.
proximityProximity <optional>
The proximity relation definition.