class sap.ui.commons.MenuBar

Control sample: sap.ui.commons.MenuBar
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/MenuBar
Application Component: CA-UI5-CTR

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.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.commons.MenuBar(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
design sap.ui.commons.MenuBarDesign Standard

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

Visibility: public
enabled boolean true

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

Visibility: public
width sap.ui.core.CSSSize 100%

Specifies the width of the MenuBar

Visibility: public

Aggregations

Default Aggregation: items

Name Cardinality Type Description
items (default) 0..n sap.ui.unified.MenuItem

Aggregation of menu items.


Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

destroyItems

Destroys all the items in the aggregation items.

sap.ui.commons.MenuBar.extend

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.

getDesign

Gets current value of property design.

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

Default value is Standard.

getEnabled

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.

getItems

Gets content of aggregation items.

Aggregation of menu items.

sap.ui.commons.MenuBar.getMetadata

Returns a metadata object for class sap.ui.commons.MenuBar.

getWidth

Gets current value of property width.

Specifies the width of the MenuBar

Default value is '100%'.

indexOfItem

Checks for the provided sap.ui.unified.MenuItem in the aggregation items. and returns its index if found or -1 otherwise.

insertItem

Inserts a item into the aggregation items.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setDesign

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.

setEnabled

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.

setWidth

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%'.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.unified.MenuItem

The item to add; if empty, nothing is inserted

destroyItems

Destroys all the items in the aggregation items.

sap.ui.commons.MenuBar.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getDesign

Gets current value of property design.

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

Default value is Standard.

getEnabled

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.

getItems

Gets content of aggregation items.

Aggregation of menu items.

sap.ui.commons.MenuBar.getMetadata

Returns a metadata object for class sap.ui.commons.MenuBar.

getWidth

Gets current value of property width.

Specifies the width of the MenuBar

Default value is '100%'.

indexOfItem

Checks for the provided sap.ui.unified.MenuItem in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.ui.unified.MenuItem

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.unified.MenuItem

The item to insert; if empty, nothing is inserted

iIndex int

The 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

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.ui.unified.MenuItem

The item to remove or its index or id

setDesign

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.

Param Type DefaultValue Description
sDesign sap.ui.commons.MenuBarDesign Standard

New value for property design

setEnabled

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.

Param Type DefaultValue Description
bEnabled boolean true

New value for property enabled

setWidth

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%'.

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize '100%'

New value for property width