Share this page
GWTTree Object
Description
A GWT tree control.
IMPORTANT
- The GWTTree test object class extends the WebElement test object class and inherits many of its operations and description properties.
- UFT One does not support recording or running steps on a GWTTree test object to select or clear check boxes contained within the GWT Tree items.
Workaround: To select a check box within a GWT Tree item, learn The check box as a regular Web object and perform a Set method on it.
Operations
The sections below list the built-in methods and properties that you can use as operations for the GWTTree object.
Note: You can also view a list and descriptions of the GWTTree description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.
Methods
 CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
| Check | Checks whether the actual value of an item matches the expected value. |
| CheckProperty | Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout. |
| ChildObjects | Returns the collection of child objects contained within the object. |
| GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
 Click | Clicks the object. |
| Collapse | Collapses the specified node in the tree. |
| DoubleClick | Clicks on the object twice. |
| Drag | Performs the 'drag' part of a drag and drop operation. |
| Drop | Performs the 'drop' part of a drag and drop operation. |
| Expand | Expands the specified node in the tree. |
| FireEvent | Triggers an event. |
| GetROProperty | Returns the current value of the description property from the object in the application. |
| GetTOProperties | Returns the collection of properties and values used to identify the object. |
| GetTOProperty | Returns the value of the specified description property from the test object description. |
| Highlight | Highlights the object in the application. |
| HoverTap | When hover is supported, places the pointer on the object. Otherwise, taps the object. |
| LongPress | Presses and holds the object. |
| MiddleClick | Middle-clicks the object. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| Pan | Perform a pan gesture. |
| Pinch | Perform a pinch gesture. |
| RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
| RightClick | Right-clicks the object. |
| Select | Selects a node in the tree. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Submit | Submits a form. |
| Swipe | Swipes the object. |
| ToString | Returns a string that represents the test object. |
| WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
 Exist | Checks whether the object currently exists in the open application. |
| Object | Accesses the native methods and properties of the object. |
Click Method
Description
Clicks the object.
Syntax
object.Click [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. UFT One records clicks with the right mouse button only if the Web-based objects and UFT One are both configured correctly. For more information, see the Web Add-in section of the UFT One Help Center. Default value = micLeftBtn |
Return Type
None
IMPORTANT
UFT One records clicks with the right mouse button only if the Web-based objects and UFT One are both configured correctly. For more information, see the Web Add-in section of the UFT One Help Center.
Collapse Method
Description
Collapses the specified node in the tree.
Syntax
object.Collapse Path
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The path of the node to collapse. The path includes the names of all tree items from the root of the tree to the required node, separated by semicolons. |
Return Type
None
Example
Collapse a Node in a Tree (VBScript)
'The following example uses the Expand method to Expand 'Widgets',
'the Select method to select the 'Custom Button' Node,
'and the Collapse method to return the tree to its original state.
'Expand
Browser("MyApplication").Page("Showcase of GWT Features").GWTTree("Widgets").Expand "Widgets"
'Select
Browser("MyApplication").Page("Showcase of GWT Features").GWTTree("Widgets").Select "Widgets; Custom Button"
'Collapse
Browser("MyApplication").Page("Showcase of GWT Features_2").GWTTree("Widgets").Collapse "Widgets"
DoubleClick Method
Description
Clicks on the object twice.
Syntax
object.DoubleClick [interval], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| interval |
Optional. A Variant. The number of seconds between the two clicks. The default value is 0.2 seconds. |
| x |
Optional. An integer value. The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
If you are testing a web or hybrid application on a mobile device, this method is equivalent to performing the DoubleTap gesture.
Drag Method
Description
Performs the 'drag' part of a drag and drop operation.
Syntax
object.Drag [x], [y], [BUTTON], [Modifier]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate within the source object. Default = micNoCoordinate (center of the source object) Default value = 0 |
| y |
Optional. An integer value. The y-coordinate within the source object. Default = micNoCoordinate (center of the source object) Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to drag the object. (Releasing the button performs the Drop operation.) Default = micLeftBtn (0) Default value = micLeftBtn |
| Modifier |
Optional. A String value. The keyboard modifier that is pressed during the Drag operation. Possible values: |
Return Type
None
Drop Method
Description
Performs the 'drop' part of a drag and drop operation.
Syntax
object.Drop [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the x-coordinate is relative to the upper left corner in the source location prior to being dragged. Default = micNoCoordinate (center of the target object) Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the y-coordinate is relative to the upper left corner in the source location prior to being dragged. Default = micNoCoordinate (center of the target object) Default value = 0 |
Return Type
None
IMPORTANT
Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur. For more information on Drag and Drop operations, see Drag Method.
Expand Method
Description
Expands the specified node in the tree.
Syntax
object.Expand Path
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The path of the node to expand. The path includes the names of all tree items from the root of the tree to the relevant node, separated by semicolons (;). |
Return Type
None
Example
Collapse a Node in a Tree (VBScript)'The following example uses the Expand method to Expand 'Widgets', 'the Select method to select the 'Custom Button' Node, 'and the Collapse method to return the tree to its original state. 'Expand Browser("MyApplication").Page("Showcase of GWT Features").GWTTree("Widgets").Expand "Widgets" 'Select Browser("MyApplication").Page("Showcase of GWT Features").GWTTree("Widgets").Select "Widgets; Custom Button" 'Collapse Browser("MyApplication").Page("Showcase of GWT Features_2").GWTTree("Widgets").Collapse "Widgets"
FireEvent Method
Description
Triggers an event.
Syntax
object.FireEvent EventName, [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| EventName |
Required. A String value. The name of event to trigger. Available events: onchange, onclick, ondblclick, onblur, onfocus, onmousedown, onmouseup, onmouseover, onmouseout, onsubmit, onreset, onpropertychange. |
| x |
Optional. An integer value. The x-coordinate, relative to the upper left corner of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate, relative to the upper left corner of the object. Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to fire the object. Default value = micLeftBtn |
Return Type
None
HoverTap Method
Description
When hover is supported, places the pointer on the object. Otherwise, taps the object.
Syntax
object.HoverTap [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
LongPress Method
Description
Presses and holds the object.
Syntax
object.LongPress [duration], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| duration |
Optional. A Variant. The time period (in seconds) to hold the long tap gesture. You can specify partial seconds as a duration time. |
| x |
Optional. An integer value. The x-coordinate of the long tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
Example
Perform a LongPress on a Tree (VBScript)'The following example performs a LongPress on a GWTTree object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").GWTTree("Widgets").LongPress 1,75,75
MiddleClick Method
Description
Middle-clicks the object.
Syntax
object.MiddleClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
Pan Method
Description
Perform a pan gesture.
Syntax
object.Pan deltaX, deltaY, [duration], [startX], [startY]
Arguments
| Parameter | Description |
|---|---|
| deltaX |
Required. An integer value. The distance moved on the x axis, relative to the start point. |
| deltaY |
Required. An integer value. The distance moved on the y axis, relative to the start point. |
| duration |
Optional. A Variant. The number of seconds required to perform the pan gesture. |
| startX |
Optional. An integer value. The x-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object. Default value = 0 |
| startY |
Optional. An integer value. The y-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported in Internet Explorer and older versions of FireFox.
Pinch Method
Description
Perform a pinch gesture.
Syntax
object.Pinch scale, [duration], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| scale |
Required. A Variant. The zoom scale resulting from the pinch gesture. This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture. |
| duration |
Optional. A Variant. The number of seconds required to perform the pinch gesture. The default value is 1 second. |
| x |
Optional. An integer value. The x-coordinate of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported in Internet Explorer and older versions of FireFox.
RightClick Method
Description
Right-clicks the object.
Syntax
object.RightClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
Select Method
Description
Selects a node in the tree.
Syntax
object.Select Path
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The path of the node to select in the tree. The path includes the names of all tree items from the root of the tree to the relevant node, separated by semicolons (;). |
Return Type
None
Example
Collapse a Node in a Tree (VBScript)'The following example uses the Expand method to Expand 'Widgets', 'the Select method to select the 'Custom Button' Node, 'and the Collapse method to return the tree to its original state. 'Expand Browser("MyApplication").Page("Showcase of GWT Features").GWTTree("Widgets").Expand "Widgets" 'Select Browser("MyApplication").Page("Showcase of GWT Features").GWTTree("Widgets").Select "Widgets; Custom Button" 'Collapse Browser("MyApplication").Page("Showcase of GWT Features_2").GWTTree("Widgets").Collapse "Widgets"
Submit Method
Description
Submits a form.
Syntax
object.Submit
Return Type
None
IMPORTANT
This method simulates pressing the Enter key, while the focus is on the object specified in the statement.
Swipe Method
Description
Swipes the object.
Syntax
object.Swipe direction, [distance], [duration], [startX], [startY]
Arguments
| Parameter | Description |
|---|---|
| direction |
Required. A MoveDirection Value. The direction of the swipe gesture. Possible values:
|
| distance |
Optional. An integer value. The distance (in pixels) of the swipe gesture. Default value = 0 |
| duration |
Optional. A Variant. The time period (in seconds) of the swipe gesture. You can specify partial seconds as a duration time. |
| startX |
Optional. An integer value. The x-coordinate at which the swipe gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| startY |
Optional. An integer value. The y-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported for Windows Phone.
Example
Swipe a Tree Object (VBScript)'The following example performs a Swipe gesture on a GWTTree object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").GWTTree("Widgets").Swipe moveDown,200,1,75,75
See also:
