Abstract Class sap.m.semantic.SemanticSelectModule: sap/m/semantic/SemanticSelect

extends SemanticControl
known direct subclasses: FilterSelect, GroupSelect, SortSelect

A semantic select is a sap.m.Select eligible for aggregation content of a sap.m.semantic.SemanticPage.


Since: 1.30.
Constructor Summary
new sap.m.semantic.SemanticSelect(sId?, mSettings?)Constructor for a new SemanticSelect.
Event Summary
change(oControlEvent)See sap.m.Select#change
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.semantic.SemanticSelect.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.semantic.SemanticSelect with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.semantic.SemanticSelect.getMetadata()Returns a metadata object for class sap.m.semantic.SemanticSelect.
addItem(oItem)Adds some item to the aggregation items.
attachChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the change event of this sap.m.semantic.SemanticSelect.
bindItems(oBindingInfo)Binds aggregation items to model data.
destroyItems()Destroys all the items in the aggregation items.
detachChange(fnFunction, oListener)Detaches event handler fnFunction from the change event of this sap.m.semantic.SemanticSelect.
fireChange(mArguments?)Fires event change to attached listeners.
getEnabled()Gets current value of property enabled.
getItems()Gets content of aggregation items.
getSelectedItem()ID of the element which is the current target of the association selectedItem, or null.
getSelectedKey()Gets current value of property selectedKey.
indexOfItem(oItem)Checks for the provided sap.ui.core.Item in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setEnabled(bEnabled)Sets a new value for property enabled.
setSelectedItem(oSelectedItem)Sets the associated selectedItem.
setSelectedKey(sSelectedKey)Sets a new value for property selectedKey.
unbindItems()Unbinds aggregation items from model data.
Methods borrowed from class sap.m.semantic.SemanticControl
getVisible, setVisible
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.semantic.SemanticSelect(sId?, mSettings?)
Constructor for a new SemanticSelect.

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.m.semantic.SemanticControl 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)
See sap.m.Select#change
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.semantic.SemanticSelect.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.semantic.SemanticSelect with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.semantic.SemanticControl.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.semantic.SemanticSelect.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.semantic.SemanticSelect.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.m.semantic.SemanticSelect
Adds some item to the aggregation items.
Parameters:
{sap.ui.core.Item}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.m.semantic.SemanticSelect} Reference to this in order to allow method chaining
attachChange(oData?, fnFunction, oListener?): sap.m.semantic.SemanticSelect
Attaches event handler fnFunction to the change event of this sap.m.semantic.SemanticSelect.

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.semantic.SemanticSelect itself.

See sap.m.Select#change

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.semantic.SemanticSelect itself
Returns:
{sap.m.semantic.SemanticSelect} Reference to this in order to allow method chaining
bindItems(oBindingInfo): sap.m.semantic.SemanticSelect
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.semantic.SemanticSelect} Reference to this in order to allow method chaining
destroyItems(): sap.m.semantic.SemanticSelect
Destroys all the items in the aggregation items.
Returns:
{sap.m.semantic.SemanticSelect} Reference to this in order to allow method chaining
detachChange(fnFunction, oListener): sap.m.semantic.SemanticSelect
Detaches event handler fnFunction from the change event of this sap.m.semantic.SemanticSelect.

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.semantic.SemanticSelect} Reference to this in order to allow method chaining
fireChange(mArguments?): sap.m.semantic.SemanticSelect
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.semantic.SemanticSelect} Reference to this in order to allow method chaining
getEnabled(): boolean
Gets current value of property enabled.

See sap.m.Select#enabled

Default value is true.

Returns:
{boolean} Value of property enabled
getItems(): sap.ui.core.Item[]
Gets content of aggregation items.

See sap.m.Select#items

Returns:
{sap.ui.core.Item[]}
getSelectedItem(): sap.ui.core.Item
ID of the element which is the current target of the association selectedItem, or null.
Returns:
{sap.ui.core.Item}
getSelectedKey(): string
Gets current value of property selectedKey.

See sap.m.Select#selectedKey

Default value is .

Returns:
{string} Value of property selectedKey
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.semantic.SemanticSelect
Inserts a item into the aggregation items.
Parameters:
{sap.ui.core.Item}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:
{sap.m.semantic.SemanticSelect} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.core.Item[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Item[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.core.Item
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.core.Item}vItem The itemto remove or its index or id
Returns:
{sap.ui.core.Item} The removed item or null
setEnabled(bEnabled): sap.m.semantic.SemanticSelect
Sets a new value for property enabled.

See sap.m.Select#enabled

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.semantic.SemanticSelect} Reference to this in order to allow method chaining
setSelectedItem(oSelectedItem): sap.m.semantic.SemanticSelect
Sets the associated selectedItem.
Parameters:
{sap.ui.core.Item}oSelectedItem Id of an element which becomes the new target of this selectedItem association; alternatively, an element instance may be given
Returns:
{sap.m.semantic.SemanticSelect} Reference to this in order to allow method chaining
setSelectedKey(sSelectedKey): sap.m.semantic.SemanticSelect
Sets a new value for property selectedKey.

See sap.m.Select#selectedKey

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

Default value is .

Parameters:
{string}sSelectedKey New value for property selectedKey
Returns:
{sap.m.semantic.SemanticSelect} Reference to this in order to allow method chaining
unbindItems(): sap.m.semantic.SemanticSelect
Unbinds aggregation items from model data.
Returns:
{sap.m.semantic.SemanticSelect} Reference to this in order to allow method chaining