Class sap.ui.commons.MenuBarModule: sap/ui/commons/MenuBar

extends Control

Represents a user interface area which is the entry point for menus with their menu items. MenuBar is useful for applications which shall offer a set of actions that shall be provided in a structured way. The MenuBar contains the menu titles from where users navigate to the single items. The control supports for example long menu item texts, automated scrolling for menu items when the browser space is not large enough to display all items, defining images for single or all items in a menu, automated layouting of items with or w/o image, and active/non-active items.
Deprecated API:
Since version 1.38. Instead, use the sap.m.OverflowToolbar control.
Constructor Summary
new sap.ui.commons.MenuBar(sId?, mSettings?)Constructor for a new MenuBar.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.MenuBar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.MenuBar with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.MenuBar.getMetadata()Returns a metadata object for class sap.ui.commons.MenuBar.
addItem(oItem)Adds some item to the aggregation items.
destroyItems()Destroys all the items in the aggregation items.
getDesign()Gets current value of property design.
getEnabled()Gets current value of property enabled.
getItems()Gets content of aggregation items.
getWidth()Gets current value of property width.
indexOfItem(oItem)Checks for the provided sap.ui.unified.MenuItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setDesign(sDesign)Sets a new value for property design.
setEnabled(bEnabled)Sets a new value for property enabled.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.ui.commons.MenuBar(sId?, mSettings?)

Constructor for a new MenuBar.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

    • enabled : boolean (default: true)
    • width : sap.ui.core.CSSSize (default: 100%)
    • design : sap.ui.commons.MenuBarDesign (default: Standard)

  • Aggregations

    • items : sap.ui.unified.MenuItem[] (default)

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.ui.commons.MenuBar.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.MenuBar with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.commons.MenuBar.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.MenuBar.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addItem(oItem): sap.ui.commons.MenuBar
Adds some item to the aggregation items.
Parameters:
sap.ui.unified.MenuItemoItemthe item to add; if empty, nothing is inserted
Returns:
sap.ui.commons.MenuBarReference to this in order to allow method chaining
destroyItems(): sap.ui.commons.MenuBar
Destroys all the items in the aggregation items.
Returns:
sap.ui.commons.MenuBarReference to this in order to allow method chaining

Gets current value of property design.

Available design options are Header and Standard. Note that design settings are theme-dependent.

Default value is Standard.

Returns:
sap.ui.commons.MenuBarDesignValue of property design
getEnabled(): boolean

Gets current value of property enabled.

When the MenuBar is not enabled, automatically all single menu items are also displayed as 'disabled'.

Default value is true.

Returns:
booleanValue of property enabled

Gets content of aggregation items.

Aggregation of menu items.

Returns:
sap.ui.unified.MenuItem[]
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Specifies the width of the MenuBar

Default value is 100%.

Returns:
sap.ui.core.CSSSizeValue of property width
indexOfItem(oItem): int
Checks for the provided sap.ui.unified.MenuItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.unified.MenuItemoItemThe item whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.commons.MenuBar
Inserts a item into the aggregation items.
Parameters:
sap.ui.unified.MenuItemoItemthe item to insert; if empty, nothing is inserted
intiIndexthe 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
sap.ui.commons.MenuBarReference to this in order to allow method chaining
removeAllItems(): sap.ui.unified.MenuItem[]

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.unified.MenuItem[]An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.unified.MenuItem
Removes a item from the aggregation items.
Parameters:
int|string|sap.ui.unified.MenuItemvItemThe item to remove or its index or id
Returns:
sap.ui.unified.MenuItemThe removed item or null
setDesign(sDesign): sap.ui.commons.MenuBar

Sets a new value for property design.

Available design options are Header and Standard. Note that design settings are theme-dependent.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Standard.

Parameters:
sap.ui.commons.MenuBarDesignsDesignNew value for property design
Returns:
sap.ui.commons.MenuBarReference to this in order to allow method chaining
setEnabled(bEnabled): sap.ui.commons.MenuBar

Sets a new value for property enabled.

When the MenuBar is not enabled, automatically all single menu items are also displayed as 'disabled'.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
booleanbEnabledNew value for property enabled
Returns:
sap.ui.commons.MenuBarReference to this in order to allow method chaining
setWidth(sWidth): sap.ui.commons.MenuBar

Sets a new value for property width.

Specifies the width of the MenuBar

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 100%.

Parameters:
sap.ui.core.CSSSizesWidthNew value for property width
Returns:
sap.ui.commons.MenuBarReference to this in order to allow method chaining