@openui5/sap.m 1.96.2 → 1.98.0

package/src/sap/m/IllustratedMessageSize.js

@@ -0,0 +1,64 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([], function() {
+	"use strict";
+
+	/**
+	 * Available <code>Illustration</code> sizes for the {@link sap.m.IllustratedMessage} control.
+	 *
+	 * @enum {string}
+	 * @public
+	 * @alias sap.m.IllustratedMessageSize
+	 * @since 1.98
+	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
+	 */
+	var IllustratedMessageSize = {
+
+		/**
+		 * Automatically decides the <code>Illustration</code> size (<code>Base</code>, <code>Spot</code>,
+		 * <code>Dialog</code>, or <code>Scene</code>) depending on the <code>IllustratedMessage</code> container width.
+		 *
+		 * <b>Note:</b> <code>Auto</code> is the only option where the illustration size is changed according to
+		 * the available container width. If any other <code>IllustratedMessageSize</code> is chosen, it remains
+		 * until changed by the app developer.
+		 *
+		 * @public
+		 */
+		Auto : "Auto",
+
+		/**
+		 * Base <code>Illustration</code> size (XS breakpoint). Suitable for cards (two columns).
+		 *
+		 * <b>Note:</b> When <code>Base</code> is in use, no illustration is displayed.
+		 *
+		 * @public
+		 */
+		Base : "Base",
+
+		/**
+		 * Spot <code>Illustration</code> size (S breakpoint). Suitable for cards (four columns).
+		 * @public
+		 */
+		Spot : "Spot",
+
+		/**
+		 * Dialog <code>Illustration</code> size (M breakpoint). Suitable for dialogs.
+		 * @public
+		 */
+		Dialog : "Dialog",
+
+		/**
+		 * Scene <code>Illustration</code> size (L breakpoint). Suitable for a <code>Page</code> or a table.
+		 * @public
+		 */
+		Scene : "Scene"
+	};
+
+	return IllustratedMessageSize;
+});
+
+

package/src/sap/m/IllustratedMessageType.js

@@ -0,0 +1,319 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([], function() {
+	"use strict";
+
+	/**
+	 * Available <code>Illustration</code> types for the {@link sap.f.IllustratedMessage} control.
+	 *
+	 * @enum {string}
+	 * @public
+	 * @alias sap.m.IllustratedMessageType
+	 * @since 1.98
+	 * @ui5-metamodel This enumeration also will be described in the UI5 (legacy) designtime metamodel
+	 */
+	var IllustratedMessageType = {
+
+		/**
+		 * "Before Search" illustration type.
+		 * @public
+		 */
+		BeforeSearch: "sapIllus-BeforeSearch",
+
+		/**
+		 * "No Activities" illustration type.
+		 * @public
+		 */
+		NoActivities: "sapIllus-NoActivities",
+
+		/**
+		 * "No Data" illustration type.
+		 * @public
+		 */
+		NoData: "sapIllus-NoData",
+
+		/**
+		 * "No Email" illustration type.
+		 * @public
+		 */
+		NoMail: "sapIllus-NoMail",
+
+		/**
+		 * "No Email v1" illustration type.
+		 * @public
+		 */
+		NoMailV1: "sapIllus-NoMail_v1",
+
+		/**
+		 * "No Entries" illustration type.
+		 * @public
+		 */
+		NoEntries: "sapIllus-NoEntries",
+
+		/**
+		 * "No Notifications" illustration type.
+		 * @public
+		 */
+		NoNotifications: "sapIllus-NoNotifications",
+
+		/**
+		 * "No Saved Items" illustration type.
+		 * @public
+		 */
+		NoSavedItems: "sapIllus-NoSavedItems",
+
+		/**
+		 * "No Saved Items v1" illustration type.
+		 * @public
+		 */
+		NoSavedItemsV1: "sapIllus-NoSavedItems_v1",
+
+		/**
+		 * "No Search Results" illustration type.
+		 * @public
+		 */
+		NoSearchResults: "sapIllus-NoSearchResults",
+
+		/**
+		 * "No Tasks" illustration type.
+		 * @public
+		 */
+		NoTasks: "sapIllus-NoTasks",
+
+		/**
+		 * "No Tasks v1" illustration type.
+		 * @public
+		 */
+		NoTasksV1: "sapIllus-NoTasks_v1",
+
+		/**
+		 * "Unable To Load" illustration type.
+		 * @public
+		 */
+		UnableToLoad: "sapIllus-UnableToLoad",
+
+		/**
+		 * "Unable To Upload" illustration type.
+		 * @public
+		 */
+		UnableToUpload: "sapIllus-UnableToUpload",
+
+		/**
+		 * "Add Column" illustration type.
+		 * @public
+		 */
+		AddColumn: "sapIllus-AddColumn",
+
+		/**
+		 * "Add People" illustration type.
+		 * @public
+		 */
+		AddPeople: "sapIllus-AddPeople",
+
+		/**
+		 * "Balloon Sky" illustration type.
+		 * @public
+		 */
+		BalloonSky: "sapIllus-BalloonSky",
+
+		/**
+		 * "Connection" illustration type.
+		 * @public
+		 */
+		Connection: "sapIllus-Connection",
+
+		/**
+		 * "Empty Calendar" illustration type.
+		 * @public
+		 */
+		EmptyCalendar: "sapIllus-EmptyCalendar",
+
+		/**
+		 * "Empty List" illustration type.
+		 * @public
+		 */
+		EmptyList: "sapIllus-EmptyList",
+
+		/**
+		 * "Empty Planning Calendar" illustration type.
+		 * @public
+		 */
+		EmptyPlanningCalendar: "sapIllus-EmptyPlanningCalendar",
+
+		/**
+		 * "Error Screen" illustration type.
+		 * @public
+		 */
+		ErrorScreen: "sapIllus-ErrorScreen",
+
+		/**
+		 * "Filter Table" illustration type.
+		 * @public
+		 */
+		FilterTable: "sapIllus-FilterTable",
+
+		/**
+		 * "Group Table" illustration type.
+		 * @public
+		 */
+		GroupTable: "sapIllus-GroupTable",
+
+		/**
+		 * "No Filter Results" illustration type.
+		 * @public
+		 */
+		NoFilterResults: "sapIllus-NoFilterResults",
+
+		/**
+		 * "Page Not Found" illustration type.
+		 * @public
+		 */
+		PageNotFound: "sapIllus-PageNotFound",
+
+		/**
+		 * "Reload Screen" illustration type.
+		 * @public
+		 */
+		ReloadScreen: "sapIllus-ReloadScreen",
+
+		/**
+		 * "Resize Column" illustration type.
+		 * @public
+		 */
+		ResizeColumn: "sapIllus-ResizeColumn",
+
+		/**
+		 * "Search Earth" illustration type.
+		 * @public
+		 */
+		SearchEarth: "sapIllus-SearchEarth",
+
+		/**
+		 * "Search Folder" illustration type.
+		 * @public
+		 */
+		SearchFolder: "sapIllus-SearchFolder",
+
+		/**
+		 * "Simple Balloon" illustration type.
+		 * @public
+		 */
+		SimpleBalloon: "sapIllus-SimpleBalloon",
+
+		/**
+		 * "Simple Bell" illustration type.
+		 * @public
+		 */
+		SimpleBell: "sapIllus-SimpleBell",
+
+		/**
+		 * "Simple Calendar" illustration type.
+		 * @public
+		 */
+		SimpleCalendar: "sapIllus-SimpleCalendar",
+
+		/**
+		 * "Simple Checkmark" illustration type.
+		 * @public
+		 */
+		SimpleCheckmark: "sapIllus-SimpleCheckmark",
+
+		/**
+		 * "Simple Connection" illustration type.
+		 * @public
+		 */
+		SimpleConnection: "sapIllus-SimpleConnection",
+
+		/**
+		 * "Simple Empty Doc" illustration type.
+		 * @public
+		 */
+		SimpleEmptyDoc: "sapIllus-SimpleEmptyDoc",
+
+		/**
+		 * "Simple Empty List" illustration type.
+		 * @public
+		 */
+		SimpleEmptyList: "sapIllus-SimpleEmptyList",
+
+		/**
+		 * "Simple Error" illustration type.
+		 * @public
+		 */
+		SimpleError: "sapIllus-SimpleError",
+
+		/**
+		 * "Simple Magnifier" illustration type.
+		 * @public
+		 */
+		SimpleMagnifier: "sapIllus-SimpleMagnifier",
+
+		/**
+		 * "Simple Mail" illustration type.
+		 * @public
+		 */
+		SimpleMail: "sapIllus-SimpleMail",
+
+		/**
+		 * "Simple No Saved Items" illustration type.
+		 * @public
+		 */
+		SimpleNoSavedItems: "sapIllus-SimpleNoSavedItems",
+
+		/**
+		 * "Simple Not Found Magnifier" illustration type.
+		 * @public
+		 */
+		SimpleNotFoundMagnifier: "sapIllus-SimpleNotFoundMagnifier",
+
+		/**
+		 * "Simple Reload" illustration type.
+		 * @public
+		 */
+		SimpleReload: "sapIllus-SimpleReload",
+
+		/**
+		 * "Simple Task" illustration type.
+		 * @public
+		 */
+		SimpleTask: "sapIllus-SimpleTask",
+
+		/**
+		 * "Sleeping Bell" illustration type.
+		 * @public
+		 */
+		SleepingBell: "sapIllus-SleepingBell",
+
+		/**
+		 * "Sort Column" illustration type.
+		 * @public
+		 */
+		SortColumn: "sapIllus-SortColumn",
+
+		/**
+		 * "Success Screen" illustration type.
+		 * @public
+		 */
+		SuccessScreen: "sapIllus-SuccessScreen",
+
+		/**
+		 * "Tent" illustration type.
+		 * @public
+		 */
+		Tent: "sapIllus-Tent",
+
+		/**
+		 * "Upload Collection" illustration type.
+		 * @public
+		 */
+		UploadCollection: "sapIllus-UploadCollection"
+
+	};
+
+	return IllustratedMessageType;
+});
+

package/src/sap/m/Illustration.js

@@ -0,0 +1,117 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 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.98.0
+	 *
+	 * @constructor
+	 * @public
+	 * @since 1.98
+	 * @alias sap.m.Illustration
+	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
+	 */
+	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}
+			},
+			dnd: { draggable: true, droppable: false }
+		}
+	});
+
+	/**
+	 * 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;
+
+});