JavaSpin Object

Description

A Java spin object.

Operations

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

Note: You can also view a list and descriptions of the JavaSpin 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

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 CreateObjectCreates an instance of any Java object within your application.
Method DblClickDouble-clicks the specified location with the specified mouse button.
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 MouseDragPerforms a mouse drag and drop operation from the specified X1, Y1 coordinates to the specified Xn, Yn coordinates.
Method NextSets the spin object to its next value.
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.
Method PrevSets the spin object to its previous value.
Common Method RefreshObjectInstructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object.
Method SetSets the value of the spin object.
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

 

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.

Example

                    'The following example uses the Click method to click the Month Spin JavaSpin object at coordinates
'5 and 15, using the left mouse button.
Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("SpinApplet").JavaSpin("Month spin").Click 5, 15, "LEFT"

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

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.

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"

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.

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"

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.

For more information on the FireEventEx method, and 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"

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.

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!")

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.

Example

                    '##IS_EXAMPLE For="JAVAPACKAGELib~Setting~MouseDrag", Caption="Perform Mouse Drag and Drop Operations"
'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"

Back to top

 

Next Method

Description

Sets the spin object to its next value.

Syntax

object.Next

Return Type

None.

Example

                    'The following example uses the Next method to set the "Month spin" spin object to its next value.
Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("SpinApplet").JavaSpin("Month spin").Next

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, OpenText Functional Testing 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

Back to top

 

Prev Method

Description

Sets the spin object to its previous value.

Syntax

object.Prev

Return Type

None.

Example

                    'The following example uses the Prev method to set the "Month spin" spin object to its previous value.
Browser("Java Examples").Page("Java Examples").Frame("MAIN").JavaApplet("SpinApplet").JavaSpin("Month spin").Prev
                    'The following example changes the JavaEdit value using the Prev  method of JavaSpin
'object  until the correct date appears. Then it checks how many time the Prev method was used

'Sets ExpectedPrevUsage and SetEditResult Results and Counter
ExpextedPrevUsage = 5
SetEditResult = 40
Counter = 0
JavaWindow("Spinner Demo").JavaSpin("Number Spinner").Set "40"
While SpinerValue <> 0
    JavaWindow("Spinner Demo").JavaSpin("Number Spinner").Prev
    SpinerValue = JavaWindow("Spinner Demo").JavaSpin("Number Spinner").GetROProperty("value")
    Counter = Counter + 1
Wend
    If Counter = ExpextedPrevUsage Then
        Reporter.ReportEvent micPass, "Spinner Work", "Spiner work is correct."
        Else
        Reporter.ReportEvent micFail, "Spinner Work", "Spinner Error. Wrong Spinner deincrement value."
    End If

Back to top

 

Set Method

Description

Sets the value of the spin object.

Syntax

object.Set (Value)

Arguments

ParameterDescription
Value

Required. A Variant.
The value to which the spin object should be set.

Note:  For SWT spinner objects, only Integer values are supported.

Return Type

None.

Example

                    'The following example uses the Set method to set the value of the Identical Spin object.
Browser("SwingSet demo").Page("Spin").JavaApplet("SpinApplet").JavaSpin("Identical spin").Set "Identical item"

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

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

Back to top

See also: