abstract class sap.ui.mdc.valuehelp.base.ListContent

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/mdc/valuehelp/base/ListContent
Application Component: CA-UI5-MDC

Content for the sap.ui.mdc.valuehelp.base.Container element.


Constructor

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


Properties

Name Type Default Value Description
caseSensitive boolean false

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.

Visibility: public
useAsValueHelp boolean true

If set, the List is also opened if the ValueHelp icon is pressed.

Visibility: public
useFirstMatch boolean true

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.

Visibility: public

Borrowed Properties

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

Aggregations

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.

Borrowed Aggregations

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


Methods Overview

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

getCaseSensitive

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.

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 true.

getUseFirstMatch

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.

indexOfInParameter

Checks for the provided sap.ui.mdc.field.InParameter in the aggregation inParameters. and returns its index if found or -1 otherwise.

indexOfOutParameter

Checks for the provided sap.ui.mdc.field.OutParameter in the aggregation outParameters. and returns its index if found or -1 otherwise.

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

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 null or undefined, the default value of the property will be restored.

Default value is true.

setUseFirstMatch

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.

addInParameter

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

addOutParameter

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

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 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

getCaseSensitive

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.

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 true.

getUseFirstMatch

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.

indexOfInParameter

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

indexOfOutParameter

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

insertInParameter

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 0-based index the inParameter should be inserted at; for a negative value of iIndex, the inParameter is inserted at position 0; for a value greater than the current size of the aggregation, the inParameter is inserted at the last position

insertOutParameter

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 0-based index the outParameter should be inserted at; for a negative value of iIndex, the outParameter is inserted at position 0; for a value greater than the current size of the aggregation, the outParameter is inserted at the last position

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.

Param Type DefaultValue Description
vInParameter int string sap.ui.mdc.field.InParameter

The inParameter to remove or its index or id

removeOutParameter

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

setCaseSensitive

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 caseSensitive

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 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 useAsValueHelp

setUseFirstMatch

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 useFirstMatch