@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
126 lines (109 loc) • 3.02 kB
JavaScript
/*!
* OpenUI5
* (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
* Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
*/
// Provides control sap.m.Illustration.
sap.ui.define([
"sap/base/Log",
"sap/ui/core/Control",
"./IllustrationRenderer",
"./IllustrationPool"
], function(
Log,
Control,
IllustrationRenderer,
IllustrationPool
) {
"use strict";
/**
* Constructor for a new <code>Illustration</code>.
*
* @param {string} [sId] ID for the new control, generated automatically if no ID is given
* @param {object} [mSettings] Initial settings for the new control
*
* @class
* A simple control which uses a Symbol ID to visualize an SVG
* which has already been loaded in the {@link sap.m.IllustrationPool}.
*
* To build a Symbol ID, all of the <code>Illustration</code> properties must be populated with data.
* @extends sap.ui.core.Control
*
* @author SAP SE
* @version 1.117.4
*
* @constructor
* @public
* @since 1.98
* @alias sap.m.Illustration
*/
var Illustration = Control.extend("sap.m.Illustration", /** @lends sap.m.Illustration.prototype */ {
metadata: {
library: "sap.m",
properties: {
/**
* Defines which illustration set should be used when building the Symbol ID.
*
* @since 1.98
*/
set: {type: "string", defaultValue: null},
/**
* Defines which media/breakpoint should be used when building the Symbol ID.
*
* @since 1.98
*/
media: {type: "string", defaultValue: null},
/**
* Defines which illustration type should be used when building the Symbol ID.
*
* @since 1.98
*/
type: {type: "string", defaultValue: null}
},
associations : {
/**
* Association to controls / IDs which label those controls (see WAI-ARIA attribute aria-labelledBy).
* @since 1.106.0
*/
ariaLabelledBy: {type : "sap.ui.core.Control", multiple : true, singularName : "ariaLabelledBy"}
},
dnd: { draggable: true, droppable: false }
},
renderer: IllustrationRenderer
});
/**
* STATIC MEMBERS
*/
Illustration.CAN_NOT_BUILD_SYMBOL_MSG = "Some of the Control's properties are missing. Can't build Symbol ID. No SVG will be displayed.";
/**
* LIFECYCLE METHODS
*/
Illustration.prototype.init = function() {
this._sId = this.getId();
};
Illustration.prototype.onBeforeRendering = function() {
this._buildSymbolId();
if (this._sSymbolId) {
IllustrationPool.loadAsset(this._sSymbolId, this._sId);
} else {
Log.warning(Illustration.CAN_NOT_BUILD_SYMBOL_MSG);
}
};
/**
* PRIVATE METHODS
*/
/**
* Builds the Symbol ID which will be used for requiring the Illustration asset.
* @private
*/
Illustration.prototype._buildSymbolId = function() {
var sSet = this.getSet(),
sMedia = this.getMedia(),
sType = this.getType();
this._sSymbolId = "";
if (sSet && sMedia && sType) {
this._sSymbolId = sSet + "-" + sMedia + "-" + sType;
}
};
return Illustration;
});