class sap.ui.mdc.ValueHelpDelegate

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

Delegate class for ValueHelp.
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.ValueHelpDelegate()

Methods Overview

Method Description
sap.ui.mdc.ValueHelpDelegate.checkBindingsPending

Checks if at least one PropertyBinding is waiting for an update. As long as the value has not been set for PropertyBinding, ValueHelp 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.ValueHelpDelegate.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.ValueHelpDelegate.executeFilter

Executes a filter in a ListBinding.

sap.ui.mdc.ValueHelpDelegate.executeSearch

Executes a search in a ListBinding.

sap.ui.mdc.ValueHelpDelegate.isSearchSupported

Checks if a ListBinding supports $Search.

sap.ui.mdc.ValueHelpDelegate.retrieveContent

Requests the content of the value help.

This function is called when the value help is opened or a key or description is requested.

So, depending on the value help content used, all content controls and data need to be assigned. Once they are assigned and the data is set, the returned Promise needs to be resolved. Only then does the value help continue opening or reading data.

sap.ui.mdc.ValueHelpDelegate.checkBindingsPending

Checks if at least one PropertyBinding is waiting for an update. As long as the value has not been set for PropertyBinding, ValueHelp 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.ValueHelpDelegate.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

oListBinding sap.ui.model.ListBinding

ListBinding to check

oListBindingInfo object

ListBindingInfo to check

sap.ui.mdc.ValueHelpDelegate.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

iRequestedItems int

Number of requested items

sap.ui.mdc.ValueHelpDelegate.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.ValueHelpDelegate.isSearchSupported

Checks if a ListBinding supports $Search.

Param Type DefaultValue Description
oPayload object

Payload for delegate

oListBinding sap.ui.model.ListBinding

ListBinding

sap.ui.mdc.ValueHelpDelegate.retrieveContent

Requests the content of the value help.

This function is called when the value help is opened or a key or description is requested.

So, depending on the value help content used, all content controls and data need to be assigned. Once they are assigned and the data is set, the returned Promise needs to be resolved. Only then does the value help continue opening or reading data.

Param Type DefaultValue Description
oPayload object

Payload for delegate

oContainer sap.ui.mdc.valuehelp.base.Container

Container instance