abstract class sap.m.SelectDialogBase

Control sample: sap.m.SelectDialogBase
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/SelectDialogBase
Application Component: CA-UI5-CTR

The sap.m.SelectDialogBase control provides a base functionality of the sap.m.SelectDialog and sap.m.TableSelectDialog controls.


Constructor

Constructor for a new SelectDialogBase.

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.SelectDialogBase(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


Events Overview

Event Description
selectionChange

Fires when selection is changed via user interaction inside the control.

Since: 1.93.

updateFinished

Fires after items binding is updated and processed by the control.

Since: 1.93.

updateStarted

Fires before items binding is updated (e.g. sorting, filtering)

Note: Event handler should not invalidate the control. *

Since: 1.93.

selectionChange

Fires when selection is changed via user interaction inside the control.

Since: 1.93.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
listItem sap.m.ListItemBase

The item whose selection has changed. In MultiSelect mode, only the up-most selected item is returned. This parameter can be used for single-selection modes.

listItems sap.m.ListItemBase[]

Array of items whose selection has changed. This parameter can be used for MultiSelect mode.

selected boolean

Indicates whether the listItem parameter is selected or not.

selectAll boolean

Indicates whether the select all action is triggered or not.

updateFinished

Fires after items binding is updated and processed by the control.

Since: 1.93.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
reason string

The reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.

actual int

Actual number of items.

total int

The total count of bound items. This can be used if the growing property is set to true.

updateStarted

Fires before items binding is updated (e.g. sorting, filtering)

Note: Event handler should not invalidate the control. *

Since: 1.93.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
reason string

The reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.

actual int

Actual number of items.

total int

The total count of bound items. This can be used if the growing property is set to true.


Methods Overview

Method Description
attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.m.SelectDialogBase.

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.SelectDialogBase itself.

Fires when selection is changed via user interaction inside the control.

attachUpdateFinished

Attaches event handler fnFunction to the updateFinished event of this sap.m.SelectDialogBase.

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.SelectDialogBase itself.

Fires after items binding is updated and processed by the control.

attachUpdateStarted

Attaches event handler fnFunction to the updateStarted event of this sap.m.SelectDialogBase.

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.SelectDialogBase itself.

Fires before items binding is updated (e.g. sorting, filtering)

Note: Event handler should not invalidate the control. *

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.m.SelectDialogBase.

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

detachUpdateFinished

Detaches event handler fnFunction from the updateFinished event of this sap.m.SelectDialogBase.

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

detachUpdateStarted

Detaches event handler fnFunction from the updateStarted event of this sap.m.SelectDialogBase.

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

sap.m.SelectDialogBase.extend

Creates a new subclass of class sap.m.SelectDialogBase 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.

fireSelectionChange

Fires event selectionChange to attached listeners.

fireUpdateFinished

Fires event updateFinished to attached listeners.

fireUpdateStarted

Fires event updateStarted to attached listeners.

sap.m.SelectDialogBase.getMetadata

Returns a metadata object for class sap.m.SelectDialogBase.

attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.m.SelectDialogBase.

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.SelectDialogBase itself.

Fires when selection is changed via user interaction inside the control.

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.SelectDialogBase itself

attachUpdateFinished

Attaches event handler fnFunction to the updateFinished event of this sap.m.SelectDialogBase.

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.SelectDialogBase itself.

Fires after items binding is updated and processed by the control.

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.SelectDialogBase itself

attachUpdateStarted

Attaches event handler fnFunction to the updateStarted event of this sap.m.SelectDialogBase.

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.SelectDialogBase itself.

Fires before items binding is updated (e.g. sorting, filtering)

Note: Event handler should not invalidate the control. *

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.SelectDialogBase itself

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.m.SelectDialogBase.

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

detachUpdateFinished

Detaches event handler fnFunction from the updateFinished event of this sap.m.SelectDialogBase.

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

detachUpdateStarted

Detaches event handler fnFunction from the updateStarted event of this sap.m.SelectDialogBase.

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.SelectDialogBase.extend

Creates a new subclass of class sap.m.SelectDialogBase 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.

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

fireSelectionChange

Fires event selectionChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

listItem sap.m.ListItemBase

The item whose selection has changed. In MultiSelect mode, only the up-most selected item is returned. This parameter can be used for single-selection modes.

listItems sap.m.ListItemBase[]

Array of items whose selection has changed. This parameter can be used for MultiSelect mode.

selected boolean

Indicates whether the listItem parameter is selected or not.

selectAll boolean

Indicates whether the select all action is triggered or not.

fireUpdateFinished

Fires event updateFinished to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

reason string

The reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.

actual int

Actual number of items.

total int

The total count of bound items. This can be used if the growing property is set to true.

fireUpdateStarted

Fires event updateStarted to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

reason string

The reason of the update, e.g. Binding, Filter, Sort, Growing, Change, Refresh, Context.

actual int

Actual number of items.

total int

The total count of bound items. This can be used if the growing property is set to true.

sap.m.SelectDialogBase.getMetadata

Returns a metadata object for class sap.m.SelectDialogBase.