Content for the sap.ui.mdc.valuehelp.base.Container
element showing a list with fix values.
Constructor for a new FixedList
content.
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.content.FixedList(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 |
---|---|---|---|
filterList | boolean | true | If set, the items of the list are filtered based on If a type-ahead behavior for the connected field is wanted, this property must be set to If not set, the list opens if the user clicks into the connected field. Visibility: public |
groupable | boolean | false | If set, the items of the list can be grouped 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: items
Name | Cardinality | Type | Description |
---|---|---|---|
items (default) | 0..n | sap.ui.mdc.field.ListFieldHelpItem |
Items of the field help. The If the Note: At the moment, icons are not supported. |
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 |
---|---|
addItem |
Adds some item to the aggregation items. |
destroyItems |
Destroys all the items in the aggregation items. |
sap.ui.mdc.valuehelp.content.FixedList.extend |
Creates a new subclass of class sap.ui.mdc.valuehelp.content.FixedList with name
|
getFilterList |
Gets current value of property filterList. If set, the items of the list are filtered based on If a type-ahead behavior for the connected field is wanted, this property must be set to If not set, the list opens if the user clicks into the connected field. Default value is |
getGroupable |
Gets current value of property groupable. If set, the items of the list can be grouped Default value is |
getItems |
Gets content of aggregation items. Items of the field help. The If the Note: At the moment, icons are not supported. |
sap.ui.mdc.valuehelp.content.FixedList.getMetadata |
Returns a metadata object for class sap.ui.mdc.valuehelp.content.FixedList. |
indexOfItem |
Checks for the provided |
insertItem |
Inserts a item into the aggregation items. |
removeAllItems |
Removes all the controls from the aggregation items. Additionally, it unregisters them from the hosting UIArea. |
removeItem |
Removes a item from the aggregation items. |
setFilterList |
Sets a new value for property filterList. If set, the items of the list are filtered based on If a type-ahead behavior for the connected field is wanted, this property must be set to If not set, the list opens if the user clicks into the connected field. When called with a value of Default value is |
setGroupable |
Sets a new value for property groupable. If set, the items of the list can be grouped When called with a value of Default value is |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.mdc.field.ListFieldHelpItem |
The item to add; if empty, nothing is inserted |
Creates a new subclass of class sap.ui.mdc.valuehelp.content.FixedList 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 filterList.
If set, the items of the list are filtered based on filterValue
.
If a type-ahead behavior for the connected field is wanted, this property must be set to true
. For small lists all values are meant to be shown, independent of the typing in the connected field. In this case this property must be set to false
.
If not set, the list opens if the user clicks into the connected field.
Default value is true
.
Gets current value of property groupable.
If set, the items of the list can be grouped
Default value is false
.
Gets content of aggregation items.
Items of the field help.
The key
of the items is not shown in the list, but is used as a value of the connected field.
If the additionalText
for all the items is not used, the column will not be displayed.
Note: At the moment, icons are not supported.
Returns a metadata object for class sap.ui.mdc.valuehelp.content.FixedList.
Checks for the provided sap.ui.mdc.field.ListFieldHelpItem
in the aggregation items. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.mdc.field.ListFieldHelpItem |
The item whose index is looked for |
Inserts a item into the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.mdc.field.ListFieldHelpItem |
The item to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
Removes a item from the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | int string sap.ui.mdc.field.ListFieldHelpItem |
The item to remove or its index or id |
Sets a new value for property filterList.
If set, the items of the list are filtered based on filterValue
.
If a type-ahead behavior for the connected field is wanted, this property must be set to true
. For small lists all values are meant to be shown, independent of the typing in the connected field. In this case this property must be set to false
.
If not set, the list opens if the user clicks into the connected field.
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 |
---|---|---|---|
bFilterList | boolean | true |
New value for property |
Sets a new value for property groupable.
If set, the items of the list can be grouped
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 |
---|---|---|---|
bGroupable | boolean | false |
New value for property |