Class sap.ui.unified.MenuTextFieldItemModule: sap/ui/unified/MenuTextFieldItem

extends MenuItemBase
known direct subclasses: MenuTextFieldItem

Special menu item which contains a label and a text field. This menu item is e.g. helpful for filter implementations. The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
Since: 1.21.0.
Constructor Summary
new sap.ui.unified.MenuTextFieldItem(sId?, mSettings?)Constructor for a new MenuTextFieldItem element.
Events borrowed from class sap.ui.unified.MenuItemBase
Method Summary
sap.ui.unified.MenuTextFieldItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.MenuTextFieldItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.MenuTextFieldItem.getMetadata()Returns a metadata object for class sap.ui.unified.MenuTextFieldItem.
getIcon()Gets current value of property icon.
getLabel()Gets current value of property label.
getValue()Gets current value of property value.
getValueState()Gets current value of property valueState.
setIcon(sIcon)Sets a new value for property icon.
setLabel(sLabel)Sets a new value for property label.
setValue(sValue)Sets a new value for property value.
setValueState(sValueState)Sets a new value for property valueState.
destroySubmenu()The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
getSubmenu()The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
setSubmenu(oMenu)The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
Constructor Detail
new sap.ui.unified.MenuTextFieldItem(sId?, mSettings?)

Constructor for a new MenuTextFieldItem 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:

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.MenuTextFieldItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.unified.MenuTextFieldItem 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.MenuTextFieldItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.MenuTextFieldItem.
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.

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

Gets current value of property label.

Defines the label of the text field of the item.

Returns:
stringValue of property label
getValue(): string

Gets current value of property value.

Defines the value of the text field of the item.

Returns:
stringValue of property value
getValueState(): sap.ui.core.ValueState

Gets current value of property valueState.

Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or errors.

Default value is None.

Returns:
sap.ui.core.ValueStateValue of property valueState

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.

Parameters:
sap.ui.core.URIsIconNew value for property icon
Returns:
sap.ui.unified.MenuTextFieldItemReference to this in order to allow method chaining

Sets a new value for property label.

Defines the label of the text field of the item.

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

Parameters:
stringsLabelNew value for property label
Returns:
sap.ui.unified.MenuTextFieldItemReference to this in order to allow method chaining

Sets a new value for property value.

Defines the value of the text field of the item.

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

Parameters:
stringsValueNew value for property value
Returns:
sap.ui.unified.MenuTextFieldItemReference to this in order to allow method chaining
setValueState(sValueState): sap.ui.unified.MenuTextFieldItem

Sets a new value for property valueState.

Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or errors.

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

Default value is None.

Parameters:
sap.ui.core.ValueStatesValueStateNew value for property valueState
Returns:
sap.ui.unified.MenuTextFieldItemReference to this in order to allow method chaining
The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
Returns:
sap.ui.unified.MenuTextFieldItemthis to allow method chaining
Deprecated API:
The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
getSubmenu(): sap.ui.unified.Menu
The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
Returns:
sap.ui.unified.Menu
Deprecated API:
The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
The aggregation submenu (inherited from parent class) is not supported for this type of menu item.
Parameters:
sap.ui.unified.MenuoMenuThe menu to which the sap.ui.unified.Submenu should be set
Returns:
sap.ui.unified.MenuTextFieldItemthis to allow method chaining
Deprecated API:
The aggregation submenu (inherited from parent class) is not supported for this type of menu item.