class sap.ui.mdc.p13n.Engine

Control sample: sap.ui.mdc.p13n.Engine
Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/mdc/p13n/Engine
Application Component: CA-UI5-MDC

Constructor

Constructor for a new Engine. The Engine should always be accessed via 'getInstance' and not by creating a new instance of it. The class should only be used to create derivations.

new sap.ui.mdc.p13n.Engine()

Methods Overview

Method Description
createChanges

Engine#createChanges can be used to programmatically trigger the creation of a set of changes based on the current control state and the provided state.

enhanceXConfig

Enhances the xConfig object by using the ModificationHandler

sap.ui.mdc.p13n.Engine.extend

Creates a new subclass of class sap.ui.mdc.p13n.Engine 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.base.Object.extend.

sap.ui.mdc.p13n.Engine.getInstance
sap.ui.mdc.p13n.Engine.getMetadata

Returns a metadata object for class sap.ui.mdc.p13n.Engine.

getModificationHandler

This method can be used to get the modification handling for a control instance

getRTASettingsActionHandler

This method can be used in the control's according designtime metadata for keyuser personalization.

registerAdaptation

This method should only be called once per instance to register provided classes of sap.ui.mdc.p13n.Controller for the control instance

reset

This method can be used to trigger a reset on the provided control instance.

retrieveState

Retrieves the externalized state for a given control instance. The retrieved state is equivalent to the "getCurrentState" API for the given Control, after all necessary changes have been applied (e.g. variant appliance and P13n/StateUtil changes). After the returned Promise has been resolved, the returned State is in sync with the according state object of the MDC control (for example "filterConditions" for the FilterBar).

createChanges

Engine#createChanges can be used to programmatically trigger the creation of a set of changes based on the current control state and the provided state.

Param Type DefaultValue Description
mDiffParameters object

A map defining the configuration to create the changes.

control sap.ui.mdc.Control

The control instance tht should be adapted.

key string

The key used to retrieve the corresponding Controller.

state object

The state which should be applied on the provided control instance

applyAbsolute boolean

Decides whether unmentioned entries should be affected, for example if "A" is existing in the control state, but not mentioned in the new state provided in the mDiffParameters.state then the absolute appliance decides whether to remove "A" or to keep it.

suppressAppliance boolean

Decides whether the change should be applied directly. Controller

enhanceXConfig

Enhances the xConfig object by using the ModificationHandler

Param Type DefaultValue Description
vControl sap.ui.mdc.Control

The registered control instance.

mEnhanceConfig object

An object providing the information about the xConfig enhancement

name object

The affected property name

controlMeta object

Object describing which config is affected

aggregation object

The affected aggregation name (such as columns or filterItems)

property object

The affected property name (such as width or lable)

value object

The value that should be written in the xConfig

propertyBag object

Optional propertybag for the ModificationHandler

sap.ui.mdc.p13n.Engine.extend

Creates a new subclass of class sap.ui.mdc.p13n.Engine 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.base.Object.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

sap.ui.mdc.p13n.Engine.getInstance

sap.ui.mdc.p13n.Engine.getMetadata

Returns a metadata object for class sap.ui.mdc.p13n.Engine.

getModificationHandler

This method can be used to get the modification handling for a control instance

Param Type DefaultValue Description
vControl sap.ui.mdc.Control

getRTASettingsActionHandler

This method can be used in the control's according designtime metadata for keyuser personalization.

Param Type DefaultValue Description
oControl sap.ui.mdc.Control

The registered control instance.

mPropertyBag object

The propertybag provided in the settings action.

aKeys string

The keys to be used to display in the corresponding Controller

registerAdaptation

This method should only be called once per instance to register provided classes of sap.ui.mdc.p13n.Controller for the control instance

Param Type DefaultValue Description
oControl sap.ui.mdc.Control

The control insance to be registered for adaptation

oConfig Object

The config object providing key value pairs of keys and sap.ui.mdc.p13n.Controller classes.

reset

This method can be used to trigger a reset on the provided control instance.

Param Type DefaultValue Description
oControl sap.ui.mdc.Control

The according control instance.

aKeys string

The key for the affected config.

retrieveState

Retrieves the externalized state for a given control instance. The retrieved state is equivalent to the "getCurrentState" API for the given Control, after all necessary changes have been applied (e.g. variant appliance and P13n/StateUtil changes). After the returned Promise has been resolved, the returned State is in sync with the according state object of the MDC control (for example "filterConditions" for the FilterBar).

Param Type DefaultValue Description
oControl object

The control instance implementing IxState to retrieve the externalized state