Bookshelf Home | Contents | Index | Search | PDF

Siebel Tools Reference > Logical User Interface Objects Layer > Applets >

List Applets

---

A list applet allows simultaneous display of data from multiple records and presents business component information in a list table format with multicolumn layout with each record of data represented in a row. In addition to textual data, lists also support images in JPEG and GIF formats and edits control such as check boxes, drop-down lists, noneditable MVGs, and text fields.

The Accounts List Applet is an example of a list applet in Siebel Call Center, and appears in Figure 144.

Figure 144. List Applet in Siebel Sales

Columns in a list applet are called list columns, and have a corresponding object type (List Column). Data entry in a list applet is performed in the cells that are at the intersections of rows and list columns. Cells in different list columns can function in different ways, depending on the properties of their list columns. Some examples of cell behavior based on list column properties are:

Cells in some list columns function like text controls in a form applet. This kind of cell is used for the display and editing of a text, numeric, date, or currency value. If the list column is not read-only, you can click the cell to activate an editing cursor, and edit the text.
Cells in some list columns function like check box controls in a form applet. A check mark in the box is a TRUE value; an empty box has a FALSE value.

NOTE:  When TRUE, a check box in a list column holds a check mark symbol, whereas a check box in a control in a form applet holds an X symbol.

Cells containing underlined, colored text are drilldown fields. Drilldown fields let the user navigate from the cell to another view that presents detailed information about the selected row.

The relationships between object types used to implement a list applet appear in Figure 145.

Figure 145. List Applet Architecture

A list applet consists of an applet object definition, a list object definition, multiple list column object definitions, and multiple control object definitions (including, at a minimum, the list control). These object definitions have the following roles in a list applet:

Applet object. The applet object definition provides the properties that apply to the entire applet, such as the Name, Business Component, Width, and Height. It specifies in the Class property that the applet is a list applet (CSSFrameList class).
List object. The list object definition provides properties that govern how the list table operates, such as whether or not totals appear at the bottom of numeric columns. Configuration of the list object definition is described in Configuring the List.
List Column object. Each list column object definition identifies one list column in the scrolling list table. A list column corresponds to one field in the business component. Configuration of the list columns is described in Configuring the List Columns.
Control object. Each Control object definition identifies one visual construct in the list applet. With the exception of the list control, they all appear outside of the scrolling list table. Typical controls in the list applet include the Title control, which indicates the current record and the total number of records listed. Sometimes a set of navigation command buttons are also included in a list applet. Configuration of the controls in the list applet is described in Configuring Controls in a List Applet.
Applet Web Template object. Associates an applet to a Web template. Web templates determine the layout and format of the applet when it is rendered in the user interface. An applet can be displayed in five modes. An Applet Web Template is defined for each mode. The modes are:
Base. Read only.
Edit. Used for editing records where users can update values. You can also use the edit for creating new records and querying.

NOTE:  Typically, New and Query modes are not necessary because Edit mode can be used for these type of actions.

New. Used for creating a new record where the requirements for new mode are different from the edit mode.
Query. Used for querying where the requirements for the query mode are different from the edit mode.
Edit List. Used for editing records in a list applet.
Applet Web Template Items object. Maps controls to placeholder tags in a Web template. They contain the name of a control or list column as well as unique identifier of a template placeholder. The placeholder determines its position of the control or list column in the Web page rendered at runtime. Applet Web Template Items are automatically populated when users drag and drop controls into placeholders using the Applet Web Layout editor.

For more information about mapping controls and list columns to Web templates, see Editing the Web Layout of Applets.

Configuring the List

List is a child object type of Applet. A list applet has exactly one list object definition, named List. The List object definition provides property values that pertain to the entire scrolling list table, and it serves as a parent object definition for the list column object definitions.

A List object definition (and a list control) are created when you create a new list applet in the Applet wizard. In an existing list applet you can select the list object definition by clicking the list table. You can then edit the properties in the Properties window or use the Object List Editor.

Configuring the List Columns

List Column is a child object type of List. It identifies one column in the scrolling list table and corresponds to one field in the business component. The List Column object type has the following important properties:

Name. The name of the list column, for reference by other object definitions. The Name must be unique among the child list column object definitions of the list.
Field. This property identifies the field from which the list column derives its values.
HTML Sequence. This property defines the tab sequence when the list applet is shown for certain actions like query, new, edit, and so on. It does not apply to list columns.
Display Name. The text which appears at the top of the list column, identifying the column.
Display Format. A format specification for data displayed by the list column. It is used for numeric, date, currency, and similar non-text data types. For details, refer to Form Applet Controls.
MVG Applet. This property identifies which applet to use for the pop-up multi-value group if the field for the list column is a multi-value field.
Pick Applet. This property identifies the applet to use for the pop-up pick applet if the field for the list column has a picklist specified.
Text Alignment. Specifies the alignment of text in the list column. Valid values are Left, Center, and Right.
Total Required. A TRUE/FALSE property indicating whether the list column is to be totaled. An example of a list applet with totals in a list column is the Expense Item List Applet.
HTML Type. Specifies the style of the control. Examples of control types include Field, Text, ComboBox, CheckBox, Button, and Active X. See the section Form Applet Controls for descriptions of common control types.

For a complete description of properties of the List Column object type, see Siebel Object Types Reference.

Configuring Controls in a List Applet

The controls in a list applet generally appear outside of the scrolling list table and control the behavior of the scrolling list table or display information about the list table. However, some controls, such as the Label in Figure 146, appear inside the scrolling list table.

Figure 146. Controls in a List Applet

For more information about controls, see Form Applet Controls.

Bookshelf Home | Contents | Index | Search | PDF