@openui5/sap.ui.mdc 1.141.2 → 1.143.0

package/src/sap/ui/mdc/GeomapDelegate.js

@@ -0,0 +1,285 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+    "sap/ui/mdc/AggregationBaseDelegate",
+    "sap/ui/mdc/enums/GeomapControlPosition"
+], (AggregationBaseDelegate, GeomapControlPosition) => {
+    "use strict";
+
+    /**
+     * Base Delegate for {@link sap.ui.mdc.Geomap Geomap}. Extend this object in your project to use all functionalities of the {@link sap.ui.mdc.GeoMap GeoMap}.<br>
+     * This class provides method calls, that are called by the <code>geomap</code> for specific operations and overwrite the internal behavior.
+     *
+     * @namespace
+     * @author SAP SE
+     * @alias module:sap/ui/mdc/GeomapDelegate
+     * @extends module:sap/ui/mdc/AggregationBaseDelegate
+     * @public
+     * @ui5-experimental-since 1.142
+     *
+     */
+    const GeomapDelegate = Object.assign({}, AggregationBaseDelegate);
+
+    /**
+     * Notifies the inner geomap to zoom in.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.zoomIn = function(oGeomap) { };
+
+    /**
+     * Notifies the inner geomap to zoom out.
+     *
+     * @param {sap.ui.mdc.GeoMap} oGeoMap Reference to the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.zoomOut = function(oGeomap) { };
+
+    /**
+     * geomap <code>ZoomState</code> type.
+     *
+     * @typedef {object} sap.ui.mdc.geomap.ZoomState
+     * @property {boolean} enabled Zooming is enabled if set to <code>true</code>
+     * @property {number} currentZoomLevel Current zoom level of the geomap in percent (between 0 and 1)
+     * @experimental As of version 1.142
+     * @public
+     */
+
+    /**
+     * Gets the current zooming information for the geomap.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @returns {float} Current <code>zoom</code> level of the inner geomap
+     *
+     * @public
+     */
+    GeomapDelegate.getZoomLevel = function(oGeomap) { };
+
+    /**
+     * Creates a new geomap item for a given property name and updates the inner geomap.<br>
+     * <b>Note:</b> This does <b>not</b> add the geomap item to the <code>Items</code> aggregation of the geomap.
+     * Called and used by <code>p13n</code>.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the MDC geomap to add the property to
+     * @param {string} sPropertyName The name of the property added
+     * @param {object} mPropertyBag The property bag containing useful information about the change
+     * @param {string} [sRole] New role for given item
+     * @returns {Promise<object>} <code>Promise</code> that resolves with new geomap <code>Item</code> as parameter
+     *
+     * @public
+     */
+    GeomapDelegate.addItem = function(oGeomap, sPropertyName, mPropertyBag, sRole) {
+        return Promise.resolve();
+    };
+
+    /**
+     * Removes an existing geomap item for a given property name and updates the inner geomap..
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the MDC geomap from which property is removed
+     * @param {object} oItem The <code>item</code> that is removed from the geomap
+     * @param {object} mPropertyBag The property bag containing useful information about the change
+     * @returns {Promise<boolean>} <code>Promise</code> containing information whether the item was deleted
+     *
+     * @public
+     */
+    GeomapDelegate.removeItem = function(oGeomap, oItem, mPropertyBag) {
+        return Promise.resolve(true);
+    };
+
+    /**
+     * Inserts a geomap item (spot / circle for <code>sap.geomap.geomap</code>) into the inner geomap.<br>
+     * This function is called by the geomap for a change of the <code>Items</code> aggregation.<br>
+     * <b>Note:</b> Do not call this yourself, as it would not be synced with the geomap, but insert the item into the geomap instead.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap geomap into which the item is insert
+     * @param {object} oGeomapItem geomap item (spot, container, circle & etc. )that is inserted into the inner geomap
+     * @param {int} iIndex The index into which the geomap item is inserted
+     * @param {string} sType the type of item which should be added to the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.insertItemToGeomap = function(oGeomap, oGeomapItem, iIndex, sType) { };
+
+    /**
+     * Removes a geomap item (spot / circle for <code>sap.geomap.geomap</code>) from the inner geomap.<br>
+     * This function is called by the geomap for a change of the <code>Items</code> aggregation.<br>
+     * <b>Note:</b> Do not call this yourself, as it would not be synced with the geomap, but remove the item from the geomap instead.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeoap geomap from which the item is removed
+     * @param {object} oGeomapItem geomap item that is removed from the geomap
+     * @param {string} sType geomap item type that should be removed from the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.removeItemFromGeomap = function(oGeomap, oGeomapItem, sType) { };
+
+    /**
+     * Loads the required libraries and creates the inner geomap.<br>
+     * By default, the method returns <code>Promise.reject()</code>.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @returns {Promise} Resolved once the inner geomap has been initialized
+     *
+     * @public
+     */
+    GeomapDelegate.initializeGeomap = function(oGeomap) {
+        return Promise.reject();
+    };
+
+    /**
+     * Creates the initial content for the geomap before the metadata is retrieved.<br>
+     * This can be used by geomap libraries that can already show some information without the actual data (for example, axis labels, legend, ...).
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.createInitialGeomapContent = function(oGeomap) { };
+
+    /**
+     * Returns the instance of the inner geomap.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the MDC geomap
+     * @returns {sap.ui.core.Control} Instance of the inner geomap
+     *
+     * @public
+     */
+    GeomapDelegate._getInnerGeomap = function(oGeomap) { };
+
+    /**
+     * Geomap <code>GeomapTypeObject</code> type.
+     *
+     * @typedef {object} sap.ui.mdc.Geomap.GeomapTypeObject
+     * @property {string} key Unique key of the geomap type
+     * @property {sap.ui.core.URI} icon URI for the icon for the current geomap type
+     * @property {string} text Name of the current geomap type
+     * @property {boolean} selected Whether the geomap type is the one currently used
+     * @experimental As of version 1.142
+     * @public
+     */
+
+    /**
+     * Returns the current geomap type.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the MDC geomap
+     * @returns {sap.ui.mdc.GeoMap.GeomapTypeObject[]} Information about the current geomap type
+     * @throws {Error} Error thrown if inner geomap is not initialized yet
+     *
+     * @public
+     */
+    GeomapDelegate.getGeomapTypeInfo = function(oGeomap) { };
+
+    /**
+     * Binds the inner geomap to the back-end data and creates the inner geomap content.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @param {function} fnCallbackDataLoaded Callback function when data is loaded
+     *
+     * @public
+     */
+    GeomapDelegate.createInnerGeomapContent = function(oGeomap, fnCallbackDataLoaded) { };
+
+
+    /**
+     * Checks the binding of the geomap and rebinds it if required.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @param {sap.ui.base.ManagedObject.AggregationBindingInfo} oBindingInfo BindingInfo of the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.rebind = function(oGeomap, oBindingInfo) { };
+
+    /**
+     * Returns the binding info for given geomap.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @returns {sap.ui.base.ManagedObject.AggregationBindingInfo} BindingInfo object
+     *
+     * @public
+     */
+    GeomapDelegate.getBindingInfo = function(oGeomap) { };
+
+    /**
+     * Updates the binding info with the relevant information.<br>
+     * By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo}.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @param {sap.ui.base.ManagedObject.AggregationBindingInfo} oBindingInfo Binding info of the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.updateBindingInfo = function(oGeomap, oBindingInfo) {
+
+    };
+
+    /**
+     * Returns the relevant property info based on the metadata used with the geomap instance.
+     *
+     * <b>Note:</b>
+     * The result of this function must be kept stable throughout the lifecycle of your application.
+     * Any changes of the returned values might result in undesired effects.
+     *
+     * <b>Note</b>: Existing properties (set via <code>sap.ui.mdc.GeoMap#setPropertyInfo</code>) must not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/GeoMapDelegate.fetchProperties fetchProperties} callback. Otherwise validation errors might occur whenever personalization-related control features (such as the opening of any personalization dialog) are activated.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @returns {Promise<sap.ui.mdc.GeoMap.PropertyInfo[]>} Array of the property infos that is used within the geomap
+     *
+     * @public
+     */
+    GeomapDelegate.fetchProperties = function(oGeomap) {
+        return Promise.resolve([]);
+    };
+
+    /**
+     * Gets the information whether the inner geomap is currently bound.
+     *
+     * @param {sap.ui.mdc.Geomap} oGeomap Reference to the geomap
+     * @returns {boolean} <code>true</code> if inner geomap is bound; <code>false</code> if not
+     *
+     * @public
+     */
+    GeomapDelegate.getGeomapBound = function() {
+        return false;
+    };
+
+    /**
+     * Returns the information for control positions on the map.
+     *
+     * @returns {object} with defined control positions
+     * @public
+     */
+    GeomapDelegate.getControlPositions = function() {
+        return {
+            controlPositions: {
+                navigation: GeomapControlPosition.TopLeft,
+                selection: GeomapControlPosition.TopRight,
+                fullscreen: GeomapControlPosition.TopRight,
+                scale: GeomapControlPosition.BottomLeft
+            }
+        };
+    };
+
+    /**
+     * Returns the visible properties (set in <code>items</code> aggregation of the geomap.
+     * @param oGeomap
+     * @returns {Array} array of visible properties
+     */
+    GeomapDelegate.getVisibleProperties = function(oGeomap) {
+        const aMDCGeomapItems = oGeomap.getAggregation("items") || [];
+        let aInitiallyVisibleProperties = [];
+        if (aMDCGeomapItems.length > 0) {
+            aInitiallyVisibleProperties = aMDCGeomapItems.map((oItem) => oItem.getPropertyKey());
+        }
+
+        return aInitiallyVisibleProperties;
+    };
+
+    return GeomapDelegate;
+});

package/src/sap/ui/mdc/GeomapRenderer.js

@@ -0,0 +1,76 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define(['./library'],
+    (library) => {
+        "use strict";
+
+        /**
+         * GeoMap renderer.
+         * @namespace
+         */
+        const GeomapRenderer = {
+            apiVersion: 2
+        };
+
+        /**
+         * CSS class to be applied to the HTML root element of the control.
+         *
+         * @readonly
+         * @const {string}
+         */
+        GeomapRenderer.CSS_CLASS = "sapUiMDCGeomap";
+
+        /**
+         * 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.ui.mdc.Geomap} oGeomap An object representation of the control that should be rendered
+         */
+        GeomapRenderer.render = function(oRm, oGeomap) {
+            oRm.openStart("div", oGeomap);
+            oRm.class(GeomapRenderer.CSS_CLASS);
+            oRm.style("height", oGeomap.getHeight());
+            oRm.style("width", oGeomap.getWidth());
+            oRm.openEnd();
+
+            const sHeader = oGeomap.getHeader();
+            if (sHeader) {
+                oRm.openStart("div", oGeomap.getId() + "-header");
+                oRm.openEnd();
+                oRm.text(sHeader);
+                oRm.close("div");
+            }
+
+            // render internal geomap
+            GeomapRenderer.renderInternalGeomap(oRm, oGeomap);
+
+            oRm.close("div");
+        };
+
+        GeomapRenderer.renderInternalGeomap = function(oRm, oGeomap) {
+            oRm.openStart("div", oGeomap.getId() + "-internal");
+            oRm.class("sapUiMDCGeomapInternal");
+            oRm.openEnd();
+            oRm.renderControl(oGeomap.getAggregation("_geomap"));
+            oRm.close("div");
+        };
+
+        GeomapRenderer.renderContent = function(oRm, oGeomap) {
+            oRm.openStart("div", oGeomap.getId() + "-content");
+            oRm.class("sapUiMDCGeomapInternal");
+            oRm.openEnd();
+            oRm.renderControl(oGeomap.getAggregation("content"));
+            oRm.close("div");
+        };
+
+        GeomapRenderer.renderInnerStructure = function(oRm, oInnerStructure) {
+            oRm.renderControl(oInnerStructure);
+        };
+
+        return GeomapRenderer;
+    },
+    true);

package/src/sap/ui/mdc/Link.js

@@ -71,7 +71,7 @@ sap.ui.define([
 	 * @extends sap.ui.mdc.field.FieldInfoBase
 	 *
 	 * @author SAP SE
-	 * @version 1.141.2
+	 * @version 1.143.0
 	 *
 	 * @constructor
 	 * @alias sap.ui.mdc.Link

package/src/sap/ui/mdc/MultiValueField.js

@@ -33,9 +33,9 @@ sap.ui.define([
 	 *
 	 * <ul>
 	 * <li>In display mode, usually a {@link sap.m.Tokenizer Tokenizer} control is rendered.</li>
-	 * <li>If <code>multipleLines</code> is set, an {@link sap.m.ExpandableText ExpandableText} control is rendered.</li>
+	 * <li>If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, an {@link sap.m.ExpandableText ExpandableText} control is rendered.</li>
 	 * <li>In edit mode, usually a {@link sap.m.MultiInput MultiInput} control is rendered.</li>
-	 * <li>If <code>multipleLines</code> is set, a {@link sap.m.TextArea TextArea} control is rendered.</li>
+	 * <li>If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, a {@link sap.m.TextArea TextArea} control is rendered.</li>
 	 * </ul>
 	 *
 	 * @extends sap.ui.mdc.field.FieldBase
@@ -44,7 +44,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.mdc.MultiValueField
 	 * @author SAP SE
-	 * @version 1.141.2
+	 * @version 1.143.0
 	 * @since 1.93.0
 	 *
 	 * @public
@@ -83,7 +83,7 @@ sap.ui.define([
 				 * Items of the <code>MultiValueField</code> control.
 				 *
 				 * The items are not updated by user input or value help selection automatically. That's because an aggregation binding can only be updated by the model,
-				 * not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItems MultiValueFieldDelegate.updateItems} function needs to be implemented
+				 * not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItemsFromConditions MultiValueFieldDelegate.updateItemsFromConditions} function needs to be implemented
 				 * to update the items after a user interaction.
 				 */
 				items: {
@@ -96,7 +96,7 @@ sap.ui.define([
 			defaultAggregation: "items",
 			events: {
 				/**
-				 * This event is fired when the <code>items</code> aggregation of the field is changed by user interaction.
+				 * This event is fired when the {@link #getItems items} aggregation of the field is changed by user interaction.
 				 *
 				 * <b>Note</b> This event is only triggered if the used content control has a change event.
 				 */
@@ -106,7 +106,7 @@ sap.ui.define([
 						/**
 						 * The new items of the <code>MultiValueField</code> control.
 						 *
-						 * If a <code>ValueHelp</code> element is assigned to the <code>MultiValueField</code> control, the <code>key</code> of the items is used as key for the <code>ValueHelp</code> items.
+						 * If a {@link sap.ui.mdc.field.FieldBase#getValueHelp ValueHelp} element is assigned to the <code>MultiValueField</code> control, the {@link sap.ui.mdc.field.MultiValueFieldItem#getKey key} of the items is used as key for the {@link sap.ui.mdc.field.FieldBase#getValueHelp ValueHelp} items.
 						 */
 						items: { type: "sap.ui.mdc.field.MultiValueFieldItem[]" },
 
@@ -288,7 +288,7 @@ sap.ui.define([
 			return;
 		}
 
-		this.getControlDelegate().updateItems(this.getPayload(), aConditions, this);
+		this.getControlDelegate().updateItemsFromConditions(this, aConditions);
 
 	}