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
Activate | Activates a node in a tree. |
Activates (double-clicks) the specified cell in an SWT tree with columns. | |
AddRange | Adds the specified range of nodes to the current selection in a tree. |
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. |
Click | Clicks the specified location with the specified mouse button. |
Clicks the specified cell in an SWT tree with columns. | |
Collapse | Collapses an expandable Java tree. |
CreateObject | Creates an instance of any Java object within your application. |
DblClick | Double-clicks the specified location with the specified mouse button. |
Deselect | Clears the selection of a node in a tree. |
DeselectRange | Clears the selection of the specified range of nodes in a tree. |
Double-clicks the specified cell in an SWT tree with columns. | |
Expand | Expands an expandable Java tree. |
ExtendSelect | Selects an additional node in the tree. |
FireEvent | Simulates an event on a test object using one of several pre-defined event constants. |
FireEventEx | Simulates an event on a Java test object, given the ClassName, Event ID, and Event Parameters. |
GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
GetColumnHeader | Returns the header of the specified column in the tree. |
GetColumnValue | Returns the text from the specified column in the specified node in the tree. |
GetItem | Returns the value of the node specified by the index. |
GetROProperty | Returns the current value of the description property from the object in the application. |
GetStatics | Returns the Java object capable of accessing static members (methods and fields) of the specified Java class. |
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. |
MouseDrag | Performs a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates. |
OpenContextMenu | Opens the context menu of a node in a Java tree. |
Output | Retrieves the current value of an item and stores it in a specified location. |
PressKey | Presses the specified key and modifier in the object. |
RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
Select | Selects a node in a tree. |
Selects the specified cell in an SWT tree with columns. | |
SelectRange | Selects the specified range of nodes in a tree. |
Sets the cell contents with the specified data. | |
SetItemState | Sets the state of the check box icon of the specified node in the tree. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ToString | Returns a string that represents the test object. |
Type | Types the specified text in the 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. |
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
'The following example uses the Activate method to activate the Hotdog node of the JTree tree. JavaApplet("SwingSetApplet").JavaTree("JTree").Activate "Hotdog"
'This example shows how to use the Activate method of a JavaTree to create a new 'Java Project in Eclipse. 'Invokes the wizard from the main menu JavaWindow("Java - Eclipse SDK").JavaMenu("File").JavaMenu("New").JavaMenu("Project...").Select 'Expands the tree to see whether the JavaProject item exists. JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Expand "Java" 'Verifies that the item with desired name exists in the tree JavaProject = JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").GetItem(6) 'If the variable JavaProject contains the expected string, the project can be created. If JavaProject = "Java;Java Project" Then 'Uses the Activate method to dblclick the item and start Java Project creation JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Activate "Java;Java Project" Else 'Else - Report the error and stop the test. Reporter.ReportEvent micFail, "Java Project item was not found in required place of the Projects tree", "Cannot create Java project." ExitTest End If 'Verifies that the appropriate dialog appears, if so - start the creation, 'otherwise, reports the error. If JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").Exist Then JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").JavaButton("Create Project").Click Else Reporter.ReportEvent micFail, "New Java Project dialog", "The dialog didn't appear", "The functionality is broken" End If
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
'The following example uses the ActivateCell method to activate the cell in row 1, column 3 in an SWT tree.
JavaWindow("SWT Controls").JavaTreeTable("Tree").ActivateCell 1, 3
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
'The following example uses the AddRange method to add the selected range of music items to those 'already selected. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("SwingSetApplet").JavaTree("JTree").AddRange "Music;Rock;The Beatles;Abbey Road;You Never Give Me Your Money", "Music;Rock;The Beatles;Abbey Road;Carry That Weight"
'This example shows how to use the methods: ExtendSelect and AddRange to define a set of classes 'in JavaProject tree in Eclipse to be moved out from the project's "build path" 'Selects a default package to see which classes should be excluded. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").Select "NewProject;(default package)" 'Selects the first item to be removed. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").Select "NewProject;(default package);AdditionalClass1.java" 'Adds another one that is located right after it in the list JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").ExtendSelect "NewProject;(default package);AdditionalClass2.java" JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").AddRange "NewProject;(default package);Class1.java", "NewProject;(default package);Class3.java" 'Uses the AddRange method here because there are 3 items Class1-Class3. 'If it used the ExtendSelect method then 3 records are added, whereas using AddRange yields 1 record. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").OpenContextMenu "NewProject;(default package);AdditionalClass1.java" JavaWindow("Java - AdditionalClass1.java").WinMenu("ContextMenu").Select "Build Path;Exclude" 'Checks that the items are excluded from the build path and appear in the root tree hierarchy TreeContentCheck ("JavaProject")
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
'The following example uses the Click method to click the Periodic JavaTree node at coordinates '503 and 55 using the left mouse button. Browser("Periodic").Page("Periodic").JavaApplet("Periodic").JavaTree("Periodic").Click 503, 55, "LEFT"
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
'The following example uses the ClickCell method to perform a shift-click the cell in row 2 of the Last
'Name column, in the SWT Tree.
JavaWindow("SWT Controls").JavaTree("Tree").ClickCell 2, "Last Name", "LEFT", "SHIFT"
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
'The following example uses the Collapse method to collapse the Jazz subfolder in the Music folder 'of the SwingSetApplet applet. Browser("SwingSet demo").Page("SwingSet demo").JavaApplet("SwingSetApplet").JavaTree("JTree").Collapse "Music;Jazz"
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
'The following example uses the CreateObject method to create a rectangle object. Set Rect = Browser("Periodic").Page("Periodic").JavaApplet("Periodic").JavaList("Panel").CreateObject("java.awt.Rectangle", 10, 20)
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
'The following example uses the DblClick method to double-click the "Periodic JavaButton" object at 'coordinates 503 and 55, using the left mouse button. Browser("Periodic").Page("Periodic").JavaApplet("Periodic").JavaButton("Frame").DblClick 5, 5, "LEFT"
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
'The following example uses the Deselect method to clear the selection of: "She's So Heavy" from the JTree tree. Browser("SwingSet demo").Page("SwingSet demo").JavaApplet("SwingSetApplet").JavaTree("JTree").Deselect "Music;Rock;The Beatles;Abbey Road;She's So Heavy"
'This example selects a range of items, and then clears some items within that range. 'It deletes the items that remain selected and runs a function that verifies that the proper 'items remain. 'Selects nodes Class1-9 under the NewProject(default package) tree node. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").SelectRange "NewProject;(default package);Class1.java", "NewProject;(default package);Class9.java" 'Clears the selection of the Class3 node. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").Deselect "NewProject;(default package);Class3.java" 'Clears the selection of the Class5-8 nodes. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").DeselectRange "NewProject;(default package);Class5.java", "NewProject;(default package);Class8.java" 'Opens the context menu and select to Delete the items that remain selected. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").OpenContextMenu "NewProject;(default package);Class8.java" JavaWindow("Java - AdditionalClass1.java").WinMenu("ContextMenu").Select "Delete Delete" 'If a confirmation window opens, clicks Yes to close the window. If it doesn't open, reports the failure to the run results. If Not JavaWindow("Java - AdditionalClass1.java").JavaWindow("Confirm Delete").Exist Then Reporter.ReportEvent micFail, "Confirm delete", "The delete operation was not accompanied with confirm dialog" Else JavaWindow("Java - AdditionalClass1.java").JavaWindow("Confirm Delete").JavaButton("Yes").Click End If 'Runs a function to confirm that the remaining items match the expected list. VerifyTreeContent (TreeName)
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
'This example selects a range of items, and then clears some items within that range. 'It deletes the items that remain selected and runs a function that verifies that the proper 'items remain. 'Selects nodes Class1-9 under the NewProject(default package) tree node. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").SelectRange "NewProject;(default package);Class1.java", "NewProject;(default package);Class9.java" 'Clears the selection of the Class3 node. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").Deselect "NewProject;(default package);Class3.java" 'Clears the selection of the Class5-8 nodes. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").DeselectRange "NewProject;(default package);Class5.java", "NewProject;(default package);Class8.java" 'Opens the context menu and select to Delete the items that remain selected. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").OpenContextMenu "NewProject;(default package);Class8.java" JavaWindow("Java - AdditionalClass1.java").WinMenu("ContextMenu").Select "Delete Delete" 'If a confirmation window opens, clicks Yes to close the window. If it doesn't open, reports the failure to the run results. If Not JavaWindow("Java - AdditionalClass1.java").JavaWindow("Confirm Delete").Exist Then Reporter.ReportEvent micFail, "Confirm delete", "The delete operation was not accompanied with confirm dialog" Else JavaWindow("Java - AdditionalClass1.java").JavaWindow("Confirm Delete").JavaButton("Yes").Click End If 'Runs a function to confirm that the remaining items match the expected list. VerifyTreeContent (TreeName)
'The following example uses the DeselectRange method to clear the selection of a range of nodes from the JTree list. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("SwingSetApplet").JavaTree("JTree").DeselectRange "Music;Rock;The Beatles;Abbey Road;You Never Give Me Your Money", "Music;Rock;The Beatles;Abbey Road;Carry That Weight"
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
'The following example uses the DoubleClickCell method to double-click the cell in row 4, column 3 in a SWT JavaTree.
JavaWindow("SWT Controls").JavaTree("Tree").DoubleClickCell 4, 3
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
'The following example uses the Expand method to expand the Jazz subfolder in the Music folder. Browser("SwingSet demo").Page("SwingSet demo").JavaApplet("SwingSetApplet").JavaTree("JTree").Expand "Music;Jazz"
'This examples shows how to use the Expand, Select, GetItem methods of JavaTree to create 'a new Java Project in Eclipse 'Invokes the wizard from the main menu. JavaWindow("Java - Eclipse SDK").JavaMenu("File").JavaMenu("New").JavaMenu("Project...").Select 'Expands the Tree to see whether the JavaProject item exists. JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Expand "Java" 'Verifies that the item with desired name exists in the tree JavaProject = JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").GetItem(6) 'If the item exists the project can be created. If JavaProject = "Java;Java Project" Then JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Select "Java;Java Project" Else 'If the item does not exist, the project cannot be created and the test cannot continue. Reporter.ReportEvent micFail, "Cannot create Java project.", "Java Project item was not found in required place of the Projects tree." ExitTest End If JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaButton("Next >").Click 'Verifies that desirable dialog box appears, if it does, creates the project. 'otherwise, reports the error. If JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").Exist Then JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").JavaButton("Create Project").Click Else Reporter.ReportEvent micFail, "New Java Project dialog", "The dialog box didn't appear." End If
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
'This example shows how to use the methods: ExtendSelect and AddRange to define a set of classes 'in JavaProject tree in Eclipse to be moved out from the project's "build path" 'Selects a default package to see which classes should be excluded. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").Select "NewProject;(default package)" 'Selects the first item to be removed. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").Select "NewProject;(default package);AdditionalClass1.java" 'Adds another one that is located right after it in the list JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").ExtendSelect "NewProject;(default package);AdditionalClass2.java" JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").AddRange "NewProject;(default package);Class1.java", "NewProject;(default package);Class3.java" 'Uses the AddRange method here because there are 3 items Class1-Class3. 'If it used the ExtendSelect method then 3 records are added, whereas using AddRange yields 1 record. JavaWindow("Java - AdditionalClass1.java").JavaTree("Tree").OpenContextMenu "NewProject;(default package);AdditionalClass1.java" JavaWindow("Java - AdditionalClass1.java").WinMenu("ContextMenu").Select "Build Path;Exclude" 'Checks that the items are excluded from the build path and appear in the root tree hierarchy TreeContentCheck ("JavaProject")
'The following example uses the ExtendSelect method to add the "She's So Heavy" node to the selected nodes. Browser("SwingSet demo").Page("SwingSet demo").JavaApplet("SwingSetApplet").JavaTree("JTree").ExtendSelect "Music;Rock;The Beatles;Abbey Road;She's So Heavy"
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
'The following example uses the FireEvent method to fire a MouseClick event on the MySpinButton_0 JavaSpin. Browser("Browser").Page("Page").JavaApplet("mybuttonapplet").JavaSpin("MySpinButton_0").FireEvent micMouseClick, 0, "BUTTON1_MASK", 4, 4, 1, "OFF"
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
'The following example uses the FireEventEx method to fire a MouseClick event on the MyCheckBox_0 Java check box. Browser("Browser").Page("Page").JavaApplet("mybuttonapplet").JavaCheckBox("MyCheckBox_0").FireEventEx "java.awt.event.MouseEvent", "MOUSE_CLICKED", 0, "BUTTON1_MASK", 4, 4, 1, "False"
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
'The following example checks the column headers and value against a fixed value header1 = JavaWindow("choose file").JavaTree("file list").GetColumnHeader(0) header2 = JavaWindow("choose file").JavaTree("file list").GetColumnHeader(1) If header1 <> "Name" And header2 <> "Modified" Then Reporter.ReportEvent micFail, "file list", "wrong header names" End If modified_value = JavaWindow("choose file").JavaTree("file list").GetColumnValue("root;Program Files", "Modified") If modified_value <> "Yesterday" Then Reporter.ReportEvent micFail, "file list", "wrong modification value" End If
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
'The following example checks the column headers and value against a fixed value header1 = JavaWindow("choose file").JavaTree("file list").GetColumnHeader(0) header2 = JavaWindow("choose file").JavaTree("file list").GetColumnHeader(1) If header1 <> "Name" And header2 <> "Modified" Then Reporter.ReportEvent micFail, "file list", "wrong header names" End If modified_value = JavaWindow("choose file").JavaTree("file list").GetColumnValue("root;Program Files", "Modified") If modified_value <> "Yesterday" Then Reporter.ReportEvent micFail, "file list", "wrong modification value" End If
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
'This examples shows how to use the Expand, Select, GetItem methods of JavaTree to create 'a new Java Project in Eclipse 'Invokes the wizard from the main menu. JavaWindow("Java - Eclipse SDK").JavaMenu("File").JavaMenu("New").JavaMenu("Project...").Select 'Expands the Tree to see whether the JavaProject item exists. JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Expand "Java" 'Verifies that the item with desired name exists in the tree JavaProject = JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").GetItem(6) 'If the item exists the project can be created. If JavaProject = "Java;Java Project" Then JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Select "Java;Java Project" Else 'If the item does not exist, the project cannot be created and the test cannot continue. Reporter.ReportEvent micFail, "Cannot create Java project.", "Java Project item was not found in required place of the Projects tree." ExitTest End If JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaButton("Next >").Click 'Verifies that desirable dialog box appears, if it does, creates the project. 'otherwise, reports the error. If JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").Exist Then JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").JavaButton("Create Project").Click Else Reporter.ReportEvent micFail, "New Java Project dialog", "The dialog box didn't appear." End If
'The following example uses the GetItem method to retrieve the value of the second node in the tree. Item = Browser("index").Page("Java Examples").Frame("MAIN").JavaApplet("TreeApplet").JavaTree("Tree View 2").GetItem("1")
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
'The following example uses the GetStatics method to retrieve the value of the 'out field of the java.lang.System class. Set OutStream = JavaWindow("Win").JavaRadioButton("SomeButton").GetStatics("java.lang.System").out
'The following example uses the GetStatics method to retrieve the object 'through which static members of the java.lang.System class can be accessed. 'It then uses this object to invoke the gc method of the .java.lang.System class, 'which runs the garbage collector on the application. Set SystemStatics = Browser("Browser").Page("Page").JavaApplet("mybuttonapplet.htm").JavaObject("MyButton").GetStatics("java.lang.System") SystemStatics.gc
'The following example uses the GetStatics method to print the "Hello, World!" string to the standard 'output, by using the static out field of the java.lang.System class. JavaWindow("Win").JavaEdit("Name").GetStatics("java.lang.System").out.println ("Hello, World!")
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
'The following example uses the MouseDrag method to perform a mouse drag and drop operation on a Java table object.Browser("Browser").Page("Page").JavaApplet("Periodic").JavaTable("Periodic").MouseDrag 4, 10, 10, 10,"LEFT"
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
'This following example deletes a resource from the Eclipse package viewer. JavaWindow("Eclipse").JavaTree("Tree").OpenContextMenu "Project111;src;org.demo;Main.java"JavaWindow("Eclipse").WinMenu("ContextMenu").Select "Delete"
'This example copies classes from an Eclipse Java project to another package using the methods 'SelectRange and OpenContextMenu.
'Expands the project's tree to get to desirable package JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Expand "NewProject" JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Expand "NewProject;(default package)" 'Selects the range of classes to copy JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").SelectRange "NewProject;(default package);Class1.java", "NewProject;(default package);Class3.java" 'Checks that the tree supports multiple selections and that the proper items are selected If Not JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").CheckProperty("value", "NewProject;(default package);Class2.javaNewProject;(default package);Class1.javaNewProject;(default package);Class3.java") Then Reporter.ReportEvent micFail, "Tree multiple selection", "The functionality is broken" End If 'Uses the OpenContextMenu method to perform copy/paste operation between packages JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").OpenContextMenu ("NewProject;(default package);Class1.java") 'Note that after invocation JavaMenu becomes a WinMenu. This is to be expected. JavaWindow("Java - Class3.java - Eclipse").WinMenu("ContextMenu").Select "Copy Ctrl+C" JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Select "NewProject;org.eclipse.core.launcher" JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").OpenContextMenu ("NewProject;org.eclipse.core.launcher") JavaWindow("Java - Class3.java - Eclipse").WinMenu("ContextMenu").Select "Paste Ctrl+V" 'Calls a user function that verifies the content of the tree. TreeContentCheck ("JavaProject") 'Collapses the tree object. JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Collapse "NewProject" 'Checks that after the work on the tree is finished, there are no extra items in its root. JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").CheckProperty "items count", 1
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, UFT One 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
'The following example enters text in an edit box and then uses the PressKey method to cut the word 'edit' 'and paste it in a different location using the Ctrl-X and Ctrl-V shortcut keys. 'Place the cursor at the beginning of the text box. Browser("Java Examples").Page ("Java Examples") .Frame("MAIN").JavaApplet("TextAreaApplet").JavaEdit("Text field").SetCaretPos 0, 0 'Enter a sentence in the text box. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("TextAreaApplet").JavaEdit("Text field ").Set "Set the edit text." 'Select (highlight) the word 'edit'. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("TextAreaApplet").JavaEdit("Text field").SetSelection 0, 8, 0, 12 'Cut the word 'edit' Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("TextAreaApplet").JavaEdit("Text field").PressKey "X", micCtrl 'Place the cursor at the end of the text. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("TextAreaApplet").JavaEdit("Text field").SetCaretPos 0, 12 'Insert a space at the end of the text. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("TextAreaApplet").JavaEdit("Text field").Insert " ", 0, 12 'Paste the word 'edit' at the end of the text. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("TextAreaApplet").JavaEdit("Text field").PressKey "V", micCtrl
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
'This examples shows how to use the Expand, Select, GetItem methods of JavaTree to create 'a new Java Project in Eclipse 'Invokes the wizard from the main menu. JavaWindow("Java - Eclipse SDK").JavaMenu("File").JavaMenu("New").JavaMenu("Project...").Select 'Expands the Tree to see whether the JavaProject item exists. JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Expand "Java" 'Verifies that the item with desired name exists in the tree JavaProject = JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").GetItem(6) 'If the item exists the project can be created. If JavaProject = "Java;Java Project" Then JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaTree("Wizards:").Select "Java;Java Project" Else 'If the item does not exist, the project cannot be created and the test cannot continue. Reporter.ReportEvent micFail, "Cannot create Java project.", "Java Project item was not found in required place of the Projects tree." ExitTest End If JavaWindow("Java - Eclipse SDK").JavaWindow("New Project").JavaButton("Next >").Click 'Verifies that desirable dialog box appears, if it does, creates the project. 'otherwise, reports the error. If JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").Exist Then JavaWindow("Java - Eclipse SDK").JavaWindow("New Java Project").JavaButton("Create Project").Click Else Reporter.ReportEvent micFail, "New Java Project dialog", "The dialog box didn't appear." End If
'The following example uses the Select method to select "Hamburger" from the Entrees list in the 'Foodlist applet. Browser("FastFoodHaven").Page("KidsMeals").JavaApplet("Foodlist").JavaTree("Entrees").Select "Hamburger"
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
'The following example uses the SelectCell method to select the cell in row 1, column 2 ("Favorite Color").
JavaWindow("SWT Controls").JavaTree("Tree").SelectCell 1, "Favorite color"
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
'The following example uses the SelectRange method to select a range of nodes in the tree. Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("SwingSetApplet").JavaTree("JTree").SelectRange "Music;Rock;The Beatles;Abbey Road;You Never Give Me Your Money", "Music;Rock;The Beatles;Abbey Road;Carry That Weight"
'This example copies classes from an Eclipse Java project to another package using the methods 'SelectRange and OpenContextMenu.
'Expands the project's tree to get to desirable package JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Expand "NewProject" JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Expand "NewProject;(default package)" 'Selects the range of classes to copy JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").SelectRange "NewProject;(default package);Class1.java", "NewProject;(default package);Class3.java" 'Checks that the tree supports multiple selections and that the proper items are selected If Not JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").CheckProperty("value", "NewProject;(default package);Class2.javaNewProject;(default package);Class1.javaNewProject;(default package);Class3.java") Then Reporter.ReportEvent micFail, "Tree multiple selection", "The functionality is broken" End If 'Uses the OpenContextMenu method to perform copy/paste operation between packages JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").OpenContextMenu ("NewProject;(default package);Class1.java") 'Note that after invocation JavaMenu becomes a WinMenu. This is to be expected. JavaWindow("Java - Class3.java - Eclipse").WinMenu("ContextMenu").Select "Copy Ctrl+C" JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Select "NewProject;org.eclipse.core.launcher" JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").OpenContextMenu ("NewProject;org.eclipse.core.launcher") JavaWindow("Java - Class3.java - Eclipse").WinMenu("ContextMenu").Select "Paste Ctrl+V" 'Calls a user function that verifies the content of the tree. TreeContentCheck ("JavaProject") 'Collapses the tree object. JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").Collapse "NewProject" 'Checks that after the work on the tree is finished, there are no extra items in its root. JavaWindow("Java - Class3.java - Eclipse").JavaTree("Tree").CheckProperty "items count", 1
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
'The following example uses the SetCellData method to set the cell contents in row 2, column 4 to "NodeTest".
JavaWindow("SWT Controls").JavaTree("Tree").SetCellData 2, 4, "NodeTest"
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
'The following example selects the check box for each visible (expanded) node in a Java tree cnt = JavaWindow("SWT Controls").JavaTree("Tree").GetROProperty("items count") For i = 0 To cnt - 1 itm = JavaWindow("SWT Controls").JavaTree("Tree").GetItem(i) JavaWindow("SWT Controls").JavaTree("Tree").SetItemState itm, 1 Next
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 UFT One 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
'The following example uses the Type method to type ABC in a Java edit box. Browser("Periodic").Page("Periodic").JavaApplet("Periodic").JavaEdit("Text").Type "ABC"
See also: