Content for the sap.ui.mdc.valuehelp.base.Container
element.
Constructor for a new FilterableListContent
.
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.ui.mdc.valuehelp.base.FilterableListContent(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 |
---|---|---|---|
descriptionPath | string | empty string | The path of the description field in the content binding. If a table is used as content, this is the binding path of the description of the items. Visibility: public |
filterFields | string | empty string | The fields based on which the table data is filtered. For filtering the value of the If set to If set to one or more properties, the filters for these properties are used for filtering. These filters are set on the If it is empty, no suggestion is available. Visibility: public |
inConditions | object | empty object | Internal property to allow to bind the conditions created by InParameters to content Visibility: public |
keyPath | string | empty string | The path of the key field in the content binding. If a table is used as content, this is the binding path of the key of the items. If not set, the FieldPath of the assigned field is used. Visibility: public |
outParameterNames | string[] | Internal property to allow to bind the paths used by OutParameters to content Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
caseSensitive | boolean | false | If this property is set to If the used back-end service supports a case-insensitive search, set this property to |
useAsValueHelp | boolean | true | If set, the List is also opened if the ValueHelp icon is pressed. Visibility: public |
useFirstMatch | boolean | true | If set, This is the case if the text of the item starts with the text entered. Visibility: public |
conditions | object[] | Conditions of the value help Note: This property must not be set from outside, it is only to be used by the corresponding container Visibility: public |
|
config | object | empty object | internal configuration Note: This property must not be set from outside, it is only to be used by the corresponding container Visibility: public |
filterValue | string | empty string | Value for filtering ($search) Note: This property must not be set from outside, it is only to be used by the corresponding container Visibility: public |
shortTitle | string | empty string | Title text that appears in the dialog header. Visibility: public |
title | string | empty string | Title text that appears tab header. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
_defaultFilterBar | 0..1 | sap.ui.mdc.filterbar.FilterBarBase |
Default FilterBar, ceated internally if none given. |
collectiveSearchItems | 0..n | sap.ui.core.Item |
Items used for collective search. If none assigned, no collective search is available. |
filterBar | 0..1 | sap.ui.mdc.filterbar.FilterBarBase |
FilterBar |
Name | Cardinality | Type | Description |
---|---|---|---|
inParameters | 0..n | sap.ui.mdc.field.InParameter |
Sets the in parameters of a field help. If set, the field help reads the data of these entities in the model and uses it to filter in the value help. |
outParameters | 0..n | sap.ui.mdc.field.OutParameter |
Sets the out parameters of a field help. If set, the fields sets the data of these entities in the model based to the selected values. |
displayContent | 0..1 | sap.ui.core.Control |
Content control that is put inside the parent container Note: This aggregation must not be set from outside, it is only to be used by the corresponding container |
Method | Description |
---|---|
addCollectiveSearchItem |
Adds some collectiveSearchItem to the aggregation collectiveSearchItems. |
destroyCollectiveSearchItems |
Destroys all the collectiveSearchItems in the aggregation collectiveSearchItems. |
destroyFilterBar |
Destroys the filterBar in the aggregation filterBar. |
sap.ui.mdc.valuehelp.base.FilterableListContent.extend |
Creates a new subclass of class sap.ui.mdc.valuehelp.base.FilterableListContent with name
|
getCollectiveSearchItems |
Gets content of aggregation collectiveSearchItems. Items used for collective search. If none assigned, no collective search is available. |
getDescriptionPath |
Gets current value of property descriptionPath. The path of the description field in the content binding. If a table is used as content, this is the binding path of the description of the items. Default value is |
getFilterBar |
Gets content of aggregation filterBar. FilterBar |
getFilterFields |
Gets current value of property filterFields. The fields based on which the table data is filtered. For filtering the value of the If set to If set to one or more properties, the filters for these properties are used for filtering. These filters are set on the If it is empty, no suggestion is available. Default value is |
getInConditions |
Gets current value of property inConditions. Internal property to allow to bind the conditions created by InParameters to content Default value is |
getKeyPath |
Gets current value of property keyPath. The path of the key field in the content binding. If a table is used as content, this is the binding path of the key of the items. If not set, the FieldPath of the assigned field is used. Default value is |
sap.ui.mdc.valuehelp.base.FilterableListContent.getMetadata |
Returns a metadata object for class sap.ui.mdc.valuehelp.base.FilterableListContent. |
getOutParameterNames |
Gets current value of property outParameterNames. Internal property to allow to bind the paths used by OutParameters to content Default value is |
indexOfCollectiveSearchItem |
Checks for the provided |
insertCollectiveSearchItem |
Inserts a collectiveSearchItem into the aggregation collectiveSearchItems. |
removeAllCollectiveSearchItems |
Removes all the controls from the aggregation collectiveSearchItems. Additionally, it unregisters them from the hosting UIArea. |
removeCollectiveSearchItem |
Removes a collectiveSearchItem from the aggregation collectiveSearchItems. |
setDescriptionPath |
Sets a new value for property descriptionPath. The path of the description field in the content binding. If a table is used as content, this is the binding path of the description of the items. When called with a value of Default value is |
setFilterBar |
Sets the aggregated filterBar. |
setFilterFields |
Sets a new value for property filterFields. The fields based on which the table data is filtered. For filtering the value of the If set to If set to one or more properties, the filters for these properties are used for filtering. These filters are set on the If it is empty, no suggestion is available. When called with a value of Default value is |
setInConditions |
Sets a new value for property inConditions. Internal property to allow to bind the conditions created by InParameters to content When called with a value of Default value is |
setKeyPath |
Sets a new value for property keyPath. The path of the key field in the content binding. If a table is used as content, this is the binding path of the key of the items. If not set, the FieldPath of the assigned field is used. When called with a value of Default value is |
setOutParameterNames |
Sets a new value for property outParameterNames. Internal property to allow to bind the paths used by OutParameters to content When called with a value of Default value is |
Adds some collectiveSearchItem to the aggregation collectiveSearchItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCollectiveSearchItem | sap.ui.core.Item |
The collectiveSearchItem to add; if empty, nothing is inserted |
Destroys all the collectiveSearchItems in the aggregation collectiveSearchItems.
Creates a new subclass of class sap.ui.mdc.valuehelp.base.FilterableListContent 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.mdc.valuehelp.base.ListContent.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 |
Gets content of aggregation collectiveSearchItems.
Items used for collective search. If none assigned, no collective search is available.
Gets current value of property descriptionPath.
The path of the description field in the content binding. If a table is used as content, this is the binding path of the description of the items.
Default value is empty string
.
Gets current value of property filterFields.
The fields based on which the table data is filtered. For filtering the value of the filterValue
property is used.
If set to $search
and the used binding supports search requests, a $search request is used for filtering.
If set to one or more properties, the filters for these properties are used for filtering. These filters are set on the ListBinding
used. The properties need to be separated by commas and enclosed by "*" characters. ("*Property1,Property2*"
)
If it is empty, no suggestion is available.
Default value is empty string
.
Gets current value of property inConditions.
Internal property to allow to bind the conditions created by InParameters to content
Default value is {}
.
Gets current value of property keyPath.
The path of the key field in the content binding. If a table is used as content, this is the binding path of the key of the items.
If not set, the FieldPath of the assigned field is used.
Default value is empty string
.
Returns a metadata object for class sap.ui.mdc.valuehelp.base.FilterableListContent.
Gets current value of property outParameterNames.
Internal property to allow to bind the paths used by OutParameters to content
Default value is []
.
Checks for the provided sap.ui.core.Item
in the aggregation collectiveSearchItems. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCollectiveSearchItem | sap.ui.core.Item |
The collectiveSearchItem whose index is looked for |
Inserts a collectiveSearchItem into the aggregation collectiveSearchItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCollectiveSearchItem | sap.ui.core.Item |
The collectiveSearchItem to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation collectiveSearchItems.
Additionally, it unregisters them from the hosting UIArea.
Removes a collectiveSearchItem from the aggregation collectiveSearchItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
vCollectiveSearchItem | int string sap.ui.core.Item |
The collectiveSearchItem to remove or its index or id |
Sets a new value for property descriptionPath.
The path of the description field in the content binding. If a table is used as content, this is the binding path of the description of the items.
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 |
---|---|---|---|
sDescriptionPath | string | "" |
New value for property |
Sets the aggregated filterBar.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFilterBar | sap.ui.mdc.filterbar.FilterBarBase |
The filterBar to set |
Sets a new value for property filterFields.
The fields based on which the table data is filtered. For filtering the value of the filterValue
property is used.
If set to $search
and the used binding supports search requests, a $search request is used for filtering.
If set to one or more properties, the filters for these properties are used for filtering. These filters are set on the ListBinding
used. The properties need to be separated by commas and enclosed by "*" characters. ("*Property1,Property2*"
)
If it is empty, no suggestion is available.
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 |
---|---|---|---|
sFilterFields | string | "" |
New value for property |
Sets a new value for property inConditions.
Internal property to allow to bind the conditions created by InParameters to content
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is {}
.
Param | Type | DefaultValue | Description |
---|---|---|---|
oInConditions | object | {} |
New value for property |
Sets a new value for property keyPath.
The path of the key field in the content binding. If a table is used as content, this is the binding path of the key of the items.
If not set, the FieldPath of the assigned field is used.
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 |
---|---|---|---|
sKeyPath | string | "" |
New value for property |
Sets a new value for property outParameterNames.
Internal property to allow to bind the paths used by OutParameters to content
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is []
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sOutParameterNames | string[] | [] |
New value for property |