Object Model Reference for GUI Testing > Java > Activate Method

JavaEdit Object

Description

A Java edit box.

Operations

The sections below list the built-in methods and properties that you can use as operations for the JavaEdit object.

Note: You can also view a list and descriptions of the JavaEdit 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 the edit box.
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 ClickLink Clicks the link with the specified name in the edit box.
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 Delete Deletes the specified text.
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.
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 Insert Inserts a text string into the specified location in a edit box.
Method MouseDrag Performs a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates.
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 Replace Replaces text in specified boundaries with new text.
Method Set Sets the value of the edit box.
Method SetCaretPos Places the cursor in the specified location in an edit box.
Method SetFocus Sets the focus on the edit box.
Method SetSecure Sets the encrypted value of an edit box.
Method SetSelection Selects the specified text in the edit box.
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 the edit box.

Syntax

object.Activate

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

ClickLink Method

Description

Clicks the link with the specified name in the edit box.

Syntax

object.ClickLink (LinkText)

Arguments

Parameter Description
LinkText Required. A Variant.
The name of the link to click.

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

Delete Method

Description

Deletes the specified text.

Syntax

object.Delete (Row1, Col1, Row2, Col2)

Arguments

Parameter Description
Row1 Required. A Variant.
The row (top) location of the first character you want to delete. For single line edit boxes, enter 0.
Col1 Required. A Variant.
The column (left) location of the first character you want to delete.
Row2 Required. A Variant.
The row (bottom) location of the last character you want to delete. For single line edit boxes, enter 0.
Col2 Required. A Variant.
The column (right) location of the last character you want to delete.

Return Type

None.

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

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

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

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

Insert Method

Description

Inserts a text string into the specified location in a edit box.

Syntax

object.Insert (str, Row, Column)

Arguments

Parameter Description
str Required. A String value.
The text string that you want to insert.
Row Required. A Variant.
The row that identifies the exact location where you want to insert the text string. For single line edit boxes, enter 0.
Column Required. A Variant.
The column that identifies the exact location where you want to insert the text string. 

Return Type

None.

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

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 key (F1-F12), use a constant from the following list:
Constant
Action
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.

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

When typing keys during a recording session, UFT records the PressKey method when one or more hot keys (such as F-keys, Alt, Ctrl, and so on) 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


 

Back to top

Replace Method

Description

Replaces text in specified boundaries with new text.

Syntax

object.Replace (StartRow, StartCol, EndRow, EndCol, Text)

Arguments

Parameter Description
StartRow Required. A Variant.
The row that identifies the exact location on which you want to start replacing text. For single line edit boxes, enter 0 for row value.
StartCol Required. A Variant.
The column that identifies the exact location on which you want to start replacing text.
EndRow Required. A Variant.
The row that identifies the exact location on which you want to stop replacing text. For single line edit boxes, enter 0 for row value.
EndCol Required. A Variant.
The column that identifies the exact location on which you want to stop replacing text.
Text Required. A String value.
The new text that you want to insert.

Return Type

None.

Example


 

Back to top

Set Method

Description

Sets the value of the edit box.

Syntax

object.Set (Text)

Arguments

Parameter Description
Text Required. A String value.
The text to insert in the edit box.

Return Type

None.

Example


 

Back to top

SetCaretPos Method

Description

Places the cursor in the specified location in an edit box.

Syntax

object.SetCaretPos (Row, Column)

Arguments

Parameter Description
Row Required. A Variant.
The row that identifies the exact location where you want to place the cursor within the edit box. For single line edit boxes, enter 0.
Column Required. A Variant.
The column that identifies the exact location where you want to place the cursor within the edit box.

Return Type

None.

Example


 

Back to top

SetFocus Method

Description

Sets the focus on the edit box.

Syntax

object.SetFocus

Return Type

None.

IMPORTANT

If a Java application or applet does not handle these events, the method may not behave as expected.

Example


 

Back to top

SetSecure Method

Description

Sets the encrypted value of an edit box.

Syntax

object.SetSecure (EncryptedText)

Arguments

Parameter Description
EncryptedText Required. A String value.
The encrypted text to be entered in the edit box.

Return Type

None.

IMPORTANT

To find the encrypted value to use as the argument for the SetSecure method, use the Password Encoder utility (Start > All Programs > Unified Functional Testing > Tools > Password Encoder) or parameterize the argument and use the Data Table encryption option (right-click each unencrypted value in the password column and choose Data > Encrypt). For more information, see the Unified Functional Testing User Guide.

Note: While the SetSecure method enables you to hide passwords on the screen when running a test, it is not intended to be a secure way to protect password information.

Example


 

Back to top

SetSelection Method

Description

Selects the specified text in the edit box.

Syntax

object.SetSelection (StartRow, StartCol, EndRow, EndCol)

Arguments

Parameter Description
StartRow Required. A Variant.
The row (top) location of the first character you want to select.
StartCol Required. A Variant.
The column (left) location of the first character you want to select.
EndRow Required. A Variant.
The row (bottom) location of the last character you want to select.
EndCol Required. A Variant.
The column (right) location of the last character you want to select.

Return Type

None.

IMPORTANT

This is recorded when dragging the mouse and highlighting a text string, or by double-clicking a single word in the edit box.

Note: In a SingleLine edit box, you must use 0 as the RowStart and RowEnd arguments.

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

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: