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.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.unified.MenuTextFieldItem(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 |
Name | Type | Default Value | Description |
---|---|---|---|
icon | sap.ui.core.URI | Defines the icon of the sap.ui.core.IconPool or an image which should be displayed on the item. Visibility: public |
|
label | string | Defines the label of the text field of the item. Visibility: public |
|
value | string | Defines the value of the text field of the item. Visibility: public |
|
valueState | sap.ui.core.ValueState | None | Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or errors. Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
enabled | boolean | true | When an item is disabled the item can not be selected by the user. The enabled property of the item has no effect when the menu of the item is disabled (Menu#getEnabled). Visibility: public |
startsSection | boolean | false | Defines whether a visual separator should be rendered before the item. Note: If an item is invisible also the separator of this item is not shown. Visibility: public |
visible | boolean | true | Invisible items do not appear in the menu. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
submenu | 0..1 | sap.ui.unified.Menu |
An optional submenu of the item which is opened when the item is selected by the user. |
Method | Description |
---|---|
destroySubmenu |
The aggregation
Since 1.21 the aggregation <code>submenu</code> (inherited from parent class) is not supported for this type of menu item.
|
sap.ui.unified.MenuTextFieldItem.extend |
Creates a new subclass of class sap.ui.unified.MenuTextFieldItem with name
|
getIcon |
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. |
getLabel |
Gets current value of property label. Defines the label of the text field of the item. |
sap.ui.unified.MenuTextFieldItem.getMetadata |
Returns a metadata object for class sap.ui.unified.MenuTextFieldItem. |
getSubmenu |
The aggregation
Since 1.21 the aggregation <code>submenu</code> (inherited from parent class) is not supported for this type of menu item.
|
getValue |
Gets current value of property value. Defines the value of the text field of the item. |
getValueState |
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 |
setIcon |
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 |
setLabel |
Sets a new value for property label. Defines the label of the text field of the item. When called with a value of |
setSubmenu |
The aggregation
Since 1.21 the aggregation <code>submenu</code> (inherited from parent class) is not supported for this type of menu item.
|
setValue |
Sets a new value for property value. Defines the value of the text field of the item. When called with a value of |
setValueState |
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 Default value is |
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.
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 |
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 a metadata object for class sap.ui.unified.MenuTextFieldItem.
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
.
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | sap.ui.core.URI |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLabel | string |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sValue | string |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sValueState | sap.ui.core.ValueState | None |
New value for property |