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.
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. 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. 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. addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
setVisible,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement addAggregation,
addAssociation,
applySettings,
attachFormatError,
attachModelContextChange,
attachParseError,
attachValidationError,
attachValidationSuccess,
bindAggregation,
bindContext,
bindObject,
bindProperty,
destroyAggregation,
detachFormatError,
detachModelContextChange,
detachParseError,
detachValidationError,
detachValidationSuccess,
findAggregatedObjects,
fireFormatError,
fireModelContextChange,
fireParseError,
fireValidationError,
fireValidationSuccess,
getAggregation,
getAssociation,
getBinding,
getBindingContext,
getBindingInfo,
getBindingPath,
getEventingParent,
getId,
getModel,
getObjectBinding,
getOriginInfo,
getParent,
getProperty,
hasModel,
indexOfAggregation,
insertAggregation,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty 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:
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.38. Instead, use the
sap.m.OverflowToolbar 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:
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
| {function} | Created class / constructor function |
Returns a metadata object for class sap.ui.commons.MenuBar.
Returns:
Adds some item to the aggregation items.
Parameters:
Returns:
Destroys all the items in the aggregation items.
Returns:
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:
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:
| {boolean} | Value of property enabled |
Gets content of aggregation
items.
Aggregation of menu items.
Returns:
Gets current value of property
width.
Specifies the width of the MenuBar
Default value is 100%.
Returns:
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:
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a item into the aggregation items.
Parameters:
| {sap.ui.unified.MenuItem} | oItem | the item to insert; if empty, nothing is inserted |
| {int} | iIndex | 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 |
Returns:
Removes all the controls from the aggregation
items.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes a item from the aggregation items.
Parameters:
Returns:
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:
Returns:
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:
| {boolean} | bEnabled | New value for property enabled |
Returns:
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:
Returns: