Show TOC

 Menu BarLocate this document in the navigation structure

Definition

Web item that allows the display of a menu. It generates a menu similar to the one used in desktop applications on the Web, into which you can add commands from the Web Design API.

Use

You can specify whether the menus or menu entries are to trigger an action that is based on a command from the Web Design API, or whether the menus are to group menu entries and thus display a nested menu. Nesting is restricted to a maximum of three levels. You can also specify whether a menu or menu entry is to be displayed in the menu bar or menu only, in the toolbar only, or in the menu bar and toolbar. You can also design the menu bar and toolbar by specifying, for example, that a menu is to be displayed with apostrophes, or is to contain a separator.

Structure

The following information lists the parameters for the Menu Bar Web item, arranged according to the various parameter groupings.

Display

Parameter Description

Width in Pixels (WIDTH)

You use this parameter to specify the width of the Web item.

Full Width (FULL_WIDTH)

You use this parameter to specify that the value in the Width in Pixels (WIDTH) parameter is to be ignored and that the width is to be set to 100% instead. The full width depends on the width of the environment in which the Web item is embedded (for example, the width of a tab page on a portal page or in an iView).

Height in Pixels (HEIGHT)

 

You use this parameter to specify the height of the Web item.

Full Height (FULL_HEIGHT)

You use this parameter to specify that the value in the Height in Pixels (HEIGHT) parameter is to be ignored and that the height is to be set to 100% instead. The full height depends on the height of the environment in which the Web item is embedded (for example, the height of a tab page on a portal page or iView).

Visibility (VISIBILITY)

 

You use this parameter to specify whether the Web item is to be visible in the Web application.

With Tray (WITH_TRAY)

 

You use this parameter to specify whether the Web item is to be displayed with an icon that allows it to be expanded and collapsed. For more information on this parameter, see Parameter Tray.

Internal Display

Parameter Description

Menu Bar

(MENU_CONTAINER_L1)

You use this parameter to design the menu bar. To do this, you create the individual menus and menu entries.

Menu (MENU_ELEMENT_L1)

You use this parameter to specify the individual menus of the menu bar; you also specify the type of menu.

Grouping of Menu Entries(MENU_ELEMENT_FOLDER_L1)

If the menu is to group menu entries, you need to set the following additional parameters:

Caption (CAPTION)

Using the text input dialog, you enter the name you want to give the menu. You can select whether the texts are to be language-dependent or language-independent. See Text Input Dialog .

Quick Info (TOOLTIP)

You use the text input dialog to enter a quick info text for the menu.

Icon (ICON)

You use this parameter to incorporate icons. More information: Storing and Including Images and Icons .

Display Separator Above

(MENU_HAS_SEPARATOR_ABOVE)

You use this parameter to specify whether the top part of the menu is to have a separator.

You need to set additional parameters for the following list of menu entries. See the table below.

Trigger an Action(MENU_ELEMENT_ACTION)

If the menu is to trigger an action, you need to set the following additional parameters:

Caption (CAPTION)

Quick Info (TOOLTIP)

Icon (ICON)

Action (Command Triggered)(ACTION)

You can select which action is to be executed and how this is to be done.

Command via Command Wizard (INSTRUCTION)

Using the pushbutton to the right of Command (INSTRUCTION), you can call the command wizard to insert a command (see Commands ).

Script Function (SCRIPT_FUNCTION)

In the Script Function field, you specify a script function to be executed.

You generate the script function using the script Web item that you previously added and set in the Web template.

Display Ellipsis (MENU_HAS_ELLIPSIS)

You use the Menu Entry Display (MENU_ELEMENT_DISPLAY) parameter to specify the type of display you want for the menu entry in the Web application.

Only Menu (VISIBLE_ONLY_IN_MENU)

You use this parameter to specify that the menu entry is to be displayed in the menu only. If you select this parameter, you need to make the following additional settings:

Display Separator Above (DISPLAY_SEPARATOR_ABOVE)

---------------------------------------------------------------

Only Toolbar (VISIBLE_ONLY_IN_TOOLBAR)

You use this parameter to specify that the menu entry is to be displayed in the toolbar only. If you select this parameter, you need to make the following additional settings:

Position in Toolbar (TOOLBAR_ITEM_POSITION)

Display Separator in Toolbar (TOOLBAR_ITEM_HAS_SEPARATOR)

---------------------------------------------------------------

Menu and Toolbar(VISIBLE_IN_MENU_AND_TOOLBAR)

You use this parameter to specify that the menu entry is to be displayed in the menu as well as in the toolbar. If you select this parameter, you need to make the following additional settings:

Display Separator Above (DISPLAY_SEPARATOR_ABOVE)

Position in Toolbar (TOOLBAR_ITEM_POSITION)

Display Separator in Toolbar (TOOLBAR_ITEM_HAS_SEPARATOR)

If you chose the Grouping of Menu Entries (MENU_ELEMENT_FOLDER_L1) type of menu under menu (MENU_ELEMENT_L1), you create a list of menu entries and set the following parameters for each menu entry.

Parameter Description

Menu Entry (MENU_ELEMENT_L2)

You use this parameter to specify a menu entry and the type of this menu entry:

Grouping of Menu Entries(MENU_ELEMENT_FOLDER_L1)

If the menu entry is to group additional menu entries, you need to set the following additional parameters:

Caption (CAPTION)

Quick Info (TOOLTIP)

Icon (ICON)

Display Separator Above

(MENU_HAS_SEPARATOR_ABOVE)

If the menu entry itself displays a menu and groups additional menu entries, specify the command that is to be stored for each of these submenu entries:

Trigger an Action (MENU_ELEMENT_ACTION)

You also need to set the following parameters:

Caption (CAPTION)

Quick Info (TOOLTIP)

Icon (ICON)

Display Ellipsis (MENU_HAS_ELLIPSIS)

Action (Command Triggered) (ACTION)

You can select which action is to be executed and how this is to be done.

Command via Command Wizard (INSTRUCTION)

You can use the pushbutton to the right of Command (INSTRUCTION) to call the command wizard to insert an additional command.

Script Function (SCRIPT_FUNCTION)

In the Script Function field, you specify a script function to be executed.

You generate the script function using the script Web item that you previously added and set in the Web template.

You also specify how the menu entry is to be displayed:

Only Menu (VISIBLE_ONLY_IN_MENU)

If you select this parameter, you need to make the following additional setting:

Display Separator Above (MENU_HAS_SEPARATOR_ABOVE)

---------------------------------------------------------------

Only Toolbar (VISIBLE_ONLY_IN_TOOLBAR)

If you select this parameter, you need to make the following additional settings:

Position in Toolbar (TOOLBAR_ITEM_POSITION)

Display Separator in Toolbar (TOOLBAR_ITEM_HAS_SEPARATOR)

---------------------------------------------------------------

Menu and Toolbar (VISIBLE_IN_MENU_AND_TOOLBAR)

If you select this parameter, you need to make the following additional settings:

Display Separator Above (MENU_HAS_SEPARATOR_ABOVE)

Position in Toolbar (TOOLBAR_ITEM_POSITION)

Display Separator in Toolbar (TOOLBAR_ITEM_HAS_SEPARATOR)

Trigger an Action (MENU_ELEMENT_ACTION)

If the menu entry is to trigger an action, you need to set the following additional parameters:

Caption (CAPTION)

Quick Info (TOOLTIP)

Icon (ICON)

Action (Command Triggered)(ACTION)

You can select which action is to be executed and how this is to be done.

Command via Command Wizard (INSTRUCTION)

You can use the pushbutton to the right of Command (INSTRUCTION) to call the command wizard to insert an additional command.

Script Function (SCRIPT_FUNCTION)

In the Script Function field, you specify a script function to be executed.

You generate the script function using the script Web item that you previously added and set in the Web template.

Display Ellipsis (MENU_HAS_ELLIPSIS)

You use the Menu Entry Display (MENU_ELEMENT_DISPLAY) parameter to specify the type of display you want for the menu entry in the Web application.

Menu Only (VISIBLE_ONLY_IN_MENU)

If you select this parameter, you need to make the following additional settings:

Display Separator Above (DISPLAY_SEPARATOR_ABOVE)

---------------------------------------------------------------

Only Toolbar (VISIBLE_ONLY_IN_TOOLBAR)

If you select this parameter, you need to make the following additional settings:

Position in Toolbar (TOOLBAR_ITEM_POSITION)

Display Separator in Toolbar (TOOLBAR_ITEM_HAS_SEPARATOR)

---------------------------------------------------------------

Menu and Toolbar (VISIBLE_IN_MENU_AND_TOOLBAR)

If you select this parameter, you need to make the following additional settings:

Display Separator Above (DISPLAY_SEPARATOR_ABOVE)

Position in Toolbar (TOOLBAR_ITEM_POSITION)

Display Separator in Toolbar (TOOLBAR_ITEM_HAS_SEPARATOR)

Behavior

Parameter Description

Allow Navigation (INTERACTION_ALLOWED)

 

You use this parameter to specify whether navigation or other interaction is to be possible in the Web application.