class sap.ui.integration.editor.Extension

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/integration/editor/Extension
Application Component: CA-UI5-CTR

Brings JavaScript capabilities for an sap.ui.integration.editor.Editor where custom logic can be implemented.


Constructor

Constructor for a new Extension.

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.integration.editor.Extension(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new extension, generated automatically if no ID is given.

mSettings? object

Initial settings for the new extension.


Properties

Name Type Default Value Description
formatters object

The formatters, which can be used in the manifest.

Visibility: public

Methods Overview

Method Description
sap.ui.integration.editor.Extension.extend

Creates a new subclass of class sap.ui.integration.editor.Extension 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.ManagedObject.extend.

getEditor

Returns an interface to the editor, which uses this extension.

getFormatters

Gets current value of property formatters.

The formatters, which can be used in the manifest.

sap.ui.integration.editor.Extension.getMetadata

Returns a metadata object for class sap.ui.integration.editor.Extension.

onEditorReady

Called when the editor is ready.

sap.ui.integration.editor.Extension.extend

Creates a new subclass of class sap.ui.integration.editor.Extension 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.ManagedObject.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

getEditor

Returns an interface to the editor, which uses this extension.

getFormatters

Gets current value of property formatters.

The formatters, which can be used in the manifest.

sap.ui.integration.editor.Extension.getMetadata

Returns a metadata object for class sap.ui.integration.editor.Extension.

onEditorReady

Called when the editor is ready.