Bookshelf Home | Contents | Index | Search | PDF

Siebel Tools Reference > Logical User Interface Objects Layer > Toolbars and Menus >

Toolbar and Menu-Related Object Types

---

The relevant object types for configuration of menus and toolbars in Tools are described in the following sections.

Command Object Type

A Command object definition specifies which invoke method is called when a toolbar icon or application-level menu item associated with the command is executed (applet-level menus do not use command objects). It also specifies which bitmap appears on the toolbar icon for toolbar items. Command object definitions are referenced by Toolbar Item or Menu Item object definitions.

See Using the Command Object Wizard for more information about creating Command objects.

A Command object definition has the following significant properties:

Target. Specifies which entity handles the invoke method the command calls. Available options are the following:
Browser. The method handler is a JavaScript service on the browser, or the JavaScript application, depending on whether a service is specified in the Business Service property.
Server. The method handler is an object manager service on the server or the object manager infrastructure (the SWE UDF loader, or, secondarily, the model), depending on whether a service is specified in the Business Service property.
Browser Applet. Used with high interactivity.

For more details on the configuration of the Target property and related properties, see Invoke Method Targeting.

Business Service. Specifies the service (either browser or server, depending on the Target property) that handles the invoke method. If the property is left blank, the browser or server infrastructure is targeted rather than a specific service. If a service is specified, it must handle CanInvokeMethod and InvokeMethod for the method specified in the Method property.
Method. Specifies the name of the method to invoke when the menu item or toolbar icon is selected. This is a required property.

See Invoke Method Targeting.

Method Argument. Provides the means to pass an argument to the invoke method specified in the Method property. For example, a command item that opens a new window and navigates to a URL in that window can specify the GotoURL method in Method and the URL to navigate to in Method Argument.
Show Popup. If TRUE, specifies that a new browser window is opened before invoking the method. If FALSE, specifies that the method is invoked in the current browser window.
HTML Popup Dimensions. Dimensions, in pixels, of the pop-up window, when Show Popup is TRUE. An example is 640x480 (specified with the "x" and without blank spaces).
HTML Bitmap. Specifies bitmap used by the Command object.
Tooltip Text. This is the tooltip text which appears when the cursor lingers on a toolbar icon. For built-in methods, the tooltip text should be left blank; blank indicates that the method will dynamically supply the text, and language localization takes place as a part of this process. For developer-defined methods, you should enter literal text (but note that this turns off language localization for this tooltip text).

Toolbar Object Type

For each toolbar in the application, you create a Toolbar object definition in the Object List Editor. This provides a named toolbar that the user can activate or deactivate in Siebel applications, and to which icons (Toolbar Item object definitions) can be associated or removed. Typical toolbar functionality for most applications is implemented using HTML toolbars. In an HTML toolbar, the buttons are static images, which may be dimmed to indicate unavailability, but otherwise are not manipulated by program logic on the browser. In contrast, communications toolbars in applications such as Call Center, require toolbar icons that can be altered in response to events, such as blinking a particular toolbar icon when a call is incoming. This requires the use of Java toolbars. To specify that a toolbar is of the Java type, a class name is entered in the Class property.

For more information about configuring communications toolbars, see Siebel Communications Server Administration Guide.

Important properties of Toolbar are:

Class. Left blank for an HTML toolbar, specified for a Java toolbar - the name of the Java class that implements the toolbar is entered.
Name. Referenced by other object definitions, and by the <swe:toolbar> tag in the "name=" clause.
Display Name. Used for the History button and to show or hide toolbars by name.

Toolbar Item Object Type

The Toolbar Item object type associates a Command object definition (identified by name as a property in the Command property) with a Toolbar object definition (the parent of the Toolbar Item). This association places a toolbar icon, whose bitmap image, invoke method, and target are specified in the Command object definition, on the specified toolbar in a given location (relative to the other toolbar icons on that toolbar). The following properties are significant in a Toolbar Item object definition:

Command. Name of the Command object definition that is to provide the bitmap, method and target for the toolbar item. One or more hyphens can be specified instead of the name of a Command object to tell the system to insert a separator there between icons.
HTML Type. Identifies the type of control to be displayed in the toolbar in the browser. Options include ComboBox, Button, Edit, Label, Hyperlink, MiniButton and Timer.
Name. Name of the toolbar item. Used internally in Siebel Tools only. This needs to be unique within the scope of a toolbar.
Sequence. Integer that orders the toolbar item in the parent toolbar from left to right. A higher sequence number relative to other toolbar items places this icon further to the right than the others.
Position. Used for sideways toolbars. A value of .1, .2, and so on, is used.
Menu. Defines a set of application-level main menus. Currently the only Menu object definition in use is called "Generic." It is the parent of Menu Item.
Menu Item. Defines an application-level main menu or menu item within the parent Menu object definition. Significant properties are the following:
Name. Uniquely identifies the menu or menu item.
Command. Name of the Command object definition that is to provide the method and target for the menu item.
Caption. The text displayed in the menu or menu item.
Position. Specifies the position of the menu or menu item in the menu tree. The top-level positions for menus (rather than items within them) are single integers such as 1, 2, and 3 (or 10, 20, and 30). Position values for menu items (2nd level and below in the menu tree) are specified using a dot notation, where the value to the right of the rightmost dot specifies the order of the item on its level, and the value or values to the left of that dot specify the parent menu or menu item. For example, 3.1 is the first item in the submenu of the third item of the top-level menu. Note that values on a level are not required to be consecutive; for example, the values 1110, 1115, 1120, and 1130 may be used to indicate four menu items on the same level; their sequence determines their order of display in the menu.

Applet Method Menu Item

Defines a menu item in the applet-level menu for the parent Applet object definition. Important properties are the following:

Menu Text. The text displayed in the menu item.
Suppress Menu Item. Default is FALSE. If TRUE, causes the class-level menu item of the specified name to be removed from the applet-level menu in the applet where this property is specified.
Command. Name of the Command object definition that is to provide the bitmap, method and target for the applet menu item.
Position. The sequence of the menu item in the single-level list of menu items.

See Defining Web Menus Using the Applet Method Menu Wizard for more information.

Class Method Menu Item

Class Method Menu Item is a child of Class. It adds (or suppresses) a menu item on applet-level menus for all SWE applets of the specified applet class and its subclasses.

Significant properties are the following:

Target. Specifies which entity handles the invoke method specified in the Method property. Available options are the following:
Browser. The method handler is a JavaScript service on the browser, or the JavaScript applet class (secondarily the JavaScript business component class) on the browser, depending on whether a service is specified in the Business Service property.
Server. The method handler is an object manager service on the server or the applet and business component and their superclasses, depending on whether a service is specified in the Business Service property.
Menu Text. The text displayed in the menu item.
Method. The method invoked when the item is selected.
Business Service. If specified, identifies the service on which to invoke the method. If unspecified, the method is invoked on the applet class on the browser or server (as specified in the Target property) with subsequent retargeting if unhandled.
Suppress Menu Item. Default is FALSE. If TRUE, causes the applet-level menu items of the specified name to be removed from the applet-level menu in all applets derived from this class and its subclasses.
Position. The sequence of the menu item in the single-level list of menu items.

Bookshelf Home | Contents | Index | Search | PDF