abstract class sap.m.semantic.SemanticSelect

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/semantic/SemanticSelect
Application Component: CA-UI5-CTR

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


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.m.semantic.SemanticSelect(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


Properties

Name Type Default Value Description
enabled boolean true

See sap.m.Select#getEnabled

Visibility: public
selectedKey string empty string

See sap.m.Select#getSelectedKey

Visibility: public

Borrowed Properties

Name Type Default Value Description
visible boolean true

See sap.ui.core.Control#visible

Visibility: public

Aggregations

Default Aggregation: items

Name Cardinality Type Description
items (default) 0..n sap.ui.core.Item

See sap.m.Select#getItems


Associations

Name Cardinality Type Description
selectedItem 0..1 sap.ui.core.Item

See sap.m.Select#getSelectedItem


Events Overview

Event Description
change

See sap.m.Select#event:change

change

See sap.m.Select#event:change

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
selectedItem sap.ui.core.Item

The selected item.


Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

attachChange

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#event:change

bindItems

Binds aggregation items to model data.

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

destroyItems

Destroys all the items in the aggregation items.

detachChange

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.

sap.m.semantic.SemanticSelect.extend

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.

fireChange

Fires event change to attached listeners.

getEnabled

Gets current value of property enabled.

See sap.m.Select#getEnabled

Default value is true.

getItems

Gets content of aggregation items.

See sap.m.Select#getItems

sap.m.semantic.SemanticSelect.getMetadata

Returns a metadata object for class sap.m.semantic.SemanticSelect.

getSelectedItem

ID of the element which is the current target of the association selectedItem, or null.

getSelectedKey

Gets current value of property selectedKey.

See sap.m.Select#getSelectedKey

Default value is empty string.

indexOfItem

Checks for the provided sap.ui.core.Item in the aggregation items. and returns its index if found or -1 otherwise.

insertItem

Inserts a item into the aggregation items.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setEnabled

Sets a new value for property enabled.

See sap.m.Select#getEnabled

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

Default value is true.

setSelectedItem

Sets the associated selectedItem.

setSelectedKey

Sets a new value for property selectedKey.

See sap.m.Select#getSelectedKey

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

Default value is empty string.

unbindItems

Unbinds aggregation items from model data.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.core.Item

The item to add; if empty, nothing is inserted

attachChange

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#event:change

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.semantic.SemanticSelect itself

bindItems

Binds aggregation items to model data.

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

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyItems

Destroys all the items in the aggregation items.

detachChange

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.m.semantic.SemanticSelect.extend

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.

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

fireChange

Fires event change to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

selectedItem sap.ui.core.Item

The selected item.

getEnabled

Gets current value of property enabled.

See sap.m.Select#getEnabled

Default value is true.

getItems

Gets content of aggregation items.

See sap.m.Select#getItems

sap.m.semantic.SemanticSelect.getMetadata

Returns a metadata object for class sap.m.semantic.SemanticSelect.

getSelectedItem

ID of the element which is the current target of the association selectedItem, or null.

getSelectedKey

Gets current value of property selectedKey.

See sap.m.Select#getSelectedKey

Default value is empty string.

indexOfItem

Checks for the provided sap.ui.core.Item in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.ui.core.Item

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.core.Item

The item to insert; if empty, nothing is inserted

iIndex int

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

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.ui.core.Item

The item to remove or its index or id

setEnabled

Sets a new value for property enabled.

See sap.m.Select#getEnabled

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

Default value is true.

Param Type DefaultValue Description
bEnabled boolean true

New value for property enabled

setSelectedItem

Sets the associated selectedItem.

Param Type DefaultValue Description
oSelectedItem sap.ui.core.ID sap.ui.core.Item

ID of an element which becomes the new target of this selectedItem association; alternatively, an element instance may be given

setSelectedKey

Sets a new value for property selectedKey.

See sap.m.Select#getSelectedKey

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

Default value is empty string.

Param Type DefaultValue Description
sSelectedKey string ""

New value for property selectedKey

unbindItems

Unbinds aggregation items from model data.