This chapter provides a complete listing and reference for the methods in the OpenScript AppletService Class of Applet Module Application Programming Interface (API).
The following section provides an alphabetical listing of the methods in the OpenScript AppletService API.
The following table lists the AppletService API methods in alphabetical order.
Table 9-1 List of AppletService Methods
Method | Description |
---|---|
Identifies a top window object that doesn't have an owner, by its path. |
|
Identifies a button object by its path. |
|
Identifies a check box object by its path. |
|
Identifies a combo box object by its path. |
|
Identifies an OcgleDcm layout editor object by its path. |
|
Identifies a dialog object by its path. |
|
Identifies a DTree object by its path. |
|
Identifies an expansion tracking tree by its path. |
|
Identifies a grid object by its path. |
|
Identifies a tree browser object by its path. |
|
Identifies a component object by its path if this component could not be recognized as a specific type of object. |
|
Identifies a radio button object by its path. |
|
Identifies a scroll bar object by its path. |
|
Identifies a tab bar object by its path. |
|
Identifies a text field object by its path. |
|
Identifies a time browser object by its path. |
|
Identifies a time line object by its path. |
|
Identifies a tool bar object by its path. |
|
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.
Identifies a top window object that doesn't have an owner, by its path.
The applet.appWindow method has the following command format(s):
applet.appWindow(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the window object.
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.
Identifies a button object by its path.
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the button object.
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.
Identifies a check box object by its path.
The applet.checkBox method has the following command format(s):
applet.checkBox(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the check box object.
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.
Identifies a combo box object by its path.
The applet.comboBox method has the following command format(s):
applet.comboBox(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the combo box object.
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.
Identifies an OcgleDcm layout editor object by its path.
The applet.dcmLayoutEditor method has the following command format(s):
applet.dcmLayoutEditor(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the layout editor object.
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.
Identifies a dialog object by its path.
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the dialog object.
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.
Identifies a DTree object by its path.
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the DTree object.
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.
Identifies an expansion tracking tree by its path.
The applet.expansionTree method has the following command format(s):
applet.expansionTree(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the expansion tracking tree object.
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.
Identifies a grid object by its path.
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the grid object.
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.
Identifies a tree browser object by its path.
The applet.infiniteScrollBar method has the following command format(s):
applet.infiniteScrollBar(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the tree browser object.
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.
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.
The applet.javaObject method has the following command format(s):
applet.javaObject(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the scroll bar object.
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.
Identifies a radio button object by its path.
The applet.radioButton method has the following command format(s):
applet.radioButton(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the radio button object.
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.
Identifies a scroll bar object by its path.
The applet.scrollBar method has the following command format(s):
applet.scrollBar(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the scroll bar object.
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.
Identifies a tab bar object by its path.
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the tab bar object.
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.
Identifies a text field object by its path.
The applet.textField method has the following command format(s):
applet.textField(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the text field object.
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.
Identifies a time browser object by its path.
The applet.timeBrowser method has the following command format(s):
applet.timeBrowser(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the time browser object.
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.
Identifies a time line object by its path.
The applet.timeline method has the following command format(s):
applet.timeline(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the time line object.
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.
Identifies a tool bar object by its path.
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the tool bar object.
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.
Identifies a tree browser object by its path.
The applet.treeBrowser method has the following command format(s):
applet.treeBrowser(recId, xPath);
the ID of a previously recorded navigation, used for comparison purposes.
a String specifying the path to identify the tree browser object.
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.