@sapui5/sap.suite.ui.generic.template 1.145.0 → 1.145.2

package/src/sap/suite/ui/generic/template/genericUtilities/controlStateWrapperFactory/PreliminaryWrapper.js

@@ -0,0 +1,151 @@
+sap.ui.define([
+	"sap/base/util/extend"
+], function(extend) {
+	"use strict";
+
+	/**
+	 * PreliminaryWrapper - Acts as a proxy wrapper before the real control is available.
+	 *
+	 * This wrapper is created when a control state wrapper is requested by ID and type,
+	 * but the actual control instance doesn't exist yet (e.g., due to lazy loading on ObjectPage).
+	 * It stores state operations and event handler registrations, then transfers them to the
+	 * real wrapper once the control is assigned via setControl().
+	 *
+	 * @param {string} sId - The local ID of the control
+	 * @param {function} fnCreateRealWrapper - Function to create the real wrapper, bound with type and params
+	 * @returns {object} Preliminary wrapper object that will delegate to real wrapper once control is set
+	 */
+	function PreliminaryWrapper(sId, fnCreateRealWrapper) {
+		var oLatestState;
+		var oRealWrapper;
+		var fnResolveRealWrapperReady;
+		var oRealWrapperReadyPromise = new Promise(function(resolve) {
+			fnResolveRealWrapperReady = resolve;
+		});
+
+		var oPublicInterface = {
+			/**
+			 * Get the current state. Returns stored state before control is set,
+			 * delegates to real wrapper afterwards.
+			 * @returns {object} The current state
+			 */
+			getState: function() {
+				return oRealWrapper ? oRealWrapper.getState() : oLatestState;
+			},
+
+			/**
+			 * Set the state. Stores state before control is set,
+			 * delegates to real wrapper afterwards.
+			 * @param {object} oState - The state to set
+			 */
+			setState: function(oState) {
+				if (oRealWrapper) {
+					oRealWrapper.setState(oState);
+				} else {
+					oLatestState = oState;
+				}
+			},
+
+			/**
+			 * Assign the actual control and create the real wrapper.
+			 * This triggers the creation of the real wrapper, applies any stored state,
+			 * extends the preliminary wrapper with all methods from the real wrapper,
+			 * and resolves the promise that queues event handler attachments.
+			 * @param {sap.ui.core.Control} oControl - The control instance
+			 */
+			setControl: function(oControl) {
+				// Create the real wrapper using bound function (already has type and params bound)
+				var oCreatedWrapper = fnCreateRealWrapper(oControl);
+
+				// Check if wrapper needs time to initialize
+				var oWrapperReadyPromise = oCreatedWrapper.oReadyPromise || Promise.resolve();
+
+				// Wait for wrapper to be ready before setting oRealWrapper
+				oWrapperReadyPromise.then(function() {
+					oRealWrapper = oCreatedWrapper;
+
+					// Apply stored state if any
+					if (oLatestState !== undefined) {
+						oRealWrapper.setState(oLatestState);
+					}
+
+					// Extend the preliminary wrapper with all properties from the real wrapper
+					// This makes any additional methods (like setSVMWrapperCallbacks) available
+					// The nested extend ensures we keep our proxy methods (getState, setState, etc.)
+					// while adding new methods from the real wrapper
+					extend(oPublicInterface, extend({}, oRealWrapper, oPublicInterface));
+
+					// Resolve the promise - this triggers all queued attachStateChanged calls
+					fnResolveRealWrapperReady(oRealWrapper);
+				});
+			},
+
+			/**
+			 * Attach a state change handler. Uses promise to queue attachment
+			 * until the real wrapper is available and ready.
+			 * @param {function} fnHandler - The event handler function
+			 */
+			attachStateChanged: function(fnHandler) {
+				// Use promise to defer attachment until real wrapper is available and ready
+				oRealWrapperReadyPromise.then(function(oWrapper) {
+					oWrapper.attachStateChanged(fnHandler);
+				});
+			},
+
+			/**
+			 * Detach a state change handler. Forwards to real wrapper once available and ready.
+			 * @param {function} fnHandler - The event handler function to detach
+			 */
+			detachStateChanged: function(fnHandler) {
+				// Forward to real wrapper once available and ready
+				oRealWrapperReadyPromise.then(function(oWrapper) {
+					oWrapper.detachStateChanged(fnHandler);
+				});
+			},
+
+			/**
+			 * Get the local ID of the control.
+			 * @returns {string} The local ID
+			 */
+			getLocalId: function() {
+				return sId;
+			},
+
+			/**
+			 * Check if the provided state matches the current state.
+			 * @param {object} oState - The state to compare
+			 * @returns {boolean} True if states match
+			 */
+			isCurrentState: function(oState) {
+				return oRealWrapper ? oRealWrapper.isCurrentState(oState) :
+					JSON.stringify(oState) === JSON.stringify(oLatestState);
+			},
+
+			/**
+			 * Called after variant is initialized (for SmartTable/SmartChart wrappers).
+			 * Delegates to real wrapper once control is set and ready.
+			 * Note: When this is called, the control always exists (event fired by control),
+			 * so the promise will already be resolved.
+			 */
+			onAfterVariantInitialise: function() {
+				oRealWrapperReadyPromise.then(function(oWrapper) {
+					if (oWrapper.onAfterVariantInitialise) {
+						oWrapper.onAfterVariantInitialise();
+					}
+				});
+			},
+
+			/**
+			 * Promise that resolves to the bVMConnection flag value once the real wrapper is ready.
+			 * This indicates whether the control is connected to page-wide variant management.
+			 */
+			oVMConnectionPromise: oRealWrapperReadyPromise.then(function(oWrapper) {
+				return oWrapper.bVMConnection;
+			})
+		};
+
+		return oPublicInterface;
+	}
+
+	return PreliminaryWrapper;
+});

package/src/sap/suite/ui/generic/template/genericUtilities/controlStateWrapperFactory/SearchFieldWrapper.js

@@ -2,54 +2,32 @@ sap.ui.define([
 ], function() {
 	"use strict";
 
-	function SearchFieldWrapper(vTarget) {
-		var oSearchField, oControlAssignedResolve, oPreliminaryState;
-        var oControlAssignedPromise = new Promise(function(resolve) {
-            oControlAssignedResolve = resolve;
-        });
-
-        if (typeof vTarget !== "string") {
-            fnSetControl(vTarget);
-        }
+	function SearchFieldWrapper(oControl) {
+		var oSearchField = oControl;
 
 		function fnGetState() {
-			if (!oSearchField) {
-				return oPreliminaryState;
-			}
-
 			return {
 				searchString: oSearchField.getValue()
 			};
 		}
 
 		function fnSetState(oState) {
-			oPreliminaryState = oState;
-			oControlAssignedPromise.then(function() {
-				oSearchField.setValue(oState.searchString);
-				// original implementation also called fireSearch. Seems to be superfluous (would fire the search event, on which worklisthandler is registered and finally calls rebindTable
-				// when restoring from an appState of a worklist, always data should be shown at time of saving the state and thus automatically search would be triggered again
-				// oSearchField.fireSearch();
-			});
+			oSearchField.setValue(oState.searchString);
+			// original implementation also called fireSearch. Seems to be superfluous (would fire the search event, on which worklisthandler is registered and finally calls rebindTable
+			// when restoring from an appState of a worklist, always data should be shown at time of saving the state and thus automatically search would be triggered again
+			// oSearchField.fireSearch();
 		}
 
 		function fnAttachStateChanged(fnHandler) {
-			oControlAssignedPromise.then(function() {
-				oSearchField.attachLiveChange(fnHandler);
-			});
+			oSearchField.attachLiveChange(fnHandler);
 		}
 
-		function fnSetControl(oControl) {
-            oSearchField = oControl;
-            oControlAssignedResolve(oSearchField);
-        }
-
 		return {
 			getState: fnGetState,
 			setState: fnSetState,
-			setControl: fnSetControl,
 			attachStateChanged: fnAttachStateChanged
 		};
 	}
 
 	return SearchFieldWrapper;
-});
+});

package/src/sap/suite/ui/generic/template/genericUtilities/controlStateWrapperFactory/SmartFilterBarWrapper.js

@@ -1,6 +1,5 @@
 sap.ui.define([
-	"sap/ui/model/FilterOperator"
-], function (FilterOperator) {
+], function () {
 	"use strict";
 
 
@@ -23,29 +22,24 @@ sap.ui.define([
 	 * @returns {object}
 	 * @alias sap.suite.ui.generic.template.genericUtilities.controlStateWrapperFactory.SmartFilterBarWrapper
 	 */
-	function SmartFilterBarWrapper(vTarget, oFactory, mParams) {
+	function SmartFilterBarWrapper(oControl, oFactory, mParams) {
 		var bIsApplying = false;
 		var aBasicFilters = [];
-		var aMissingNavFilters = [];
-		var oSmartFilterBar, oControlAssignedResolve, oPreliminaryState;
-		var oControlAssignedPromise = new Promise(function (resolve) {
-			oControlAssignedResolve = resolve;
-		});
+		var oSmartFilterBar = oControl;
 
-		function fnInitialize() {
-			if (typeof vTarget !== "string") {
-				fnSetControl(vTarget);
-			}
+		var oVariantManagementInitializedPromise;
 
+		function fnInitialize() {
 			// Filters visible initially (after initialization). Stored here to be
 			// able to compare with currently visible ones to identify added and
 			// removed ones	without need to instantiate all possible filter items
 			// (which would harm performance). Can only be retrieved in initialized event.
-			oControlAssignedPromise.then(function () {
-				oSmartFilterBar.getInitializedPromise().then(function () {
-					aBasicFilters = oSmartFilterBar.getAllFilterItems(true);
-				});
+			oSmartFilterBar.getInitializedPromise().then(function () {
+				aBasicFilters = oSmartFilterBar.getAllFilterItems(true);
 			});
+
+			// Initialize variant management promise
+			oVariantManagementInitializedPromise = oSmartFilterBar.getInitializedPromise();
 		}
 
 		// Attach to variantFetch and variantLoad events to be able to store and restore also custom filters and state of other controls (in case of page VM) with variant.
@@ -69,7 +63,7 @@ sap.ui.define([
 			// in SFB instead of SVM where it would make more sense.
 			// Here the event is afterVariantLoad, as the variant content known to SVM/SFB has first to be applied to the SFB, which will also pass the custom data accordingly. Only
 			// after this has happened, we can get the custom data from SFB.
-			oSmartFilterBar.attachAfterVariantLoad(function(oEvent){
+			oSmartFilterBar.attachAfterVariantLoad(function(){
 				var oCustomData = oSmartFilterBar.getCustomFilterData();
 				// variant stored with 1.103 or later: all customFilter data stored in property customFilters
 				// legacy variant stored with 1.102 or earlier: customFilters (from storing point of view) separated according to their origin
@@ -81,91 +75,11 @@ sap.ui.define([
 				aBasicFilters = oSmartFilterBar.getAllFilterItems(true);
 				mParams.oCustomFiltersWrapper.setState(oCustomFiltersState);
 				oSVMWrapperCallbacks.setManagedControlStates(oCustomData[dataPropertyNameGeneric]);
-				/* SFB header state of a variant (standard or custom) gets determined by the Apply Automatically checkbox's value of the corresponding
-				   variant i.e. if the checkbox is checked, then the header should be collapsed and vice versa. */
-				oSVMWrapperCallbacks.setHeaderState(!oEvent.getParameter("executeOnSelect"));
-				aMissingNavFilters = fnGetNavigationProperties();
 			});
 
 		}
 
-		function fnGetNavigationProperties() {
-			//Fetch the navigation properties
-			const oMetaModel = oSmartFilterBar.getModel().getMetaModel(),
-				sEntitySet = oSmartFilterBar.getEntitySet(),
-				oDataEntitySet = oMetaModel.getODataEntitySet(sEntitySet),
-				oDataEntityType = oMetaModel.getODataEntityType(oDataEntitySet.entityType),
-				aNavigationProperties = oDataEntityType['navigationProperty'];
-			//Fetch the added filters in the current variant
-			const sCurrentVariantID = oSmartFilterBar.getVariantManagement().getCurrentVariantId(),
-				oCurrentVariant = oSmartFilterBar.getVariantManagement().getAllVariants().find(function(variant) {
-					return variant.getId() === sCurrentVariantID;
-				});
-			if (!oCurrentVariant
-				|| !oCurrentVariant.getContent()
-				|| !oCurrentVariant.getContent().searchListReportVariant
-				|| !oCurrentVariant.getContent().searchListReportVariant.filterBarVariant
-				|| !aNavigationProperties
-				|| !aNavigationProperties.length
-			) {
-				return [];
-			}
-			const oManifestNavigationProperties = oSmartFilterBar.getNavigationProperties() ?
-				oSmartFilterBar.getNavigationProperties().split(",").reduce(function(accumulator, currentValue){
-					accumulator[currentValue] = true;
-					return accumulator;
-				}, {}) : {},
-				oNavigationProperties = aNavigationProperties.reduce(function(accumulator, currentValue){
-					accumulator[currentValue.name] = true;
-					return accumulator;
-				}, {}),
-				oSmartFilterBarVariant = JSON.parse(oCurrentVariant.getContent().searchListReportVariant.filterBarVariant),
-				aMissing = [];
-			delete oSmartFilterBarVariant["_CUSTOM"];
-
-			// Compare the filter source and navigation properties
-			// Take into account if parameter is already specified in page setting in manifest.json - settings->filterSettings->navigationProperties
-			// If parameter exist in navigationProperties -> SFB will handle specific parameter and code ignore it
-			for (const sFilterKey in oSmartFilterBarVariant) {
-				const sParamName = sFilterKey.split(".")[0]; // take first part from navigation parameter. Example: to_Currency.Currency_Code -> to_Currency
-				if (!oNavigationProperties[sParamName] || oManifestNavigationProperties[sParamName]
-				) {
-					// Parameter is
-					// 1) not navigation property -> we don't process it
-					// 2) is defined in manifest.json - settings->filterSettings->navigationProperties -> value will be handled by SFB
-					continue;
-				}
-				if (oSmartFilterBarVariant[sFilterKey].items && oSmartFilterBarVariant[sFilterKey].items.length) {
-					aMissing.push(oSmartFilterBarVariant[sFilterKey].items.map(function(entry) {
-						return {
-							exclude: false,
-							field: sFilterKey,
-							operation: FilterOperator.EQ,
-							value1: entry.key
-						};
-					}));
-					continue;
-				}
-				if (oSmartFilterBarVariant[sFilterKey].ranges && oSmartFilterBarVariant[sFilterKey].ranges.length) {
-					aMissing.push(oSmartFilterBarVariant[sFilterKey].ranges.map(function(entry) {
-						return {
-							exclude: entry.exclude,
-							field: entry.keyField,
-							operation: entry.operation,
-							value1: entry.value1,
-							value2: entry.value2
-						};
-					}));
-				}
-			}
-			return aMissing;
-		}
-
 		function fnGetState() {
-			if (!oSmartFilterBar) {
-				return oPreliminaryState;
-			}
-
 			var oUiState = oSmartFilterBar.getUiState();
 			// UiState is not Serializable, but a managed object, containing information only partly relevant
 			// relevant information are
@@ -224,43 +138,40 @@ sap.ui.define([
 			}
 
 			bIsApplying = true;
-			oPreliminaryState = oState;
-
-			oControlAssignedPromise.then(function() {
-				// SFB expects a UIState object - not serializable, but a managed object, actually containing also information not belonging to SFBs state
-				// => get current UIState object from SFB, replace only relevant information, and set it again
-				var oUiState = oSmartFilterBar.getUiState(),
-					oSmartVariant = oSmartFilterBar.getSmartVariant(),
-					bIsCurrentVariantModifiedBeforeSetState = oSmartVariant.currentVariantGetModified();
-
-				oUiState.getSelectionVariant().SelectOptions = oPreliminaryState && oPreliminaryState.selectOptions;
-				oUiState.getSelectionVariant().Parameters = oPreliminaryState && oPreliminaryState.parameters;
-				oUiState.setSemanticDates(oPreliminaryState && oPreliminaryState.semanticDates);
-				// setState is meant to set the state absolutely, no merge needed => replace and strictMode can be set to true.
-				// (replace=false can be used to set additional selectOptions but keeping the existing ones. strictMode=false is used to map filters to parameters. Both might make sense in navigation
-				// scenarios (navigation parameter to be merged with defaults, property used in source app as filter but in target as parameter), but not when just restoring to a state (provided from the
-				// same control))
-				oSmartFilterBar.setUiState(oUiState, {replace: true, strictMode: true});
-
-				mParams.oCustomFiltersWrapper.setState(oPreliminaryState && oPreliminaryState.customFilters);
 
-				// set visibility
-				// TODO:
-				// - How to deal with old states (not containing all information about visibility) -> legacy state handler?
-				// - restoring from old state when annotation has changed (new selection fields)?
-				oSmartFilterBar.getAllFilterItems().forEach(function(oFilterItem){
-					if (oPreliminaryState && oPreliminaryState.addedFilterItems && oPreliminaryState.addedFilterItems.includes(oFilterItem.getName())){
-						oFilterItem.setVisibleInFilterBar();
-					}
-					if (oPreliminaryState && oPreliminaryState.removedFilterItems && oPreliminaryState.removedFilterItems.includes(oFilterItem.getName())){
-						oFilterItem.setVisibleInFilterBar(false);
-					}
-				});
-
-				// Retaining the old value of "modified" flag in the smart variant
-				oSmartVariant.currentVariantSetModified(bIsCurrentVariantModifiedBeforeSetState);
+			// SFB expects a UIState object - not serializable, but a managed object, actually containing also information not belonging to SFBs state
+			// => get current UIState object from SFB, replace only relevant information, and set it again
+			var oUiState = oSmartFilterBar.getUiState(),
+				oSmartVariant = oSmartFilterBar.getSmartVariant(),
+				bIsCurrentVariantModifiedBeforeSetState = oSmartVariant.currentVariantGetModified();
+
+			oUiState.getSelectionVariant().SelectOptions = oState && oState.selectOptions;
+			oUiState.getSelectionVariant().Parameters = oState && oState.parameters;
+			oUiState.setSemanticDates(oState && oState.semanticDates);
+			// setState is meant to set the state absolutely, no merge needed => replace and strictMode can be set to true.
+			// (replace=false can be used to set additional selectOptions but keeping the existing ones. strictMode=false is used to map filters to parameters. Both might make sense in navigation
+			// scenarios (navigation parameter to be merged with defaults, property used in source app as filter but in target as parameter), but not when just restoring to a state (provided from the
+			// same control))
+			oSmartFilterBar.setUiState(oUiState, {replace: true, strictMode: true});
+
+			mParams.oCustomFiltersWrapper.setState(oState && oState.customFilters);
+
+			// set visibility
+			// TODO:
+			// - How to deal with old states (not containing all information about visibility) -> legacy state handler?
+			// - restoring from old state when annotation has changed (new selection fields)?
+			oSmartFilterBar.getAllFilterItems().forEach(function(oFilterItem){
+				if (oState && oState.addedFilterItems && oState.addedFilterItems.includes(oFilterItem.getName())){
+					oFilterItem.setVisibleInFilterBar();
+				}
+				if (oState && oState.removedFilterItems && oState.removedFilterItems.includes(oFilterItem.getName())){
+					oFilterItem.setVisibleInFilterBar(false);
+				}
 			});
 
+			// Retaining the old value of "modified" flag in the smart variant
+			oSmartVariant.currentVariantSetModified(bIsCurrentVariantModifiedBeforeSetState);
+
 			// Apparently, SFB does not always correctly adapt the adapt filters count automatically. The following method has been provided espacially to trigger the same.
 			// TODO: Verify, whether this is really needed (or was rather an artifact of old structure) - if yes, this API should be made public, if no, we should remove the call.
 			oSmartFilterBar.refreshFiltersCount();
@@ -275,25 +186,11 @@ sap.ui.define([
 				}
 			}
 
-			oControlAssignedPromise.then(function () {
-				oSmartFilterBar.attachFilterChange(function () {
-					// Don't forward filter change event while dialog is open - changes should only be registered when dialog is closed
-					if (!oSmartFilterBar.isDialogOpen()) {
-						handleStateChanged();
-					}
-				});
-				// unclear, whether this is needed, or filterChange event is anyway raised again (after dialog is closed)
-				oSmartFilterBar.attachFiltersDialogClosed(handleStateChanged);
-
-				// do we need to provide and handle change events from custom filters?
-				// contra:
-				// - SFB raises filteChange event also for custom filters
-				// - maybe also needed to be suppressed while dialog is open
-				// pro:
-				// - cleaner from architectural perspective
-				// - SFB cannot deal correctly with unknown custom controls
-				// - existing method in extensionAPI (onCustomAppStateChange)
-				mParams.oCustomFiltersWrapper.attachStateChanged(handleStateChanged);
+			oSmartFilterBar.attachFilterChange(function () {
+				// Don't forward filter change event while dialog is open - changes should only be registered when dialog is closed
+				if (!oSmartFilterBar.isDialogOpen()) {
+					handleStateChanged();
+				}
 			});
 			// unclear, whether this is needed, or filterChange event is anyway raised again (after dialog is closed)
 			oSmartFilterBar.attachFiltersDialogClosed(handleStateChanged);
@@ -321,15 +218,6 @@ sap.ui.define([
 			});
 		}
 
-		function fnSetControl(oControl) {
-			oSmartFilterBar = oControl;
-			oControlAssignedResolve(oSmartFilterBar);
-		}
-
-		function fnGetMissingNavProperties() {
-			return aMissingNavFilters;
-		}
-
 		// check waiting for initialization (like in SmartTableWrapper/SmartChartWrapper)
 		// currently, whole appState restoring is waiting for initialized event from sfb - but probably it would be enough to wait for it here
 		fnInitialize();
@@ -338,15 +226,14 @@ sap.ui.define([
 			// generic properties (provided by all state wrappers)
 			getState: fnGetState,
 			setState: fnSetState,
-			setControl: fnSetControl,
 			attachStateChanged: fnAttachStateChanged,
 			// specific properties (needed to workaround direct connection between SFB and SVM)
 			setSVMWrapperCallbacks: setSVMWrapperCallbacks,
 			bVMConnection: oSmartFilterBar.getSmartVariant(),
 			suppressSelection: oSmartFilterBar.setSuppressSelection.bind(oSmartFilterBar), // if multiple reasons for suppressing overlap, a counter (to avoid to early resume) could be implemented here
-			getMissingNavProperties: fnGetMissingNavProperties
+			oVariantManagementInitializedPromise: oVariantManagementInitializedPromise
 		};
 	}
 
 	return SmartFilterBarWrapper;
-});
+});