abstract class sap.ui.core.support.Plugin

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/core/support/Plugin
Application Component: CA-UI5-COR

This class represents a plugin for the support tool functionality of UI5. This class is internal and all its functions must not be used by an application.


Constructor

Creates an instance of sap.ui.core.support.Plugin.

new sap.ui.core.support.Plugin()

Methods Overview

Method Description
$

Returns the DOM node that represents this plugin wrapped as jQuery object.

If an ID suffix is given, the ID of this Element is concatenated with the suffix (separated by a single dash) and the DOM node with that compound ID will be wrapped by jQuery. This matches the naming convention for named inner DOM nodes of a plugin.

If no suffix is given and if no DOM exists, a DIV with the ID of this plugin will be created and appended to the support popup content section (identified by class .sapUiSupportCntnt).

addStylesheet

Adds the given stylesheet to the Support Tool's HTML page.

A <link> tag will be added to the head of the HTML page, referring to the given CSS resource. The URL of the resource is determined from the given resource name by calling jQuery.sap.getResourcePath.

A plugin should call this method only when it is running inside the tool window.

exit

Finalization function called each time the support mode is ended (support popup is closed).

sap.ui.core.support.Plugin.extend

Creates a new subclass of class sap.ui.core.support.Plugin 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.

getId

Returns the id of this plugin instance.

sap.ui.core.support.Plugin.getMetadata

Returns a metadata object for class sap.ui.core.support.Plugin.

getTitle

Returns the title of this plugin instance.

init

Initialization function called each time the support mode is started (diagnostics popup is opened). For Plugins that are for diagnostics tool window and application window, the init method is called twice, with the oSupportStub

isActive

Returns whether the plugin is currently active or not.

isAppPlugin

Returns whether this plugin instance can run in the application window, default is true. Plugins that are only available on the diagnostics tool window should return false and overwrite the method for this matter.

The method is also used in a static manner (called on the prototype) and therefore must not rely on any instance specific members.

References:

  • sap.ui.core.support.Support.StubType.APP
  • sap.ui.core.support.Plugin.prototype.init

isToolPlugin

Returns whether a plugin instance can run in the diagnostics tool window, default is true. Plugins that are only available on the application window should return false and overwrite the method for this matter.

The method is also used in a static manner (called on the prototype) and therefore must not rely on any instance specific members.

References:

  • sap.ui.core.support.Support.StubType.TOOL
  • sap.ui.core.support.Plugin.prototype.init

runsAsToolPlugin

Returns true if the plugin instance currently runs in tool window, otherwise false

References:

  • sap.ui.core.support.Plugin.prototype.isToolPlugin
  • sap.ui.core.support.Plugin.prototype.isAppPlugin

$

Returns the DOM node that represents this plugin wrapped as jQuery object.

If an ID suffix is given, the ID of this Element is concatenated with the suffix (separated by a single dash) and the DOM node with that compound ID will be wrapped by jQuery. This matches the naming convention for named inner DOM nodes of a plugin.

If no suffix is given and if no DOM exists, a DIV with the ID of this plugin will be created and appended to the support popup content section (identified by class .sapUiSupportCntnt).

Param Type DefaultValue Description
sSuffix string

ID suffix to get a jQuery object for

addStylesheet

Adds the given stylesheet to the Support Tool's HTML page.

A <link> tag will be added to the head of the HTML page, referring to the given CSS resource. The URL of the resource is determined from the given resource name by calling jQuery.sap.getResourcePath.

A plugin should call this method only when it is running inside the tool window.

Param Type DefaultValue Description
sCssResourcePath string

Resource name of a CSS file, but without the '.css' extension

exit

Finalization function called each time the support mode is ended (support popup is closed).

Param Type DefaultValue Description
oSupportStub sap.ui.core.support.Support

the support stub

sap.ui.core.support.Plugin.extend

Creates a new subclass of class sap.ui.core.support.Plugin 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

getId

Returns the id of this plugin instance.

sap.ui.core.support.Plugin.getMetadata

Returns a metadata object for class sap.ui.core.support.Plugin.

getTitle

Returns the title of this plugin instance.

init

Initialization function called each time the support mode is started (diagnostics popup is opened). For Plugins that are for diagnostics tool window and application window, the init method is called twice, with the oSupportStub

Param Type DefaultValue Description
oSupportStub sap.ui.core.support.Support

the support stub

isActive

Returns whether the plugin is currently active or not.

isAppPlugin

Returns whether this plugin instance can run in the application window, default is true. Plugins that are only available on the diagnostics tool window should return false and overwrite the method for this matter.

The method is also used in a static manner (called on the prototype) and therefore must not rely on any instance specific members.

References:

isToolPlugin

Returns whether a plugin instance can run in the diagnostics tool window, default is true. Plugins that are only available on the application window should return false and overwrite the method for this matter.

The method is also used in a static manner (called on the prototype) and therefore must not rely on any instance specific members.

References:

runsAsToolPlugin

Returns true if the plugin instance currently runs in tool window, otherwise false

References: