@sapui5/sap.suite.ui.generic.template 1.140.0 → 1.141.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/package.json +1 -1
  2. package/src/sap/suite/ui/generic/template/.library +1 -1
  3. package/src/sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/ExtensionAPI.js +4 -1
  4. package/src/sap/suite/ui/generic/template/AnalyticalListPage/manifest.json +1 -1
  5. package/src/sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI.js +4 -1
  6. package/src/sap/suite/ui/generic/template/Canvas/manifest.json +1 -1
  7. package/src/sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionAPI.js +4 -1
  8. package/src/sap/suite/ui/generic/template/ListReport/manifest.json +1 -1
  9. package/src/sap/suite/ui/generic/template/ObjectPage/annotationHelpers/AnnotationHelperActionButtons.js +24 -4
  10. package/src/sap/suite/ui/generic/template/ObjectPage/annotationHelpers/AnnotationHelperActionButtons.qunit.js +27 -0
  11. package/src/sap/suite/ui/generic/template/ObjectPage/controller/RelatedAppsHandler.js +2 -0
  12. package/src/sap/suite/ui/generic/template/ObjectPage/controller/SectionTitleHandler.js +1 -1
  13. package/src/sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExtensions.js +285 -270
  14. package/src/sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionAPI.js +4 -1
  15. package/src/sap/suite/ui/generic/template/ObjectPage/manifest.json +1 -1
  16. package/src/sap/suite/ui/generic/template/ObjectPage/view/fragments/CRUDActionButtons.fragment.xml +31 -24
  17. package/src/sap/suite/ui/generic/template/ObjectPage/view/fragments/SmartForm.fragment.xml +1 -1
  18. package/src/sap/suite/ui/generic/template/QuickCreate/manifest.json +1 -1
  19. package/src/sap/suite/ui/generic/template/QuickView/manifest.json +1 -1
  20. package/src/sap/suite/ui/generic/template/fragments/ToolbarButton.fragment.xml +1 -0
  21. package/src/sap/suite/ui/generic/template/js/AnnotationHelper.js +60 -1
  22. package/src/sap/suite/ui/generic/template/lib/AppComponent.js +1 -1
  23. package/src/sap/suite/ui/generic/template/lib/CRUDManager.js +97 -14
  24. package/src/sap/suite/ui/generic/template/lib/CommonEventHandlers.js +4 -2
  25. package/src/sap/suite/ui/generic/template/lib/CommonUtils.js +21 -12
  26. package/src/sap/suite/ui/generic/template/lib/i18n/i18n.properties +5 -5
  27. package/src/sap/suite/ui/generic/template/lib/navigation/NavigationController.js +1 -1
  28. package/src/sap/suite/ui/generic/template/lib/presentationControl/SmartTableHandler.js +1 -1
  29. package/src/sap/suite/ui/generic/template/library.js +1 -1
  30. package/src/sap/suite/ui/generic/template/listTemplates/controller/SmartChartController.js +5 -3
@@ -1,285 +1,300 @@
1
1
  sap.ui.define([
2
2
  "sap/ui/core/mvc/OverrideExecution"
3
- ], function(OverrideExecution) {
4
- "use strict";
5
-
3
+ ], function (OverrideExecution) {
4
+ "use strict";
5
+
6
+ /**
7
+ * This class contains all extension functions that can be implemented by Application
8
+ * developers in their extension code. Application developers should not override any methods
9
+ * outside this documentation.
10
+ * @namespace sap.suite.ui.generic.template.ObjectPage.controllerFrameworkExtensions
11
+ * @public
12
+ */
13
+
14
+ return /** @lends sap.suite.ui.generic.template.ObjectPage.controllerFrameworkExtensions */ {
15
+ metadata: {
16
+ methods: {
17
+ adaptNavigationParameterExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
18
+ onBeforeRebindTableExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
19
+ onListNavigationExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
20
+ provideCustomStateExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
21
+ applyCustomStateExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
22
+ adaptTransientMessageExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
23
+ onSaveAsTileExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
24
+ beforeDeleteExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
25
+ beforeSaveExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
26
+ beforeLineItemDeleteExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
27
+ onLeaveAppExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
28
+ onChildOpenedExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
29
+ onSubSectionEnteredExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
30
+ beforeSmartLinkPopoverOpensExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
31
+ onBeforeExportTableExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
32
+ focusOnEditExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After },
33
+ modifyRelatedAppsSettings: { "public": true, "final": false, overrideExecution: OverrideExecution.After }
34
+ }
35
+ },
36
+
37
+ /**
38
+ * This method is called by SAP Fiori elements on the initialization of View. Application developers
39
+ * can override this method & perform internal setup in this hook.
40
+ *
41
+ * @protected
42
+ */
43
+ onInit: function () { },
44
+
45
+ /**
46
+ * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
47
+ * can override this method and programmatically adapt the parameters which are passed to the target application.
48
+ * Application developers can use the oObjectInfo parameter to identify the navigation context and
49
+ * modify the oSelectionVariant which contains the navigation parameters.
50
+ *
51
+ * @param {sap.fe.navigation.SelectionVariant} oSelectionVariant - Selection variant object
52
+ * containing the information which needs to be passed to the target application
53
+ * @param {object} oObjectInfo - Context object based on which the intent based navigation is triggered
54
+ * @param {string} oObjectInfo.semanticObject - Semantic object used for the intend based navigation
55
+ * @param {string} oObjectInfo.action - Action on the context for which the navigation is triggered
56
+ * @protected
57
+ */
58
+ adaptNavigationParameterExtension: function (oSelectionVariant, oObjectInfo) { },
59
+
60
+ /**
61
+ * This method is called by SAP Fiori elements before binding a table. Application developers can
62
+ * override this method and programmatically modify parameters or filters before the table triggers
63
+ * a query to retrieve data. Source property of the oEvent shall be used to determine table
64
+ * triggering the event
65
+ *
66
+ * <b>Note: </b>This method is called only when a table is rebound, and not when it is refreshed.
67
+ *
68
+ * @param {sap.ui.base.Event} oEvent - The
69
+ * {@link sap.ui.comp.smarttable.SmartTable.prototype.event:beforeRebindTable beforeRebindTable} event
70
+ * @protected
71
+ */
72
+ onBeforeRebindTableExtension: function (oEvent) { },
73
+
74
+ /**
75
+ * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
76
+ * developers can override this method and perform conditional (internal or external) navigation from different
77
+ * rows of a table. Such custom navigation should be triggered via corresponding methods of
78
+ * {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
79
+ *
80
+ * @param {sap.ui.base.Event} oEvent - The press event fired when navigating from a row in the SmartTable. It
81
+ * is recommended to ignore this parameter and use <code>oBindingContext</code> instead
82
+ * @param {sap.ui.model.Context} oBindingContext - The context of the corresponding table row
83
+ * @param {boolean} bReplaceInHistory - This parameter should be considered if the method triggers an internal
84
+ * navigation. Pass this parameter to <code>oNavigationData.replaceInHistory</code> in this case
85
+ *
86
+ * @returns {boolean} Method should return <code>true</code> if framework navigation should be suppressed
87
+ * (that means: extension code has taken over navigation)
88
+ * @protected
89
+ */
90
+ onListNavigationExtension: function (oEvent, oBindingContext, bReplaceInHistory) { },
91
+
92
+ /**
93
+ * This method will be called by SAP Fiori elements before persisting the AppState. Application developers can
94
+ * override this method for persisting the state of custom controls. State of the custom controls
95
+ * should be stored in the oState object passed as a parameter to this method. To make a complete functionality,
96
+ * this method should be overridden with <code>applyCustomStateExtension</code>.
97
+ *
98
+ * @param {object} oState - Object which needs to enriched with the custom control state
99
+ * @protected
100
+ * @see {@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
101
+ */
102
+ provideCustomStateExtension: function (oState) { },
103
+
104
+ /**
105
+ * This method will be called by SAP Fiori elements while applying the AppState. The custom state object retrieved
106
+ * from the AppState will be passed as a parameter to this method. Application developers can use this custom
107
+ * state for restoring the state of the custom control. To make a complete functionality, this method should be
108
+ * overridden with <code>provideCustomStateExtension</code>.
109
+ *
110
+ * @param {object} oState - Custom data containing the information
111
+ * @param {boolean} bIsSameAsLast - Set to True if the method is called for the same instance
112
+ * <b>Note: </b> In draft scenarios, this parameter will be set to true if the instance that is currently
113
+ * displayed and the instance that was visited previously are semantically same but differ in their draft status
114
+ * @protected
115
+ * @see {@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
116
+ */
117
+ applyCustomStateExtension: function (oState, bIsSameAsLast) { },
118
+
119
+ /**
120
+ * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers can
121
+ * override this method, access the message model and adapt the transient messages related to the component.
122
+ *
123
+ * @protected
124
+ */
125
+ adaptTransientMessageExtension: function () { },
126
+
6
127
  /**
7
- * This class contains all extension functions that can be implemented by Application
8
- * developers in their extension code. Application developers should not override any methods
9
- * outside this documentation.
10
- * @namespace sap.suite.ui.generic.template.ObjectPage.controllerFrameworkExtensions
11
- * @public
128
+ * This method is called by SAP Fiori elements when the Share functionality is triggered. Application
129
+ * developers can adapt the service URL passed as a parameter to this method. Adapted service URL will
130
+ * be used in the 'Send Email' or 'Save as Tile' options.
131
+ *
132
+ * @param {object} oShareInfo - Object containing the serviceURL
133
+ * @param {string} oShareInfo.serviceUrl - Service URL which is derived by SAP Fiori elements
134
+ * @protected
12
135
  */
13
-
14
- return /** @lends sap.suite.ui.generic.template.ObjectPage.controllerFrameworkExtensions */ {
15
- metadata: {
16
- methods: {
17
- adaptNavigationParameterExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
18
- onBeforeRebindTableExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
19
- onListNavigationExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
20
- provideCustomStateExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
21
- applyCustomStateExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
22
- adaptTransientMessageExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
23
- onSaveAsTileExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
24
- beforeDeleteExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
25
- beforeSaveExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
26
- beforeLineItemDeleteExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
27
- onLeaveAppExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
28
- onChildOpenedExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
29
- onSubSectionEnteredExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
30
- beforeSmartLinkPopoverOpensExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
31
- onBeforeExportTableExtension: { "public": true, "final": false, overrideExecution: OverrideExecution.After},
32
- focusOnEditExtension:{ "public": true, "final": false, overrideExecution: OverrideExecution.After}
33
- }
34
- },
136
+ onSaveAsTileExtension: function (oShareInfo) { },
35
137
 
36
- /**
37
- * This method is called by SAP Fiori elements on the initialization of View. Application developers
38
- * can override this method & perform internal setup in this hook.
39
- *
40
- * @protected
41
- */
42
- onInit: function() {},
43
-
44
- /**
45
- * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
46
- * can override this method and programmatically adapt the parameters which are passed to the target application.
47
- * Application developers can use the oObjectInfo parameter to identify the navigation context and
48
- * modify the oSelectionVariant which contains the navigation parameters.
49
- *
50
- * @param {sap.fe.navigation.SelectionVariant} oSelectionVariant - Selection variant object
51
- * containing the information which needs to be passed to the target application
52
- * @param {object} oObjectInfo - Context object based on which the intent based navigation is triggered
53
- * @param {string} oObjectInfo.semanticObject - Semantic object used for the intend based navigation
54
- * @param {string} oObjectInfo.action - Action on the context for which the navigation is triggered
55
- * @protected
56
- */
57
- adaptNavigationParameterExtension: function(oSelectionVariant, oObjectInfo) {},
58
-
59
- /**
60
- * This method is called by SAP Fiori elements before binding a table. Application developers can
61
- * override this method and programmatically modify parameters or filters before the table triggers
62
- * a query to retrieve data. Source property of the oEvent shall be used to determine table
63
- * triggering the event
64
- *
65
- * <b>Note: </b>This method is called only when a table is rebound, and not when it is refreshed.
66
- *
67
- * @param {sap.ui.base.Event} oEvent - The
68
- * {@link sap.ui.comp.smarttable.SmartTable.prototype.event:beforeRebindTable beforeRebindTable} event
69
- * @protected
70
- */
71
- onBeforeRebindTableExtension: function(oEvent) {},
138
+ /**
139
+ * This method is called by SAP Fiori element when Delete button on the Object Page is clicked. Application
140
+ * developers can override this method & perform additional checks before executing the delete operation.
141
+ * Method is expected to return a Promise. To veto the delete operation, promise needs to be rejected
142
+ * else resolved.
143
+ *
144
+ * @returns {Promise} Promise object created by the extension, used for delete operation chaining
145
+ * @protected
146
+ */
147
+ beforeDeleteExtension: function () { },
72
148
 
73
- /**
74
- * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
75
- * developers can override this method and perform conditional (internal or external) navigation from different
76
- * rows of a table. Such custom navigation should be triggered via corresponding methods of
77
- * {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
78
- *
79
- * @param {sap.ui.base.Event} oEvent - The press event fired when navigating from a row in the SmartTable. It
80
- * is recommended to ignore this parameter and use <code>oBindingContext</code> instead
81
- * @param {sap.ui.model.Context} oBindingContext - The context of the corresponding table row
82
- * @param {boolean} bReplaceInHistory - This parameter should be considered if the method triggers an internal
83
- * navigation. Pass this parameter to <code>oNavigationData.replaceInHistory</code> in this case
84
- *
85
- * @returns {boolean} Method should return <code>true</code> if framework navigation should be suppressed
86
- * (that means: extension code has taken over navigation)
87
- * @protected
88
- */
89
- onListNavigationExtension: function(oEvent, oBindingContext, bReplaceInHistory) {},
90
-
91
- /**
92
- * This method will be called by SAP Fiori elements before persisting the AppState. Application developers can
93
- * override this method for persisting the state of custom controls. State of the custom controls
94
- * should be stored in the oState object passed as a parameter to this method. To make a complete functionality,
95
- * this method should be overridden with <code>applyCustomStateExtension</code>.
96
- *
97
- * @param {object} oState - Object which needs to enriched with the custom control state
98
- * @protected
99
- * @see {@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
100
- */
101
- provideCustomStateExtension: function(oState){},
102
-
103
- /**
104
- * This method will be called by SAP Fiori elements while applying the AppState. The custom state object retrieved
105
- * from the AppState will be passed as a parameter to this method. Application developers can use this custom
106
- * state for restoring the state of the custom control. To make a complete functionality, this method should be
107
- * overridden with <code>provideCustomStateExtension</code>.
108
- *
109
- * @param {object} oState - Custom data containing the information
110
- * @param {boolean} bIsSameAsLast - Set to True if the method is called for the same instance
111
- * <b>Note: </b> In draft scenarios, this parameter will be set to true if the instance that is currently
112
- * displayed and the instance that was visited previously are semantically same but differ in their draft status
113
- * @protected
114
- * @see {@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
115
- */
116
- applyCustomStateExtension: function(oState, bIsSameAsLast){},
117
-
118
- /**
119
- * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers can
120
- * override this method, access the message model and adapt the transient messages related to the component.
121
- *
122
- * @protected
123
- */
124
- adaptTransientMessageExtension: function(){},
125
-
126
- /**
127
- * This method is called by SAP Fiori elements when the Share functionality is triggered. Application
128
- * developers can adapt the service URL passed as a parameter to this method. Adapted service URL will
129
- * be used in the 'Send Email' or 'Save as Tile' options.
130
- *
131
- * @param {object} oShareInfo - Object containing the serviceURL
132
- * @param {string} oShareInfo.serviceUrl - Service URL which is derived by SAP Fiori elements
133
- * @protected
134
- */
135
- onSaveAsTileExtension: function(oShareInfo) {},
136
-
137
- /**
138
- * This method is called by SAP Fiori element when Delete button on the Object Page is clicked. Application
139
- * developers can override this method & perform additional checks before executing the delete operation.
140
- * Method is expected to return a Promise. To veto the delete operation, promise needs to be rejected
141
- * else resolved.
142
- *
143
- * @returns {Promise} Promise object created by the extension, used for delete operation chaining
144
- * @protected
145
- */
146
- beforeDeleteExtension: function() {},
147
-
148
- /**
149
- * This method is called by SAP Fiori elements when Save button is selected. Application developers can override
150
- * this method and perform a custom operation before executing the Save operation. The method is expected to return a
151
- * Promise. The save operation will be continued only once the promise is resolved. If the extension code would
152
- * like to veto the save operation, promise must be rejected.
153
- * Note that this function should <b>not</b> be used to implement any checks on the object to be saved, since all checks should
154
- * be implemented by the backend logic. However, the implementation may display user interaction (dialog) requesting the
155
- * user to enter additional data or confirmation. The returned Promise would be resolved if the user confirms the dialog
156
- * and rejected if it is canceled.
157
- *
158
- * @returns {Promise} Promise object created by the extension, used for Save operation chaining
159
- * @protected
160
- */
161
- beforeSaveExtension: function() {},
149
+ /**
150
+ * This method is called by SAP Fiori elements when Save button is selected. Application developers can override
151
+ * this method and perform a custom operation before executing the Save operation. The method is expected to return a
152
+ * Promise. The save operation will be continued only once the promise is resolved. If the extension code would
153
+ * like to veto the save operation, promise must be rejected.
154
+ * Note that this function should <b>not</b> be used to implement any checks on the object to be saved, since all checks should
155
+ * be implemented by the backend logic. However, the implementation may display user interaction (dialog) requesting the
156
+ * user to enter additional data or confirmation. The returned Promise would be resolved if the user confirms the dialog
157
+ * and rejected if it is canceled.
158
+ *
159
+ * @returns {Promise} Promise object created by the extension, used for Save operation chaining
160
+ * @protected
161
+ */
162
+ beforeSaveExtension: function () { },
162
163
 
163
- /**
164
- * This method is called when the Delete operation is triggered on a table in the Object Page. Application
165
- * developers can override this method & perform additional checks before executing the delete operation.
166
- * Method is expected to return a Promise. Delete operation is executed only once the returned promise is
167
- * resolved. In case the extension code wants to veto the Delete operation, promise needs to be rejected.
168
- * Application developers can use <code>sUiElementId</code> property of the object passed as param to
169
- * identify the smart table where the Delete operation is being triggered.
170
- *
171
- * @param {object} oBeforeLineItemDeleteProperties - Object containing the selected context for delete
172
- * @param {string} oBeforeLineItemDeleteProperties.sUiElementId - Id of the smart table relevant for
173
- * Delete operation
174
- * @param {Array} oBeforeLineItemDeleteProperties.aContexts - Array of the selected contexts
175
- * @returns {Promise} Promise object created by the extension, used for Delete operation chaining
176
- * @protected
177
- */
178
- beforeLineItemDeleteExtension: function(oBeforeLineItemDeleteProperties) {},
179
-
180
- /**
181
- * This method is called when the user leaves the app and this page has been displayed within the same app
182
- * session (this is the time since last opening the app) at least once.
183
- * Moreover, it is called for all pages that have been displayed within some app session when the app is finally destroyed.
184
- * @param {boolean} bIsDestroyed - If this parameter is true this app instance is destroyed. Otherwise it might
185
- * be rewoken if the user navigates again to this app within the same FLP session
186
- * @return {function} - Only relevant in case that <code>bIsDestroyed</code> is false. In this case Application
187
- * developers can provide a function to be called when the same page is opened again (after the user has navigated back to the app).
188
- * @protected
189
- */
190
- onLeaveAppExtension: function(bIsDestroyed) {},
164
+ /**
165
+ * This method is called when the Delete operation is triggered on a table in the Object Page. Application
166
+ * developers can override this method & perform additional checks before executing the delete operation.
167
+ * Method is expected to return a Promise. Delete operation is executed only once the returned promise is
168
+ * resolved. In case the extension code wants to veto the Delete operation, promise needs to be rejected.
169
+ * Application developers can use <code>sUiElementId</code> property of the object passed as param to
170
+ * identify the smart table where the Delete operation is being triggered.
171
+ *
172
+ * @param {object} oBeforeLineItemDeleteProperties - Object containing the selected context for delete
173
+ * @param {string} oBeforeLineItemDeleteProperties.sUiElementId - Id of the smart table relevant for
174
+ * Delete operation
175
+ * @param {Array} oBeforeLineItemDeleteProperties.aContexts - Array of the selected contexts
176
+ * @returns {Promise} Promise object created by the extension, used for Delete operation chaining
177
+ * @protected
178
+ */
179
+ beforeLineItemDeleteExtension: function (oBeforeLineItemDeleteProperties) { },
191
180
 
192
- /**
193
- * This method should be implemented whenever application uses onListNavigationExtension for internal navigation. In this case the implementation of
194
- * this method should provide an 'inverse' mapping to the transformation implemented within onListNavigationExtension.
195
- * More precisely, the identification of a child page instance is passed to this function. The implementation of this function should provide information
196
- * about the list item which has triggered the opening of the child page.
197
- * @param {object} oSelectionInfo - Information about the child page instance opened last
198
- * @param {string} [oSelectionInfo.pageEntitySet] The entity set identifying the child page which was opened last.
199
- * Note: In case the child page has been defined without reference to OData this will be the routeName taken from the routingSpec.
200
- * @param {string} [oSelectionInfo.path] The context path that was used for the last opened child page
201
- * @param {string[]} [oSelectionInfo.keys] The array of keys (one on each hierarchy level) used for the last opened child page
202
- * @param {function} fnSetPath - pass the binding path of the corresponding list item to this function if it is not identical to <code>oSelectionInfo.path</code>
203
- * @protected
204
- */
205
- onChildOpenedExtension: function(oSelectionInfo, fnSetPath) {},
181
+ /**
182
+ * This method is called when the user leaves the app and this page has been displayed within the same app
183
+ * session (this is the time since last opening the app) at least once.
184
+ * Moreover, it is called for all pages that have been displayed within some app session when the app is finally destroyed.
185
+ * @param {boolean} bIsDestroyed - If this parameter is true this app instance is destroyed. Otherwise it might
186
+ * be rewoken if the user navigates again to this app within the same FLP session
187
+ * @return {function} - Only relevant in case that <code>bIsDestroyed</code> is false. In this case Application
188
+ * developers can provide a function to be called when the same page is opened again (after the user has navigated back to the app).
189
+ * @protected
190
+ */
191
+ onLeaveAppExtension: function (bIsDestroyed) { },
206
192
 
207
- /**
208
- * This method is called when the SubSection enters the Viewport first time for an ObjectPage.
209
- * Method would be called again for the same SubSection only in case ObjectPage binding context is changed.
210
- * Application developers could use this method to perform specific actions on the current SubSection children.
211
- * This enables the application to perform actions relevant to a specific section when it really comes to view
212
- * port. Control specific handling should be done in this method in case View LazyLoading is enabled.
213
- *
214
- * @param {sap.uxap.ObjectPageSubSection} oSubSection - Reference to the ObjectPageSubSection cause for this method call
215
- * @returns {void}
216
- * @protected
217
- */
218
- onSubSectionEnteredExtension: function(oSubSection) {},
193
+ /**
194
+ * This method should be implemented whenever application uses onListNavigationExtension for internal navigation. In this case the implementation of
195
+ * this method should provide an 'inverse' mapping to the transformation implemented within onListNavigationExtension.
196
+ * More precisely, the identification of a child page instance is passed to this function. The implementation of this function should provide information
197
+ * about the list item which has triggered the opening of the child page.
198
+ * @param {object} oSelectionInfo - Information about the child page instance opened last
199
+ * @param {string} [oSelectionInfo.pageEntitySet] The entity set identifying the child page which was opened last.
200
+ * Note: In case the child page has been defined without reference to OData this will be the routeName taken from the routingSpec.
201
+ * @param {string} [oSelectionInfo.path] The context path that was used for the last opened child page
202
+ * @param {string[]} [oSelectionInfo.keys] The array of keys (one on each hierarchy level) used for the last opened child page
203
+ * @param {function} fnSetPath - pass the binding path of the corresponding list item to this function if it is not identical to <code>oSelectionInfo.path</code>
204
+ * @protected
205
+ */
206
+ onChildOpenedExtension: function (oSelectionInfo, fnSetPath) { },
219
207
 
220
- /**
221
- * This method is called by SAP Fiori elements when a smart link in a table or form is clicked. Application developers
222
- * can override this method and invoke the oParams.getSourceInfo method to find out the information about the
223
- * clicked smart link.
224
- *
225
- * If the application expect the framework should not handle the <code>beforePopoverOpens</code> event,
226
- * then this method should return true. Otherwise, framework will proceed with its handling.
227
- *
228
- * @param {object} oParams Object containing the "getSourceInfo" method and the selection variant
229
- * @param {sap.fe.navigation.SelectionVariant} oParams.oSelectionVariant - Selection variant object
230
- * containing the information which needs to be passed to the target application
231
- * @param {function} [oParams.getSourceInfo] Returns an object contains information about the smart link
232
- * @param {sap.ui.comp.navpopover.SmartLink} [oParams.getSourceInfo().smartLink] The smart link cliked by the user
233
- * @param {sap.m.Column | sap.ui.table.Column} [oParams.getSourceInfo().column] The table column contains the smart link
234
- * @param {sap.ui.comp.smarttable.SmartTable} [oParams.getSourceInfo().column] The smart table contains the smart link
235
- * @returns {boolean} Method should return <code>true</code> if framework should not handle <code>beforePopoverOpens</code> event
236
- * (that means: extension code will handle the event)
237
- * @protected
238
- */
239
- beforeSmartLinkPopoverOpensExtension: function(oParams) {},
208
+ /**
209
+ * This method is called when the SubSection enters the Viewport first time for an ObjectPage.
210
+ * Method would be called again for the same SubSection only in case ObjectPage binding context is changed.
211
+ * Application developers could use this method to perform specific actions on the current SubSection children.
212
+ * This enables the application to perform actions relevant to a specific section when it really comes to view
213
+ * port. Control specific handling should be done in this method in case View LazyLoading is enabled.
214
+ *
215
+ * @param {sap.uxap.ObjectPageSubSection} oSubSection - Reference to the ObjectPageSubSection cause for this method call
216
+ * @returns {void}
217
+ * @protected
218
+ */
219
+ onSubSectionEnteredExtension: function (oSubSection) { },
240
220
 
241
- /**
242
- * This method is called by SAP Fiori elements when the table data is getting exported.
243
- * Application developers can override this method to add/remove the filters in the exported file.
244
- *
245
- * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
246
- * and add it to "oExportParams.filterSettings"
247
- *
248
- * @param {object} oExportParams Object containing the table export info
249
- * @param {sap.ui.export.util.Filter[]} oExportParams.filterSettings The filters in the exported file
250
- * Note: Please make changes on "oExportParams.filterSettings" array only when "Include filter settings" is selected.
251
- * Otherwise, the changes will be ignored.
252
- * @param {boolean} oExportParams.includeFilterSettings The value of "Include filter settings" checkbox
253
- * @protected
254
- */
255
- onBeforeExportTableExtension: function(oExportParams) {},
221
+ /**
222
+ * This method is called by SAP Fiori elements when a smart link in a table or form is clicked. Application developers
223
+ * can override this method and invoke the oParams.getSourceInfo method to find out the information about the
224
+ * clicked smart link.
225
+ *
226
+ * If the application expect the framework should not handle the <code>beforePopoverOpens</code> event,
227
+ * then this method should return true. Otherwise, framework will proceed with its handling.
228
+ *
229
+ * @param {object} oParams Object containing the "getSourceInfo" method and the selection variant
230
+ * @param {sap.fe.navigation.SelectionVariant} oParams.oSelectionVariant - Selection variant object
231
+ * containing the information which needs to be passed to the target application
232
+ * @param {function} [oParams.getSourceInfo] Returns an object contains information about the smart link
233
+ * @param {sap.ui.comp.navpopover.SmartLink} [oParams.getSourceInfo().smartLink] The smart link cliked by the user
234
+ * @param {sap.m.Column | sap.ui.table.Column} [oParams.getSourceInfo().column] The table column contains the smart link
235
+ * @param {sap.ui.comp.smarttable.SmartTable} [oParams.getSourceInfo().column] The smart table contains the smart link
236
+ * @returns {boolean} Method should return <code>true</code> if framework should not handle <code>beforePopoverOpens</code> event
237
+ * (that means: extension code will handle the event)
238
+ * @protected
239
+ */
240
+ beforeSmartLinkPopoverOpensExtension: function (oParams) { },
256
241
 
257
- /**
258
- * SAP Fiori elements offers a generic implementation for function getContext() called by Joule.
259
- * Additionally, the app context contains a custom object that an application developer can leverage to provide additional information relevant to the capability.
260
- *
261
- * @param {object} oContext - context object generated by Fiori elements
262
- * @returns enhanced context object with custom properties
263
- */
264
- getContext: function(oContext) {
265
- return oContext;
266
- },
242
+ /**
243
+ * This method is called by SAP Fiori elements when the table data is getting exported.
244
+ * Application developers can override this method to add/remove the filters in the exported file.
245
+ *
246
+ * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
247
+ * and add it to "oExportParams.filterSettings"
248
+ *
249
+ * @param {object} oExportParams Object containing the table export info
250
+ * @param {sap.ui.export.util.Filter[]} oExportParams.filterSettings The filters in the exported file
251
+ * Note: Please make changes on "oExportParams.filterSettings" array only when "Include filter settings" is selected.
252
+ * Otherwise, the changes will be ignored.
253
+ * @param {boolean} oExportParams.includeFilterSettings The value of "Include filter settings" checkbox
254
+ * @protected
255
+ */
256
+ onBeforeExportTableExtension: function (oExportParams) { },
267
257
 
268
- /**
269
- * Extension point for the application to specify the control to focus on in the object page upon edit.
270
- *
271
- * @param {String} sSelectedSection - The ID of the selected section.
272
- * @returns {sap.ui.core.Control} - The control that needs to be focused.
273
- *
274
- * The returned control must meet the following criteria:
275
- * - Be focusable and have a "focus" property.
276
- * - Be visible within the viewport.
277
- *
278
- * If the returned control does not satisfy these conditions, the standard focus handling logic is executed.
279
- * @protected
280
- */
281
- focusOnEditExtension: function (sSelectedSection) {
282
- return {};
283
- }
258
+ /**
259
+ * SAP Fiori elements offers a generic implementation for function getContext() called by Joule.
260
+ * Additionally, the app context contains a custom object that an application developer can leverage to provide additional information relevant to the capability.
261
+ *
262
+ * @param {object} oContext - context object generated by Fiori elements
263
+ * @returns enhanced context object with custom properties
264
+ */
265
+ getContext: function (oContext) {
266
+ return oContext;
267
+ },
268
+
269
+ /**
270
+ * Extension point for the application to specify the control to focus on in the object page upon edit.
271
+ *
272
+ * @param {String} sSelectedSection - The ID of the selected section.
273
+ * @returns {sap.ui.core.Control} - The control that needs to be focused.
274
+ *
275
+ * The returned control must meet the following criteria:
276
+ * - Be focusable and have a "focus" property.
277
+ * - Be visible within the viewport.
278
+ *
279
+ * If the returned control does not satisfy these conditions, the standard focus handling logic is executed.
280
+ * @protected
281
+ */
282
+ focusOnEditExtension: function (sSelectedSection) {
283
+ return {};
284
+ },
285
+
286
+ /**
287
+ * An extension point in the application that allows modification of the related app settings.
288
+ *
289
+ * This allows the application team to adjust the relevant application settings in accordance with the current semantics.
290
+ *
291
+ * @param {Object} oRelatedAppSetting - related app setting
292
+ * @param {String} sCurrentSemanticObject - current semantic object for the app
293
+ * @returns {Object} modified related app setting
294
+ * @see {@link topic:8dcfe2e4555f49db8859cb6eb838692e Enabling the Related Apps Button}
295
+ */
296
+ modifyRelatedAppsSettings: function(oRelatedAppSetting, sCurrentSemanticObject) {
297
+ return oRelatedAppSetting;
298
+ }
284
299
  };
285
300
  });
@@ -139,8 +139,11 @@ sap.ui.define(
139
139
  * @param {map} [mUrlParameters] The URL parameters (name-value pairs) for the function or action. Only needed in special cases.
140
140
  * @param {object} [oSettings] Additional settings
141
141
  * @param {boolean} [oSettings.bInvocationGroupingChangeSet=false] Determines whether the common or unique changeset gets sent in batch
142
+ * @param {string} [oSettings.sLabel=""] Optional label for the Function Import.
143
+ * * This label is only used when action is invoked in strict mode and HTTP 412 (Precondition Failed) handling is required.
144
+ * * If not provided, the Function Import name is used as the default label.
145
+ * @param {boolean} [oSettings.bStrict=false] Optional flag to indicate whether the action should be invoked in strict mode. Defaults to <code>false</code>.
142
146
  * @returns {Promise} A <code>Promise</code> for asynchronous execution of the action, resolving to the same result as the <code>Promise</code>
143
- * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
144
147
  * @throws {Error} Throws an error if the OData function import does not exist or the action input parameters are invalid
145
148
  * @public
146
149
  */
@@ -6,7 +6,7 @@
6
6
  "type": "component",
7
7
  "i18n": "i18n/i18n.properties",
8
8
  "applicationVersion": {
9
- "version": "1.140.0"
9
+ "version": "1.141.0"
10
10
  },
11
11
  "title": "{{TITLE}}",
12
12
  "description": "{{DESCRIPTION}}",