Home
Reference
The documents in this section provide reference material and samples for HCL Leap .
JavaScript™ API
Running Custom JavaScript™ – Events
Custom JavaScript™ is run in response to events in the form. These events can be triggered at the application, form, page, and item level in response to form lifecycle changes, and to user interactions. A list of the events available, and how to interact with the form using them is shown in the following list.
Page Events
This topic describes the Page Events, and their parameters when using JavaScript™ API in HCL Leap .

Reference
The documents in this section provide reference material and samples for HCL Leap .
- REST API reference
  The REST API can be used by other programs to communicate with Leap.
- JavaScript™ API
  - Running Custom JavaScript™ – Events
    Custom JavaScript™ is run in response to events in the form. These events can be triggered at the application, form, page, and item level in response to form lifecycle changes, and to user interactions. A list of the events available, and how to interact with the form using them is shown in the following list.
    - Application Events
      This topic describes the Application Events, and their parameters when using JavaScript™ API in HCL Leap .
    - Form Events
      This topic describes the Form Events, and their parameters when using JavaScript™ API in HCL Leap .
    - Page Events
      This topic describes the Page Events, and their parameters when using JavaScript™ API in HCL Leap .
    - Item Events
      This topic describes the Item Events, and their parameters when using JavaScript™ API in HCL Leap .
  - Running Custom JavaScript™ Files
    Custom JavaScript™ can also be loaded from attached JavaScript files. Any .js file that is added to the application in the Settings > Files section is automatically loaded into your running application. An associated JavaScript file is evaluated once when the browser first loads the running application, and is not called in response to any events.
  - Reference Objects and Functions
    Describes the Functions available on different parts of the HCL Leap object model.
- Services
  The following topics provide reference information about adding services to HCL Leap .
- Embedding items in an iframe
  You can use iFrames to embed charts and applications in a web page.
- Embedding API
  The Embedding API can be used to embed a Leap form directly in another webpage without using an <iframe>. The Leap form will be inserted into the DOM of the hosting page and can be interacted with using the Leap JavaScript API or any custom JavaScript. Additionally, the style of items in the Leap form can be customized by the CSS of the hosting page.
- Creating customized Cascading Style Sheets
  You can apply your own custom Cascading Style Sheet (CSS) to the rendering of your HCL Leap application. To create a custom theme, you must be familiar with the basic concepts of CSS.
- Custom Widget API
  This API provides a mechanism to incorporate custom widgets into the HCL Leap product.

Page Events

This topic describes the Page Events, and their parameters when using JavaScript™ API in HCL Leap .

There are many events available to hook into on a page that are accessed from the page Edit Properties dialog.

Table 1. JavaScript™ objects available in page events
Variable	Full name	Description	Example	Type
app	Application object	Contains functions for accessing global general information	`app.isSingleFormView()`	GUI
form	Form object	For accessing the pages and controlling page navigation	`form.getPage('P_Page1');`	GUI
page	Page object	For accessing the Page and the items on it	`page.F_Text.setContent('This a Label');`	GUI
BO	Business Object object	Top-level data object for the form	`BO.F_Username.getValue();`	DATA

Table 2. Page Events
Event	Description	Example
onHide	Called when the page is hidden. This is usually a result of page navigation.
onNavigateAway	Called as the page is about to be switched away from this one. A pAllowSwitch variable is passed to this event that contains one property called allow. Setting this property to `false` cancels the page switch.	Cancel the page switch if a check box is not checked: `if(!BO.F_Agree.getValue()) pAllowSwitch.allow = false;`
onRemoveFromNavigation	Called when this page is removed from navigation by calling the form.removePageFromNavigation() method for this page.
onRestoreFromNavigation	Called when a page is restored to navigation by calling the form.restorePageNavigation() method for this page.
onShow	Called every time the page is shown. This includes when the form is first displayed and when the user navigates to the page. A good location to update any display items. Note: When a form is first opened, this event is only called on the current displayed page.