Content for the sap.ui.mdc.valuehelp.base.Container
element.
Constructor for a new ListContent
.
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.ListContent(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 |
---|---|---|---|
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 |
Name | Type | Default Value | Description |
---|---|---|---|
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 |
---|---|---|---|
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. |
Name | Cardinality | Type | Description |
---|---|---|---|
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 |
---|---|
addInParameter |
Adds some inParameter to the aggregation inParameters. |
addOutParameter |
Adds some outParameter to the aggregation outParameters. |
destroyInParameters |
Destroys all the inParameters in the aggregation inParameters. |
destroyOutParameters |
Destroys all the outParameters in the aggregation outParameters. |
sap.ui.mdc.valuehelp.base.ListContent.extend |
Creates a new subclass of class sap.ui.mdc.valuehelp.base.ListContent with name
|
getCaseSensitive |
Gets current value of property caseSensitive. If this property is set to If the used back-end service supports a case-insensitive search, set this property to Default value is |
getInParameters |
Gets content of aggregation inParameters. 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. |
sap.ui.mdc.valuehelp.base.ListContent.getMetadata |
Returns a metadata object for class sap.ui.mdc.valuehelp.base.ListContent. |
getOutParameters |
Gets content of aggregation outParameters. 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. |
getUseAsValueHelp |
Gets current value of property useAsValueHelp. If set, the List is also opened if the ValueHelp icon is pressed. Default value is |
getUseFirstMatch |
Gets current value of property useFirstMatch. If set, This is the case if the text of the item starts with the text entered. Default value is |
indexOfInParameter |
Checks for the provided |
indexOfOutParameter |
Checks for the provided |
insertInParameter |
Inserts a inParameter into the aggregation inParameters. |
insertOutParameter |
Inserts a outParameter into the aggregation outParameters. |
removeAllInParameters |
Removes all the controls from the aggregation inParameters. Additionally, it unregisters them from the hosting UIArea. |
removeAllOutParameters |
Removes all the controls from the aggregation outParameters. Additionally, it unregisters them from the hosting UIArea. |
removeInParameter |
Removes a inParameter from the aggregation inParameters. |
removeOutParameter |
Removes a outParameter from the aggregation outParameters. |
setCaseSensitive |
Sets a new value for property caseSensitive. If this property is set to If the used back-end service supports a case-insensitive search, set this property to When called with a value of Default value is |
setUseAsValueHelp |
Sets a new value for property useAsValueHelp. If set, the List is also opened if the ValueHelp icon is pressed. When called with a value of Default value is |
setUseFirstMatch |
Sets a new value for property useFirstMatch. If set, This is the case if the text of the item starts with the text entered. When called with a value of Default value is |
Adds some inParameter to the aggregation inParameters.
Param | Type | DefaultValue | Description |
---|---|---|---|
oInParameter | sap.ui.mdc.field.InParameter |
The inParameter to add; if empty, nothing is inserted |
Adds some outParameter to the aggregation outParameters.
Param | Type | DefaultValue | Description |
---|---|---|---|
oOutParameter | sap.ui.mdc.field.OutParameter |
The outParameter to add; if empty, nothing is inserted |
Creates a new subclass of class sap.ui.mdc.valuehelp.base.ListContent 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.Content.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 current value of property caseSensitive.
If this property is set to true
, the filtering for user input is always case-sensitive. Otherwise user input is checked case-insensitively. If $search
is used, this property has no effect on the $search
request.
If the used back-end service supports a case-insensitive search, set this property to false
.
Default value is false
.
Gets content of aggregation inParameters.
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.
Returns a metadata object for class sap.ui.mdc.valuehelp.base.ListContent.
Gets content of aggregation outParameters.
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.
Gets current value of property useAsValueHelp.
If set, the List is also opened if the ValueHelp icon is pressed.
Default value is true
.
Gets current value of property useFirstMatch.
If set, getKeyForText
returns the first item that matches the text.
This is the case if the text of the item starts with the text entered.
Default value is true
.
Checks for the provided sap.ui.mdc.field.InParameter
in the aggregation inParameters. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oInParameter | sap.ui.mdc.field.InParameter |
The inParameter whose index is looked for |
Checks for the provided sap.ui.mdc.field.OutParameter
in the aggregation outParameters. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oOutParameter | sap.ui.mdc.field.OutParameter |
The outParameter whose index is looked for |
Inserts a inParameter into the aggregation inParameters.
Param | Type | DefaultValue | Description |
---|---|---|---|
oInParameter | sap.ui.mdc.field.InParameter |
The inParameter to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a outParameter into the aggregation outParameters.
Param | Type | DefaultValue | Description |
---|---|---|---|
oOutParameter | sap.ui.mdc.field.OutParameter |
The outParameter to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation inParameters.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation outParameters.
Additionally, it unregisters them from the hosting UIArea.
Removes a inParameter from the aggregation inParameters.
Param | Type | DefaultValue | Description |
---|---|---|---|
vInParameter | int string sap.ui.mdc.field.InParameter |
The inParameter to remove or its index or id |
Removes a outParameter from the aggregation outParameters.
Param | Type | DefaultValue | Description |
---|---|---|---|
vOutParameter | int string sap.ui.mdc.field.OutParameter |
The outParameter to remove or its index or id |
Sets a new value for property caseSensitive.
If this property is set to true
, the filtering for user input is always case-sensitive. Otherwise user input is checked case-insensitively. If $search
is used, this property has no effect on the $search
request.
If the used back-end service supports a case-insensitive search, set this property to false
.
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 |
---|---|---|---|
bCaseSensitive | boolean | false |
New value for property |
Sets a new value for property useAsValueHelp.
If set, the List is also opened if the ValueHelp icon is pressed.
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 |
---|---|---|---|
bUseAsValueHelp | boolean | true |
New value for property |
Sets a new value for property useFirstMatch.
If set, getKeyForText
returns the first item that matches the text.
This is the case if the text of the item starts with the text entered.
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 |
---|---|---|---|
bUseFirstMatch | boolean | true |
New value for property |