class sap.ui.mdc.field.FieldValueHelpDelegate

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Extends:
Module: sap/ui/mdc/field/FieldValueHelpDelegate
Application Component: CA-UI5-MDC

Delegate class for sap.ui.mdc.field.FieldValueHelp.
Note: The class is experimental and the API/behavior is not finalized and hence this should not be used for productive usage.


Constructor

new sap.ui.mdc.field.FieldValueHelpDelegate()

Methods Overview

Method Description
sap.ui.mdc.field.FieldValueHelpDelegate.checkBindingsPending

Checks if at least one PropertyBinding is waiting for an update. As long as the value has not been set for PropertyBinding, FieldValueHelp needs to wait.

This check is used when selecting the description for a key if in parameters are used. The description can only be determined if the values of the in parameters are known.

sap.ui.mdc.field.FieldValueHelpDelegate.checkListBindingPending

Checks if the ListBinding is waiting for an update. As long as the context has not been set for ListBinding, FieldValueHelp needs to wait.

sap.ui.mdc.field.FieldValueHelpDelegate.determineSearchSupported

Requests to set the filterFields property of the FieldValueHelp element.

This function is called when the field help is opened for suggestion. If no search is supported, content controls are not needed right now as the field help is not opened in this case.

sap.ui.mdc.field.FieldValueHelpDelegate.executeFilter

Executes a filter in a ListBinding.

sap.ui.mdc.field.FieldValueHelpDelegate.executeSearch

Executes a search in a ListBinding.

sap.ui.mdc.field.FieldValueHelpDelegate.isSearchSupported

Checks if a ListBinding supports $Search.

sap.ui.mdc.field.FieldValueHelpDelegate.checkBindingsPending

Checks if at least one PropertyBinding is waiting for an update. As long as the value has not been set for PropertyBinding, FieldValueHelp needs to wait.

This check is used when selecting the description for a key if in parameters are used. The description can only be determined if the values of the in parameters are known.

Param Type DefaultValue Description
oPayload object

Payload for delegate

aBindings sap.ui.model.PropertyBinding[]

PropertyBinding array to check

sap.ui.mdc.field.FieldValueHelpDelegate.checkListBindingPending

Checks if the ListBinding is waiting for an update. As long as the context has not been set for ListBinding, FieldValueHelp needs to wait.

Param Type DefaultValue Description
oPayload object

Payload for delegate

oListBindings sap.ui.model.ListBinding

ListBinding to check

sap.ui.mdc.field.FieldValueHelpDelegate.determineSearchSupported

Requests to set the filterFields property of the FieldValueHelp element.

This function is called when the field help is opened for suggestion. If no search is supported, content controls are not needed right now as the field help is not opened in this case.

Param Type DefaultValue Description
oPayload object

Payload for delegate

oFieldHelp sap.ui.mdc.field.FieldValueHelp

Field help instance

sap.ui.mdc.field.FieldValueHelpDelegate.executeFilter

Executes a filter in a ListBinding.

Param Type DefaultValue Description
oPayload object

Payload for delegate

oListBinding sap.ui.model.ListBinding

List binding

oFilter sap.ui.model.Filter

Filter

fnCallback function

Callback function after result has been received

iRequestedItems int

Number of requested items

sap.ui.mdc.field.FieldValueHelpDelegate.executeSearch

Executes a search in a ListBinding.

Param Type DefaultValue Description
oPayload object

Payload for delegate

oListBinding sap.ui.model.ListBinding

ListBinding

sSearch string

Search string

sap.ui.mdc.field.FieldValueHelpDelegate.isSearchSupported

Checks if a ListBinding supports $Search.

Param Type DefaultValue Description
oPayload object

Payload for delegate

oListBinding sap.ui.model.ListBinding

ListBinding