Class sap.m.SelectModule: sap/m/Select

extends Control
known direct subclasses: ActionSelect, HierarchicalSelect

The sap.m.Select control provides a list of items that allows users to select an item.

Constructor Summary
new sap.m.Select(sId?, mSettings?)Constructor for a new sap.m.Select.
Event Summary
change(oControlEvent)This event is fired when the value in the selection field is changed in combination with one of the following actions:
  • The focus leaves the selection field
  • The Enter key is pressed
  • The item is pressed
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.Select.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.Select with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.Select.getMetadata()Returns a metadata object for class sap.m.Select.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addItem(oItem)Adds an item to the aggregation named items.
attachChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the change event of this sap.m.Select.
bindItems(oBindingInfo)Binds aggregation items to model data.
close()Closes the control's picker popup.
createPicker(sPickerType)Creates a picker popup container where the selection should take place.
destroyItems()Destroys all the items in the aggregation named items.
detachChange(fnFunction, oListener)Detaches event handler fnFunction from the change event of this sap.m.Select.
fireChange(mArguments?)Fires event change to attached listeners.
getAccessibilityInfo()
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getAutoAdjustWidth()Gets current value of property autoAdjustWidth.
getEnabled()Gets current value of property enabled.
getEnabledItems(aItems?)Gets the enabled items from the aggregation named items.
getFirstItem()Gets the first item from the aggregation named items.
getForceSelection()Gets current value of property forceSelection.
getIcon()Gets current value of property icon.
getItemAt(iIndex)Gets the item from the aggregation named items at the given 0-based index.
getItemByKey(sKey)Gets the item with the given key from the aggregation named items.
getItems()Gets aggregation items.
getLastItem()Gets the last item from the aggregation named items.
getMaxWidth()Gets current value of property maxWidth.
getName()Gets current value of property name.
getSelectedItem()Gets the selected item object from the aggregation named items.
getSelectedItemId()Gets current value of property selectedItemId.
getSelectedKey()Gets current value of property selectedKey.
getTextAlign()Gets current value of property textAlign.
getTextDirection()Gets current value of property textDirection.
getType()Gets current value of property type.
getWidth()Gets current value of property width.
indexOfItem(oItem)Checks for the provided sap.ui.core.Item in the aggregation items.
insertItem(oItem, iIndex)Inserts an item into the aggregation named items.
isOpen()Indicates whether the control's picker popup is opened.
open()Open the control's picker popup.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllItems()Removes all the items in the aggregation named items.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeItem(vItem)Removes an item from the aggregation named items.
setAutoAdjustWidth(bAutoAdjustWidth)Sets a new value for property autoAdjustWidth.
setEnabled(bEnabled)Sets a new value for property enabled.
setForceSelection(bForceSelection)Sets a new value for property forceSelection.
setIcon(sIcon)Sets a new value for property icon.
setMaxWidth(sMaxWidth)Sets a new value for property maxWidth.
setName(sName)Sets a new value for property name.
setSelectedItem(vItem)Sets the selectedItem association.
setSelectedItemId(vItem)Sets the selectedItemId property.
setSelectedKey(sKey)Sets property selectedKey.
setTextAlign(sTextAlign)Sets a new value for property textAlign.
setTextDirection(sTextDirection)Sets a new value for property textDirection.
setType(sType)Sets a new value for property type.
setWidth(sWidth)Sets a new value for property width.
unbindItems()Unbinds aggregation items from model data.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
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
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.Select(sId?, mSettings?)
Constructor for a new sap.m.Select.

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
  • Aggregations
    • items : sap.ui.core.Item[] (default)
  • Events
    • change : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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.
Event Detail
change(oControlEvent)
This event is fired when the value in the selection field is changed in combination with one of the following actions:
  • The focus leaves the selection field
  • The Enter key is pressed
  • The item is pressed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Item}oControlEvent.getParameters.selectedItem The selected item.
Method Detail
sap.m.Select.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.Select 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
sap.m.Select.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.Select.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAriaLabelledBy(vAriaLabelledBy): sap.m.Select
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
{string|sap.ui.core.Control}vAriaLabelledBy the ariaLabelledBy to add; if empty, nothing is inserted
Since:
1.27.0
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
addItem(oItem): sap.m.Select
Adds an item to the aggregation named items.
Parameters:
{sap.ui.core.Item}oItem The item to be added; if empty, nothing is added.
Returns:
{sap.m.Select}this to allow method chaining.
attachChange(oData?, fnFunction, oListener?): sap.m.Select
Attaches event handler fnFunction to the change event of this sap.m.Select.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.Select itself.

This event is fired when the value in the selection field is changed in combination with one of the following actions:

  • The focus leaves the selection field
  • The Enter key is pressed
  • The item is pressed
Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.Select itself
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
bindItems(oBindingInfo): sap.m.Select
Binds aggregation items to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
close(): sap.m.Select
Closes the control's picker popup.
Since:
1.16
Returns:
{sap.m.Select}this to allow method chaining.
createPicker(sPickerType): sap.m.Popover|sap.m.Dialog
Creates a picker popup container where the selection should take place.
Parameters:
{string}sPickerType
Returns:
{sap.m.Popover|sap.m.Dialog}
destroyItems(): sap.m.Select
Destroys all the items in the aggregation named items.
Returns:
{sap.m.Select}this to allow method chaining.
detachChange(fnFunction, oListener): sap.m.Select
Detaches event handler fnFunction from the change event of this sap.m.Select.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
fireChange(mArguments?): sap.m.Select
Fires event change to attached listeners.

Expects the following event parameters:

  • selectedItem of type sap.ui.core.ItemThe selected item.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
getAccessibilityInfo()
See:
{sap.ui.core.Control#getAccessibilityInfo}
getAriaLabelledBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Since:
1.27.0
Returns:
{sap.ui.core.Control[]}
getAutoAdjustWidth(): boolean
Gets current value of property autoAdjustWidth.

Indicates whether the width of the input field is determined by the selected item's content.

Default value is false.

Since:
1.16
Returns:
{boolean} Value of property autoAdjustWidth
getEnabled(): boolean
Gets current value of property enabled.

Indicates whether the user can change the selection.

Default value is true.

Returns:
{boolean} Value of property enabled
getEnabledItems(aItems?): sap.ui.core.Item[]
Gets the enabled items from the aggregation named items.
Parameters:
{sap.ui.core.Item[]}aItems?, Default: getItems() Items to filter.
Since:
1.22.0
Returns:
{sap.ui.core.Item[]} An array containing the enabled items.
getFirstItem(): sap.ui.core.Item|null
Gets the first item from the aggregation named items.
Since:
1.16
Returns:
{sap.ui.core.Item|null} The first item, or null if there are no items.
getForceSelection(): boolean
Gets current value of property forceSelection.

Indicates whether the selection is restricted to one of the items in the list. Note: We strongly recommend that you always set this property to false and bind the selectedKey property to the desired value for better interoperability with data binding.

Default value is true.

Since:
1.34
Returns:
{boolean} Value of property forceSelection
getIcon(): sap.ui.core.URI
Gets current value of property icon.

The URI to the icon that will be displayed only when using the IconOnly type.

Default value is .

Since:
1.16
Returns:
{sap.ui.core.URI} Value of property icon
getItemAt(iIndex): sap.ui.core.Item|null
Gets the item from the aggregation named items at the given 0-based index.
Parameters:
{int}iIndex Index of the item to return.
Since:
1.16
Returns:
{sap.ui.core.Item|null} Item at the given index, or null if none.
getItemByKey(sKey): sap.ui.core.Item|null
Gets the item with the given key from the aggregation named items.

Note: If duplicate keys exist, the first item matching the key is returned.

Parameters:
{string}sKey An item key that specifies the item to be retrieved.
Since:
1.16
Returns:
{sap.ui.core.Item|null}
getItems(): sap.ui.core.Item[]
Gets aggregation items.

Note: This is the default aggregation.

Returns:
{sap.ui.core.Item[]}
getLastItem(): sap.ui.core.Item|null
Gets the last item from the aggregation named items.
Since:
1.16
Returns:
{sap.ui.core.Item|null} The last item, or null if there are no items.
getMaxWidth(): sap.ui.core.CSSSize
Gets current value of property maxWidth.

Sets the maximum width of the control.

Note: This property is ignored if the autoAdjustWidth property is set to true.

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property maxWidth
getName(): string
Gets current value of property name.

The name to be used in the HTML code (for example, for HTML forms that send data to the server via submit).

Default value is .

Returns:
{string} Value of property name
getSelectedItem(): sap.ui.core.Item|null
Gets the selected item object from the aggregation named items.
Returns:
{sap.ui.core.Item|null} The current target of the selectedItem association, or null.
getSelectedItemId(): string
Gets current value of property selectedItemId.

ID of the selected item.

Default value is .

Since:
1.12
Returns:
{string} Value of property selectedItemId
getSelectedKey(): string
Gets current value of property selectedKey.

Key of the selected item.

Note: If duplicate keys exist, the first item matching the key is used.

Default value is .

Since:
1.11
Returns:
{string} Value of property selectedKey
getTextAlign(): sap.ui.core.TextAlign
Gets current value of property textAlign.

Sets the horizontal alignment of the text within the input field.

Default value is Initial.

Since:
1.28
Returns:
{sap.ui.core.TextAlign} Value of property textAlign
getTextDirection(): sap.ui.core.TextDirection
Gets current value of property textDirection.

Specifies the direction of the text within the input field with enumerated options. By default, the control inherits text direction from the DOM.

Default value is Inherit.

Since:
1.28
Returns:
{sap.ui.core.TextDirection} Value of property textDirection
getType(): sap.m.SelectType
Gets current value of property type.

Type of a select. Possible values Default, IconOnly.

Default value is Default.

Since:
1.16
Returns:
{sap.m.SelectType} Value of property type
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Sets the width of the control. The default width is derived from the widest item. If the width defined is smaller than the widest item in the selection list, only the width of the selection field will be changed: the list will keep the width of its widest item. If the list is wider than the viewport, it is truncated and an ellipsis is displayed for each item. For phones, the width of the list is always the same as the viewport.

Note: This property is ignored if the autoAdjustWidth property is set to true.

Default value is auto.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfItem(oItem): int
Checks for the provided sap.ui.core.Item in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Item}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.m.Select
Inserts an item into the aggregation named items.
Parameters:
{sap.ui.core.Item}oItem The item to be inserted; 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:
{sap.m.Select}this to allow method chaining.
isOpen(): boolean
Indicates whether the control's picker popup is opened.
Since:
1.16
Returns:
{boolean} Indicates whether the picker popup is currently open (this includes opening and closing animations).
open(): sap.m.Select
Open the control's picker popup.
Since:
1.16
Returns:
{sap.m.Select}this to allow method chaining.
removeAllAriaLabelledBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaLabelledBy.
Since:
1.27.0
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllItems(): sap.ui.core.Item[]
Removes all the items in the aggregation named items. Additionally unregisters them from the hosting UIArea.
Returns:
{sap.ui.core.Item[]} An array of the removed items (might be empty).
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
{int|string|sap.ui.core.Control}vAriaLabelledBy The ariaLabelledByto be removed or its index or ID
Since:
1.27.0
Returns:
{sap.ui.core.Control} the removed ariaLabelledBy or null
removeItem(vItem): sap.ui.core.Item
Removes an item from the aggregation named items.
Parameters:
{int|string|sap.ui.core.Item}vItem The item to be removed or its index or ID.
Returns:
{sap.ui.core.Item} The removed item or null.
setAutoAdjustWidth(bAutoAdjustWidth): sap.m.Select
Sets a new value for property autoAdjustWidth.

Indicates whether the width of the input field is determined by the selected item's content.

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

Default value is false.

Parameters:
{boolean}bAutoAdjustWidth New value for property autoAdjustWidth
Since:
1.16
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setEnabled(bEnabled): sap.m.Select
Sets a new value for property enabled.

Indicates whether the user can change the selection.

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:
{sap.m.Select} Reference to this in order to allow method chaining
setForceSelection(bForceSelection): sap.m.Select
Sets a new value for property forceSelection.

Indicates whether the selection is restricted to one of the items in the list. Note: We strongly recommend that you always set this property to false and bind the selectedKey property to the desired value for better interoperability with data binding.

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

Default value is true.

Parameters:
{boolean}bForceSelection New value for property forceSelection
Since:
1.34
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setIcon(sIcon): sap.m.Select
Sets a new value for property icon.

The URI to the icon that will be displayed only when using the IconOnly type.

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

Default value is .

Parameters:
{sap.ui.core.URI}sIcon New value for property icon
Since:
1.16
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setMaxWidth(sMaxWidth): sap.m.Select
Sets a new value for property maxWidth.

Sets the maximum width of the control.

Note: This property is ignored if the autoAdjustWidth property is set to true.

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

Default value is 100%.

Parameters:
{sap.ui.core.CSSSize}sMaxWidth New value for property maxWidth
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setName(sName): sap.m.Select
Sets a new value for property name.

The name to be used in the HTML code (for example, for HTML forms that send data to the server via submit).

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

Default value is .

Parameters:
{string}sName New value for property name
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setSelectedItem(vItem): sap.m.Select
Sets the selectedItem association.

Default value is null.

Parameters:
{string|sap.ui.core.Item|null}vItem New value for the selectedItem association. If an ID of a sap.ui.core.Item is given, the item with this ID becomes the selectedItem association. Alternatively, a sap.ui.core.Item instance may be given or null. If the value of null is provided, the first enabled item will be selected (if any items exist).
Returns:
{sap.m.Select}this to allow method chaining.
setSelectedItemId(vItem): sap.m.Select
Sets the selectedItemId property.

Default value is an empty string "" or undefined.

Parameters:
{string|undefined}vItem New value for property selectedItemId. If the provided vItem has a default value, the first enabled item will be selected (if any items exist).
Since:
1.12
Returns:
{sap.m.Select}this to allow method chaining.
setSelectedKey(sKey): sap.m.Select
Sets property selectedKey.

Default value is an empty string "" or undefined.

Parameters:
{string}sKey New value for property selectedKey. If the forceSelection property is set to true and the provided sKey is an empty string "" or undefined, the value of sKey is changed to match the key of the first enabled item and the first enabled item is selected (if any items exist).

In the case that an item has the default key value, it is selected instead. If duplicate keys exist, the first item matching the key is selected.

Since:
1.11
Returns:
{sap.m.Select}this to allow method chaining.
setTextAlign(sTextAlign): sap.m.Select
Sets a new value for property textAlign.

Sets the horizontal alignment of the text within the input field.

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

Default value is Initial.

Parameters:
{sap.ui.core.TextAlign}sTextAlign New value for property textAlign
Since:
1.28
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setTextDirection(sTextDirection): sap.m.Select
Sets a new value for property textDirection.

Specifies the direction of the text within the input field with enumerated options. By default, the control inherits text direction from the DOM.

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

Default value is Inherit.

Parameters:
{sap.ui.core.TextDirection}sTextDirection New value for property textDirection
Since:
1.28
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setType(sType): sap.m.Select
Sets a new value for property type.

Type of a select. Possible values Default, IconOnly.

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

Default value is Default.

Parameters:
{sap.m.SelectType}sType New value for property type
Since:
1.16
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
setWidth(sWidth): sap.m.Select
Sets a new value for property width.

Sets the width of the control. The default width is derived from the widest item. If the width defined is smaller than the widest item in the selection list, only the width of the selection field will be changed: the list will keep the width of its widest item. If the list is wider than the viewport, it is truncated and an ellipsis is displayed for each item. For phones, the width of the list is always the same as the viewport.

Note: This property is ignored if the autoAdjustWidth property is set to true.

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

Default value is auto.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.m.Select} Reference to this in order to allow method chaining
unbindItems(): sap.m.Select
Unbinds aggregation items from model data.
Returns:
{sap.m.Select} Reference to this in order to allow method chaining