Class sap.ui.unified.MenuItemModule: sap/ui/unified/MenuItem

extends MenuItemBase
known direct subclasses: MenuItem

Standard item to be used inside a menu. A menu item represents an action which can be selected by the user in the menu or it can provide a submenu to organize the actions hierarchically.
Since: 1.21.0.
Constructor Summary
new sap.ui.unified.MenuItem(sId?, mSettings?)Constructor for a new MenuItem element.
Events borrowed from class sap.ui.unified.MenuItemBase
Method Summary
sap.ui.unified.MenuItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.MenuItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.MenuItem.getMetadata()Returns a metadata object for class sap.ui.unified.MenuItem.
getIcon()Gets current value of property icon.
getText()Gets current value of property text.
setIcon(sIcon)Sets a new value for property icon.
setText(sText)Sets a new value for property text.
Methods borrowed from class sap.ui.base.Object
Constructor Detail
new sap.ui.unified.MenuItem(sId?, mSettings?)

Constructor for a new MenuItem element.

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

    • text : string (default: )
    • icon : sap.ui.core.URI (default: )

In addition, all settings applicable to the base type sap.ui.unified.MenuItemBase 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.unified.MenuItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.unified.MenuItem 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.unified.MenuItemBase.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.unified.MenuItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.MenuItem.
Returns:
sap.ui.base.MetadataMetadata object describing this class
getIcon(): sap.ui.core.URI

Gets current value of property icon.

Defines the icon of the sap.ui.core.IconPool or an image which should be displayed on the item.

Default value is empty string.

Returns:
sap.ui.core.URIValue of property icon
getText(): string

Gets current value of property text.

Defines the text which should be displayed on the item.

Default value is empty string.

Returns:
stringValue of property text
setIcon(sIcon): sap.ui.unified.MenuItem

Sets a new value for property icon.

Defines the icon of the sap.ui.core.IconPool or an image which should be displayed on the item.

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

Default value is empty string.

Parameters:
sap.ui.core.URIsIconNew value for property icon
Returns:
sap.ui.unified.MenuItemReference to this in order to allow method chaining
setText(sText): sap.ui.unified.MenuItem

Sets a new value for property text.

Defines the text which should be displayed on the item.

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

Default value is empty string.

Parameters:
stringsTextNew value for property text
Returns:
sap.ui.unified.MenuItemReference to this in order to allow method chaining