@openui5/sap.ui.integration 1.120.10 → 1.121.1

package/src/sap/ui/integration/controls/ActionsStrip.js

@@ -7,36 +7,47 @@
 sap.ui.define([
 	"../library",
 	"sap/m/library",
-	"sap/ui/core/Core",
+	"sap/ui/core/library",
 	"sap/ui/core/Control",
+	"sap/ui/core/Element",
 	"sap/ui/integration/cards/actions/CardActions",
 	"sap/ui/integration/util/BindingHelper",
+	"sap/ui/integration/util/BindingResolver",
+	"sap/ui/model/json/JSONModel",
 	"sap/m/Button",
 	"sap/ui/integration/controls/LinkWithIcon",
 	"sap/m/OverflowToolbarButton",
 	"sap/m/OverflowToolbar",
 	"sap/m/OverflowToolbarLayoutData",
-	"sap/m/ToolbarSpacer"
+	"sap/m/ToolbarSpacer",
+	"sap/m/Label"
 ], function (
 	library,
 	mLibrary,
-	Core,
+	coreLibrary,
 	Control,
+	Element,
 	CardActions,
 	BindingHelper,
+	BindingResolver,
+	JSONModel,
 	Button,
 	LinkWithIcon,
 	OverflowToolbarButton,
 	OverflowToolbar,
 	OverflowToolbarLayoutData,
-	ToolbarSpacer
+	ToolbarSpacer,
+	Label
 ) {
 	"use strict";
 
-	var ToolbarStyle = mLibrary.ToolbarStyle;
-	var ToolbarDesign = mLibrary.ToolbarDesign;
+	const ToolbarStyle = mLibrary.ToolbarStyle;
+	const ToolbarDesign = mLibrary.ToolbarDesign;
 
-	var ActionArea = library.CardActionArea;
+	const AriaHasPopup = coreLibrary.aria.HasPopup;
+
+	const ActionArea = library.CardActionArea;
+	const CardActionType = library.CardActionType;
 
 	/**
 	 * Constructor for a new ActionsStrip.
@@ -49,7 +60,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @constructor
 	 * @private
@@ -63,6 +74,12 @@ sap.ui.define([
 				disableItemsInitially: {
 					type: "boolean",
 					defaultValue: false
+				},
+				configuration: {
+					type: "object"
+				},
+				cardActions: {
+					type: "object"
 				}
 			},
 			aggregations: {
@@ -99,6 +116,12 @@ sap.ui.define([
 		}
 	});
 
+	ActionsStrip.prototype.onDataChanged = function () {
+		if (this.getConfiguration()?.item) {
+			this._updateToolbar(this._createItemsFromTemplate(this.getBindingContext().getProperty(this.getConfiguration().item?.path)));
+		}
+	};
+
 	ActionsStrip.prototype._getToolbar = function () {
 		var oToolbar = this.getAggregation("_toolbar");
 		if (!oToolbar) {
@@ -112,77 +135,110 @@ sap.ui.define([
 		return oToolbar;
 	};
 
-	ActionsStrip.prototype._initButtons = function (aButtons) {
-		if (!aButtons || !aButtons.length) {
+	ActionsStrip.prototype._updateToolbar = function (aItemsConfigs) {
+		if (!aItemsConfigs || !aItemsConfigs.length) {
+			return;
+		}
+
+		const oToolbar = this._getToolbar();
+
+		aItemsConfigs.forEach((oItemConfig) => {
+			oToolbar.addContent(this._createItem(oItemConfig));
+		});
+
+		const bHasSpacer = oToolbar.getContent().find((oItem) => oItem instanceof ToolbarSpacer);
+
+		if (!bHasSpacer) {
+			oToolbar.insertContent(new ToolbarSpacer(), 0);
+		}
+	};
+
+	ActionsStrip.prototype._createItems = function (aItems) {
+		if (!aItems || !aItems.length) {
 			return null;
 		}
 
-		var oToolbar = this._getToolbar(),
-			oCard = Core.byId(this.getCard()),
-			oActions = new CardActions({
-				card: oCard
-			}),
-			bHasSpacer = false,
-			mActionsConfig;
+		const oCard = Element.getElementById(this.getCard());
 
-		this._oActions = oActions;
+		aItems = BindingHelper.createBindingInfos(aItems, oCard.getBindingNamespaces());
 
-		aButtons = BindingHelper.createBindingInfos(aButtons, oCard.getBindingNamespaces());
+		return aItems;
+	};
 
-		aButtons.forEach(function (mConfig) {
-			if (mConfig.type === "ToolbarSpacer") {
-				bHasSpacer = true;
-				oToolbar.addContent(new ToolbarSpacer());
-				return;
-			}
+	ActionsStrip.prototype._createItemsFromTemplate = function (aData) {
+		if (!aData || !aData.length) {
+			return null;
+		}
 
-			var aActions = mConfig.actions,
-				oOverflow = new OverflowToolbarLayoutData({
-					group: mConfig.overflowGroup,
-					priority: mConfig.overflowPriority
-				}),
-				oControl;
+		const oItemConfiguration = this.getConfiguration().item;
+		let sPath = oItemConfiguration.path + "/";
 
-			switch (mConfig.type) {
-				case "Link":
-					oControl = this._createLink(mConfig);
-				break;
-				case "Button":
-				default:
-					oControl = this._createButton(mConfig);
-				break;
+		if (!BindingHelper.isAbsolutePath(sPath)) {
+			sPath = this.getBindingContext().getPath();
+
+			if (sPath !== "/") {
+				sPath +=  "/";
 			}
 
-			oControl.setLayoutData(oOverflow);
+			sPath += oItemConfiguration.path + "/";
+		}
 
-			mActionsConfig = {
-				area: ActionArea.ActionsStrip,
-				control: oControl,
-				actions: aActions,
-				enabledPropertyName: "enabled"
-			};
+		const oParentData = this.getBindingContext().getProperty();
+		this.setModel(new JSONModel(oParentData), "parent");
 
-			if (this.getDisableItemsInitially()) {
-				mActionsConfig.enabledPropertyValue = false;
-				oControl._mActionsConfig = mActionsConfig;
-				oControl._bIsDisabled = true;
-			}
+		return aData.map((oItemData, i) => {
+			return BindingResolver.resolveValue(oItemConfiguration.template, this, sPath + i);
+		});
+	};
 
-			oActions.attach(mActionsConfig);
+	ActionsStrip.prototype._createItem = function (oConfig) {
+		let oItem;
 
-			oToolbar.addContent(oControl);
-		}.bind(this));
+		switch (oConfig.type) {
+			case "Label":
+				oItem = this._createLabel(oConfig);
+				break;
+			case "ToolbarSpacer":
+				return new ToolbarSpacer();
+			case "Link":
+				oItem = this._createLink(oConfig);
+				break;
+			case "Button":
+			default:
+				oItem = this._createButton(oConfig);
+		}
 
-		if (!bHasSpacer) {
-			oToolbar.insertContent(new ToolbarSpacer(), 0);
+		oItem.setLayoutData(new OverflowToolbarLayoutData({
+			group: oConfig.overflowGroup,
+			priority: oConfig.overflowPriority
+		}));
+
+		const oActionsConfig = {
+			area: ActionArea.ActionsStrip,
+			control: oItem,
+			actions: oConfig.actions,
+			enabledPropertyName: "enabled"
+		};
+
+		if (this.getDisableItemsInitially()) {
+			oActionsConfig.enabledPropertyValue = false;
+			oItem._mActionsConfig = oActionsConfig;
+			oItem._bIsDisabled = true;
+		}
+
+		if (oConfig.type !== "Label") {
+			this.getCardActions().attach(oActionsConfig);
 		}
+
+		return oItem;
 	};
 
 	ActionsStrip.prototype.disableItems = function () {
 		var aItems = this._getToolbar().getContent();
 
+		// TODO: find better way to disable the items
 		aItems.forEach(function (oItem) {
-			if (oItem.setEnabled && !oItem._bIsDisabled) {
+			if (oItem.setEnabled && !oItem._bIsDisabled && oItem.getEnabled()) {
 				oItem.setEnabled(false);
 				oItem._bIsDisabled = true;
 			}
@@ -191,15 +247,15 @@ sap.ui.define([
 
 	ActionsStrip.prototype.enableItems = function () {
 		var aItems = this._getToolbar().getContent(),
-			oActions = this._oActions,
 			mActionsConfig;
 
-		aItems.forEach(function (oItem) {
+		// TODO: find better way to enable the items
+		aItems.forEach((oItem) => {
 			if (oItem.setEnabled && oItem._bIsDisabled) {
 				mActionsConfig = oItem._mActionsConfig;
-				if (mActionsConfig.action) {
+				if (mActionsConfig?.action) {
 					mActionsConfig.enabledPropertyValue = true;
-					oActions._setControlEnabledState(mActionsConfig);
+					this.getCardActions()._setControlEnabledState(mActionsConfig);
 				} else {
 					oItem.setEnabled(true);
 				}
@@ -209,12 +265,21 @@ sap.ui.define([
 		});
 	};
 
+	ActionsStrip.prototype._createLabel = function (mConfig) {
+		var oLabel = new Label({
+			text: mConfig.text,
+			visible: mConfig.visible
+		});
+
+		return oLabel;
+	};
+
 	ActionsStrip.prototype._createLink = function (mConfig) {
 		var oLink = new LinkWithIcon({
 			icon: mConfig.icon,
 			text: mConfig.text,
 			tooltip: mConfig.tooltip,
-			ariaHasPopup: mConfig.ariaHasPopup,
+			ariaHasPopup: mConfig.ariaHasPopup ?? this._getAriaHasPopup(mConfig),
 			emphasized: mConfig.emphasized,
 			visible: mConfig.visible
 		});
@@ -223,45 +288,85 @@ sap.ui.define([
 	};
 
 	ActionsStrip.prototype._createButton = function (mConfig) {
-		var oButton;
-
-		if (mConfig.icon) {
-			oButton = new OverflowToolbarButton({
-				icon: mConfig.icon,
-				text: mConfig.text || mConfig.tooltip,
-				tooltip: mConfig.tooltip || mConfig.text,
-				type: mConfig.buttonType,
-				ariaHasPopup: mConfig.ariaHasPopup,
-				visible: mConfig.visible
-			});
+		const vAriaHasPopup = mConfig.ariaHasPopup ?? this._getAriaHasPopup(mConfig);
 
-			return oButton;
-		}
-
-		oButton = new Button({
+		const mButtonSettings = {
+			icon: mConfig.icon,
 			text: mConfig.text,
 			tooltip: mConfig.tooltip,
 			type: mConfig.buttonType,
-			ariaHasPopup: mConfig.ariaHasPopup,
+			ariaHasPopup: vAriaHasPopup,
 			visible: mConfig.visible
-		});
+		};
+
+		// @todo this will not work well if text is set to binding which later resolves to an empty string
+		if (mConfig.icon && (mConfig.preferIcon || !mConfig.text)) {
+			mButtonSettings.text = mConfig.text || mConfig.tooltip;
+			mButtonSettings.tooltip = mConfig.tooltip || mConfig.text;
+
+			return new OverflowToolbarButton(mButtonSettings);
+		}
+
+		return new Button(mButtonSettings);
+	};
 
-		return oButton;
+	/**
+	 * Checks the correct value for ariaHasPopup for the given item configuration.
+	 * Note: Only checks the first action since we support only one action for now.
+	 * Note: If custom action opens a popup - the custom action developer is responsible to add the ariaHasPopup property.
+	 * @param {map} mConfig The config for the item.
+	 * @returns {sap.ui.core.aria.HasPopup|null} True if the item opens a popup. False otherwise.
+	 */
+	ActionsStrip.prototype._getAriaHasPopup = function (mConfig) {
+		const aActions = mConfig.actions;
+
+		if (aActions?.length > 0 && aActions[0].type === CardActionType.ShowCard) {
+			return AriaHasPopup.Dialog;
+		}
+
+		return null;
 	};
 
-	ActionsStrip.create = function (oCard, aButtons, bDisableItemsInitially) {
-		if (!aButtons) {
+	ActionsStrip.create = function (oConfiguration, oCard, bDisableItemsInitially) {
+		if (!oConfiguration) {
 			return null;
 		}
 
-		var oActionsStrip = new ActionsStrip({
+		const oActionsStrip = new ActionsStrip({
 			card: oCard,
+			configuration: oConfiguration,
+			cardActions: new CardActions({
+				card: oCard
+			}),
 			disableItemsInitially: bDisableItemsInitially
 		});
-		oActionsStrip._initButtons(aButtons);
+
+		if (Array.isArray(oConfiguration)) {
+			oActionsStrip._updateToolbar(oActionsStrip._createItems(oConfiguration));
+		}
 
 		return oActionsStrip;
 	};
 
+	ActionsStrip.hasVisibleTemplateItems = function (oConfiguration, oContent) {
+		const vActionsStrip = oConfiguration;
+
+		if (!Array.isArray(vActionsStrip)) {
+			//@todo fix this case
+			return false;
+		}
+
+		const vResolvedConfig = BindingResolver.resolveValue(vActionsStrip, oContent);
+
+		return vResolvedConfig.some((oItem) => !oItem.hasOwnProperty("visible") || !!oItem.visible);
+	};
+
+	ActionsStrip.prototype.hasVisibleItems = function () {
+		const oToolbar = this._getToolbar(),
+			aContent = oToolbar.getContent();
+
+		return aContent.some((oItem) => !(oItem instanceof ToolbarSpacer) && oItem.getVisible());
+	};
+
 	return ActionsStrip;
 });

package/src/sap/ui/integration/controls/ActionsToolbar.js

@@ -10,27 +10,27 @@ sap.ui.define([
 	"sap/base/strings/capitalize",
 	"sap/ui/core/Control",
 	"sap/m/library",
+	"sap/ui/core/Element",
+	"sap/ui/core/Lib",
 	"sap/ui/core/library",
 	"sap/m/Button",
 	"sap/m/ActionSheet",
 	"sap/ui/base/ManagedObjectObserver",
-	"sap/ui/core/Core",
 	"sap/ui/integration/cards/actions/CardActions"
-
-], function (
+], function(
 	ActionsToolbarRenderer,
 	capitalize,
 	Control,
 	mLibrary,
+	Element,
+	Library,
 	coreLibrary,
 	Button,
 	ActionSheet,
 	ManagedObjectObserver,
-	Core,
 	CardActions
 ) {
 	"use strict";
-	/* global Map */
 
 	var ButtonType = mLibrary.ButtonType;
 
@@ -76,7 +76,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @constructor
 	 * @private
@@ -156,6 +156,9 @@ sap.ui.define([
 			aActions = aActions.concat(oHost.getActions() || []);
 		}
 
+		/**
+		 * @deprecated As of version 1.85
+		 */
 		if (oExtension) {
 			aActions = aActions.concat(oExtension.getActions() || []);
 		}
@@ -190,7 +193,7 @@ sap.ui.define([
 	};
 
 	ActionsToolbar.prototype._getToolbar = function () {
-		var oResourceBundle = Core.getLibraryResourceBundle("sap.ui.integration");
+		var oResourceBundle = Library.getResourceBundleFor("sap.ui.integration");
 		var oToolbar = this.getAggregation('_toolbar');
 		if (!oToolbar) {
 			oToolbar = new Button({
@@ -306,7 +309,7 @@ sap.ui.define([
 			this._mActionObservers.set(oActionDefinition.getId(), oActionObserver);
 			this._updateVisibility();
 		} else if (oChanges.mutation === "remove") {
-			Core.byId(oActionDefinition.getAssociation("_menuButton")).destroy();
+			Element.getElementById(oActionDefinition.getAssociation("_menuButton")).destroy();
 			this._mActionObservers.get(oActionDefinition.getId()).disconnect();
 			this._mActionObservers.delete(oActionDefinition.getId());
 		}
@@ -315,7 +318,7 @@ sap.ui.define([
 	ActionsToolbar.prototype._observeSingleAction = function (oChanges) {
 		var oActionDefinition = oChanges.object,
 			sName = oChanges.name,
-			oButton = Core.byId(oActionDefinition.getAssociation("_menuButton")),
+			oButton = Element.getElementById(oActionDefinition.getAssociation("_menuButton")),
 			vVal = oChanges.current;
 
 		if (["type", "parameters"].indexOf(sName) !== -1) {

package/src/sap/ui/integration/controls/BlockingMessage.js

@@ -16,10 +16,10 @@ sap.ui.define([
 	"sap/m/Title",
 	"sap/m/Text",
 	"sap/ui/Device",
-	"sap/ui/core/Core",
-	"sap/ui/core/Configuration",
 	"sap/ui/core/Control",
-	"sap/ui/core/library"
+	"sap/ui/core/Lib",
+	"sap/ui/core/library",
+	"sap/ui/core/Supportability"
 ], function (
 	library,
 	Log,
@@ -32,10 +32,10 @@ sap.ui.define([
 	Title,
 	Text,
 	Device,
-	Core,
-	Configuration,
 	Control,
-	coreLibrary
+	Library,
+	coreLibrary,
+	Supportability
 ) {
 	"use strict";
 
@@ -53,7 +53,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @constructor
 	 * @private
@@ -98,6 +98,14 @@ sap.ui.define([
 				}
 			},
 			aggregations: {
+				additionalContent: {
+					type: "sap.m.Button",
+					multiple: true,
+					forwarding: {
+						getter: "_getIllustratedMessage",
+						aggregation: "additionalContent"
+					}
+				},
 				_illustratedMessage: {
 					type: "sap.m.IllustratedMessage",
 					multiple: false
@@ -158,15 +166,6 @@ sap.ui.define([
 			sIllustratedMessageType = sIllustratedMessageType || IllustratedMessageType.NoData;
 		}
 
-		oCard._oContentMessage = {
-			type: mSettings.type === CardBlockingMessageType.NoData ? "noData" : "error",
-			illustrationType: sIllustratedMessageType,
-			illustrationSize: sIllustratedMessageSize,
-			title: sTitle,
-			description: sDescription,
-			details: sDetails
-		};
-
 		if (oCard.getCardContent() && oCard.getCardContent().getDomRef()) {
 			sBoxHeight = oCard.getCardContent().getDomRef().offsetHeight + "px";
 		}
@@ -178,49 +177,54 @@ sap.ui.define([
 			illustrationSize: sIllustratedMessageSize,
 			title: sTitle,
 			description: sDescription,
-			httpResponse: mSettings.httpResponse
+			httpResponse: mSettings.httpResponse,
+			details: sDetails,
+			additionalContent: BlockingMessage._createButtons(mSettings.additionalContent)
 		});
 
-		if (sDetails && Configuration.getDebug()) {
-			oBlockingMessage.setDetails(sDetails);
-		} else if (sDetails) {
-			Log.error(sDetails);
+		if (sDetails && Supportability.isDebugModeEnabled()) {
+			oBlockingMessage.addAdditionalContent(BlockingMessage._createDetailsButton(sDetails));
+
+			Log.error(sDetails); // @todo logging should happen at different place
 		}
 
 		return oBlockingMessage;
 	};
 
-	BlockingMessage.prototype.init = function () {
-		this.setAggregation("_illustratedMessage", new IllustratedMessage({
-			enableDefaultTitleAndDescription: false,
-			enableVerticalResponsiveness: true
-		}));
-	};
-
-	BlockingMessage.prototype.onBeforeRendering = function () {
-		var oIllustratedMessage = this.getAggregation("_illustratedMessage");
-
-		oIllustratedMessage
-			.setIllustrationType(this.getIllustrationType())
-			.setIllustrationSize(this.getIllustrationSize())
-			.setTitle(this.getTitle())
-			.setDescription(this.getDescription())
-			.destroyAdditionalContent();
+	/**
+	 * Static method which creates all the buttons from the additionalContent settings.
+	 * @param {array} aAdditionalContentSettings The additionalContent settings.
+	 * @returns {sap.m.Button[]} An array of buttons.
+	 */
+	BlockingMessage._createButtons = function (aAdditionalContentSettings) {
+		const aButtons = aAdditionalContentSettings || [];
 
-		if (this.getDetails()) {
-			oIllustratedMessage.addAdditionalContent(this._getAdditionalContent());
-		}
+		return aButtons.map((mButtonSettings) => {
+			return new Button({
+				text: mButtonSettings.text,
+				icon: mButtonSettings.icon,
+				tooltip: mButtonSettings.tooltip,
+				type: mButtonSettings.buttonType,
+				ariaHasPopup: mButtonSettings.ariaHasPopup,
+				press: mButtonSettings.press
+			});
+		});
 	};
 
-	BlockingMessage.prototype._getAdditionalContent = function () {
-		var oRb = Core.getLibraryResourceBundle("sap.ui.integration");
+	/**
+	 * Static method which creates the button to show additional details in a dialog.
+	 * @param {string} sDetails The details.
+	 * @returns {sap.m.Button} The button.
+	 */
+	BlockingMessage._createDetailsButton = function (sDetails) {
+		var oRb = Library.getResourceBundleFor("sap.ui.integration");
 
 		return new Button({
 			text: oRb.getText("CARD_BUTTON_SHOW_MORE"),
 			press: function () {
 				var oText = new Text({
 					renderWhitespace: true,
-					text: this.getDetails()
+					text: sDetails
 				}).addStyleClass("sapUiSmallMargin");
 
 				var oDialog = new Dialog({
@@ -259,9 +263,54 @@ sap.ui.define([
 				});
 
 				oDialog.open();
-			}.bind(this)
+			}
 		});
 	};
 
+	BlockingMessage.prototype.onBeforeRendering = function () {
+		var oIllustratedMessage = this._getIllustratedMessage();
+
+		oIllustratedMessage
+			.setIllustrationType(this.getIllustrationType())
+			.setIllustrationSize(this.getIllustrationSize())
+			.setTitle(this.getTitle())
+			.setDescription(this.getDescription());
+	};
+
+	/**
+	 * Creates lazily the illustrated message which is shown.
+	 * @returns {sap.m.IllustratedMessage} The illustrated message.
+	 */
+	BlockingMessage.prototype._getIllustratedMessage = function () {
+		let oIllustratedMessage = this.getAggregation("_illustratedMessage");
+
+		if (!oIllustratedMessage) {
+			oIllustratedMessage = new IllustratedMessage({
+				enableDefaultTitleAndDescription: false,
+				enableVerticalResponsiveness: true
+			});
+
+			this.setAggregation("_illustratedMessage", oIllustratedMessage);
+		}
+
+		return oIllustratedMessage;
+	};
+
+	/**
+	 * @private
+	 * @ui5-restricted sap.ui.integration
+	 * @returns {Object} The static configuration for the blocking message
+	 */
+	BlockingMessage.prototype.getStaticConfiguration = function () {
+		return {
+			type: this.getType() === CardBlockingMessageType.NoData ? "noData" : "error",
+			illustrationType: this.getIllustrationType(),
+			illustrationSize: this.getIllustrationSize(),
+			title: this.getTitle(),
+			description: this.getDescription() ? this.getDescription() : undefined,
+			details: this.getDetails() ? this.getDetails() : undefined
+		};
+	};
+
 	return BlockingMessage;
 });