Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
JavaScript™ language elements (JavaScript™)
The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
Embedding Java™ in JavaScript™
Java™ code can be embedded directly into JavaScript™ code.
Parameter conversion
JavaScript™ parameters are passed by value (JavaScript arrays and objects used as parameters are not modified by the Java™ code).

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript™)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
  - Statements (JavaScript)
    JavaScript™ statements consist of keywords and syntax.
  - Operators (JavaScript)
  - Top-level functions (JavaScript)
    Top-level functions are not associated with an object. In the ECMA specification, these functions are properties and methods of the global object.
  - @Functions (JavaScript)
    @Functions emulate their counterparts in Notes®.
  - Implied variable typing (JavaScript)
    You can associate a variable with a data type to document your code and direct content assist.
  - Embedding Java™ in JavaScript™
    Java™ code can be embedded directly into JavaScript™ code.
    - Java™ classes
      Java™ classes can be accessed from JavaScript™ code by specifying the fully qualified name, for example, java.lang.Class or java.util.Random. The package containing the class must be available as a shared library on the server. The standard Java packages are available on all servers; other packages must be installed.
    - User classes
      User Java™ classes can be created in an application using the Domino® or Java perspective, and called in JavaScript™ by specifying the fully qualified name. The class must belong to a package (not the default package).
    - Java™ arrays
      Java™ arrays can be embedded in the JavaScript™ code without prior declarations or inclusions. This provides the ability to create multi-dimension arrays and to pass them as parameters to Java methods included in the JavaScript code.
    - JavaScript™ objects
      A JavaScript™ object (when created with new Object()) is automatically converted to a map of properties when used as an argument to a Java™ method. A map is a Java interface that provides a list of name/value pairs. For example, you should pass a map when you call an XML adapter.
    - Parameter conversion
      JavaScript™ parameters are passed by value (JavaScript arrays and objects used as parameters are not modified by the Java™ code).
    - JavaScript™ keywords and Java™ methods
      You cannot use JavaScript™ keywords in Java™ syntax even if the word is legal in Java.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the HCL Domino® back-end.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

Parameter conversion

JavaScript™ parameters are passed by value (JavaScript™ arrays and objects used as parameters are not modified by the Java™ code).

Parameter conversions are as follows by type:


JavaScript™	Java™
`Boolean`	`Boolean`
`byte`	`Byte`
`short`	`Short`
`int`	`Integer`
`long`	`Long`
`float`	`Float`
`double`	`Double`
`Object`	`java.util.Map` – A temporary `HashMap` is created containing all the property name/value pairs. Primitive values (number, Boolean, string) are converted to a `java.lang.String` while Java™ objects are left as is.
`char`	`java.lang.Character` – When converting, only the first character is extracted.
`undefined`	Not assignable.
`null`	Created as any Java™ object and assigned the Java™ `null` value.
`Date`	`java.util.Date`
`Array`	A temporary Java™ array of the correct type is created and filled by converting all the values in the JavaScript™ array.
Wrapped Java™ object	Any Java™ object that is compatible (`isAssignableFrom`) passed as is without conversion

Java™ return values are passed as follows:


Java™	JavaScript™
`void`	`undefined`
Any number whether primitive or object	`number`
`java.lang.String`	`string`
`java.util.Date`	`Date`
Array	Not converted
Other objects	Wrapped and used as is