@openui5/sap.f 1.114.0 → 1.115.0

package/src/sap/f/cards/loading/ListPlaceholder.js

@@ -4,9 +4,9 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/ui/core/Control",
-	"sap/ui/core/Core"
-], function (Control, Core) {
+	"sap/f/cards/loading/PlaceholderBase",
+	"./ListPlaceholderRenderer"
+], function (PlaceholderBase, ListPlaceholderRenderer) {
 	"use strict";
 
 	/**
@@ -19,14 +19,14 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.114.0
+	 * @version 1.115.0
 	 *
 	 * @constructor
 	 * @private
 	 * @since 1.76
 	 * @alias sap.f.cards.loading.ListPlaceholder
 	 */
-	var ListPlaceholder = Control.extend("sap.f.cards.loading.ListPlaceholder", {
+	var ListPlaceholder = PlaceholderBase.extend("sap.f.cards.loading.ListPlaceholder", {
 		metadata: {
 			library: "sap.f",
 			properties: {
@@ -51,120 +51,7 @@ sap.ui.define([
 				}
 			}
 		},
-		renderer: {
-			apiVersion: 2,
-			render: function (oRm, oControl) {
-				var iMinItems = oControl.getMinItems(),
-					oItem = oControl.getItem(),
-					// set title for screen reader
-					oResBundle = Core.getLibraryResourceBundle("sap.ui.core"),
-					sTitle = oResBundle.getText("BUSY_TEXT");
-
-				oRm.openStart("div", oControl)
-					.class("sapFCardContentPlaceholder")
-					.class("sapFCardContentListPlaceholder")
-					.attr("tabindex", "0")
-					.attr("title", sTitle);
-
-				oRm.accessibilityState(oControl, {
-					role: "progressbar",
-					valuemin: "0",
-					valuemax: "100"
-				});
-
-				oRm.openEnd();
-
-				for (var i = 0; i < iMinItems; i++) {
-					oRm.openStart("div")
-						.class("sapFCardListPlaceholderItem")
-						.style("height", oControl.getItemHeight())
-						.openEnd();
-
-					if (oItem && oItem.icon) {
-						oRm.openStart("div")
-							.class("sapFCardListPlaceholderImg")
-							.class("sapFCardLoadingShimmer")
-							.openEnd()
-							.close("div");
-					}
-
-					oRm.openStart("div")
-						.class("sapFCardListPlaceholderRows")
-						.openEnd();
-
-					if (oItem) {
-						this.renderTitleAndDescription(oRm, oItem);
-						this.renderAttributes(oRm, oItem);
-
-						if (oItem.chart) {
-							this.renderRow(oRm);
-						}
-
-						if (oItem.actionsStrip) {
-							this.renderRow(oRm);
-						}
-					}
-
-					oRm.close("div");
-					oRm.close("div");
-				}
-				oRm.close("div");
-			},
-
-			renderTitleAndDescription: function (oRm, oItem) {
-				if (oItem.attributes && oItem.title && oItem.description) {
-					this.renderRow(oRm, true);
-					return;
-				}
-
-				if (oItem.title) {
-					this.renderRow(oRm);
-				}
-
-				if (oItem.description) {
-					this.renderRow(oRm);
-				}
-			},
-
-			renderRow: function (oRm, bCombined) {
-				oRm.openStart("div")
-					.class("sapFCardListPlaceholderRow")
-					.class("sapFCardLoadingShimmer");
-
-				if (bCombined) {
-					oRm.class("sapFCardListPlaceholderRowCombined");
-				}
-
-				oRm.openEnd()
-					.close("div");
-			},
-
-			renderAttributes: function (oRm, oItem) {
-				if (!oItem.attributes) {
-					return;
-				}
-
-				var iAttrRows = oItem.attributes.length / 2 + 1;
-
-				for (var j = 0; j < iAttrRows; j++) {
-					oRm.openStart("div")
-						.class("sapFCardListPlaceholderRow")
-						.openEnd();
-
-					var iAttrPerRow = j === iAttrRows - 1 ? 1 : 2; // render single attribute on the last row
-
-					for (var i = 0; i < iAttrPerRow; i++) {
-						oRm.openStart("div")
-							.class("sapFCardListPlaceholderAttr")
-							.class("sapFCardLoadingShimmer")
-							.openEnd()
-							.close("div");
-					}
-					oRm.close("div");
-				}
-
-			}
-		}
+		renderer: ListPlaceholderRenderer
 	});
 
 	return ListPlaceholder;

package/src/sap/f/cards/loading/ListPlaceholderRenderer.js

@@ -0,0 +1,131 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define(["sap/ui/core/Renderer", "./PlaceholderBaseRenderer"], function(Renderer, PlaceholderBaseRenderer) {
+	"use strict";
+
+	/**
+	 * ListPlaceholderRenderer renderer.
+	 * @namespace
+	 */
+	var ListPlaceholderRenderer = Renderer.extend(PlaceholderBaseRenderer);
+
+	ListPlaceholderRenderer.apiVersion = 2;
+
+	/**
+	 * CSS class to be applied to the HTML root element of the placeholder.
+	 *
+	 * @type {string}
+	 */
+	ListPlaceholderRenderer.CSS_CLASS_PLACEHOLDER = "sapFCardContentListPlaceholder";
+
+	ListPlaceholderRenderer.renderTitleAndDescription = function(oRm, oItem) {
+		if (oItem.attributes && oItem.title && oItem.description) {
+			this.renderRow(oRm, true);
+			return;
+		}
+
+		if (oItem.title) {
+			this.renderRow(oRm);
+		}
+
+		if (oItem.description) {
+			this.renderRow(oRm);
+		}
+	};
+
+	ListPlaceholderRenderer.renderRow = function (oRm, bCombined) {
+		oRm.openStart("div")
+			.class("sapFCardListPlaceholderRow")
+			.class("sapFCardLoadingShimmer");
+
+		if (bCombined) {
+			oRm.class("sapFCardListPlaceholderRowCombined");
+		}
+
+		oRm.openEnd()
+			.close("div");
+	};
+
+	ListPlaceholderRenderer.renderAttributes = function (oRm, oItem) {
+		if (!oItem.attributes) {
+			return;
+		}
+
+		var iAttrRows = oItem.attributes.length / 2 + 1;
+
+		for (var j = 0; j < iAttrRows; j++) {
+			oRm.openStart("div")
+				.class("sapFCardListPlaceholderRow")
+				.openEnd();
+
+			var iAttrPerRow = j === iAttrRows - 1 ? 1 : 2; // render single attribute on the last row
+
+			for (var i = 0; i < iAttrPerRow; i++) {
+				oRm.openStart("div")
+					.class("sapFCardListPlaceholderAttr")
+					.class("sapFCardLoadingShimmer")
+					.openEnd()
+					.close("div");
+			}
+			oRm.close("div");
+		}
+
+	};
+
+	ListPlaceholderRenderer.renderContent = function(oControl, oRm) {
+
+		var iMinItems = oControl.getMinItems(),
+			oItem = oControl.getItem();
+
+		for (var i = 0; i < iMinItems; i++) {
+			oRm.openStart("div")
+				.class("sapFCardListPlaceholderItem")
+				.style("height", oControl.getItemHeight())
+				.openEnd();
+
+			if (oItem && oItem.icon) {
+				oRm.openStart("div")
+					.class("sapFCardListPlaceholderImg")
+					.class("sapFCardLoadingShimmer")
+					.openEnd()
+					.close("div");
+			}
+
+			oRm.openStart("div")
+				.class("sapFCardListPlaceholderRows")
+				.openEnd();
+			//debugger
+			if (oItem) {
+				this.renderTitleAndDescription(oRm, oItem);
+				this.renderAttributes(oRm, oItem);
+
+				if (oItem.chart) {
+					this.renderRow(oRm);
+				}
+
+				if (oItem.actionsStrip) {
+					this.renderRow(oRm);
+				}
+			}
+
+			oRm.close("div");
+			oRm.close("div");
+		}
+
+	};
+
+	ListPlaceholderRenderer.addOuterAttributes = function(oControl, oRm) {
+
+		PlaceholderBaseRenderer.addOuterAttributes.apply(this, arguments);
+
+		oRm.class(ListPlaceholderRenderer.CSS_CLASS_PLACEHOLDER);
+
+	};
+
+	return ListPlaceholderRenderer;
+
+}, /* bExport= */ true);

package/src/sap/f/cards/loading/ObjectPlaceholder.js

@@ -4,13 +4,13 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/ui/core/Control",
-	"sap/ui/core/Core",
+	"sap/f/cards/loading/PlaceholderBase",
+	"./ObjectPlaceholderRenderer",
 	"sap/ui/core/ResizeHandler",
 	"sap/ui/dom/units/Rem"
 ], function (
-	Control,
-	Core,
+	PlaceholderBase,
+	ObjectPlaceholderRenderer,
 	ResizeHandler,
 	Rem
 ) {
@@ -29,14 +29,14 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.114.0
+	 * @version 1.115.0
 	 *
 	 * @constructor
 	 * @private
 	 * @since 1.104
 	 * @alias sap.f.cards.loading.ObjectPlaceholder
 	 */
-	var ObjectPlaceholder = Control.extend("sap.f.cards.loading.ObjectPlaceholder", {
+	var ObjectPlaceholder = PlaceholderBase.extend("sap.f.cards.loading.ObjectPlaceholder", {
 		metadata: {
 			library: "sap.f",
 			properties: {
@@ -54,56 +54,7 @@ sap.ui.define([
 				}
 			}
 		},
-		renderer: {
-			apiVersion: 2,
-			render: function (oRm, oObjectPlaceholder) {
-				var oResBundle = Core.getLibraryResourceBundle("sap.ui.core"),
-					sTitle = oResBundle.getText("BUSY_TEXT");
-
-				oRm.openStart("div", oObjectPlaceholder)
-					.class("sapFCardContentPlaceholder")
-					.class("sapFCardContentObjectPlaceholder")
-					.attr("tabindex", "0")
-					.attr("title", sTitle);
-
-				oRm.accessibilityState(oObjectPlaceholder, {
-					role: "progressbar",
-					valuemin: "0",
-					valuemax: "100"
-				});
-				oRm.openEnd();
-
-				for (var i = 0; i < oObjectPlaceholder._iColsCnt; i++) {
-					this.renderColumn(oRm, oObjectPlaceholder._iRowsCnt);
-				}
-
-				oRm.close("div");
-			},
-			renderColumn: function (oRm, iRowsCnt) {
-				oRm.openStart("div")
-					.class("sapFCardObjectPlaceholderColumn")
-					.openEnd();
-
-				for (var i = 0; i < iRowsCnt; i++) {
-					this.renderRow(oRm, "First", false);
-					this.renderRow(oRm, "Second", i === iRowsCnt);
-				}
-
-				oRm.close("div");
-			},
-			renderRow: function (oRm, sRow, bLastInColumn) {
-				oRm.openStart("div")
-					.class("sapFCardLoadingShimmer")
-					.class("sapFCardObjectPlaceholderGroup" + sRow + "Row");
-
-				if (bLastInColumn) {
-					oRm.class("sapFCardObjectPlaceholderGroupLastRow");
-				}
-
-				oRm.openEnd()
-					.close("div");
-			}
-		}
+		renderer: ObjectPlaceholderRenderer
 	});
 
 	ObjectPlaceholder.prototype.init = function () {

package/src/sap/f/cards/loading/ObjectPlaceholderRenderer.js

@@ -0,0 +1,67 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define(["sap/ui/core/Renderer", "./PlaceholderBaseRenderer"], function(Renderer, PlaceholderBaseRenderer) {
+	"use strict";
+
+	/**
+	 * ObjectPlaceholderRenderer renderer.
+	 * @namespace
+	 */
+	var ObjectPlaceholderRenderer = Renderer.extend(PlaceholderBaseRenderer);
+
+	ObjectPlaceholderRenderer.apiVersion = 2;
+
+	/**
+	 * CSS class to be applied to the HTML root element of the placeholder.
+	 *
+	 * @type {string}
+	 */
+	ObjectPlaceholderRenderer.CSS_CLASS_PLACEHOLDER = "sapFCardContentObjectPlaceholder";
+
+	ObjectPlaceholderRenderer.renderColumn = function(oRm, iRowsCnt) {
+		oRm.openStart("div")
+			.class("sapFCardObjectPlaceholderColumn")
+			.openEnd();
+
+		for (var i = 0; i < iRowsCnt; i++) {
+			this.renderRow(oRm, "First", false);
+			this.renderRow(oRm, "Second", i === iRowsCnt);
+		}
+
+		oRm.close("div");
+	};
+
+	ObjectPlaceholderRenderer.renderRow = function(oRm, sRow, bLastInColumn) {
+		oRm.openStart("div")
+			.class("sapFCardLoadingShimmer")
+			.class("sapFCardObjectPlaceholderGroup" + sRow + "Row");
+
+		if (bLastInColumn) {
+			oRm.class("sapFCardObjectPlaceholderGroupLastRow");
+		}
+
+		oRm.openEnd()
+			.close("div");
+	};
+
+	ObjectPlaceholderRenderer.renderContent = function(oControl, oRm) {
+		for (var i = 0; i < oControl._iColsCnt; i++) {
+			this.renderColumn(oRm, oControl._iRowsCnt);
+		}
+	};
+
+	ObjectPlaceholderRenderer.addOuterAttributes = function(oControl, oRm) {
+
+		PlaceholderBaseRenderer.addOuterAttributes.apply(this, arguments);
+
+		oRm.class(ObjectPlaceholderRenderer.CSS_CLASS_PLACEHOLDER);
+
+	};
+
+	return ObjectPlaceholderRenderer;
+
+}, /* bExport= */ true);

package/src/sap/f/cards/loading/PlaceholderBase.js

@@ -0,0 +1,58 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/ui/core/Control",
+	"sap/ui/core/Core",
+	"sap/f/cards/loading/PlaceholderBaseRenderer"
+], function (Control, Core, PlaceholderBaseRenderer) {
+	"use strict";
+
+
+	/**
+	 * Constructor for a new <code>PlaceholderBase</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
+	 * The <code>PlaceholderBase</code> control provides a base for all placeholder types.
+	 *
+	 * @extends sap.ui.core.Control
+	 *
+	 * @author SAP SE
+	 * @version 1.115.0
+	 *
+	 * @constructor
+	 * @private
+	 * @since 1.115.0
+	 * @alias sap.f.cards.loading.PlaceholderBase
+	 */
+	var PlaceholderBase = Control.extend("sap.f.cards.loading.PlaceholderBase", /** @lends sap.f.cards.loading.PlaceholderBase.prototype */ {
+		metadata: {
+
+			library: "sap.f",
+			properties: {
+
+				/**
+				 * Indicates whether the tooltip will be rendered by subclasses
+				 * @public
+				 */
+				renderTooltip: { type: "boolean", defaultValue: true },
+
+				/**
+				 * Indicates whether the card has any content
+				 * @private
+				 */
+				hasContent: { type: "boolean", defaultValue: true}
+			}
+		},
+
+		renderer: PlaceholderBaseRenderer
+	});
+
+	return PlaceholderBase;
+
+});

package/src/sap/f/cards/loading/PlaceholderBaseRenderer.js

@@ -0,0 +1,79 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define(["sap/ui/core/Core"], function(Core) {
+	"use strict";
+
+	/**
+	 * PlaceholderBase renderer.
+	 *
+	 * @namespace
+	 * @alias sap.f.cards.loading.PlaceholderBaseRenderer
+	 * @static
+	 * @protected
+	 */
+	var PlaceholderBaseRenderer = {
+		apiVersion: 2
+	};
+
+	/**
+	 * Renders the HTML for the given control, using the provided {@link sap.ui.core.RenderManager}.
+	 *
+	 * @param {sap.ui.core.RenderManager} oRm The RenderManager that can be used for writing to the render output buffer.
+	 * @param {sap.f.cards.loading.PlaceholderBase} oControl An object representation of the control that should be rendered.
+	 */
+	PlaceholderBaseRenderer.render = function(oRm, oControl) {
+		var oResBundle = Core.getLibraryResourceBundle("sap.ui.core"),
+			sTitle = oResBundle.getText("BUSY_TEXT");
+
+		if (!oControl.getHasContent()) {
+			return;
+		}
+
+		oRm.openStart("div", oControl)
+			.class("sapFCardContentPlaceholder")
+			.attr("tabindex", "0");
+		this.addOuterAttributes(oControl, oRm);
+
+		if (oControl.getRenderTooltip()) {
+			oRm.attr("title", sTitle);
+		}
+
+		oRm.accessibilityState(oControl, {
+			role: "progressbar",
+			valuemin: "0",
+			valuemax: "100"
+		});
+		oRm.openEnd();
+
+		this.renderContent(oControl, oRm);
+
+		oRm.close("div");
+	};
+
+	/**
+	 * This method is reserved for derived classes to add their respective attributes.
+	 *
+	 * @protected
+	 * @param {sap.f.cards.loading.PlaceholderBase} oControl An object representation of the control that should be rendered.
+	 * @param {sap.ui.core.RenderManager} oRm The RenderManager that can be used for writing to the render output buffer.
+	 */
+	PlaceholderBaseRenderer.addOuterAttributes = function(oControl, oRm) {
+	};
+
+	/**
+	 * This method is reserved for derived classes to render their respective content.
+	 *
+	 * @protected
+	 * @param {sap.f.cards.loading.PlaceholderBase} oControl An object representation of the control that should be rendered.
+	 * @param {sap.ui.core.RenderManager} oRm The RenderManager that can be used for writing to the render output buffer.
+	 */
+	PlaceholderBaseRenderer.renderContent = function(oControl, oRm) {
+	};
+
+	return PlaceholderBaseRenderer;
+
+}, /* bExport= */ true);

package/src/sap/f/cards/loading/TablePlaceholder.js

@@ -4,9 +4,9 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/ui/core/Control",
-	"sap/ui/core/Core"
-], function (Control, Core) {
+	"sap/f/cards/loading/PlaceholderBase",
+	"./TablePlaceholderRenderer"
+], function (PlaceholderBase, TablePlaceholderRenderer) {
 	"use strict";
 
 	/**
@@ -19,14 +19,14 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.114.0
+	 * @version 1.115.0
 	 *
 	 * @constructor
 	 * @private
 	 * @since 1.104
 	 * @alias sap.f.cards.loading.TablePlaceholder
 	 */
-	var TablePlaceholder = Control.extend("sap.f.cards.loading.TablePlaceholder", {
+	var TablePlaceholder = PlaceholderBase.extend("sap.f.cards.loading.TablePlaceholder", {
 		metadata: {
 			library: "sap.f",
 			properties: {
@@ -49,60 +49,7 @@ sap.ui.define([
 				}
 			}
 		},
-		renderer: {
-			apiVersion: 2,
-			render: function (oRm, oControl) {
-				var iMinItems = oControl.getMinItems(),
-					iColumns = oControl.getColumns(),
-					bHasActualContent = oControl.getParent()._getTable().getColumns().length,
-					// set title for screen reader
-					oResBundle = Core.getLibraryResourceBundle("sap.ui.core"),
-					sTitle = oResBundle.getText("BUSY_TEXT");
-
-				if (!bHasActualContent) {
-					return;
-				}
-
-				oRm.openStart("div", oControl)
-					.class("sapFCardContentPlaceholder")
-					.class("sapFCardContentTablePlaceholder")
-					.attr("tabindex", "0")
-					.attr("title", sTitle);
-
-				oRm.accessibilityState(oControl, {
-					role: "progressbar",
-					valuemin: "0",
-					valuemax: "100"
-				});
-
-				oRm.openEnd();
-
-				for (var i = 0; i < iMinItems + 1; i++) { // number of rows + header
-					oRm.openStart("div")
-						.class("sapFCardTablePlaceholderItem")
-						.style("height", oControl.getItemHeight())
-						.openEnd();
-
-					oRm.openStart("div")
-						.class("sapFCardTablePlaceholderRows")
-						.openEnd();
-
-						if (iColumns > 1) {
-							for (var j = 0; j < iColumns; j++) {
-								oRm.openStart("div")
-								.class("sapFCardTablePlaceholderColumns")
-								.class("sapFCardLoadingShimmer")
-								.openEnd();
-								oRm.close("div");
-							}
-						}
-
-					oRm.close("div");
-					oRm.close("div");
-				}
-				oRm.close("div");
-			}
-		}
+		renderer: TablePlaceholderRenderer
 	});
 
 	return TablePlaceholder;