sap.m.TableSelectDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.TableSelectDialog 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 |
Returns a metadata object for class sap.m.TableSelectDialog.
Returns:
Adds some column to the aggregation columns
.
Parameters:
{sap.m.Column} | oColumn | the column to add; if empty, nothing is inserted |
Returns:
Adds some item to the aggregation items
.
Parameters:
Returns:
Attaches event handler
fnFunction
to the
cancel
event of this
sap.m.TableSelectDialog
.
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.TableSelectDialog
itself.
Fires when the Cancel button is clicked.
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.TableSelectDialog itself |
Returns:
Attaches event handler
fnFunction
to the
confirm
event of this
sap.m.TableSelectDialog
.
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.TableSelectDialog
itself.
Fires when the dialog is confirmed by selecting an item in single-selection mode or by pressing the confirmation button in multi-selection mode. The items being selected are returned as event parameters.
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.TableSelectDialog itself |
Returns:
Attaches event handler
fnFunction
to the
liveChange
event of this
sap.m.TableSelectDialog
.
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.TableSelectDialog
itself.
Fires when the value of the search field is changed by a user (for example at each key press).
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.TableSelectDialog itself |
Returns:
Attaches event handler
fnFunction
to the
search
event of this
sap.m.TableSelectDialog
.
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.TableSelectDialog
itself.
Fires when the search button has been clicked on dialog.
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.TableSelectDialog itself |
Returns:
Forwards aggregations with the name of items or columns to the internal table.
Parameters:
{string} | sAggregationName | The name for the binding |
{object} | oBindingInfo | The configuration parameters for the binding |
Returns:
Binds aggregation
columns
to model data.
See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo
.
Parameters:
{object} | oBindingInfo | The binding information |
Returns:
Parameters:
{object} | oBindingInfo | The binding information |
Returns:
Destroys all the columns in the aggregation columns
.
Returns:
Destroys all the items in the aggregation items
.
Returns:
Detaches event handler
fnFunction
from the
cancel
event of this
sap.m.TableSelectDialog
.
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:
Detaches event handler
fnFunction
from the
confirm
event of this
sap.m.TableSelectDialog
.
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:
Detaches event handler
fnFunction
from the
liveChange
event of this
sap.m.TableSelectDialog
.
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:
Detaches event handler
fnFunction
from the
search
event of this
sap.m.TableSelectDialog
.
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:
Fires event cancel
to attached listeners.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
confirm
to attached listeners.
Expects the following event parameters:
selectedItem
of type sap.m.StandardListItem
Returns the selected list item. When no item is selected, "null" is returned. When multi-selection is enabled and multiple items are selected, only the first selected item is returned.selectedItems
of type sap.m.StandardListItem[]
Returns an array containing the visible selected list items. If no items are selected, an empty array is returned.selectedContexts
of type string
Returns the binding contexts of the selected items including the non-visible items. Note: In contrast to the parameter "selectedItems", this parameter includes the selected but NOT visible items (due to list filtering). An empty array is set for this parameter if no Databinding is used.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
liveChange
to attached listeners.
Expects the following event parameters:
value
of type string
Specifies the value entered in the search field.itemsBinding
of type any
The Items binding of the Table Select Dialog. Only available if the items aggregation is bound to a model.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
search
to attached listeners.
Expects the following event parameters:
value
of type string
Specifies the value entered in the search field.itemsBinding
of type any
Determines the Items binding of the Table Select Dialog. Only available if the items aggregation is bound to a model.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Gets content of aggregation
columns
.
The columns bindings.
Returns:
getGrowingThreshold(): int
Gets current value of property
growingThreshold
.
Determines the number of items initially displayed in the table.
Returns:
{int} | Value of property growingThreshold |
Gets content of aggregation
items
.
The items of the table.
Returns:
getMultiSelect(): boolean
Gets current value of property
multiSelect
.
Enables the user to select several options from the table.
Default value is false
.
Returns:
{boolean} | Value of property multiSelect |
getNoDataText(): string
Retrieves the internal List's no data text property
Returns:
{string} | the current no data text |
getRememberSelections(): boolean
Gets current value of property
rememberSelections
.
Controls whether the dialog clears the selection or not. When the dialog is opened multiple times in the same context to allow for corrections of previous user inputs, set this flag to "true". When the dialog should reset the selection to allow for a new selection each time set it to "false" Note: This property must be set before the Dialog is opened to have an effect.
Default value is false
.
- Since:
- 1.18
Returns:
{boolean} | Value of property rememberSelections |
getTitle(): string
Gets current value of property
title
.
Specifies the title text in the dialog header.
Returns:
{string} | Value of property title |
indexOfColumn(oColumn): int
Checks for the provided sap.m.Column
in the aggregation columns
. and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
indexOfItem(oItem): int
Checks for the provided sap.m.ColumnListItem
in the aggregation items
. and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a column into the aggregation columns
.
Parameters:
{sap.m.Column} | oColumn | the column to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the column should be inserted at; for a negative value of iIndex , the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position |
Returns:
Inserts a item into the aggregation items
.
Parameters:
{sap.m.ColumnListItem} | 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:
Invalidates the dialog instead of this control, as there is no renderer.
Returns:
Shows the busy state and is called after the renderer is finished.
Returns:
Opens the internal dialog with a searchfield and a table.
Parameters:
{string} | sSearchValue | Value for the search. The table will be automatically trigger the search event if this parameter is set. |
Returns:
Removes all the controls from the aggregation
columns
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
{sap.m.Column[]} | An array of the removed elements (might be empty) |
Removes all the controls from the aggregation
items
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes a column from the aggregation columns
.
Parameters:
{int|string|sap.m.Column} | vColumn | The columnto remove or its index or id |
Returns:
Removes a item from the aggregation items
.
Parameters:
Returns:
Sets the busyIndicatorDelay value to the internal table
Parameters:
{int} | iValue | Value for the busyIndicatorDelay. |
Returns:
Sets the growing threshold to the internal table
Parameters:
{int} | iValue | Value for the table's growing threshold. |
Returns:
Enables/Disables multi selection mode.
Parameters:
{boolean} | bMulti | flag for multi selection mode |
Returns:
setNoDataText(sNoDataText)
Sets the no data text of the internal table
Parameters:
{string} | sNoDataText | the no data text for the table |
Sets a new value for property
rememberSelections
.
Controls whether the dialog clears the selection or not. When the dialog is opened multiple times in the same context to allow for corrections of previous user inputs, set this flag to "true". When the dialog should reset the selection to allow for a new selection each time set it to "false" Note: This property must be set before the Dialog is opened to have an effect.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Parameters:
{boolean} | bRememberSelections | New value for property rememberSelections |
- Since:
- 1.18
Returns:
Sets the title of the internal dialog
Parameters:
{string} | sTitle | the title text for the dialog |
Returns:
Unbinds aggregation columns
from model data.
Returns:
Unbinds aggregation items
from model data.
Returns: