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 ActivateActivates the edit box.
Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ClickClicks the specified location with the specified mouse button.
Method ClickLinkClicks the link with the specified name in the edit box.
Method CreateObjectCreates an instance of any Java object within your application.
Method DblClickDouble-clicks the specified location with the specified mouse button.
Method DeleteDeletes the specified text.
Method FireEventSimulates an event on a test object using one of several pre-defined event constants.
Method FireEventExSimulates an event on a Java test object, given the ClassName, Event ID, and Event Parameters.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetStaticsReturns the Java object capable of accessing static members (methods and fields) of the specified Java class.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method InsertInserts a text string into the specified location in a edit box.
Method MouseDragPerforms a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PressKeyPresses the specified key and modifier in the object.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method ReplaceReplaces text in specified boundaries with new text.
Method SetSets the value of the edit box.
Method SetCaretPosPlaces the cursor in the specified location in an edit box.
Method SetFocusSets the focus on the edit box.
Method SetSecureSets the encrypted value of an edit box.
Method SetSelectionSelects the specified text in the edit box.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Method TypeTypes the specified text in the object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

Back to top

 

Activate Method

Description

Activates the edit box.

Syntax

object.Activate

Return Type

None.

IMPORTANT

This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

Click Method

Description

Clicks the specified location with the specified mouse button.

Syntax

object.Click (X, Y, [MouseButton])

Arguments

ParameterDescription
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.

  • This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

ClickLink Method

Description

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

Syntax

object.ClickLink (LinkText)

Arguments

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

Return Type

None

IMPORTANT

This method is not supported for JavaFX edit and text area objects.

Example

Back to top

 

CreateObject Method

Description

Creates an instance of any Java object within your application.

Syntax

object.CreateObject (ClassName, ConsArgs)

Arguments

ParameterDescription
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.

  • We recommend using 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 additional documentation on standard JDK classes, see: http://docs.oracle.com/javase/6/docs/api/index.html

  • This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

DblClick Method

Description

Double-clicks the specified location with the specified mouse button.

Syntax

object.DblClick (X, Y, [MouseButton])

Arguments

ParameterDescription
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.

  • This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

Delete Method

Description

Deletes the specified text.

Syntax

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

Arguments

ParameterDescription
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.

IMPORTANT

This method is not recorded for text area objects in a JavaFX application.

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, EventArguments)

Arguments

ParameterDescription
EventType

Required. A Numeric Value.

The name of the pre-defined constant for the event you want to fire.

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.

  • This method is not supported for SWT-based controls.

  • This method is not recorded for text area objects in a JavaFX application.

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, EventArguments)

Arguments

ParameterDescription
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.

  • This method is not supported for SWT-based controls.

  • This method is not recorded for text area objects in a JavaFX application.

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

ParameterDescription
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.

  • This method is not recorded for text area objects in a JavaFX application.

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

ParameterDescription
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.

IMPORTANT

This method is not recorded for text area objects in a JavaFX application.

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

ParameterDescription
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.

IMPORTANT

This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

PressKey Method

Description

Presses the specified key and modifier in the object.

Syntax

object.PressKey (Key, [Modifier])

Arguments

ParameterDescription
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

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.

This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

Replace Method

Description

Replaces text in specified boundaries with new text.

Syntax

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

Arguments

ParameterDescription
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

IMPORTANT

This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

Set Method

Description

Sets the value of the edit box.

Syntax

object.Set (Text)

Arguments

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

Return Type

None.

Examples

Back to top

 

SetCaretPos Method

Description

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

Syntax

object.SetCaretPos (Row, Column)

Arguments

ParameterDescription
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

IMPORTANT

This method is not recorded for text area objects in a JavaFX application.

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.

  • This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

SetSecure Method

Description

Sets the encrypted value of an edit box.

Syntax

object.SetSecure (EncryptedText)

Arguments

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

Return Type

None.

IMPORTANT

  • To find the encoded value to use as the argument for the this method, do one of the following: 

    • Use the Password Encoder utility (available from the Windows Start menu).

    • Parameterize the argument using a Data Table parameter and use the Data Table encryption option (right-click each unencrypted value in the password column and choose Data > Encrypt).

    For more information, refer to the UFT One User Guide.

  • 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.

  • This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

SetSelection Method

Description

Selects the specified text in the edit box.

Syntax

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

Arguments

ParameterDescription
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.

This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

 

Type Method

Description

Types the specified text in the object.

Syntax

object.Type (Text)

Arguments

ParameterDescription
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.

This method is not recorded for text area objects in a JavaFX application.

Example

Back to top

See also: