Object Model Reference for GUI Testing > Java > Activate Method

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

Method Activate Activates a node in a tree.
Method AddRange Adds the specified range of nodes to the current selection in a tree.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the specified location with the specified mouse button.
Method Collapse Collapses an expandable Java tree.
Method CreateObject Creates an instance of any Java object within your application.
Method DblClick Double-clicks the specified location with the specified mouse button.
Method Deselect Clears the selection of a node in a tree.
Method DeselectRange Clears the selection of the specified range of nodes in a tree.
Method Expand Expands an expandable Java tree.
Method ExtendSelect Selects an additional node in the tree.
Method FireEvent Simulates an event on a test object using one of several pre-defined event constants.
Method FireEventEx Simulates an event on a Java test object, given the ClassName, Event ID, and Event Parameters.
Method GetColumnHeader Returns the header of the specified column in the tree.
Method GetColumnValue Returns the text from the specified column in the specified node in the tree.
Method GetItem Returns the value of the node specified by the index.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Method GetStatics Returns the Java object capable of accessing static members (methods and fields) of the specified Java class.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method MouseDrag Performs a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates.
Method OpenContextMenu Opens the context menu of a node in a Java tree.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method PressKey Presses the specified key and modifier in the object.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method Select Selects a node in a tree.
Method SelectRange Selects the specified range of nodes in a tree.
Method SetItemState Sets the state of the check box icon of the specified node in the tree.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Common Method ToString Returns a string that represents the test object.
Method Type Types the specified text in the object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

Collapse Method

Description

Collapses 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

Back to top

 

CreateObject Method

Description

Creates an instance of any Java object within your application.

Syntax

object.CreateObject (ClassName)

Arguments

Parameter Description
ClassName Required. A String value.
The Java class name.
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

Example

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

Expand Method

Description

Expands 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

Back to top

 

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

Back to top

 

FireEvent Method

Description

Simulates an event on a test object using one of several pre-defined event constants.

Syntax

object.FireEvent (EventType)

Arguments

Parameter Description
EventType Required. A tagJAVAEVENTTYPE Value.
The name of the pre-defined constant for the event you want to fire.
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 AWTEvents, see:

http://docs.oracle.com/javase/6/docs/api/java/awt/AWTEvent.html

For additional documentation on MouseEvents, see:

http://docs.oracle.com/javase/6/docs/api/java/awt/event/MouseEvent.html

For additional documentation on KeyEvents, see:

http://docs.oracle.com/javase/6/docs/api/java/awt/event/KeyEvent.html

Example

Back to top

 

FireEventEx Method

Description

Simulates an event on a Java test object, given the ClassName, Event ID, and Event Parameters.

Syntax

object.FireEventEx (ClassName, EventId)

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.
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 additional documentation on AWTEvents, see:

http://docs.oracle.com/javase/6/docs/api/java/awt/AWTEvent.html

For additional documentation on MouseEvents, see:

http://docs.oracle.com/javase/6/docs/api/java/awt/event/MouseEvent.html

For additional documentation on KeyEvents, see:

http://docs.oracle.com/javase/6/docs/api/java/awt/event/KeyEvent.html

Example

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

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

Back to top

 

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

Back to top

 

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.
The keyboard key(s) to press. If you want to press a function or operation key, use a constant from the following list:

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

Example

Back to top

 

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


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


 

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

Back to top

 

Type Method

Description

Types the specified text in the object.

Syntax

object.Type (Text)

Arguments

Parameter Description
Text

Required. A String value.
The text to type and/or the modifier(s) to press.
Supported modifiers:
micAlt
micShift
micCtrlAlt
micCtrlShift
micCtrlShiftAlt
micShiftAlt

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 Unified 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

Back to top

 

See also: