9 Applet Module

This chapter provides a complete listing and reference for the methods in the OpenScript AppletService Class of Applet Module Application Programming Interface (API).

9.1 AppletService API Reference

The following section provides an alphabetical listing of the methods in the OpenScript AppletService API.

9.1.1 Alphabetical Command Listing

The following table lists the AppletService API methods in alphabetical order.

Table 9-1 List of AppletService Methods

Method Description

applet.appWindow

Identifies a top window object that doesn't have an owner, by its path.

applet.button

Identifies a button object by its path.

applet.checkBox

Identifies a check box object by its path.

applet.comboBox

Identifies a combo box object by its path.

applet.dcmLayoutEditor

Identifies an OcgleDcm layout editor object by its path.

applet.dialog

Identifies a dialog object by its path.

applet.dtree

Identifies a DTree object by its path.

applet.expansionTree

Identifies an expansion tracking tree by its path.

applet.grid

Identifies a grid object by its path.

applet.infiniteScrollBar

Identifies a tree browser object by its path.

applet.javaObject

Identifies a component object by its path if this component could not be recognized as a specific type of object.

applet.radioButton

Identifies a radio button object by its path.

applet.scrollBar

Identifies a scroll bar object by its path.

applet.tab

Identifies a tab bar object by its path.

applet.textField

Identifies a text field object by its path.

applet.timeBrowser

Identifies a time browser object by its path.

applet.timeline

Identifies a time line object by its path.

applet.toolBar

Identifies a tool bar object by its path.

applet.treeBrowser

Identifies a tree browser object by its path.


The following sections provide detailed reference information for each method and enum in the AppletService Class of Applet Module Application Programming Interface.


applet.appWindow

Identifies a top window object that doesn't have an owner, by its path.

Format

The applet.appWindow method has the following command format(s):

applet.appWindow(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the window object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the window object.

Example

Performs an action on a window object specified by its path.

applet.appWindow(399, "/applet:TJavaAppWindow[@text='Oracle Applications' " +
 "or @posIndex='1']")
 .selectMenu("File|Close");
 

applet.button

Identifies a button object by its path.

Format

The applet.button method has the following command format(s):

applet.button(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the button object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the button object.

Example

Performs an action on a button object specified by its path.

applet.button(2967, "/applet:TJavaDialog[@posIndex='0']" +
 "/applet:TJavaButton[@text=' OK ' or @posIndex='0']")
 .click();

applet.checkBox

Identifies a check box object by its path.

Format

The applet.checkBox method has the following command format(s):

applet.checkBox(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the check box object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the check box object.

Example

Performs an action on a check box object specified by its path.

applet.checkBox(8956, "/applet:TJavaDialog[@text='Source Questions - " +
  "Create Conditional Blocks' or @posIndex='0']" +
 "/applet:TJavaCheckbox[@text='AE_ANY1' or @posIndex='0']")
 .setCheck(true);

applet.comboBox

Identifies a combo box object by its path.

Format

The applet.comboBox method has the following command format(s):

applet.comboBox(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the combo box object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the text field object.

Example

Performs an action on a combo box object specified by its path.

applet.comboBox(8092, "/applet:TJavaDcmLayoutEditor[" +
  "@text='AE_IND SUBSET 1 LAYOUT 1 Adverse Events' or @posIndex='4']" +
 "/applet:TJavaToolbar[@posIndex='0']" +
 "/applet:TJavaCombobox[@posIndex='0']")
 .selectItem("200%");

applet.dcmLayoutEditor

Identifies an OcgleDcm layout editor object by its path.

Format

The applet.dcmLayoutEditor method has the following command format(s):

applet.dcmLayoutEditor(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the layout editor object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the OcgleDcm layout editor object.

Example

Performs an action on an Ocgle DCM layout editor object specified by its path.

applet.dcmLayoutEditor(2962, "/applet:TJavaDcmLayoutEditor[@text='AE_IND " +
 "SUBSET 1 LAYOUT 1 Adverse Events' or @posIndex='4']")
 .selectMenu("File|Validate");

applet.dialog

Identifies a dialog object by its path.

Format

The applet.dialog method has the following command format(s):

applet.dialog(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the dialog object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the dialog object.

Example

Performs an action on a dialog object specified by its path.

applet.dialog(1097,"/applet:TJavaDcmLayoutEditor[@text='AE_IND SUBSET 1 " +
  "LAYOUT 1 Adverse Events' or @posIndex='4']" +
 "/applet:TJavaDialog[@text='Validation' or @posIndex='-1']")
 .close();

applet.dtree

Identifies a DTree object by its path.

Format

The applet.dtree method has the following command format(s):

applet.dtree(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the DTree object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the DTree object.

Example

Performs an action on a DTree object specified by its path.

applet.dtree(110, "/applet:TJavaWindow[@text='Edit Schedule' " +
  or @posIndex='4']" +
 "/applet:TJavaDTree[@posIndex='0']")
 .selectNode("49010");

applet.expansionTree

Identifies an expansion tracking tree by its path.

Format

The applet.expansionTree method has the following command format(s):

applet.expansionTree(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the expansion tracking tree object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the expansion tracking tree object.

Example

Performs an action on an expansion tracking tree object specified by its path.

applet.expansionTree(3284,"/applet:TJavaWindow[@text='Flow Workstation  (M1)' " +
  "or @posIndex='3']" +
 "/applet:TJavaExpansionTree[@posIndex='0']")
 .expandNode("Vision Pad:CASE|Assemblies");

applet.grid

Identifies a grid object by its path.

Format

The applet.grid method has the following command format(s):

applet.grid(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the grid object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the grid object.

Example

Performs an action on a grid object specified by its path.

applet.grid(3490, "/applet:TJavaWindow[@text='Edit Schedule' " +
  "or @posIndex='5']" +
 "/applet:TJavaGrid[@posIndex='0']")
 .editCell(3, 1);

applet.infiniteScrollBar

Identifies a tree browser object by its path.

Format

The applet.infiniteScrollBar method has the following command format(s):

applet.infiniteScrollBar(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the tree browser object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the tree browser object.

Example

Performs an action on a tree browser object specified by its path.

applet.infiniteScrollBar(152, "/applet:TJavaWindow[@text='Job Scheduling Workbench' " +
  or @posIndex='3']
 "/applet:TJavaInfiniteScrollBar[@posIndex='0']")
 .scroll(-349);

applet.javaObject

Identifies a component object by its path if this component could not be recognized as a specific type of object. Gives a default representation to the component object.

Format

The applet.javaObject method has the following command format(s):

applet.javaObject(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the scroll bar object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the component object.

Example

Performs an action on a component object specified by its path.

applet.javaObject(6315, "/applet:TJavaObject[@posIndex='4']")
 .mouseClick();

applet.radioButton

Identifies a radio button object by its path.

Format

The applet.radioButton method has the following command format(s):

applet.radioButton(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the radio button object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the radio button object.

Example

Performs an action on a radio button object specified by its path.

applet.radioButton(533, "/applet:TJavaWindow[@text='Filter' " +
  "or @posIndex='4']" +
 "/applet:TJavaRadioButton[@text='Date' or @posIndex='8']")
 .select();

applet.scrollBar

Identifies a scroll bar object by its path.

Format

The applet.scrollBar method has the following command format(s):

applet.scrollBar(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the scroll bar object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the scroll bar object.

Example

Performs an action on a scroll bar object specified by its path.

applet.scrollBar(6658, "/applet:TJavaDcmLayoutEditor[@text='AE_IND SUBSET 1 " +
  "LAYOUT 1 Adverse Events' or @posIndex='4']" +
 "/applet:TJavaScrollbar[@posIndex='0']")
 .setPosition(0);

applet.tab

Identifies a tab bar object by its path.

Format

The applet.tab method has the following command format(s):

applet.tab(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the tab bar object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the tab bar object.

Example

Performs an action on a tab bar object specified by its path.

applet.tab(725,"/applet:TJavaWindow[@text='Flow Workstation  (M1)' " +
  "or @posIndex='3']" +
 "/applet:TJavaTabBar[posIndex=0 and tClass='TJavaTabBar']")
 .select("Properties");

applet.textField

Identifies a text field object by its path.

Format

The applet.textField method has the following command format(s):

applet.textField(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the text field object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the text field object.

Example

Performs an action on a text field object specified by its path.

applet.textField(7945, "/applet:TJavaDcmLayoutEditor[@text='AE_IND SUBSET 1 " +
  "LAYOUT 1 Adverse Events' or @posIndex='4']" +
 "/applet:TJavaTextfield[@posIndex='31']")
 .setSelectedRange(0, 0);

applet.timeBrowser

Identifies a time browser object by its path.

Format

The applet.timeBrowser method has the following command format(s):

applet.timeBrowser(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the time browser object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the time browser object.

Example

Performs an action on a time browser object specified by its path.

applet.timeBrowser(145, "/applet:TJavaWindow[@text='Job Scheduling Workbench' " +
  "or @posIndex='3']" +
 "/applet:TJavaTimeBrowser[@posIndex='0']")
 .move("243645 : XA1000", "07-DEC-2006 17:03:00", "05-DEC-2006 15:45:55");

applet.timeline

Identifies a time line object by its path.

Format

The applet.timeline method has the following command format(s):

applet.timeline(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the time line object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the time line object.

Example

Performs an action on a time line object specified by its path.

applet.timeline(186, "/applet:TJavaWindow[@text='Job Scheduling Workbench' " +
  "or @posIndex='3']" +
 "/applet:TJavaTimeline[@posIndex='0']")
 .selectPopupMenu("Months");

applet.toolBar

Identifies a tool bar object by its path.

Format

The applet.toolBar method has the following command format(s):

applet.toolBar(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the tool bar object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the tool bar object.

Example

Performs an action on a tool bar object specified by its path.

applet.toolBar(7086, "/applet:TJavaDcmLayoutEditor[@text='AE_IND SUBSET 1 " +
  LAYOUT 1 Adverse Events' or @posIndex='4']" +
 "/applet:TJavaToolbar[@posIndex='0']")
 .clickItemByLabel("Center items horizontally");

applet.treeBrowser

Identifies a tree browser object by its path.

Format

The applet.treeBrowser method has the following command format(s):

applet.treeBrowser(recId, xPath);

Command Parameters

recId

the ID of a previously recorded navigation, used for comparison purposes.

xPath

a String specifying the path to identify the tree browser object.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

the tree browser object.

Example

Performs an action on a tree browser object specified by its path.

applet.treeBrowser(220, "/applet:TJavaWindow[@text='Job Scheduling Workbench' " +
  "or @posIndex='3']" + 
 "/applet:TJavaTreeBrowser[@posIndex='0']")
 .selectNode("NC132 : CM52295|:10");