Delegate class for sap.ui.mdc.field.FieldBase
.
Note: The class is experimental and the API/behavior is not finalized and hence this should not be used for productive usage.
Method | Description |
---|---|
sap.ui.mdc.field.FieldBaseDelegate.enhanceValueForUnit |
This function enhances the value with unit or currency information if needed by the data type. |
sap.ui.mdc.field.FieldBaseDelegate.getDefaultFieldHelpBaseDelegate |
This function returns which |
sap.ui.mdc.field.FieldBaseDelegate.getDefaultFieldValueHelpDelegate |
This function returns which |
sap.ui.mdc.field.FieldBaseDelegate.getDescription |
Determines the description for a given key. This function is called while formatting the output of a If this needs to be determined asynchronously, a As the key might change (uppercase), an object with key and description can be returned. If the description cannot be determined, a corresponding |
sap.ui.mdc.field.FieldBaseDelegate.getItemForValue |
Determines the key, description, and the in and out parameters of a user input. If this needs to be determined asynchronously, a The result needs to be an object containing the following properties: description, key, and in and out parameters.
If the item cannot be determined, a corresponding |
sap.ui.mdc.field.FieldBaseDelegate.initializeInternalUnitType |
This function initializes the unit type. If the |
sap.ui.mdc.field.FieldBaseDelegate.initializeTypeFromBinding |
If the |
sap.ui.mdc.field.FieldBaseDelegate.isInputValidationEnabled |
Defines if the input of the |
sap.ui.mdc.field.FieldBaseDelegate.isInvalidInputAllowed |
Defines if the input of the |
This function enhances the value with unit or currency information if needed by the data type.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
|
aValues | any[] |
Value |
|
oTypeInitialization | object |
Information needed to initialize internal type |
This function returns which FieldHelpBaseDelegate
is used if a default field help (for example, for Boolean values) is created.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
This function returns which FieldValueHelpDelegate
is used if a default field help (for example, for defining conditions in FilterField) is created.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
Determines the description for a given key.
This function is called while formatting the output of a Field
or FilterField
control in case a description is to be displayed but only a key is given.
If this needs to be determined asynchronously, a Promise
is returned.
As the key might change (uppercase), an object with key and description can be returned.
If the description cannot be determined, a corresponding FormatException
is thrown.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
|
oFieldHelp | sap.ui.mdc.field.FieldHelpBase |
Field help assigned to the |
|
vKey | any |
Key |
|
oInParameters | object |
In parameters for the key (as a key must not be unique.) |
|
oOutParameters | object |
Out parameters for the key (as a key must not be unique.) |
|
oBindingContext | sap.ui.model.Context |
|
|
oConditionModel | sap.ui.mdc.condition.ConditionModel |
|
|
sConditionModelName | string |
Name of the |
Determines the key, description, and the in and out parameters of a user input.
If this needs to be determined asynchronously, a Promise
is returned.
The result needs to be an object containing the following properties: description, key, and in and out parameters.
key
: Key of the item description
: Description of the item inParameters
: Object with in parameters and the corresponding value outParameters
: Object with out parameters and the corresponding value If the item cannot be determined, a corresponding ParseException
is thrown.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
|
oFieldHelp | sap.ui.mdc.field.FieldHelpBase |
Field help assigned to the |
|
vValue | any |
Value as entered by user |
|
vParsedValue | any |
Value parsed by data type to fit the data type of the key |
|
oBindingContext | sap.ui.model.Context |
|
|
bCheckKeyFirst | boolean |
If set, it first should be checked if the value fits a key |
|
bCheckKey | boolean |
If set, it should be checked if there is an item with the given key. This is set to |
|
bCheckDescription | boolean |
If set, it should be checked if there is an item with the given description. This is set to |
|
oConditionModel | sap.ui.mdc.condition.ConditionModel |
|
|
sConditionModelName | string |
Name of the |
This function initializes the unit type. If the Field
control is used, the used data type might come from the binding. If the type is a V4 unit or currency, it might need to be formatted once.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
|
oType | sap.ui.model.SimpleType |
Type from binding |
|
oTypeInitialization | object |
Information needed to initialize internal type |
If the Field
control is used, the used data type might come from the binding. In V4-unit or currency case it might need to be formatted once. To initialize the internal type later on, the currencies must be returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
|
oType | sap.ui.model.SimpleType |
Type from binding |
|
vValue | any |
Given value |
Defines if the input of the Field
or FilterField
control is checked to determine the key and description.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
|
oFieldHelp | sap.ui.mdc.field.FieldHelpBase |
Field help assigned to the |
Defines if the input of the Field
or FilterField
control that is not found in the field help or custom logic is accepted.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPayload | object |
Payload for delegate |
|
oFieldHelp | sap.ui.mdc.field.FieldHelpBase |
Field help assigned to the |