@sapui5/sap.suite.ui.generic.template 1.131.1 → 1.132.0

package/src/sap/suite/ui/generic/template/designtime/controls/DynamicPage.designtime.js

@@ -6,13 +6,12 @@
 */
 sap.ui.define([
 	"sap/base/util/deepClone",
-	"sap/base/util/ObjectPath",
 	"sap/suite/ui/generic/template/designtime/utils/designtimeUtils",
+	"sap/base/util/ObjectPath",
 	"sap/suite/ui/generic/template/genericUtilities/testableHelper"
 ],
-	function (deepClone, ObjectPath, designtimeUtils, testableHelper) {
+	function (deepClone, designtimeUtils, ObjectPath, testableHelper) {
 		"use strict";
-		const { SettingScope } = designtimeUtils;
 
 		/**
 		 * @typedef {Object} DesigntimeSetting
@@ -36,7 +35,7 @@ sap.ui.define([
 		===============================================
 
 		 * @typedef {Object} ControlInfo
-		 * @property {string} sParentComponentName - The name of the parent component.
+		 * @property {string} [sParentComponentName] - The name of the parent component.
 		 * @extends ChangeParameters
 
 		 * @typedef {ChangeParameters & ControlInfo} ControlChangeParams
@@ -51,40 +50,153 @@ sap.ui.define([
 
 
 
+
+		/**
+		 * Retrieves the designtime metadata for the control.
+		 * @param {Object} oControl - Dynamic Page control
+		 * @returns {DesigntimeSetting[]} The designtime metadata
+		 */
+		function getAllDesigntimeSettings(oControl) {
+
+			/**
+			 * @type {DesigntimeSetting}
+			*/
+			const smartVariantManagement = {
+				id: "smartVariantManagement",
+				name: "Variant Management",
+				description: "Enable Smart Variant Management",
+				type: "booleanOrString",
+				value: "true",
+				enums: [
+					{
+						id: "true",
+						name: "Entire Page"
+					},
+					{
+						id: "false",
+						name: "Per Control"
+					}
+				],
+				getPath: () => getSettingsPath("smartVariantManagement")
+
+			};
+
+			/**
+			 * @type {DesigntimeSetting}
+			 */
+			const hideVariantManagement = {
+				id: "variantManagementHidden",
+				name: "Hide Variant Management",
+				description: "Hide Variant Management",
+				type: "boolean",
+				value: false,
+				getPath: () => getSettingsPath("variantManagementHidden")
+			};
+
+			/**
+			 * @type {DesigntimeSetting}
+			 */
+			const enableTableFilterInPageVariant = {
+				id: "enableTableFilterInPageVariant",
+				name: "Enable Table Filter in Page Variant",
+				description: "Enable Table Filter in Page Variant",
+				type: "boolean",
+				value: false,
+				getPath: () => getSettingsPath("enableTableFilterInPageVariant")
+			};
+
+
+			/**
+			 * @type {DesigntimeSetting}
+			 * enum for dataLoadSettings - ifFilterExists, always, never
+			 */
+			const initialLoad = {
+				id: "loadDataOnAppLaunch",
+				name: "Initial Load",
+				description: "Initial Load",
+				type: "string",
+				value: "ifFilterExists",
+				enums: [
+					{
+						id: "ifFilterExists",
+						name: "Auto"
+					},
+					{
+						id: "always",
+						name: "Enabled"
+					},
+					{
+						id: "never",
+						name: "Disabled"
+					}
+				],
+				getPath: () => "component/settings/dataLoadSettings/loadDataOnAppLaunch"
+			};
+
+			/**
+			 * @type {DesigntimeSetting}
+			 */
+			const openInEditMode = {
+				id: "editFlow",
+				name: "Open in Edit Mode",
+				description: "Define the selection limit",
+				value: "display",
+				type: "booleanOrStringCheckbox",
+				getPath: () => getSettingsPath("editFlow"),
+				enums: [
+					{ id: "direct", name: "true" },
+					{ id: "display", name: "false" }
+
+				]
+			};
+
+
+
+			return [
+				smartVariantManagement,
+				hideVariantManagement,
+				enableTableFilterInPageVariant,
+				initialLoad,
+				openInEditMode
+			];
+
+		}
+
+
+		function getSettingsPath(name, mControlDetails) {
+			return `component/settings/${name}`;
+		}
+
+
+
 		/**
 		 * Retrieves the runtime adaptation properties based on the allowed design-time settings and global settings.
 		 *
 		 * @param {Array} aAllowedDesigntimeSettings - The array of allowed design-time settings.
-		 * @param {Object} mGlobalSettings - The global manifest settings object.
+		 * @param {Object} mLrOrALPSettings - The global manifest settings object.
 		 * @returns {Object} - The object containing the runtime adaptation properties.
 		 */
-		function getRuntimeAdapationProperties(aAllowedDesigntimeSettings, mGlobalSettings) {
+		function getRuntimeAdapationProperties(aAllowedDesigntimeSettings, mLrOrALPSettings) {
 			const mPropertyValues = {};
 
 			aAllowedDesigntimeSettings.forEach(oSetting => {
 				const sProperty = oSetting.id;
 				switch (sProperty) {
-					case "statePreservationMode":
-						mPropertyValues[sProperty] = mGlobalSettings[sProperty] || oSetting.value;
-						break;
-					case "flexibleColumnLayout":
-						mPropertyValues[sProperty] = !!mGlobalSettings.flexibleColumnLayout || oSetting.value;
+					case "smartVariantManagement":
+						mPropertyValues[sProperty] = mLrOrALPSettings.smartVariantManagement || oSetting.value;
 						break;
-					case "defaultTwoColumnLayoutType":
-						const manifestPath = "flexibleColumnLayout.defaultTwoColumnLayoutType";
-						mPropertyValues[sProperty] = ObjectPath.get(manifestPath, mGlobalSettings) || oSetting.value;
+					case "variantManagementHidden":
+						mPropertyValues[sProperty] = mLrOrALPSettings.variantManagementHidden || oSetting.value;
 						break;
-					case "defaultThreeColumnLayoutType":
-						const manifestPathThreeColumns = "flexibleColumnLayout.defaultThreeColumnLayoutType";
-						mPropertyValues[sProperty] = ObjectPath.get(manifestPathThreeColumns, mGlobalSettings) || oSetting.value;
+					case "enableTableFilterInPageVariant":
+						mPropertyValues[sProperty] = mLrOrALPSettings.enableTableFilterInPageVariant || oSetting.value;
 						break;
-					case "externalNavigationSettings":
-						mPropertyValues[sProperty] = mGlobalSettings[sProperty] || oSetting.value;
+					case "loadDataOnAppLaunch":
+						mPropertyValues[sProperty] = ObjectPath.get("dataLoadSettings.loadDataOnAppLaunch", mLrOrALPSettings) || oSetting.value;
 						break;
-					case "inboundParameters":
-						mPropertyValues[sProperty] = mGlobalSettings[sProperty] || oSetting.value;
+					case "editFlow":
+						mPropertyValues[sProperty] = mLrOrALPSettings.editFlow || oSetting.value;
 						break;
-
 					default:
 						break;
 				}
@@ -92,6 +204,9 @@ sap.ui.define([
 			return mPropertyValues;
 		}
 
+
+
+
 		/**
 		 * Opens the dialog for the table configuration.
 		 * @param {sap.ui.core.Control} oControl - The control for which the dialog should be opened.
@@ -101,199 +216,32 @@ sap.ui.define([
 		async function fnOpenTableConfigurationDialog(oControl, mPropertyBag) {
 			const oResourceModel = oControl.getModel("i18n");
 			const oComponent = designtimeUtils.getOwnerComponentFor(oControl);
-			const oAppComponent = oComponent.getAppComponent();
-			const sComponentName = oComponent.getMetadata().getComponentName();
-
-			const aAllowedDesigntimeSettings = getAllowedDesigntimeSettings(oControl);
-			const mGlobalSettings = designtimeUtils.getSupportedGlobalManifestSettings(oAppComponent);
+			const mLrOrALPSettings = oComponent.mProperties;
+			const aAllowedDesigntimeSettings = getAllDesigntimeSettings(oControl);
 
 			// Get the current values of the properties
-			const mRuntimeAdaptationPropertyValues = getRuntimeAdapationProperties(aAllowedDesigntimeSettings, mGlobalSettings);
+			const mRuntimeAdaptationPropertyValues = getRuntimeAdapationProperties(aAllowedDesigntimeSettings, mLrOrALPSettings);
 			// Save the unchanged data to compare later
 			const mUnchangedData = deepClone(mRuntimeAdaptationPropertyValues);
 			// Get the settings of the dialog from the designtime settings using which the dialog will be created
 			const aItems = designtimeUtils.getSettings(mRuntimeAdaptationPropertyValues, aAllowedDesigntimeSettings);
-			// Add the scope of the changes
-			const oScopeControlData = {
-				type: "string",
-				"enum": [],
-				value: SettingScope.Page,
-				id: "scope",
-				disabled: false
-			};
-			const aChangeScopeOption = [
-				{
-					label: "Scope of the changes",
-					tooltip: "Scope of the changes",
-					control: [
-						oScopeControlData
-					]
-				}
-			];
 
-			// if the allowed designtime settings contain a setting that supports global scope
-			// then add the global scope option
-			const bSupportsGlobalScope = aAllowedDesigntimeSettings.some(oSetting => oSetting.bSupportsGlobalScope);
-			if (bSupportsGlobalScope) {
-				// @ts-ignore
-				oScopeControlData.enum.push({ id: SettingScope.Application, name: SettingScope.Application });
-			}
 			// disable the scope control if there is only one option
-			oScopeControlData.disabled = oScopeControlData.enum.length <= 1;
 
-			const mPropertyValuesEntered = await designtimeUtils.openAdaptionDialog([...aChangeScopeOption, ...aItems], mRuntimeAdaptationPropertyValues, mUnchangedData, "{i18n>RTA_CONFIGURATION_TITLE_LIST_REPORT}", { width: "650px", height: "800px" }, oResourceModel);
+			const mPropertyValuesEntered = await designtimeUtils.openAdaptionDialog([...aItems], mRuntimeAdaptationPropertyValues, mUnchangedData, "{i18n>RTA_CONFIGURATION_TITLE_LIST_REPORT}", { width: "650px", height: "800px" }, oResourceModel);
 
-			// if the scope is not set, set it to the default is "Application Scope"
-			mPropertyValuesEntered["scope"] = mPropertyValuesEntered["scope"] || SettingScope.Application;
-			mUnchangedData["scope"] = mUnchangedData["scope"] || SettingScope.Application;
 
 			/**
 			 * @type {ControlChangeParams}
 			 */
 			const mPathParameters = {
-				sChangeType: designtimeUtils.ChangeType.ChangePageConfiguration,
-				sParentComponentName: sComponentName,
-				sScope: mPropertyValuesEntered["scope"]
+				sChangeType: designtimeUtils.ChangeType.ChangePageConfiguration
 			};
 			return designtimeUtils.extractChanges(mPropertyValuesEntered, mUnchangedData, aAllowedDesigntimeSettings, oComponent, mPathParameters);
 
 		}
 
-
-		/**
-		 * Retrieves the designtime settings for the Control.
-		 * @param {object} oControl - The Control object.
-		 * @returns {DesigntimeSetting[]} - The designtime settings for the Control.
-		 */
-		let getAllowedDesigntimeSettings = function getAllowedDesigntimeSettings(oControl) {
-
-			/**
-			 * @type {DesigntimeSetting}
-			*/
-			const statePreservationMode = {
-				id: "statePreservationMode",
-				name: "State Preservation Mode",
-				description: "The state preservation mode.",
-				value: "auto",
-				type: "string",
-				//  "auto" - indicates that "persistence" should be used in FCL and "discovery" in non-FCL case
-				enums: [
-					{ id: "auto", name: "Auto" },
-					{ id: "persistence", name: "Persistence" },
-					{ id: "discovery", name: "Discovery" }
-				],
-				bSupportsGlobalScope: true,
-				getPath: (mControlDetails) => {
-					return "settings/statePreservationMode";
-				}
-			};
-
-			/**
-			 * @type {DesigntimeSetting}
-			 */
-			const flexibleColumnLayout = {
-				id: "flexibleColumnLayout",
-				name: "Flexible Column Layout (FCL)",
-				description: "The flexible column layout.",
-				type: "booleanOrString",
-				value: null,
-				bSupportsGlobalScope: true,
-				getPath: (mControlDetails) => {
-					return "settings/flexibleColumnLayout";
-				},
-				enums: [
-					{ id: "null", name: "Standard", value: {} },
-					{ id: "object", name: "Flexible Column Layout" }
-				],
-				writeObject: [
-					{
-						id: "defaultTwoColumnLayoutType",
-						getPath: () => "defaultTwoColumnLayoutType",
-						description: "Select layout for 2 columns"
-					},
-					{
-						id: "defaultThreeColumnLayoutType", getPath: () => "defaultThreeColumnLayoutType",
-						description: "Select layout for 3 columns"
-					}
-				],
-				writeObjectFor: "object"
-			};
-			/**
-			 * @type {DesigntimeSetting}
-			 */
-			const fclDefaultTwoColumnLayoutType = {
-				id: "defaultTwoColumnLayoutType",
-				name: "FCL / Default Two Column Layout Type",
-				description: "The default two column layout type.",
-				type: "string",
-				value: "TwoColumnsBeginExpanded",
-				enums: [
-					{ id: "TwoColumnsBeginExpanded", name: "Begin-Expanded" },
-					{ id: "TwoColumnsMidExpanded", name: "Mid-Expanded" }
-				],
-				skipChange: true
-			};
-
-			/**
-			 * @type {DesigntimeSetting}
-			 */
-			const fclDefaultThreeColumnLayoutType = {
-				id: "defaultThreeColumnLayoutType",
-				name: "FCL / Default Three Column Layout Type",
-				description: "The default three column layout type.",
-				type: "string",
-				value: "ThreeColumnsMidExpanded",
-				enums: [
-					{ id: "ThreeColumnsMidExpanded", name: "Mid-Expanded" },
-					{ id: "ThreeColumnsEndExpanded", name: "End-Expanded" }
-				],
-				skipChange: true
-			};
-
-			/**
-			 * @type {DesigntimeSetting}
-			 */
-			const externalNavigationSettings = {
-				id: "externalNavigationSettings",
-				name: "External Navigation Settings",
-				description: "The external navigation settings.",
-				type: "json",
-				value: undefined
-			};
-
-			/**
-			 * @type {DesigntimeSetting}
-			 */
-			const inboundParameters = {
-				id: "inboundParameters",
-				name: "Inbound Parameters",
-				description: "The inbound parameters.",
-				type: "json",
-				value: undefined
-			};
-
-
-			/**
-			 * @type {DesigntimeSetting[]}
-			 */
-			const designtimeSettings = [
-				statePreservationMode,
-				flexibleColumnLayout,
-				fclDefaultTwoColumnLayoutType,
-				fclDefaultThreeColumnLayoutType,
-				externalNavigationSettings,
-				inboundParameters
-
-			];
-			return designtimeSettings.filter(oSetting => {
-				const sComponentName = designtimeUtils.getOwnerComponentFor(oControl).getMetadata().getComponentName();
-				return !oSetting.restrictedTo || oSetting.restrictedTo.includes(sComponentName);
-			});
-		};
-
 		// Expose the functions for QUnit tests
-
-		testableHelper.testableStatic(getRuntimeAdapationProperties, "getRuntimeAdapationProperties");
 		testableHelper.testableStatic(fnOpenTableConfigurationDialog, "fnOpenTableConfigurationDialog");
 
 

package/src/sap/suite/ui/generic/template/designtime/controls/ObjectPageLayout.designtime.js

@@ -0,0 +1,204 @@
+/*!
+* SAP UI development toolkit for HTML5 (SAPUI5)
+
+		(c) Copyright 2009-2015 SAP SE. All rights reserved
+	
+*/
+sap.ui.define([
+	"sap/base/util/deepClone",
+	"sap/suite/ui/generic/template/designtime/utils/designtimeUtils",
+	"sap/base/util/ObjectPath",
+	"sap/suite/ui/generic/template/genericUtilities/testableHelper"
+],
+	function (deepClone, designtimeUtils, ObjectPath, testableHelper) {
+		"use strict";
+
+		/**
+		 * @typedef {Object} DesigntimeSetting
+		 * @property {string} id - The ID of the designtime setting.
+		 * @property {string} name - The name of the designtime setting.
+		 * @property {string} description - The description of the designtime setting.
+		 * @property {PropertyValue} [value] - The default value of the designtime setting.
+		 * @property {string} type - The type of the designtime setting.
+		 * @property {Array.<Enum>} [enums] - The array of possible enum values for the designtime setting.
+		 * @property {(mControlDetails: ControlInfo) => string} [getPath] - The path to the designtime setting in the manifest.
+		 * @property {boolean} [bSupportsGlobalScope] - Indicates if the setting supports global scope. (Default: false)
+		 * @property {string[]} [restrictedTo] - The array of components for which the setting is restricted.
+		 * @property {Partial<DesigntimeSetting>[]} [writeObject] - An array of DesigntimeSetting objects.
+		 * @property {string} [writeObjectFor] - The value for which the writeObject should be applied.
+		 * @property {boolean} [skipChange] - Indicates if the change should be skipped.
+
+		===============================================
+		 * @typedef {Object} ChangeParameters - Descriptor change parameters.
+		 * @property {string} [sScope] - The scope of the manifest setting.
+		 * @property {string} [sChangeType] - Desciptor change type.
+		===============================================
+
+		 * @typedef {Object} ControlInfo
+		 * @property {string} [sParentComponentName] - The name of the parent component.
+		 * @extends ChangeParameters
+
+		 * @typedef {ChangeParameters & ControlInfo} ControlChangeParams
+
+		 * @typedef {string | boolean | string[] | null } PropertyValue
+
+		 * @typedef {Object} Enum
+		 * @property {string} id - The ID of the enum value.
+		 * @property {string} name - The name of the enum value.
+		 * @property {Object} [value] - The value of the enum value.
+		 */
+
+
+		/**
+	 * Retrieves the runtime adaptation properties based on the allowed design-time settings and global settings.
+	 *
+	 * @param {Array} aAllowedDesigntimeSettings - The array of allowed design-time settings.
+	 * @param {Object} mSettings - The global manifest settings object.
+	 * @returns {Object} - The object containing the runtime adaptation properties.
+	 */
+		function getRuntimeAdapationProperties(aAllowedDesigntimeSettings, mSettings) {
+			const mPropertyValues = {};
+
+			aAllowedDesigntimeSettings.forEach(oSetting => {
+				const sProperty = oSetting.id;
+				switch (sProperty) {
+					case "editableHeaderContent":
+						mPropertyValues[sProperty] = mSettings[sProperty] || oSetting.value;
+						break;
+					case "tableVariantManagement":
+						mPropertyValues[sProperty] = mSettings[sProperty] || oSetting.value;
+						break;
+					case "showRelatedApps":
+						mPropertyValues[sProperty] = mSettings[sProperty] || oSetting.value;
+						break;
+					default:
+						break;
+				}
+			});
+			return mPropertyValues;
+		}
+
+		/**
+		 * Retrieves the designtime settings for the Control.
+		 * @param {object} oControl - The Control object.
+		 * @returns {DesigntimeSetting[]}
+		 */
+		let getAllDesigntimeSettings = function getAllDesigntimeSettings(oControl) {
+
+			/**
+			 * @type {DesigntimeSetting}
+			 */
+			const editableHeaderContent = {
+				id: "editableHeaderContent",
+				name: "Editable Header Content",
+				description: "Decide whether the header content is editable",
+				value: false,
+				getPath: () => 'component/settings/editableHeaderContent',
+				type: "boolean"
+			};
+			/**
+			 * @type {DesigntimeSetting}
+			 */
+			const tableVariantManagement = {
+				id: "variantManagement",
+				name: "Table Variant Management",
+				description: "Decide whether Variant Management is used",
+				value: false,
+				getPath: () => 'component/settings/tableSettings/variantManagement',
+				type: "boolean"
+			};
+
+			/**
+			 * @type {DesigntimeSetting}
+			 */
+			const showRelatedApps = {
+				id: "showRelatedApps",
+				name: "Show Related Apps",
+				description: "Decide whether Related Apps are shown",
+				value: false,
+				getPath: () => 'component/settings/showRelatedApps',
+				type: "boolean"
+			};
+
+			return [
+				editableHeaderContent,
+				tableVariantManagement,
+				showRelatedApps
+			];
+
+		};
+
+
+
+		function getObjectPageSettings(oComponent) {
+			return {
+				editableHeaderContent: JSON.parse(oComponent.getEditableHeaderContent()),
+				tableVariantManagement: !!(ObjectPath.get(["tableVariantManagement"], oComponent.getTableSettings())),
+				showRelatedApps: JSON.parse(oComponent.getShowRelatedApps())
+			};
+		}
+
+
+
+
+		/**
+		 * Opens the dialog for the table configuration.
+		 * @param {sap.ui.core.Control} oControl - The control for which the dialog should be opened.
+		 * @param {object} mPropertyBag - The property bag.
+		 * @returns {Promise<ControlChangeParams[]>} - The changes.
+		 */
+		async function fnOpenTableConfigurationDialog(oControl, mPropertyBag) {
+			const oResourceModel = oControl.getModel("i18n");
+			const oComponent = designtimeUtils.getOwnerComponentFor(oControl);
+
+			const mObjectPageSettings = getObjectPageSettings(oComponent);
+
+			// Get all the designtime settings
+			const aAllDesigntimeSettings = getAllDesigntimeSettings(oControl);
+			// Get the allowed designtime settings based on the floorplan
+			const aAllowedDesigntimeSettings = designtimeUtils.getAllowedDesigntimeSettings(oControl, aAllDesigntimeSettings);
+
+			// Get the current values of the properties
+			const mRuntimeAdaptationPropertyValues = getRuntimeAdapationProperties(aAllowedDesigntimeSettings, mObjectPageSettings);
+			// Save the unchanged data to compare later
+			const mUnchangedData = deepClone(mRuntimeAdaptationPropertyValues);
+			// Get the settings of the dialog from the designtime settings using which the dialog will be created
+			const aItems = designtimeUtils.getSettings(mRuntimeAdaptationPropertyValues, aAllowedDesigntimeSettings);
+
+			// disable the scope control if there is only one option
+
+			const mPropertyValuesEntered = await designtimeUtils.openAdaptionDialog([...aItems], mRuntimeAdaptationPropertyValues, mUnchangedData, "{i18n>RTA_CONFIGURATION_TITLE_OBJECT_PAGE}", { width: "650px", height: "800px" }, oResourceModel);
+
+
+			/**
+			 * @type {ControlChangeParams}
+			 */
+			const mPathParameters = {
+				sChangeType: designtimeUtils.ChangeType.ChangePageConfiguration
+			};
+			return designtimeUtils.extractChanges(mPropertyValuesEntered, mUnchangedData, aAllowedDesigntimeSettings, oComponent, mPathParameters);
+
+		}
+
+		// Expose the functions for QUnit tests
+		testableHelper.testableStatic(fnOpenTableConfigurationDialog, "fnOpenTableConfigurationDialog");
+
+
+		const oHelper = {
+			getDesigntime: function (oControl) {
+				return {
+					actions: {
+						settings: {
+							fe: {
+								name: "Configuration",
+								icon: "sap-icon://developer-settings",
+								handler: fnOpenTableConfigurationDialog
+							}
+						}
+					}
+				};
+			}
+		};
+		return oHelper;
+	}
+);