Entering content frame

Object documentation Menu Bar Locate the document in its SAP Library structure

Definition

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

Use

You can determine whether the menus or menu entries trigger an action that uses a command from the Web Design API as a basis, or whether the menus group menu entries, which leads to a nested menu being displayed. Nesting is restricted to a maximum of three levels. You can simultaneously determine if a menu or menu entry is only displayed in the menu bar or menu, or if it is only or additionally shown in the toolbar. You can also design the menu bar and toolbar by setting, for example, that a menu is displayed with apostrophes, or has a separator.

Structure

The following is a parameter list 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 determine the width of the Web item.

Full width (FULL_WIDTH)

 

     

 

You use this parameter to determine that the specification in the Width in Pixels (WIDTH) parameter be ignored and that the width 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 iView).

Height in pixels (HEIGHT)

 

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

Full height (FULL_HEIGHT)

You use this parameter to determine that the specification in the Height in Pixels (HEIGHT) parameter be ignored and that the height 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 determine whether the Web item is visible in the Web application.

With tray (WITH_TRAY)

 

You use this parameter to determine whether the Web item has a symbol 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. Create the individual menus and menu entries.

Menu (MENU_ELEMENT_L1)

You use this parameter to determine the individual menus of the menu bar, you also determine the type of menu.

Grouping of menu entries (MENU_ELEMENT_FOLDER_L1)

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

Label (CAPTION)

Using the text input dialog, you enter the name of the menu. You can select whether the texts are to be language dependent or language independent. See Structure linkText Input Dialog.

Quick Info (TOOLTIP)

Using the text input dialog, you can enter a quick info text for the menu.

Display Separator Above

(MENU_HAS_SEPARATOR_ABOVE)

Here you can determine whether the menu has an upper 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 triggers an action, you need to set the following additional parameters:

Label (CAPTION)

Quick Info (TOOLTIP)

Action (Command to Be Triggered) (ACTION)

You select the command from the Web Design API that defines the menu and that is executed when the menu is selected in the Web application.  The Command Wizard is available for this purpose.

Display Ellipsis (MENU_HAS_ELLIPSIS)

Under Menu Entry Display (MENU_ELEMENT_DISPLAY), you determine the type of display of the menu entry in the Web application:

Menu Only (VISIBLE_ONLY_IN_MENU)

You use this parameter to determine whether the menu entry is only displayed in the menu. If you choose this parameter you need to make the following further settings:

Display Separator Above (DISPLAY_SEPARATOR_ABOVE)

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

Toolbar Only (VISIBLE_ONLY_IN_TOOLBAR)

You use this parameter to determine whether the menu entry is only displayed in the toolbar. If you select this parameter you need to make the following further 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 determine whether the menu entry is displayed in the menu as well as in the toolbar. If you select this parameter you need to make the following further 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), 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 determine a menu entry and in doing so you also set the type of the menu entry:

 Grouping of menu entries (MENU_ELEMENT_FOLDER_L1)

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

Label (CAPTION)

Quick Info (TOOLTIP)

Display Separator Above

(MENU_HAS_SEPARATOR_ABOVE)

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

Trigger an Action (MENU_ELEMENT_ACTION)

To do this you need to set the following parameters:

Label (CAPTION)

Quick Info (TOOLTIP)

Display Ellipsis (MENU_HAS_ELLIPSIS)

Action (Command to Be Triggered) (ACTION)

You select the command from the Web Design API that defines the menu entry and that is executed when the menu entry is selected in the Web application.  The Command Wizard is available for this purpose.

You also determine how the menu entry is displayed:

Menu Only (VISIBLE_ONLY_IN_MENU)

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

Display Separator Above (MENU_HAS_SEPARATOR_ABOVE)

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

Toolbar (VISIBLE_ONLY_IN_TOOLBAR)

If you select this parameter you need to make the following further 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 further 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 triggers an action, you need to set the following additional parameters:

Label (CAPTION)

Quick Info (TOOLTIP)

Action (Command to Be Triggered) (ACTION)

You select the command from the Web Design API that forms the basis of the menu entry and that is executed when the menu is selected in the Web application.  The Command Wizard is available for this purpose.

Display Ellipsis (MENU_HAS_ELLIPSIS)

Under Menu Entry Display (MENU_ELEMENT_DISPLAY), you determine the type of display of the menu entry in the Web application:

Menu Only (VISIBLE_ONLY_IN_MENU)

If you choose this parameter you need to make the following further settings:

Display Separator Above (DISPLAY_SEPARATOR_ABOVE)

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

Toolbar Only (VISIBLE_ONLY_IN_TOOLBAR)

If you select this parameter you need to make the following further 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 further settings:

Display Separator Above (DISPLAY_SEPARATOR_ABOVE)

Position in Toolbar (TOOLBAR_ITEM_POSITION)

Display Separator in Toolbar (TOOLBAR_ITEM_HAS_SEPARATOR)

Behavior

Parameter

Description

Activate navigation (INTERACTION_ALLOWED)

 

You use this parameter to determine whether navigation or other interactions are possible in the Web application.

 

 

Leaving content frame