Namespace contract.configurationUi

The namespace for the contract interface (to be used by a page builder) for the configurationUi contract, which allows you to use a CHIP-specific configuration UI with all related functionality.
Defined in: configurationUi.js.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	contract.configurationUi

Method Summary
Method Attributes	Method Name and Description
<static>	contract.configurationUi.attachDisplay(fnEventHandler) Attaches the given event handler to the "display" event which is fired by the CHIP instance whenever the user has triggered configuration of this CHIP.
<static>	contract.configurationUi.fireCancel() Fires the "cancel" event on this CHIP instance's configuration UI.
<static>	contract.configurationUi.fireSave() Fires the "save" event on this CHIP instance's configuration UI.
<static>	contract.configurationUi.getUi(mParameters) Returns this CHIP's configuration UI, if available.
<static>	contract.configurationUi.isDirty() Tells whether this CHIP's configuration UI is currently in a "dirty" state (contains unsaved changes).
<static>	contract.configurationUi.setEnabled(bNewEnabled) Determines whether this CHIP instance's configuration UI is enabled by the page builder.

Namespace Detail

contract.configurationUi

Since:: 1.11.0

Method Detail

<static> contract.configurationUi.attachDisplay(fnEventHandler)

Attaches the given event handler to the "display" event which is fired by the CHIP instance whenever the user has triggered configuration of this CHIP.

Parameters:
{function} fnEventHandler: the event handler for the "display" event

Since:: 1.11.0

See:: chip.configurationUi.display

<static> contract.configurationUi.fireCancel()

Fires the "cancel" event on this CHIP instance's configuration UI.

Since:: 1.11.0

See:: chip.configurationUi.attachCancel

<static> {object} contract.configurationUi.fireSave()

Fires the "save" event on this CHIP instance's configuration UI.

Since:: 1.11.0

Returns:: {object} a jQuery.Deferred object's promise as returned by the "save" event handler

See:: chip.configurationUi.attachSave

<static> {sap.ui.core.Control} contract.configurationUi.getUi(mParameters)

Returns this CHIP's configuration UI, if available.

Parameters:
{map <string|string>} mParameters Optional: Since 1.21.0 an optional parameter map can be passed to the UI provider. This map can be used for example to pass default configuration values to the UI.

Since:: 1.11.0

Returns:: {sap.ui.core.Control} this CHIP's configuration UI or undefined

See:: chip.configurationUi.setUiProvider

<static> {boolean} contract.configurationUi.isDirty()

Tells whether this CHIP's configuration UI is currently in a "dirty" state (contains unsaved changes).

Since:: 1.11.0

Returns:: {boolean} whether this CHIP's configuration UI is currently in a "dirty" state; returns undefined in case the CHIP instance has not set a corresponding provider function

See:: chip.configurationUi.setDirtyProvider

<static> contract.configurationUi.setEnabled(bNewEnabled)

Determines whether this CHIP instance's configuration UI is enabled by the page builder. Note: Changing this setting after getImplementationAsSapui5() has been called violates the contract of chip.configurationUi.isEnabled()!

Parameters:
{boolean} bNewEnabled: whether this CHIP instance's configuration UI is enabled by the page builder

Since:: 1.11.0

See:: sap.ui2.srvc.ChipInstance#getImplementationAsSapui5(); chip.configurationUi.isEnabled

Classes

Namespace contract.configurationUi