Siebel Developer's Reference > Siebel Web Engine Tags >

swe:toolbar, swe:toolbaritem

Toolbars and menus give users the means to initiate various actions. Toolbars appear in their own frame near the top of the application in the browser window.

Clicking on a toolbar icon or menu item is translated into a call to an invoked method, which may reside in a service on the browser or server, or in classes in the browser application or server infrastructure (applet or business component classes, SWE frame manager, or model). The toolbar icon or menu item is configured to target a method name, a method handler (from which it may be automatically retargeted if not found), and, optionally, a service.

Application-level items (which include both toolbar icons and application-level menus) are implemented through the use of Command object definitions in Siebel Tools, which are then mapped to Toolbar Item or Menu Item object definitions. Applet-level menus use Applet Method Menu Item objects, which also call commands.

In SWE templates, the swe:toolbar tag specifies a named toolbar (where the name corresponds to the Name property in the Toolbar object definition in the repository), and the swe:toolbaritem tag between the toolbar start and end tags recursively retrieves all of the toolbar items for that toolbar from the repository.

Two types of toolbars are supported: HTML and Java applet. HTML toolbars reside in the topmost frame in the application template, which is set aside for this purpose. An additional frame beneath this one is specified for Java toolbars in Siebel Call Center and similar applications using CTI. If no Java toolbar is used, this frame is omitted.

For an HTML toolbar, in the SWT file, add the following:

<swe:toolbar name=xxx>    // where xxx is the name of toolbar in the repository.

// any HTML stuff here...

<swe:toolbaritem>

// any HTML stuff here...

</swe:toolbar>

NOTE:  For box items, the command has to be targeted to a service.

For a Java toolbar, add the following to the SWT file:

<swe:toolbar name="xxx" javaapplet="true" />

The Java applet invokes the ShellUIInit method on the command target service when the Java applet tries to initialize. The Java applet invokes ShellUIExit when it exits. There is a set of communication protocols defined for the communication between the Java applet and the service.

The toolbar is implemented as a Java applet (including all the toolbar controls and the threads interacting with the server).

swe:toolbar

This tag specifies a named toolbar.

Usage

<swe:toolbar name="xxx" javaapplet="true/false" />

Attributes

Name. Name of the toolbar, as specified in the repository Toolbar object definition.

Javaapplet. Specify as TRUE to implement a Java toolbar. Specify as FALSE or omit to implement an HTML toolbar.

swe:toolbaritem

This tag between the toolbar start and end tags recursively retrieves all of the toolbar items for that toolbar from the repository.

Usage

<swe:toolbaritem>

Attributes

None