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

10.1 AppletService API Reference

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

10.1.1 Alphabetical Command Listing

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

Table 10-1 List of AppletService Methods

Method	Description
applet.applet	Identifies an applet object by its path.
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.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 infinite scroll bar 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.label	Identifies a label object by its path.
applet.list	Identifies a list object by its path.
applet.mdiChild	Identifies a mdiChild object by its path.
applet.menu	Identifies a menu object by its path.
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.tabbedPage	Identifies a tabbed page object by its path.
applet.table	Identifies a table object by its path.
applet.textField	Identifies a text field object by its path.
applet.textView	Identifies a text view 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.
applet.treeView	Identifies a tree view object by its path.
applet.window	Identifies a Java window 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.applet

Identifies an applet object by its path.

Format

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

applet.applet(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the applet object.

Throws

Exception: on any error.

Returns

the applet object.

Example

Identifies an applet object by its path.

applet.applet(399, "/applet:TApplet[@text='Oracle Applications' " +
 "or @posIndex='1']");

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, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the window object.

Throws

Exception: on any error.

Returns

the window object.

Example

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

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

applet.button

Identifies a button object by its path.

Format

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

applet.button(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the button object.

Throws

Exception: on any error.

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, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the check box object.

Throws

Exception: on any error.

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, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the combo box object.

Throws

Exception: on any error.

Returns

the combo box 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.dialog

Identifies a dialog object by its path.

Format

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

applet.dialog(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the dialog object.

Throws

Exception: on any error.

Returns

the dialog object.

Example

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

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

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

Exception: on any error.

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

Exception: on any error.

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, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the grid object.

Throws

Exception: on any error.

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 infiniteScrollBar object by its path.

Format

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

applet.infiniteScrollBar(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the infiniteScrollBar object.

Throws

Exception: on any error.

Returns

the infiniteScrollBar object.

Example

Performs an action on a infiniteScrollBar 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, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the Java object.

Throws

Exception: on any error.

Returns

the component object.

Example

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

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

applet.label

Identifies a label object by its path.

Format

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

applet.label(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the label object.

Throws

Exception: on any error.

Returns

the label object.

Example

Identifies a label object specified by its path.

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

applet.list

Identifies a list object by its path.

Format

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

applet.list(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the list object.

Throws

Exception: on any error.

Returns

the list object.

Example

Performs an action on a Java list object specified by its path.

String selected = applet.list(533, "/applet:TJavaWindow[@text='Filter' " +
  "or @posIndex='4']" +
 "/applet:TJavaList[@text='Names' or @posIndex='8']")
 .getSelected();

applet.mdiChild

Identifies a mdiChild object by its path.

Format

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

applet.mdiChild(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the mdiChild object.

Throws

Exception: on any error.

Returns

the mdiChild object.

Example

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

applet.mdiChild(533, "/applet:TJavaWindow[@text='Filter' " +
  "or @posIndex='4']" +
 "/applet:TJavamdiChild[@text='Names' or @posIndex='8']")
 .setActive();

applet.menu

Identifies a menu object by its path.

Format

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

applet.menu(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the menu object.

Throws

Exception: on any error.

Returns

the menu object.

Example

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

applet.menu(53, "/applet:TJavaWindow[@text='Filter' " +
  "or @posIndex='4']" +
 "/applet:TJavaMenu[@text='Edit' or @posIndex='2']")
 .menuClick();

applet.radioButton

Identifies a radio button object by its path.

Format

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

applet.radioButton(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the radio button object.

Throws

Exception: on any error.

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, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the scroll bar object.

Throws

Exception: on any error.

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

Identifies a slider object by its path.

Format

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

applet.slider(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the slider object.

Throws

Exception: on any error.

Returns

the slider object.

Example

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

applet.slider(725,"/applet:TJavaWindow[@text='Flow Workstation  (M1)' " +
  "or @posIndex='3']" +
 "/applet:TJavaSlider[posIndex=0 and tClass='TJavaSlider']")
 .setPosition(3);

applet.tab

Identifies a tab bar object by its path.

Format

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

applet.tab(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the tab bar object.

Throws

Exception: on any error.

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

Identifies a tabbedPage object by its path.

Format

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

applet.tabbedPage(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the tabbed page object.

Throws

Exception: on any error.

Returns

the tabbedPage object.

Example

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

applet.tabbedPage(725,"/applet:TJavaWindow[@text='Flow Workstation  (M1)' " +
  "or @posIndex='3']" +
 "/applet:TJavaTabbedPage[posIndex=0 and tClass='TJavaTabbedPage']")
 .selectByIndex(2);

applet.table

Identifies a table object by its path.

Format

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

applet.table(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the table object.

Throws

Exception: on any error.

Returns

the table object.

Example

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

applet.table(725,"/applet:TJavaWindow[@text='Flow Workstation  (M1)' " +
  "or @posIndex='3']" +
 "/applet:TJavaTable[posIndex=0 and tClass='TJavaTable']")
 .selectCell(1, 1, "");

applet.textField

Identifies a text field object by its path.

Format

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

applet.textField(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the text field object.

Throws

Exception: on any error.

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']")
 .setText("Owner");

applet.textView

Identifies a textView object by its path.

Format

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

applet.textView(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the textView object.

Throws

Exception: on any error.

Returns

the textView object.

Example

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

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

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

Exception: on any error.

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

Exception: on any error.

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, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the tool bar object.

Throws

Exception: on any error.

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 treeBrowser object by its path.

Format

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

applet.treeBrowser(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the treeBrowser object.

Throws

Exception: on any error.

Returns

the treeBrowser object.

Example

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

applet.treeBrowser(145, "/applet:TJavaWindow[@text='Job Scheduling Workbench' " +
  "or @posIndex='3']" +
 "/applet:TJavaTreeBrowser[@posIndex='0']")
 .click();

applet.treeView

Identifies a treeView object by its path.

Format

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

applet.treeView(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the treeView object.

Throws

Exception: on any error.

Returns

the treeView object.

Example

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

in count = applet.treeView(145, "/applet:TJavaWindow " +
 "[@text='Job Scheduling Workbench' " +
  "or @posIndex='3']" +
 "/applet:TJavaTreeView[@posIndex='0']")
 .itemCount();

applet.window

Identifies a Java window object by its path.

Format

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

applet.window(recId, scriptId);

Command Parameters

recId: the ID of a previously recorded navigation, used for comparison purposes.
scriptId: a String specifying the path to identify the Java window object.

Throws

Exception: on any error.

Returns

the Java window object.

Example

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

applet.window(145, "/applet:TJavaWindow " +
 "[@text='Job Scheduling Workbench' " +
  "or @posIndex='3']" +
 "/applet:TJavaWindow[@posIndex='0']")
 .close();