A dialog to select items in a table containing multiple values and attributes.
The table select dialog helps users select items in a table-like structure with several attributes and values per item. A search fields helps narrow down the results.
The table select dialog consists of the following elements:
multiSelect
property is set to true
.The selected items can be stored for later editing when the rememberSelections
property is set. Note: This property has to be set before the dialog is opened.
growing
must not be used together with two-way binding. growing
is set to true
(default value), selected count (if present) and search, will work for currently loaded items only. To make sure that all items in the table are loaded at once and the above features work properly, set the property to false
. resizable
and draggable
properties. Both properties are available only in desktop mode.sticky
property.
sap.m.TableSelectDialog
in SAP Quartz themes, the breakpoints and layout paddings could be determined by the dialog's width. To enable this concept and add responsive paddings to an element of the control, you have to add the following classes depending on your use case: sapUiResponsivePadding--header
, sapUiResponsivePadding--subHeader
, sapUiResponsivePadding--content
, sapUiResponsivePadding--footer
.
Constructor for a new TableSelectDialog.
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.TableSelectDialog(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 |
Name | Type | Default Value | Description |
---|---|---|---|
confirmButtonText | string | Overwrites the default text for the confirmation button. Note: This property applies only when the property |
|
contentHeight | sap.ui.core.CSSSize | Specifies the content height of the inner dialog. For more information, see the Dialog documentation. Visibility: public |
|
contentWidth | sap.ui.core.CSSSize | Determines the content width of the inner dialog. For more information, see the Dialog documentation. |
|
draggable | boolean | false | When set to |
growing | boolean | true | Determines the progressive loading. When set to |
growingThreshold | int | Determines the number of items initially displayed in the table and defines the number of items to be requested from the model for each grow. This property can only be used if the property |
|
multiSelect | boolean | false | Enables the user to select several options from the table. Visibility: public |
noDataText | string | Specifies the text displayed when the table has no data. Visibility: public |
|
rememberSelections | boolean | false | 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 |
resizable | boolean | false | When set to |
showClearButton | boolean | false | This flag controls whether the Clear button is shown. When set to We recommend enabling of the Clear button in the following cases, where a mechanism to clear the value is needed: In case the Table Select Dialog is in single-selection mode (default mode) and Optional: In case Note: When used with OData, only the loaded selections will be cleared. |
title | string | Specifies the title text in the dialog header. Visibility: public |
|
titleAlignment | sap.m.TitleAlignment | Auto | Specifies the Title alignment (theme specific). If set to |
Default Aggregation: items
Name | Cardinality | Type | Description |
---|---|---|---|
_dialog | 0..1 | sap.ui.core.Control |
The internal dialog that is displayed when method open is called. |
columns | 0..n | sap.m.Column |
The columns bindings. |
items (default) | 0..n | sap.m.ColumnListItem |
The items of the table. |
Event | Description |
---|---|
cancel |
Fires when the Cancel button is clicked. |
confirm |
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. |
liveChange |
Fires when the value of the search field is changed by a user (for example at each key press). |
search |
Fires when the search button has been clicked on dialog. |
Fires when the Cancel button is clicked.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
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.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
selectedItem | 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 | sap.m.StandardListItem[] |
Returns an array containing the visible selected list items. If no items are selected, an empty array is returned. |
selectedContexts | string |
Returns the binding contexts of the selected items including the non-visible items, but excluding the not loaded 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. NOTE: When the list binding is pre-filtered and there are items in the selection that are not visible upon opening the dialog, these contexts are not loaded. Therefore, these items will not be included in the selectedContexts array unless they are displayed at least once. |
Fires when the value of the search field is changed by a user (for example at each key press).
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
value | string |
Specifies the value entered in the search field. |
itemsBinding | any |
The Items binding of the Table Select Dialog. Only available if the items aggregation is bound to a model. |
Fires when the search button has been clicked on dialog.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
value | string |
Specifies the value entered in the search field. |
itemsBinding | any |
Determines the Items binding of the Table Select Dialog. Only available if the items aggregation is bound to a model. |
clearButtonPressed | boolean |
Returns if the Clear button is pressed. |
Method | Description |
---|---|
addColumn |
Adds some column to the aggregation columns. |
addItem |
Adds some item to the aggregation items. |
addStyleClass |
Transfers method to the inner dialog: addStyleClass |
attachCancel |
Attaches event handler When called, the context of the event handler (its Fires when the Cancel button is clicked. |
attachConfirm |
Attaches event handler When called, the context of the event handler (its 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. |
attachLiveChange |
Attaches event handler When called, the context of the event handler (its Fires when the value of the search field is changed by a user (for example at each key press). |
attachSearch |
Attaches event handler When called, the context of the event handler (its Fires when the search button has been clicked on dialog. |
bindColumns |
Binds aggregation columns to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
bindItems |
Binds aggregation items to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
destroyColumns |
Destroys all the columns in the aggregation columns. |
destroyItems |
Destroys all the items in the aggregation items. |
detachCancel |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachConfirm |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachLiveChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSearch |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.TableSelectDialog.extend |
Creates a new subclass of class sap.m.TableSelectDialog with name
|
fireCancel |
Fires event cancel to attached listeners. |
fireConfirm |
Fires event confirm to attached listeners. |
fireLiveChange |
Fires event liveChange to attached listeners. |
fireSearch |
Fires event search to attached listeners. |
getBusy |
Gets current busy state. |
getColumns |
Gets content of aggregation columns. The columns bindings. |
getConfirmButtonText |
Gets current value of property confirmButtonText. Overwrites the default text for the confirmation button. Note: This property applies only when the property |
getContentHeight |
Retrieves content height of the select dialog sap.m.Dialog |
getContentWidth |
Retrieves content width of the select dialog sap.m.Dialog |
getDomRef |
Transfers method to the inner dialog: getDomRef |
getDraggable |
Gets current value of property draggable. When set to Default value is |
getGrowing |
Gets current value of property growing. Determines the progressive loading. When set to Default value is |
getGrowingThreshold |
Gets current value of property growingThreshold. Determines the number of items initially displayed in the table and defines the number of items to be requested from the model for each grow. This property can only be used if the property |
getItems |
Gets content of aggregation items. The items of the table. |
sap.m.TableSelectDialog.getMetadata |
Returns a metadata object for class sap.m.TableSelectDialog. |
getMultiSelect |
Gets current value of property multiSelect. Enables the user to select several options from the table. Default value is |
getNoDataText |
Retrieves the internal List's no data text property |
getRememberSelections |
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 Default value is |
getResizable |
Gets current value of property resizable. When set to Default value is |
getShowClearButton |
Gets current value of property showClearButton. This flag controls whether the Clear button is shown. When set to We recommend enabling of the Clear button in the following cases, where a mechanism to clear the value is needed: In case the Table Select Dialog is in single-selection mode (default mode) and Optional: In case Note: When used with OData, only the loaded selections will be cleared. Default value is |
getTitle |
Gets current value of property title. Specifies the title text in the dialog header. |
getTitleAlignment |
Gets current value of property titleAlignment. Specifies the Title alignment (theme specific). If set to Default value is |
hasStyleClass |
Transfers method to the inner dialog: hasStyleClass |
indexOfColumn |
Checks for the provided |
indexOfItem |
Checks for the provided |
insertColumn |
Inserts a column into the aggregation columns. |
insertItem |
Inserts a item into the aggregation items. |
invalidate |
Invalidates the dialog instead of this control, as there is no renderer. |
onAfterRendering |
Shows the busy state and is called after the renderer is finished. |
open |
Opens the internal dialog with a searchfield and a table. |
removeAllColumns |
Removes all the controls from the aggregation columns. Additionally, it unregisters them from the hosting UIArea. |
removeAllItems |
Removes all the controls from the aggregation items. Additionally, it unregisters them from the hosting UIArea. |
removeColumn |
Removes a column from the aggregation columns. |
removeItem |
Removes a item from the aggregation items. |
removeStyleClass |
Transfers method to the inner dialog: removeStyleClass |
setBindingContext |
Set the binding context for the internal table AND the current control so that both controls can be used with the context. |
setBusy |
Enables/Disables busy state. |
setBusyIndicatorDelay |
Sets the busyIndicatorDelay value to the internal table |
setConfirmButtonText |
Sets the text of the confirmation button. |
setContentHeight |
Sets content height of the select dialog sap.m.Dialog |
setContentWidth |
Sets content width of the select dialog sap.m.Dialog |
setDraggable |
Sets the draggable property. |
setGrowing |
Sets the growing to the internal table |
setGrowingThreshold |
Sets the growing threshold to the internal table |
setModel |
Sets the model for the internal table and the current control, so that both controls can be used with data binding. |
setMultiSelect |
Enables/Disables multi selection mode. |
setNoDataText |
Sets the no data text of the internal table |
setRememberSelections |
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 When called with a value of Default value is |
setResizable |
Sets the resizable property. |
setShowClearButton |
Sets the Clear button visible state |
setTitle |
Sets the title of the internal dialog |
setTitleAlignment |
Sets a new value for property titleAlignment. Specifies the Title alignment (theme specific). If set to When called with a value of Default value is |
toggleStyleClass |
Transfers method to the inner dialog: toggleStyleClass |
unbindColumns |
Unbinds aggregation columns from model data. |
unbindItems |
Unbinds aggregation items from model data. |
Adds some column to the aggregation columns.
Param | Type | DefaultValue | Description |
---|---|---|---|
oColumn | sap.m.Column |
The column to add; if empty, nothing is inserted |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.m.ColumnListItem |
The item to add; if empty, nothing is inserted |
Transfers method to the inner dialog: addStyleClass
Param | Type | DefaultValue | Description |
---|---|---|---|
sStyleClass | string |
CSS class name to add |
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.
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 |
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.
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 |
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).
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 |
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.
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 |
Binds aggregation columns 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 |
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 |
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.
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 |
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.
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 |
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.
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 |
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.
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 |
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.m.SelectDialogBase.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 |
Fires event cancel to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event confirm to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
selectedItem | 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 | sap.m.StandardListItem[] |
Returns an array containing the visible selected list items. If no items are selected, an empty array is returned. |
|
selectedContexts | string |
Returns the binding contexts of the selected items including the non-visible items, but excluding the not loaded 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. NOTE: When the list binding is pre-filtered and there are items in the selection that are not visible upon opening the dialog, these contexts are not loaded. Therefore, these items will not be included in the selectedContexts array unless they are displayed at least once. |
Fires event liveChange to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
value | string |
Specifies the value entered in the search field. |
|
itemsBinding | any |
The Items binding of the Table Select Dialog. Only available if the items aggregation is bound to a model. |
Fires event search to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
value | string |
Specifies the value entered in the search field. |
|
itemsBinding | any |
Determines the Items binding of the Table Select Dialog. Only available if the items aggregation is bound to a model. |
|
clearButtonPressed | boolean |
Returns if the Clear button is pressed. |
Gets current value of property confirmButtonText.
Overwrites the default text for the confirmation button. Note: This property applies only when the property multiSelect
is set to true
.
Gets current value of property draggable.
When set to true
, the TableSelectDialog is draggable by its header. The default value is false
. Note: The TableSelectDialog can be draggable only in desktop mode.
Default value is false
.
Gets current value of property growing.
Determines the progressive loading. When set to true
, enables the growing feature of the control to load more items by requesting from the bound model. Note: This feature only works when an items
aggregation is bound. Growing must not be used together with two-way binding. Note: If the property is set to true
, selected count (if present) and search, will work for currently loaded items only. To make sure that all items in the table are loaded at once and the above features work properly, we recommend setting the growing
property to false
.
Default value is true
.
Gets current value of property growingThreshold.
Determines the number of items initially displayed in the table and defines the number of items to be requested from the model for each grow. This property can only be used if the property growing
is set to true
.
Gets current value of property multiSelect.
Enables the user to select several options from the table.
Default value is false
.
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
.
Gets current value of property resizable.
When set to true
, the TableSelectDialog will have a resize handler in its bottom right corner. The default value is false
. Note: The TableSelectDialog can be resizable only in desktop mode.
Default value is false
.
Gets current value of property showClearButton.
This flag controls whether the Clear button is shown. When set to true
, it provides a way to clear a selection made in Table Select Dialog.
We recommend enabling of the Clear button in the following cases, where a mechanism to clear the value is needed: In case the Table Select Dialog is in single-selection mode (default mode) and rememberSelections
is set to true
. The Clear button needs to be enabled in order to allow users to clear the selection. In case of using sap.m.Input
with valueHelpOnly
set to true
, the Clear button can be used for clearing the selection. In case the application stores a value and uses only Table Select Dialog to edit/maintain it.
Optional: In case multiSelect
is set to true
, the selection can be easily cleared with one click.
Note: When used with OData, only the loaded selections will be cleared.
Default value is false
.
Gets current value of property titleAlignment.
Specifies the Title alignment (theme specific). If set to TitleAlignment.Auto
, the Title will be aligned as it is set in the theme (if not set, the default value is center
); Other possible values are TitleAlignment.Start
(left or right depending on LTR/RTL), and TitleAlignment.Center
(centered)
Default value is Auto
.
Checks for the provided sap.m.Column
in the aggregation columns. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oColumn | sap.m.Column |
The column whose index is looked for |
Checks for the provided sap.m.ColumnListItem
in the aggregation items. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.m.ColumnListItem |
The item whose index is looked for |
Inserts a column into the aggregation columns.
Param | Type | DefaultValue | Description |
---|---|---|---|
oColumn | sap.m.Column |
The column to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a item into the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.m.ColumnListItem |
The item to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Opens the internal dialog with a searchfield and a table.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSearchValue | string |
Value for the search. The table will be automatically trigger the search event if this parameter is set. |
Removes all the controls from the aggregation columns.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
Removes a column from the aggregation columns.
Param | Type | DefaultValue | Description |
---|---|---|---|
vColumn | int string sap.m.Column |
The column to remove or its index or id |
Removes a item from the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | int string sap.m.ColumnListItem |
The item to remove or its index or id |
Transfers method to the inner dialog: removeStyleClass
Param | Type | DefaultValue | Description |
---|---|---|---|
sStyleClass | string |
CSS class name to remove |
Set the binding context for the internal table AND the current control so that both controls can be used with the context.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContext | sap.ui.model.Context |
The new context |
|
sModelName | string |
The optional model name |
Enables/Disables busy state.
Param | Type | DefaultValue | Description |
---|---|---|---|
flag | boolean |
for enabling busy indicator |
Sets the busyIndicatorDelay value to the internal table
Param | Type | DefaultValue | Description |
---|---|---|---|
iValue | int |
Value for the busyIndicatorDelay. |
Sets the text of the confirmation button.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string |
The text for the confirm button |
Sets content height of the select dialog sap.m.Dialog
Param | Type | DefaultValue | Description |
---|---|---|---|
sHeight | sap.ui.core.CSSSize |
the new content height value for the dialog |
Sets content width of the select dialog sap.m.Dialog
Param | Type | DefaultValue | Description |
---|---|---|---|
sWidth | sap.ui.core.CSSSize |
the new content width value for the dialog |
Sets the draggable property.
Param | Type | DefaultValue | Description |
---|---|---|---|
bValue | boolean |
Value for the draggable property |
Sets the growing to the internal table
Param | Type | DefaultValue | Description |
---|---|---|---|
bValue | boolean |
Value for the table's growing. |
Sets the growing threshold to the internal table
Param | Type | DefaultValue | Description |
---|---|---|---|
iValue | int |
Value for the table's growing threshold. |
Sets the model for the internal table and the current control, so that both controls can be used with data binding.
Param | Type | DefaultValue | Description |
---|---|---|---|
oModel | sap.ui.model.Model |
The model that holds the data for the table |
|
sName | string |
The optional model name |
Enables/Disables multi selection mode.
Param | Type | DefaultValue | Description |
---|---|---|---|
bMulti | boolean |
flag for multi selection mode |
Sets the no data text of the internal table
Param | Type | DefaultValue | Description |
---|---|---|---|
sNoDataText | string |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bRememberSelections | boolean | false |
New value for property |
Sets the resizable property.
Param | Type | DefaultValue | Description |
---|---|---|---|
bValue | boolean |
Value for the resizable property |
Sets the Clear button visible state
Param | Type | DefaultValue | Description |
---|---|---|---|
bVisible | boolean |
Value for the Clear button visible state. |
Sets the title of the internal dialog
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
the title text for the dialog |
Sets a new value for property titleAlignment.
Specifies the Title alignment (theme specific). If set to TitleAlignment.Auto
, the Title will be aligned as it is set in the theme (if not set, the default value is center
); Other possible values are TitleAlignment.Start
(left or right depending on LTR/RTL), and TitleAlignment.Center
(centered)
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Auto
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleAlignment | sap.m.TitleAlignment | Auto |
New value for property |
Transfers method to the inner dialog: toggleStyleClass
Param | Type | DefaultValue | Description |
---|---|---|---|
sStyleClass | string |
CSS class name to add or remove |
|
bAdd | boolean |
Whether style class should be added (or removed); when this parameter is not given, the given style class will be toggled (removed, if present, and added if not present) |