Siebel Interactive Designer API Reference > Application File Reference > Files in the ui Directory >

ol_ui.htm

This file is also known as the Application UI Definition file. It defines the HTML frameset layout of the application. Each application contains a single Application UI Definition file.

The HTML frameset layout defined in the Application UI Definition file represents what a user sees when the application first loads, as well as the static areas surrounding the display pages as a user continues to interact with the application.

One of the frames defined in the Application UI Definition file usually outlines the area, called mainArea in the Interactive Designer templates, into which all the display pages in your application load. You must use the RegisterUI function to indicate which frame defines this pageset display page area. The nested frameset structure of this single area is managed by a Pageset UI Definition file.

Use the RegisterContentsListFrame function to identify which frame defined in the Application UI Definition file displays the contents list. You can also use the SetContentsListFrame function inside a Pageset UI Definition file to display the Contents List inside the frameset of a pageset.

The Application UI Definition file must reference the header.js file from inside the <HEAD> tags, as in:

<HEAD><SCRIPT src="../jd/header.js"></SCRIPT></HEAD>

You must include a call to the RegisterUI function inside the onLoad event handler of the main frameset definition in the Application UI Definition file. The RegisterUI function identifies which of the frames defined in this file contains the nested pageset framesets defined in Pageset UI Definition files.


 Siebel Interactive Designer API Reference 
 Published: 18 April 2003