JavaTree Object
Description
A Java tree.
Operations
The sections below list the built-in methods and properties that you can use as operations for the JavaTree object.
Note: You can also view a list and descriptions of the JavaTree 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
![]() | Activates a node in a tree. |
Activates (double-clicks) the specified cell in an SWT tree with columns. | |
![]() | Adds the specified range of nodes to the current selection in a tree. |
![]() | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
![]() | Checks whether the actual value of an item matches the expected value. |
![]() | Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout. |
![]() | Returns the collection of child objects contained within the object. |
![]() | Clicks the specified location with the specified mouse button. |
Clicks the specified cell in an SWT tree with columns. | |
![]() | Collapses an expandable Java tree. |
![]() | Creates an instance of any Java object within your application. |
![]() | Double-clicks the specified location with the specified mouse button. |
![]() | Clears the selection of a node in a tree. |
![]() | Clears the selection of the specified range of nodes in a tree. |
Double-clicks the specified cell in an SWT tree with columns. | |
![]() | Expands an expandable Java tree. |
![]() | Selects an additional node in the tree. |
![]() | Simulates an event on a test object using one of several pre-defined event constants. |
![]() | Simulates an event on a Java test object, given the ClassName, Event ID, and Event Parameters. |
![]() | Returns the collection of properties and current values from the object in the application. |
![]() | Returns the header of the specified column in the tree. |
![]() | Returns the text from the specified column in the specified node in the tree. |
![]() | Returns the value of the node specified by the index. |
![]() | Returns the current value of the description property from the object in the application. |
![]() | Returns the Java object capable of accessing static members (methods and fields) of the specified Java class. |
![]() | Returns the collection of properties and values used to identify the object. |
![]() | Returns the value of the specified description property from the test object description. |
![]() | Highlights the object in the application. |
![]() | Performs a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates. |
![]() | Opens the context menu of a node in a Java tree. |
![]() | Retrieves the current value of an item and stores it in a specified location. |
![]() | Presses the specified key and modifier in the object. |
![]() | Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
![]() | Selects a node in a tree. |
Selects the specified cell in an SWT tree with columns. | |
![]() | Selects the specified range of nodes in a tree. |
Sets the cell contents with the specified data. | |
![]() | Sets the state of the check box icon of the specified node in the tree. |
![]() | Sets the value of the specified description property in the test object description. |
![]() | Returns a string that represents the test object. |
![]() | Types the specified text in the object. |
![]() | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
![]() | Checks whether the object currently exists in the open application. |
![]() | Accesses the native methods and properties of the object. |
Activate Method
Description
Activates a node in a tree.
Syntax
object.Activate (Item)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The path of the node to activate (double-click) in the tree. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
ActivateCell Method
Description
Activates (double-clicks) the specified cell in an SWT tree with columns.
Syntax
object.ActivateCell (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The row number or row header label of the row containing the cell you want to activate. Row numbers begin with 0. |
Column |
Required. A Variant. The column number or column header label of the column containing the cell you want to activate. Column numbers begin with 0. |
Return Type
None.
IMPORTANT
This method is only supported for SWT JavaTree objects.
Example
AddRange Method
Description
Adds the specified range of nodes to the current selection in a tree.
Syntax
object.AddRange (Item1, Item2)
Arguments
Parameter | Description |
---|---|
Item1 |
Required. A Variant. The tree path of the first node in the range to add to the selection. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Item2 |
Required. A Variant. The tree path of the last node in the range to add to the selection. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
Click Method
Description
Clicks the specified location with the specified mouse button.
Syntax
object.Click (X, Y, [MouseButton])
Arguments
Parameter | Description |
---|---|
X |
Required. A Variant. The x-coordinate of the click. |
Y |
Required. A Variant. The y-coordinate of the click. |
MouseButton |
Optional. A String value. Indicates whether the click should be performed with the left or right mouse button. Possible values: "LEFT" (default) "RIGHT" Default value = "LEFT" |
Return Type
None.
IMPORTANT
You must enter valid x- and y-coordinates.
Example
ClickCell Method
Description
Clicks the specified cell in an SWT tree with columns.
Syntax
object.ClickCell (Row, Column, [MouseButton], [Modifier])
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The row number or the row header label. Row numbers begin with 0. |
Column |
Required. A Variant. The column number or the column header label. Column numbers begin with 0. |
MouseButton |
Optional. A Variant. Indicates whether the click should be performed with the left or right mouse button. Possible values: "RIGHT" "LEFT" |
Modifier |
Optional. A Variant. The keyboard keys used to perform the operation. Use one of the following values: NONE (default) SHIFT CONTROL CONTROL_SHIFT LOCK ALT |
Return Type
None.
IMPORTANT
This method is only supported for SWT JavaTree objects.
Example
Collapse Method
Description
Collapses a node in an expandable Java tree.
Syntax
object.Collapse (Item)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The node to collapse in the tree. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
CreateObject Method
Description
Creates an instance of any Java object within your application.
Syntax
object.CreateObject (ClassName, ConsArgs)
Arguments
Parameter | Description |
---|---|
ClassName |
Required. A String value. The Java class name. |
ConsArgs |
Required. None Any arguments required for the object's constructor. Enter the values in a comma separated list. If no arguments are required for the constructor, you do not need to supply a value for the ConsArgs argument. |
Return Type
A Variant.
Returns an object reference. You can use this reference to access the object's methods and properties, without using the Object property.
IMPORTANT
- The class loader of the Java test object on which the CreateObject method is performed is used to load the class of the newly created Java object.
- It is recommended to use the CreateObject method on a test object from the same toolkit as the object you want to create. For example, to create a Swing/JFC object, use the CreateObject method on an existing Swing/JFC Java test object.
- For more information on the CreateObject method and for additional documentation on standard JDK classes, see the Java documentation.
Example
DblClick Method
Description
Double-clicks the specified location with the specified mouse button.
Syntax
object.DblClick (X, Y, [MouseButton])
Arguments
Parameter | Description |
---|---|
X |
Required. A Variant. The x coordinate of the location on the applet to be clicked. |
Y |
Required. A Variant. The y-coordinate of the location on the applet to be clicked. |
MouseButton |
Optional. A String value. Indicates whether the double-click should be performed with the left or right mouse button. Possible values: "LEFT" (default) "RIGHT" Default value = "LEFT" |
Return Type
None.
IMPORTANT
You must enter valid x- and y-coordinates.
Example
Deselect Method
Description
Clears the selection of a node in a tree.
Syntax
object.Deselect (Item)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The tree path of the node to deselect. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
DeselectRange Method
Description
Clears the selection of the specified range of nodes in a tree.
Syntax
object.DeselectRange (Item1, Item2)
Arguments
Parameter | Description |
---|---|
Item1 |
Required. A Variant. The tree path of the first node in the range to deselect. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Item2 |
Required. A Variant. The tree path of the last node in the range to deselect. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
DoubleClickCell Method
Description
Double-clicks the specified cell in an SWT tree with columns.
Syntax
object.DoubleClickCell (Row, Column, [MouseButton], [Modifier])
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The row number or the row header label. Row numbers begin with 0. |
Column |
Required. A Variant. The column number or the column header label. Column numbers begin with 0. |
MouseButton |
Optional. A Variant. Indicates whether the click should be performed with the left or right mouse button. Possible values: "RIGHT" "LEFT" |
Modifier |
Optional. A Variant. The keyboard keys used to perform the operation. Use one of the following values: NONE (default) SHIFT CONTROL CONTROL_SHIFT LOCK ALT |
Return Type
None.
IMPORTANT
This method is only supported for SWT JavaTree objects.
Example
Expand Method
Description
Expands a node in an expandable Java tree.
Syntax
object.Expand (Item)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The tree path of the node to expand within the tree. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
ExtendSelect Method
Description
Selects an additional node in the tree.
Syntax
object.ExtendSelect (Item)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The path of the node to be selected in the tree. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
IMPORTANT
You can use this method, for example, to simulate using the control button to select multiple, non-consecutive nodes in a tree.
Example
FireEvent Method
Description
Simulates an event on a test object using one of several pre-defined event constants.
Syntax
object.FireEvent (EventType, EventArguments)
Arguments
Parameter | Description |
---|---|
EventType |
Required. A Numeric Value. Possible values: micMouseEnter, micMouseExit, micMouseClick, micMousePress, micMouseRelease, micMouseDrag, micMouseMove, micKeyPress, micKeyRelease, micKeyType, micFocusGain, micFocusLost. Note: The FireEvent method is supported only for java.awt.* components . The events for org.eclipse.swt.widgets.* controls are not supported. |
EventArguments |
Required. None Any parameters of the event's constructor except for the source and EventID. You can pass any Java constant that is used as one of the event’s constructor parameters using its string instead of its value. Enter the values in a comma separated list. If no additional parameters are required, you do not need to supply a value for the EventArguments argument. |
Return Type
None.
IMPORTANT
If the list of pre-defined constants does not cover the event you want to fire, you can use the FireEventEx method to fire any event that has a constructor.
For more information on the FireEvent method and additional documentation on events, see the Java documentation.
Example
FireEventEx Method
Description
Simulates an event on a Java test object, given the ClassName, Event ID, and Event Parameters.
Syntax
object.FireEventEx (ClassName, EventId, EventArguments)
Arguments
Parameter | Description |
---|---|
ClassName |
Required. A String value. The name of the Java class representing the event to be activated. |
EventId |
Required. A String value. The event ID number or the final field string that represents the event ID. |
EventArguments |
Required. None Any parameters of the event's constructor except for the source and EventID. You can pass any Java constant that is used as one of the event’s constructor parameters using its string instead of its value. Enter the values in a comma separated list. If no additional parameters are required, you do not need to supply a value for the EventArguments argument. |
Return Type
None.
IMPORTANT
You can use FireEventEx for any Java event.
For more information on the FireEventEx method and for additional documentation on events, see the Java documentation.
Example
GetColumnHeader Method
Description
Returns the header of the specified column in the tree.
Syntax
object.GetColumnHeader (Column)
Arguments
Parameter | Description |
---|---|
Column |
Required. A Variant. The name or index of the column whose header you want to return. Specify index values in the format "#N" where N is the numeric index. Index values begin with 0. |
Return Type
A Variant.
IMPORTANT
This method is not supported for tree view objects in JavaFX applications.
Example
GetColumnValue Method
Description
Returns the text from the specified column in the specified node in the tree.
Syntax
object.GetColumnValue (Item, Column)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The name or index of the node from which you want to return the value. Specify index values in the format "#N" where N is the numeric index. Index values begin with 0. |
Column |
Required. A Variant. The name or index of the column from which you want to return the value. Specify index values in the format "#N" where N is the numeric index. Index values begin with 0. |
Return Type
A Variant.
IMPORTANT
This method is not supported for tree view objects in JavaFX applications.
Example
GetItem Method
Description
Returns the value of the node specified by the index.
Syntax
object.GetItem (index)
Arguments
Parameter | Description |
---|---|
index |
Required. A Variant. The numeric index of the node you want to retrieve. Index values begin with 0. Note: To calculate the index, count only the expanded nodes in the tree. Do not count child nodes of a collapsed parent node. The first root node in the tree is numbered 0. |
Return Type
A Variant.
Example
GetStatics Method
Description
Returns the Java object capable of accessing static members (methods and fields) of the specified Java class.
Syntax
object.GetStatics (ClassName)
Arguments
Parameter | Description |
---|---|
ClassName |
Required. A String value. The Java class name whose static members you want to access. |
Return Type
A Variant.
A reference to a Java object.
IMPORTANT
The class loader of the Java test object on which the GetStatics method is performed is used to load the class specified as a parameter of the GetStatics method.
Example
MouseDrag Method
Description
Performs a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates.
Syntax
object.MouseDrag (X1, Y1, X2, Y2, [MouseButton])
Arguments
Parameter | Description |
---|---|
X1 |
Required. A Variant. The x-coordinate of the location from which to begin the mouse drag. |
Y1 |
Required. A Variant. The y-coordinate of the location from which to begin the mouse drag. |
X2 |
Required. A Variant. The x-coordinate of the location where the mouse drag stops. |
Y2 |
Required. A Variant. The y-coordinate of the location where the mouse drag stops. |
MouseButton |
Optional. A String value. Indicates whether the click should be performed with the left or right mouse button. Possible values: "LEFT" (default) "RIGHT" Default value = "LEFT" |
Return Type
None.
Example
OpenContextMenu Method
Description
Opens the context menu of a node in a Java tree.
Syntax
object.OpenContextMenu (Item)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The path of the tree node whose context menu you want to open. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Important
This method is not supported for tree view objects in JavaFX applications
Examples
PressKey Method
Description
Presses the specified key and modifier in the object.
Syntax
object.PressKey (Key, [Modifier])
Arguments
Parameter | Description |
---|---|
Key |
Required. A String value. micF1. Presses the F1 key. micF2. Presses the F2 key. micF3. Presses the F3 key. micF4. Presses the F4 key. micF5. Presses the F5 key. micF6. Presses the F6 key. micF7. Presses the F7 key. micF8. Presses the F8 key. micF9. Presses the F9 key. micF10. Presses the F10 key. micF11. Presses the F11 key. micF12. Presses the F12 key. micLeft. Presses the left arrow key. micRight. Presses the right arrow key. micDwn. Presses the down arrow key. micUp. Presses the up arrow key. micTab. Presses the TAB key. micReturn. Presses the RETURN or ENTER key. micBack. Presses the BACK key. micDel. Presses the DELETE key. micHome. Presses the HOME key. micEnd. Presses the END key. micEsc. Presses the ESC key. micPause. Presses the PAUSE key. micPrintScr. Presses the PRINT SCREEN key; supported for JavaFX only. micIns. Presses the INSERT key. |
Modifier |
Optional. A String value. The modifier(s) to use. Supported modifiers: micCtrl micAlt micShift micCtrlAlt micCtrlShift micCtrlShiftAlt micShiftAlt Default value = "" |
Return Type
None.
IMPORTANT
This method is not supported for tree view objects in JavaFX applications.
When typing keys during a recording session, OpenText Functional Testing records the PressKey method when one or more hot keys (such as F-keys, Alt, and Ctrl) are used.
It also records the PressKey method for any typed key in a Java object that supports text editing, but does not support the Set method.
Example
Select Method
Description
Selects a node in a tree.
Syntax
object.Select (Item)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The tree path of the node to select in the tree. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
SelectCell Method
Description
Selects the specified cell in a tree with columns.
Syntax
object.SelectCell (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The row number or row header label of the row containing the cell you want to select. Row numbers begin with 0. |
Column |
Required. A Variant. The column number or column header label of the column containing the cell you want to select. Column numbers begin with 0. |
Return Type
None.
IMPORTANT
This method is only supported for SWT JavaTree objects.
Example
SelectRange Method
Description
Selects the specified range of nodes in a tree.
Syntax
object.SelectRange (Item1, Item2)
Arguments
Parameter | Description |
---|---|
Item1 |
Required. A Variant. The tree path of the first node in the range to be selected. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Item2 |
Required. A Variant. The tree path of the last node in the range to be selected. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
Return Type
None.
Example
SetCellData Method
Description
Sets the cell contents with the specified data.
Syntax
object.SetCellData (Row, Column, data)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The row number or row header label of the row containing the cell in which you want to insert data. Row numbers begin with 0. |
Column |
Required. A Variant. Indicates the column number or the column header label of the column containing the cell in which you want to insert data. Column numbers begin with 0. |
data |
Required. A String value. The data to be inserted in the specified cell. |
Return Type
None
IMPORTANT
This method is only supported for SWT JavaTree objects.
Example
SetItemState Method
Description
Sets the state of the check box icon of the specified node in the tree.
Syntax
object.SetItemState (Item, State)
Arguments
Parameter | Description |
---|---|
Item |
Required. A Variant. The path of the tree node whose context menu you want to open. The path is a list of the names or index values separated by the separator character specified in the Tree view path separator option in the Java pane of the Options dialog box. Default separator value = semi-colon (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 0. |
State |
Required. A long integer value. The state you want to set. The state can either be an index, or one of the following state constants: micChecked (1)--Selects the node's check box micUnchecked (0)--Clears the node's check box micClick (-1)--Clicks the node icon micDblClick (-2)--Double-clicks the node icon |
Return Type
None
IMPORTANT
This method is not supported for tree view objects in JavaFX applications.
Example
Type Method
Description
Types the specified text in the object.
Syntax
object.Type (Text)
Arguments
Parameter | Description |
---|---|
Text |
Required. A String value. For additional supported keyboard presses, see PressKey method. |
Return Type
None.
IMPORTANT
This method is not recorded. (Keyboard operations are recorded using the Set or PressKey methods.) The Type method is useful for entering a combination of text and keyboard modifiers. You concatenate text strings and keyboard modifiers using the ampersand (&) symbol. For example, you can enter: Type "Hello World" & micCtrl & "S"
To add this method to your test, use the Step Generator or enter it manually in the Keyword View or Editor. For more information, see the OpenText Functional Testing User Guide.
Note: Although the Type method is supported for most objects, if you enter a Type statement for an object in which a user cannot enter text, the method has no visual effect.
Example
See also: