Object Model Reference for GUI Testing > Java > Activate Method

JavaDialog Object

Description

A Java dialog box.

Operations

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

Note: You can also view a list and descriptions of the JavaDialog 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 dialog 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 Close Closes a dialog 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 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 Maximize Maximizes a dialog box to fill the entire screen.
Method Minimize Minimizes a dialog box to an icon.
Method MouseDrag Performs a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates.
Method Move Moves a dialog box to the specified absolute location on the screen.
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 Resize Resizes a dialog box to the specified dimensions.
Method Restore Restores a dialog box to its previous size.
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 dialog 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

 

Close Method

Description

Closes a dialog box.

Syntax

object.Close

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

 

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

 

Maximize Method

Description

Maximizes a dialog box to fill the entire screen.

Syntax

object.Maximize

Return Type

None.

Example

Back to top

 

Minimize Method

Description

Minimizes a dialog box to an icon.

Syntax

object.Minimize

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

 

Move Method

Description

Moves a dialog box to the specified absolute location on the screen.

Syntax

object.Move (X, Y)

Arguments

Parameter Description
X Required. A Variant.
The new x-coordinate for the top left corner of the window or dialog box.
Y Required. A Variant.
The new y-coordinate for the top left corner of the window or dialog box.

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

 

Resize Method

Description

Resizes a dialog box to the specified dimensions.

Syntax

object.Resize (X, Y)

Arguments

Parameter Description
X Required. A Variant.
The new width of the window, in pixels.
Y Required. A Variant.
The new height of the window, in pixels.

Return Type

None.

Example

Back to top

 

Restore Method

Description

Restores a dialog box to its previous size.

Syntax

object.Restore

Return Type

None.

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: