abstract class sap.ui.mdc.Control

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

The base class for MDC controls providing delegate-related functionality (see sap.ui.mdc.mixin.DelegateMixin).


Constructor

Creates and initializes a new MDC control with the given sId and settings.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.mdc.Control(sId?, mSettings?)
Param Type Default Value Description
sId? string

Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be omitted, no matter whether mSettings will be given or not!

mSettings? object

Object with initial settings for the new control


Properties

Name Type Default Value Description
delegate object

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

Visibility: public

Methods Overview

Method Description
sap.ui.mdc.Control.awaitControlDelegate

Provides access to the delegate initialization Promise. Note: initControlDelegate must be called to start the delegate initialization

sap.ui.mdc.Control.awaitPropertyHelper

Provides access to the property helper initialization Promise.

sap.ui.mdc.Control.extend

Creates a new subclass of class sap.ui.mdc.Control 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.core.Control.extend.

sap.ui.mdc.Control.getControlDelegate

Returns the delegate instance, if available.

getDelegate

Gets current value of property delegate.

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

sap.ui.mdc.Control.getMetadata

Returns a metadata object for class sap.ui.mdc.Control.

sap.ui.mdc.Control.getPayload

Returns the payload object set for the delegate property.

sap.ui.mdc.Control.getPropertyHelper

Returns the property helper instance, if available.

sap.ui.mdc.Control.getTypeUtil

Returns the typeUtil made available by a delegate module.

sap.ui.mdc.Control.initControlDelegate

Loads and initializes the delegate module related to the enhanced control.

sap.ui.mdc.Control.initPropertyHelper

Loads and initializes the property helper related to the enhanced control.

setDelegate

Sets a new value for property delegate.

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

When called with a value of null or undefined, the default value of the property will be restored.

sap.ui.mdc.Control.awaitControlDelegate

Provides access to the delegate initialization Promise. Note: initControlDelegate must be called to start the delegate initialization

sap.ui.mdc.Control.awaitPropertyHelper

Provides access to the property helper initialization Promise.

sap.ui.mdc.Control.extend

Creates a new subclass of class sap.ui.mdc.Control 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.core.Control.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.Control.getControlDelegate

Returns the delegate instance, if available.

getDelegate

Gets current value of property delegate.

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

sap.ui.mdc.Control.getMetadata

Returns a metadata object for class sap.ui.mdc.Control.

sap.ui.mdc.Control.getPayload

Returns the payload object set for the delegate property.

sap.ui.mdc.Control.getPropertyHelper

Returns the property helper instance, if available.

sap.ui.mdc.Control.getTypeUtil

Returns the typeUtil made available by a delegate module.

sap.ui.mdc.Control.initControlDelegate

Loads and initializes the delegate module related to the enhanced control.

Param Type DefaultValue Description
oPreloadedModule object

Preloaded delegate module

sap.ui.mdc.Control.initPropertyHelper

Loads and initializes the property helper related to the enhanced control.

Param Type DefaultValue Description
CustomPropertyHelper sap.ui.mdc.util.PropertyHelper

Custom property helper class

setDelegate

Sets a new value for property delegate.

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oDelegate object

New value for property delegate