Scripting Language Reference
- Scripting Language Reference
The J9Script scripting language can be used to create powerful rules, web pages, and touch screen interface actions.
Basic Data Types
Represents text; that is, a series of characters (letters, numbers, symbols, etc).
Represents a signed IEEE 64-bit (8-byte) double-precision floating-point number ranging in value from -1.79769313486231570E+308 through -4.94065645841246544E-324 for negative values and from 4.94065645841246544E-324 through 1.79769313486231570E+308 for positive values.
Represents a Boolean value of true or false.
Represents a collection of key/value pairs that are ordered based on the key/index. The key is a case-insensitive string.
Represents an instant in time, typically expressed as a date and time of day.
Represents a time interval (duration of time or elapsed time).
The Array object is used to store a set of values in a single variable name.
Represents an error that occurred during script execution.
Used only as the return type for a method or a parameter type of a method to specify that the return value or parameter value can be any data type.
- Null Reference
The null keyword is a literal that represents a null reference, one that does not refer to any object.
Used only as the return type for a method to specify that the method does not return a value.
Advanced Datatypes & Objects
Represents an image file for a graphics image in one of the following formats: BMP, GIF, EXIF, JPG, PNG and TIFF.
Provides constants and static methods for logarithmic, and other common mathematical functions. This object can not be instantiated in a script.
Provides static methods for common file system operations. This object can not be instantiated in a script.
Represents an OLE DB connection to a data source (such as a database). With a client/server database system, it is equivalent to a network connection to the server.
Reresents an ODBC connection to a data source (such as a database). With a client/server database system, it is equivalent to a network connection to the server.
Represents an immutable regular expression.
Provides base automation system methods and properties, such as Sleep() and Log().
Many device events have arguments associated with them which can be referenced from the rule's script using the this object. This object is instantiated by the event and can not be created in a script.
All devices (driver instances) defined in the configuration can be referenced in a script by their user defined name. These objects can not be instantiated in a script.
This object contains information about a device and a reference to the device if it is running. Use the methods in the System Object to get a reference to device containers.
The following objects are only available from within touch screen control action scripts. These objects can not be instantiated in a script.
Scripts run from a touch screen control action can reference their touch screen and touch screen controls using the TouchScreen keyword. The TouchScreen object is instantiated by the associated touch screen and can not be created in a script.
This is similar to the TouchScreen object but references the touch screen at the top of the touch screen hierarchy.
Scripts run from a touch screen control action, can reference the current control, using the this keyword. The this object is instantiated by the associated touch screen and can not be created in a script.
The label control is used to display static or dynamic text with an optional background image, background color, and/or border.
A button control is used to execute a script when it is pressed. The button's image can be changed when it is depressed.
A boolean control is used to display an image based on the result of a true/false (boolean) expression. This can be used as a checkbox for example.
The Slider control enables the user to adjust a numeric value in a finite range along a horizontal or vertical axis.
Displays the cover art for a specified media player device's current playing track.
An inner touch screen control is used to display a separate touch screen within the current touch screen. This allows nesting of touch screens within each other. The touchscreen shown in the control can be changed for example when a button is pressed in the current touchscreen.
The spinner list control contains a list of name/value pairs, with the selected item's name being displayed in the control.
The device list control displays all the current devices that are running for a particular device type.
The paged list control contains a list of name/value pairs, with multiple items of the list being shown vertically. The selected item's name is highlighted in the control.
A web browser control is used to display web a page. Web Browser controls will always appear above other control types in the viewer.
Elve Web Objects
The following web objects are only available from within J9 Server Pages (J9SP)
web applications. These objects can not be instantiated in a script.
Enables the web application to read the HTTP values sent by a client during a Web request.
Encapsulates HTTP-response information from the web application.
Provides helper methods for processing Web requests.
Enables sharing of global information across multiple sessions and requests within the web application.
Provides access to session-state values as well as session-level settings and lifetime management methods.