@sapui5/types 1.125.1 → 1.126.1

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 (67) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +75 -89
  7. package/types/sap.cux.home.d.ts +336 -0
  8. package/types/sap.esh.search.ui.d.ts +65 -144
  9. package/types/sap.f.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +13 -3
  12. package/types/sap.fe.macros.d.ts +156 -126
  13. package/types/sap.fe.navigation.d.ts +1 -1
  14. package/types/sap.fe.placeholder.d.ts +1 -1
  15. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  16. package/types/sap.fe.templates.d.ts +1 -1
  17. package/types/sap.fe.test.d.ts +1 -1
  18. package/types/sap.fe.tools.d.ts +1 -1
  19. package/types/sap.feedback.ui.d.ts +1 -1
  20. package/types/sap.gantt.d.ts +885 -21
  21. package/types/sap.insights.d.ts +1 -1
  22. package/types/sap.m.d.ts +510 -720
  23. package/types/sap.makit.d.ts +1 -1
  24. package/types/sap.me.d.ts +1 -1
  25. package/types/sap.ndc.d.ts +1 -1
  26. package/types/sap.ovp.d.ts +25 -8
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.df.d.ts +89 -250
  29. package/types/sap.suite.ui.commons.d.ts +6 -5
  30. package/types/sap.suite.ui.generic.template.d.ts +4 -1
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +1 -1
  33. package/types/sap.ui.codeeditor.d.ts +1 -1
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +1699 -1226
  36. package/types/sap.ui.core.d.ts +410 -291
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +2 -2
  39. package/types/sap.ui.fl.d.ts +7 -1
  40. package/types/sap.ui.generic.app.d.ts +1 -1
  41. package/types/sap.ui.generic.template.d.ts +1 -1
  42. package/types/sap.ui.integration.d.ts +26 -117
  43. package/types/sap.ui.layout.d.ts +43 -32
  44. package/types/sap.ui.mdc.d.ts +830 -2992
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +1 -1
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +1 -1
  49. package/types/sap.ui.table.d.ts +14 -3
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +1 -153
  52. package/types/sap.ui.ux3.d.ts +1 -1
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +16 -271
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.ui.webc.common.d.ts +1 -1
  57. package/types/sap.ui.webc.fiori.d.ts +1 -1
  58. package/types/sap.ui.webc.main.d.ts +1 -1
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +1 -1
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +3 -1
  63. package/types/sap.viz.d.ts +1 -1
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.125.0
1
+ // For Library Version: 1.126.1
2
2
 
3
3
  declare module "sap/ui/comp/library" {
4
4
  /**
@@ -768,6 +768,230 @@ declare module "sap/ui/comp/library" {
768
768
  }
769
769
  }
770
770
 
771
+ declare module "sap/ui/comp/config/ControlConfigurationBase" {
772
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
773
+
774
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
775
+
776
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
777
+
778
+ /**
779
+ * An abstract class for configuration of filters in the smart filter bar or in the smart table
780
+ *
781
+ * @since 1.126.0
782
+ */
783
+ export default class ControlConfigurationBase extends UI5Element {
784
+ /**
785
+ * Constructor for a new `ControlConfigurationBase`
786
+ *
787
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
788
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
789
+ * of the syntax of the settings object.
790
+ */
791
+ constructor(
792
+ /**
793
+ * initial settings for the new control
794
+ */
795
+ mSettings?: $ControlConfigurationBaseSettings
796
+ );
797
+ /**
798
+ * Constructor for a new `ControlConfigurationBase`
799
+ *
800
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
801
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
802
+ * of the syntax of the settings object.
803
+ */
804
+ constructor(
805
+ /**
806
+ * ID for the new control, generated automatically if no ID is given
807
+ */
808
+ sID?: string,
809
+ /**
810
+ * initial settings for the new control
811
+ */
812
+ mSettings?: $ControlConfigurationBaseSettings
813
+ );
814
+
815
+ /**
816
+ * Creates a new subclass of class sap.ui.comp.config.ControlConfigurationBase with name `sClassName` and
817
+ * enriches it with the information contained in `oClassInfo`.
818
+ *
819
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
820
+ *
821
+ *
822
+ * @returns Created class / constructor function
823
+ */
824
+ static extend<T extends Record<string, unknown>>(
825
+ /**
826
+ * Name of the class being created
827
+ */
828
+ sClassName: string,
829
+ /**
830
+ * Object literal with information about the class
831
+ */
832
+ oClassInfo?: sap.ClassInfo<T, ControlConfigurationBase>,
833
+ /**
834
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
835
+ * used by this class
836
+ */
837
+ FNMetaImpl?: Function
838
+ ): Function;
839
+ /**
840
+ * Returns a metadata object for class sap.ui.comp.config.ControlConfigurationBase.
841
+ *
842
+ *
843
+ * @returns Metadata object describing this class
844
+ */
845
+ static getMetadata(): ElementMetadata;
846
+ /**
847
+ * Gets current value of property {@link #getConditionType conditionType}.
848
+ *
849
+ * The `conditionType` class name to be used for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type
850
+ *
851
+ *
852
+ * @returns Value of property `conditionType`
853
+ */
854
+ getConditionType(): any;
855
+ /**
856
+ * Gets current value of property {@link #getKey key}.
857
+ *
858
+ * The `key` property corresponds to the field name from the OData service $metadata document.
859
+ *
860
+ *
861
+ * @returns Value of property `key`
862
+ */
863
+ getKey(): string;
864
+ /**
865
+ * Sets a new value for property {@link #getConditionType conditionType}.
866
+ *
867
+ * The `conditionType` class name to be used for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type
868
+ *
869
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
870
+ *
871
+ *
872
+ * @returns Reference to `this` in order to allow method chaining
873
+ */
874
+ setConditionType(
875
+ /**
876
+ * New value for property `conditionType`
877
+ */
878
+ oConditionType?: any
879
+ ): this;
880
+ /**
881
+ * Sets a new value for property {@link #getKey key}.
882
+ *
883
+ * The `key` property corresponds to the field name from the OData service $metadata document.
884
+ *
885
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
886
+ *
887
+ *
888
+ * @returns Reference to `this` in order to allow method chaining
889
+ */
890
+ setKey(
891
+ /**
892
+ * New value for property `key`
893
+ */
894
+ sKey?: string
895
+ ): this;
896
+ }
897
+ /**
898
+ * Describes the settings that can be provided to the ControlConfigurationBase constructor.
899
+ */
900
+ export interface $ControlConfigurationBaseSettings extends $ElementSettings {
901
+ /**
902
+ * The `key` property corresponds to the field name from the OData service $metadata document.
903
+ */
904
+ key?: string | PropertyBindingInfo;
905
+
906
+ /**
907
+ * The `conditionType` class name to be used for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type
908
+ */
909
+ conditionType?: any | PropertyBindingInfo | `{${string}}`;
910
+ }
911
+ }
912
+
913
+ declare module "sap/ui/comp/config/FilterControlConfiguration" {
914
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
915
+
916
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
917
+
918
+ /**
919
+ * The `FilterControlConfiguration` can be used to generate the dynamic date range control used for filtering
920
+ * the smart table.
921
+ *
922
+ * @since 1.126.0
923
+ */
924
+ export default class FilterControlConfiguration extends UI5Element {
925
+ /**
926
+ * Constructor for a new `FilterControlConfiguration`
927
+ *
928
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
929
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
930
+ * of the syntax of the settings object.
931
+ */
932
+ constructor(
933
+ /**
934
+ * initial settings for the new control
935
+ */
936
+ mSettings?: $FilterControlConfigurationSettings
937
+ );
938
+ /**
939
+ * Constructor for a new `FilterControlConfiguration`
940
+ *
941
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
942
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
943
+ * of the syntax of the settings object.
944
+ */
945
+ constructor(
946
+ /**
947
+ * ID for the new control, generated automatically if no ID is given
948
+ */
949
+ sID?: string,
950
+ /**
951
+ * initial settings for the new control
952
+ */
953
+ mSettings?: $FilterControlConfigurationSettings
954
+ );
955
+
956
+ /**
957
+ * Creates a new subclass of class sap.ui.comp.config.FilterControlConfiguration with name `sClassName`
958
+ * and enriches it with the information contained in `oClassInfo`.
959
+ *
960
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
961
+ *
962
+ *
963
+ * @returns Created class / constructor function
964
+ */
965
+ static extend<T extends Record<string, unknown>>(
966
+ /**
967
+ * Name of the class being created
968
+ */
969
+ sClassName: string,
970
+ /**
971
+ * Object literal with information about the class
972
+ */
973
+ oClassInfo?: sap.ClassInfo<T, FilterControlConfiguration>,
974
+ /**
975
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
976
+ * used by this class
977
+ */
978
+ FNMetaImpl?: Function
979
+ ): Function;
980
+ /**
981
+ * Returns a metadata object for class sap.ui.comp.config.FilterControlConfiguration.
982
+ *
983
+ *
984
+ * @returns Metadata object describing this class
985
+ */
986
+ static getMetadata(): ElementMetadata;
987
+ }
988
+ /**
989
+ * Describes the settings that can be provided to the FilterControlConfiguration constructor.
990
+ */
991
+ export interface $FilterControlConfigurationSettings
992
+ extends $ElementSettings {}
993
+ }
994
+
771
995
  declare module "sap/ui/comp/filterbar/FilterBar" {
772
996
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
773
997
 
@@ -2403,6 +2627,19 @@ declare module "sap/ui/comp/filterbar/FilterBar" {
2403
2627
  */
2404
2628
  mParameters?: FilterBar$ClearEventParameters
2405
2629
  ): this;
2630
+ /**
2631
+ * Fires event {@link #event:filterChange filterChange} to attached listeners.
2632
+ *
2633
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2634
+ *
2635
+ * @returns Reference to `this` in order to allow method chaining
2636
+ */
2637
+ fireFilterChange(
2638
+ /**
2639
+ * Parameters to pass along with the event
2640
+ */
2641
+ mParameters?: FilterBar$FilterChangeEventParameters
2642
+ ): this;
2406
2643
  /**
2407
2644
  * Fires event {@link #event:filtersDialogBeforeOpen filtersDialogBeforeOpen} to attached listeners.
2408
2645
  *
@@ -5123,7 +5360,10 @@ declare module "sap/ui/comp/filterbar/FilterItem" {
5123
5360
  }
5124
5361
 
5125
5362
  declare module "sap/ui/comp/navpopover/LinkData" {
5126
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
5363
+ import {
5364
+ default as LinkItem,
5365
+ $LinkItemSettings,
5366
+ } from "sap/ui/mdc/link/LinkItem";
5127
5367
 
5128
5368
  import ElementMetadata from "sap/ui/core/ElementMetadata";
5129
5369
 
@@ -5136,7 +5376,7 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5136
5376
  *
5137
5377
  * @since 1.28.0
5138
5378
  */
5139
- export default class LinkData extends UI5Element {
5379
+ export default class LinkData extends LinkItem {
5140
5380
  /**
5141
5381
  * Constructor for a new navpopover/LinkData.
5142
5382
  *
@@ -5172,7 +5412,7 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5172
5412
  * Creates a new subclass of class sap.ui.comp.navpopover.LinkData with name `sClassName` and enriches it
5173
5413
  * with the information contained in `oClassInfo`.
5174
5414
  *
5175
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
5415
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.link.LinkItem.extend}.
5176
5416
  *
5177
5417
  *
5178
5418
  * @returns Created class / constructor function
@@ -5199,38 +5439,6 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5199
5439
  * @returns Metadata object describing this class
5200
5440
  */
5201
5441
  static getMetadata(): ElementMetadata;
5202
- /**
5203
- * Gets current value of property {@link #getDescription description}.
5204
- *
5205
- * Description of the link.
5206
- *
5207
- * Default value is `undefined`.
5208
- *
5209
- * @since 1.42.0
5210
- *
5211
- * @returns Value of property `description`
5212
- */
5213
- getDescription(): string;
5214
- /**
5215
- * Gets current value of property {@link #getHref href}.
5216
- *
5217
- * Destination link for a navigation operation in external format using the `hrefForExternal` method of
5218
- * the CrossApplicationNavigation service.
5219
- *
5220
- *
5221
- * @returns Value of property `href`
5222
- */
5223
- getHref(): string;
5224
- /**
5225
- * Gets current value of property {@link #getInternalHref internalHref}.
5226
- *
5227
- * Destination link for a navigation operation in internal format provided by FLP. Only for internal use
5228
- * in the NavigationPopoverHandler
5229
- *
5230
- *
5231
- * @returns Value of property `internalHref`
5232
- */
5233
- getInternalHref(): string;
5234
5442
  /**
5235
5443
  * Gets current value of property {@link #getIsSuperiorAction isSuperiorAction}.
5236
5444
  *
@@ -5241,28 +5449,6 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5241
5449
  * @returns Value of property `isSuperiorAction`
5242
5450
  */
5243
5451
  getIsSuperiorAction(): boolean;
5244
- /**
5245
- * Gets current value of property {@link #getKey key}.
5246
- *
5247
- * Key of link.
5248
- *
5249
- * Default value is `undefined`.
5250
- *
5251
- * @since 1.44.0
5252
- *
5253
- * @returns Value of property `key`
5254
- */
5255
- getKey(): string;
5256
- /**
5257
- * Gets current value of property {@link #getPress press}.
5258
- *
5259
- * Callback for `press` event.
5260
- *
5261
- * @since 1.46.0
5262
- *
5263
- * @returns Value of property `press`
5264
- */
5265
- getPress(): object;
5266
5452
  /**
5267
5453
  * Gets current value of property {@link #getTarget target}.
5268
5454
  *
@@ -5273,15 +5459,6 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5273
5459
  * @returns Value of property `target`
5274
5460
  */
5275
5461
  getTarget(): string;
5276
- /**
5277
- * Gets current value of property {@link #getText text}.
5278
- *
5279
- * Text which can be displayed on the UI
5280
- *
5281
- *
5282
- * @returns Value of property `text`
5283
- */
5284
- getText(): string;
5285
5462
  /**
5286
5463
  * Gets current value of property {@link #getVisible visible}.
5287
5464
  *
@@ -5300,63 +5477,11 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5300
5477
  * Describes whether the visibility is changed by end user or not.
5301
5478
  *
5302
5479
  * @since 1.58.0
5480
+ * @deprecated (since 1.122) - The SmartLink now uses information stored on {@link sap.ui.mdc.link.PanelItem}
5303
5481
  *
5304
5482
  * @returns Value of property `visibleChangedByUser`
5305
5483
  */
5306
5484
  getVisibleChangedByUser(): boolean;
5307
- /**
5308
- * Sets a new value for property {@link #getDescription description}.
5309
- *
5310
- * Description of the link.
5311
- *
5312
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5313
- *
5314
- * Default value is `undefined`.
5315
- *
5316
- * @since 1.42.0
5317
- *
5318
- * @returns Reference to `this` in order to allow method chaining
5319
- */
5320
- setDescription(
5321
- /**
5322
- * New value for property `description`
5323
- */
5324
- sDescription?: string
5325
- ): this;
5326
- /**
5327
- * Sets a new value for property {@link #getHref href}.
5328
- *
5329
- * Destination link for a navigation operation in external format using the `hrefForExternal` method of
5330
- * the CrossApplicationNavigation service.
5331
- *
5332
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5333
- *
5334
- *
5335
- * @returns Reference to `this` in order to allow method chaining
5336
- */
5337
- setHref(
5338
- /**
5339
- * New value for property `href`
5340
- */
5341
- sHref?: string
5342
- ): this;
5343
- /**
5344
- * Sets a new value for property {@link #getInternalHref internalHref}.
5345
- *
5346
- * Destination link for a navigation operation in internal format provided by FLP. Only for internal use
5347
- * in the NavigationPopoverHandler
5348
- *
5349
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5350
- *
5351
- *
5352
- * @returns Reference to `this` in order to allow method chaining
5353
- */
5354
- setInternalHref(
5355
- /**
5356
- * New value for property `internalHref`
5357
- */
5358
- sInternalHref?: string
5359
- ): this;
5360
5485
  /**
5361
5486
  * Sets a new value for property {@link #getIsSuperiorAction isSuperiorAction}.
5362
5487
  *
@@ -5374,42 +5499,6 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5374
5499
  */
5375
5500
  bIsSuperiorAction: boolean
5376
5501
  ): this;
5377
- /**
5378
- * Sets a new value for property {@link #getKey key}.
5379
- *
5380
- * Key of link.
5381
- *
5382
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5383
- *
5384
- * Default value is `undefined`.
5385
- *
5386
- * @since 1.44.0
5387
- *
5388
- * @returns Reference to `this` in order to allow method chaining
5389
- */
5390
- setKey(
5391
- /**
5392
- * New value for property `key`
5393
- */
5394
- sKey?: string
5395
- ): this;
5396
- /**
5397
- * Sets a new value for property {@link #getPress press}.
5398
- *
5399
- * Callback for `press` event.
5400
- *
5401
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5402
- *
5403
- * @since 1.46.0
5404
- *
5405
- * @returns Reference to `this` in order to allow method chaining
5406
- */
5407
- setPress(
5408
- /**
5409
- * New value for property `press`
5410
- */
5411
- oPress?: object
5412
- ): this;
5413
5502
  /**
5414
5503
  * Sets a new value for property {@link #getTarget target}.
5415
5504
  *
@@ -5427,22 +5516,6 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5427
5516
  */
5428
5517
  sTarget?: string
5429
5518
  ): this;
5430
- /**
5431
- * Sets a new value for property {@link #getText text}.
5432
- *
5433
- * Text which can be displayed on the UI
5434
- *
5435
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5436
- *
5437
- *
5438
- * @returns Reference to `this` in order to allow method chaining
5439
- */
5440
- setText(
5441
- /**
5442
- * New value for property `text`
5443
- */
5444
- sText?: string
5445
- ): this;
5446
5519
  /**
5447
5520
  * Sets a new value for property {@link #getVisible visible}.
5448
5521
  *
@@ -5470,6 +5543,7 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5470
5543
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5471
5544
  *
5472
5545
  * @since 1.58.0
5546
+ * @deprecated (since 1.122) - The SmartLink now uses information stored on {@link sap.ui.mdc.link.PanelItem}
5473
5547
  *
5474
5548
  * @returns Reference to `this` in order to allow method chaining
5475
5549
  */
@@ -5483,37 +5557,13 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5483
5557
  /**
5484
5558
  * Describes the settings that can be provided to the LinkData constructor.
5485
5559
  */
5486
- export interface $LinkDataSettings extends $ElementSettings {
5487
- /**
5488
- * Text which can be displayed on the UI
5489
- */
5490
- text?: string | PropertyBindingInfo;
5491
-
5492
- /**
5493
- * Destination link for a navigation operation in external format using the `hrefForExternal` method of
5494
- * the CrossApplicationNavigation service.
5495
- */
5496
- href?: string | PropertyBindingInfo;
5497
-
5498
- /**
5499
- * Destination link for a navigation operation in internal format provided by FLP. Only for internal use
5500
- * in the NavigationPopoverHandler
5501
- */
5502
- internalHref?: string | PropertyBindingInfo;
5503
-
5560
+ export interface $LinkDataSettings extends $LinkItemSettings {
5504
5561
  /**
5505
5562
  * The standard values for the `target` property are: _self, _top, _blank, _parent, _search. Alternatively,
5506
5563
  * a frame name can be entered. This property is only used if the `href` property is set.
5507
5564
  */
5508
5565
  target?: string | PropertyBindingInfo;
5509
5566
 
5510
- /**
5511
- * Description of the link.
5512
- *
5513
- * @since 1.42.0
5514
- */
5515
- description?: string | PropertyBindingInfo;
5516
-
5517
5567
  /**
5518
5568
  * Describes whether the link should be visible on the screen.
5519
5569
  *
@@ -5521,20 +5571,6 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5521
5571
  */
5522
5572
  visible?: boolean | PropertyBindingInfo | `{${string}}`;
5523
5573
 
5524
- /**
5525
- * Key of link.
5526
- *
5527
- * @since 1.44.0
5528
- */
5529
- key?: string | PropertyBindingInfo;
5530
-
5531
- /**
5532
- * Callback for `press` event.
5533
- *
5534
- * @since 1.46.0
5535
- */
5536
- press?: object | PropertyBindingInfo | `{${string}}`;
5537
-
5538
5574
  /**
5539
5575
  * Marker for superior action.
5540
5576
  *
@@ -5546,6 +5582,7 @@ declare module "sap/ui/comp/navpopover/LinkData" {
5546
5582
  * Describes whether the visibility is changed by end user or not.
5547
5583
  *
5548
5584
  * @since 1.58.0
5585
+ * @deprecated (since 1.122) - The SmartLink now uses information stored on {@link sap.ui.mdc.link.PanelItem}
5549
5586
  */
5550
5587
  visibleChangedByUser?: boolean | PropertyBindingInfo | `{${string}}`;
5551
5588
  }
@@ -6716,6 +6753,7 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
6716
6753
  * to change the targets.
6717
6754
  *
6718
6755
  * @since 1.36.0
6756
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
6719
6757
  *
6720
6758
  * @returns Reference to `this` in order to allow method chaining
6721
6759
  */
@@ -6748,6 +6786,7 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
6748
6786
  * to change the targets.
6749
6787
  *
6750
6788
  * @since 1.36.0
6789
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
6751
6790
  *
6752
6791
  * @returns Reference to `this` in order to allow method chaining
6753
6792
  */
@@ -6813,6 +6852,7 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
6813
6852
  * The passed function and listener object must match the ones used for event registration.
6814
6853
  *
6815
6854
  * @since 1.36.0
6855
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
6816
6856
  *
6817
6857
  * @returns Reference to `this` in order to allow method chaining
6818
6858
  */
@@ -6860,6 +6900,7 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
6860
6900
  * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners.
6861
6901
  *
6862
6902
  * @since 1.36.0
6903
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
6863
6904
  * @ui5-protected Do not call from applications (only from related classes in the framework)
6864
6905
  *
6865
6906
  * @returns Reference to `this` in order to allow method chaining
@@ -6885,10 +6926,10 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
6885
6926
  /**
6886
6927
  * Gets current value of property {@link #getBeforeNavigationCallback beforeNavigationCallback}.
6887
6928
  *
6888
- * Function that is called before the actual navigation happens. This function has to return a promise resolving
6889
- * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
6890
- * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
6891
- *
6929
+ * Function that is called before the actual navigation happens. This function has to return a `Promise`
6930
+ * resolving into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the
6931
+ * navigation will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the
6932
+ * following data:
6892
6933
  * - {String} text: Text of the navigation intent
6893
6934
  * - {String} href: HREF of the navigation intent
6894
6935
  * - {String} originalId: ID of the control that fires the navigation intent
@@ -6957,6 +6998,21 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
6957
6998
  * @returns Value of property `mapFieldToSemanticObject`
6958
6999
  */
6959
7000
  getMapFieldToSemanticObject(): boolean;
7001
+ /**
7002
+ * Gets current value of property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}.
7003
+ *
7004
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
7005
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
7006
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
7007
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
7008
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
7009
+ * event. The event handling is ignored if this callback is set.
7010
+ *
7011
+ * @since 1.126
7012
+ *
7013
+ * @returns Value of property `navigationTargetsObtainedCallback`
7014
+ */
7015
+ getNavigationTargetsObtainedCallback(): Function;
6960
7016
  /**
6961
7017
  * Gets current value of property {@link #getSemanticObject semanticObject}.
6962
7018
  *
@@ -7032,10 +7088,10 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7032
7088
  /**
7033
7089
  * Sets a new value for property {@link #getBeforeNavigationCallback beforeNavigationCallback}.
7034
7090
  *
7035
- * Function that is called before the actual navigation happens. This function has to return a promise resolving
7036
- * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
7037
- * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
7038
- *
7091
+ * Function that is called before the actual navigation happens. This function has to return a `Promise`
7092
+ * resolving into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the
7093
+ * navigation will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the
7094
+ * following data:
7039
7095
  * - {String} text: Text of the navigation intent
7040
7096
  * - {String} href: HREF of the navigation intent
7041
7097
  * - {String} originalId: ID of the control that fires the navigation intent
@@ -7147,6 +7203,28 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7147
7203
  */
7148
7204
  bMapFieldToSemanticObject?: boolean
7149
7205
  ): this;
7206
+ /**
7207
+ * Sets a new value for property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}.
7208
+ *
7209
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
7210
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
7211
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
7212
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
7213
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
7214
+ * event. The event handling is ignored if this callback is set.
7215
+ *
7216
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7217
+ *
7218
+ * @since 1.126
7219
+ *
7220
+ * @returns Reference to `this` in order to allow method chaining
7221
+ */
7222
+ setNavigationTargetsObtainedCallback(
7223
+ /**
7224
+ * New value for property `navigationTargetsObtainedCallback`
7225
+ */
7226
+ fnNavigationTargetsObtainedCallback: Function
7227
+ ): this;
7150
7228
  /**
7151
7229
  * Sets a new value for property {@link #getSemanticObject semanticObject}.
7152
7230
  *
@@ -7277,10 +7355,10 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7277
7355
  | `{${string}}`;
7278
7356
 
7279
7357
  /**
7280
- * Function that is called before the actual navigation happens. This function has to return a promise resolving
7281
- * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
7282
- * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
7283
- *
7358
+ * Function that is called before the actual navigation happens. This function has to return a `Promise`
7359
+ * resolving into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the
7360
+ * navigation will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the
7361
+ * following data:
7284
7362
  * - {String} text: Text of the navigation intent
7285
7363
  * - {String} href: HREF of the navigation intent
7286
7364
  * - {String} originalId: ID of the control that fires the navigation intent
@@ -7292,6 +7370,21 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7292
7370
  */
7293
7371
  beforeNavigationCallback?: Function | PropertyBindingInfo | `{${string}}`;
7294
7372
 
7373
+ /**
7374
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
7375
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
7376
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
7377
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
7378
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
7379
+ * event. The event handling is ignored if this callback is set.
7380
+ *
7381
+ * @since 1.126
7382
+ */
7383
+ navigationTargetsObtainedCallback?:
7384
+ | Function
7385
+ | PropertyBindingInfo
7386
+ | `{${string}}`;
7387
+
7295
7388
  /**
7296
7389
  * The parent control.
7297
7390
  *
@@ -7315,6 +7408,7 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7315
7408
  * to change the targets.
7316
7409
  *
7317
7410
  * @since 1.36.0
7411
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
7318
7412
  */
7319
7413
  navigationTargetsObtained?: (
7320
7414
  oEvent: NavigationPopoverHandler$NavigationTargetsObtainedEvent
@@ -7430,6 +7524,8 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7430
7524
 
7431
7525
  /**
7432
7526
  * Parameters of the NavigationPopoverHandler#navigationTargetsObtained event.
7527
+ *
7528
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
7433
7529
  */
7434
7530
  export interface NavigationPopoverHandler$NavigationTargetsObtainedEventParameters {
7435
7531
  /**
@@ -7500,6 +7596,8 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7500
7596
 
7501
7597
  /**
7502
7598
  * Event object of the NavigationPopoverHandler#navigationTargetsObtained event.
7599
+ *
7600
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
7503
7601
  */
7504
7602
  export type NavigationPopoverHandler$NavigationTargetsObtainedEvent = Event<
7505
7603
  NavigationPopoverHandler$NavigationTargetsObtainedEventParameters,
@@ -7507,64 +7605,121 @@ declare module "sap/ui/comp/navpopover/NavigationPopoverHandler" {
7507
7605
  >;
7508
7606
  }
7509
7607
 
7510
- declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7511
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
7608
+ declare module "sap/ui/comp/navpopover/SmartLink" {
7609
+ import LinkData from "sap/ui/comp/navpopover/LinkData";
7512
7610
 
7513
- import ElementMetadata from "sap/ui/core/ElementMetadata";
7611
+ import SimpleForm from "sap/ui/layout/form/SimpleForm";
7514
7612
 
7515
- import SmartLink from "sap/ui/comp/navpopover/SmartLink";
7613
+ import Control from "sap/ui/core/Control";
7516
7614
 
7517
- import NavigationPopoverHandler from "sap/ui/comp/navpopover/NavigationPopoverHandler";
7615
+ import { default as Link, $LinkSettings } from "sap/m/Link";
7616
+
7617
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
7518
7618
 
7519
7619
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
7520
7620
 
7521
7621
  import Event from "sap/ui/base/Event";
7522
7622
 
7523
- import LinkData from "sap/ui/comp/navpopover/LinkData";
7524
-
7525
- import SimpleForm from "sap/ui/layout/form/SimpleForm";
7623
+ /**
7624
+ * Object holding the information regarding the obtained navigation targets and extra content. This is used
7625
+ * as parameter and return value of the `Promise` in the `navigationTargetsObtainedCallback`.
7626
+ */
7627
+ export type NavigationTargets = {
7628
+ /**
7629
+ * The text of the main link / text that is displayed in the header of the popover.
7630
+ */
7631
+ mainNavigationId: string;
7632
+ /**
7633
+ * The main navigation object
7634
+ */
7635
+ mainNavigation: LinkData;
7636
+ /**
7637
+ * Array of available navigation target objects
7638
+ */
7639
+ actions: LinkData[];
7640
+ /**
7641
+ * The navigation object for the own application. This navigation option is not visible on the popover by
7642
+ * default.
7643
+ */
7644
+ ownNavigation: LinkData;
7645
+ /**
7646
+ * Array containing contact data. Manipulating this property won't have an effect, it's only relevant to
7647
+ * be streamlined with the old API. The `extraContent` property is used to return the intended content.
7648
+ */
7649
+ popoverForms: SimpleForm[];
7650
+ /**
7651
+ * The semantic object for which the navigation targets have been retrieved
7652
+ */
7653
+ semanticObject: String;
7654
+ /**
7655
+ * Map containing the semantic attributes
7656
+ */
7657
+ semanticAttributes: object;
7658
+ /**
7659
+ * The ID of the `SmartLink` or other parent control
7660
+ */
7661
+ originalId: String;
7662
+ /**
7663
+ * The control that is displayed in the extra content section on the popover. If set to `null`, the extra
7664
+ * content is removed. If set to `undefined`, a {@link sap.m.VBox} containing the `popoverForms` as items
7665
+ * is used as extra content. The `popoverForms` can be empty.
7666
+ */
7667
+ extraContent: Control | null | undefined;
7668
+ };
7526
7669
 
7527
7670
  /**
7528
- * The `SemanticObjectController` control operates as a single entry point for `SmartLink` controls created
7529
- * automatically by {@link sap.ui.comp.smarttable.SmartTable SmartTable} control, {@link sap.ui.comp.smartchart.SmartChart SmartChart }
7530
- * control, {@link sap.ui.comp.smartform.SmartForm SmartForm} control and {@link sap.ui.comp.smartfield.SmartField SmartField }
7531
- * control based on OData metadata. Additionally, all events provided by the `SmartLink` control are registered
7532
- * by the SemanticObjectController and can be consumed there in a single place. As usual, the SemanticObjectController
7533
- * can be defined within the XML view as well as in the code.
7671
+ * The `SmartLink` control uses a semantic object to display {@link sap.ui.comp.navpopover.NavigationPopover NavigationPopover }
7672
+ * for further navigation steps.
7673
+ * **Note:** Navigation targets are determined using {@link sap.ushell.services.CrossApplicationNavigation CrossApplicationNavigation }
7674
+ * of the unified shell service.
7675
+ *
7676
+ * **Important:** Keep in mind that `SmartLink`, like all SAPUI5 smart controls, retrieves and analyzes
7677
+ * the metadata and annotations of OData services. **The OData metadata is its primary API. These OData
7678
+ * services are not part of the SAPUI5 framework and are usually maintained by the backend developers of
7679
+ * your application.**
7680
+ *
7681
+ * With time, `SmartLink` can evolve and acquire new features. This means that its behavior or functionalities
7682
+ * may change if the annotations that define this change are maintained in your backend metadata. To benefit
7683
+ * from the new functionalities, your application should be able to adapt the backend metadata. **Therefore,
7684
+ * we recommend using `SmartLink` only if you have control over the metadata of your application.**
7534
7685
  */
7535
- export default class SemanticObjectController extends UI5Element {
7686
+ export default class SmartLink extends Link {
7536
7687
  /**
7537
7688
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
7538
7689
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
7539
7690
  * of the syntax of the settings object.
7691
+ * See:
7692
+ * {@link https://ui5.sap.com/#/topic/f638884d0d624ad8a243f4005f8e9972 Smart Link}
7540
7693
  */
7541
7694
  constructor(
7542
7695
  /**
7543
- * initial settings for the new control
7696
+ * Initial settings for the new control
7544
7697
  */
7545
- mSettings?: $SemanticObjectControllerSettings
7698
+ mSettings?: $SmartLinkSettings
7546
7699
  );
7547
7700
  /**
7548
7701
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
7549
7702
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
7550
7703
  * of the syntax of the settings object.
7704
+ * See:
7705
+ * {@link https://ui5.sap.com/#/topic/f638884d0d624ad8a243f4005f8e9972 Smart Link}
7551
7706
  */
7552
7707
  constructor(
7553
7708
  /**
7554
7709
  * ID for the new control, generated automatically if no ID is given
7555
7710
  */
7556
- sID?: string,
7711
+ sId?: string,
7557
7712
  /**
7558
- * initial settings for the new control
7713
+ * Initial settings for the new control
7559
7714
  */
7560
- mSettings?: $SemanticObjectControllerSettings
7715
+ mSettings?: $SmartLinkSettings
7561
7716
  );
7562
7717
 
7563
7718
  /**
7564
- * Creates a new subclass of class sap.ui.comp.navpopover.SemanticObjectController with name `sClassName`
7565
- * and enriches it with the information contained in `oClassInfo`.
7719
+ * Creates a new subclass of class sap.ui.comp.navpopover.SmartLink with name `sClassName` and enriches
7720
+ * it with the information contained in `oClassInfo`.
7566
7721
  *
7567
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
7722
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Link.extend}.
7568
7723
  *
7569
7724
  *
7570
7725
  * @returns Created class / constructor function
@@ -7577,7 +7732,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7577
7732
  /**
7578
7733
  * Object literal with information about the class
7579
7734
  */
7580
- oClassInfo?: sap.ClassInfo<T, SemanticObjectController>,
7735
+ oClassInfo?: sap.ClassInfo<T, SmartLink>,
7581
7736
  /**
7582
7737
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
7583
7738
  * used by this class
@@ -7585,7 +7740,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7585
7740
  FNMetaImpl?: Function
7586
7741
  ): Function;
7587
7742
  /**
7588
- * Returns a metadata object for class sap.ui.comp.navpopover.SemanticObjectController.
7743
+ * Returns a metadata object for class sap.ui.comp.navpopover.SmartLink.
7589
7744
  *
7590
7745
  *
7591
7746
  * @returns Metadata object describing this class
@@ -7593,14 +7748,14 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7593
7748
  static getMetadata(): ElementMetadata;
7594
7749
  /**
7595
7750
  * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event
7596
- * of this `sap.ui.comp.navpopover.SemanticObjectController`.
7751
+ * of this `sap.ui.comp.navpopover.SmartLink`.
7597
7752
  *
7598
7753
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7599
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7754
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
7600
7755
  *
7601
- * Event is fired before the navigation popover opens and before navigation target links are retrieved.
7602
- * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink,
7603
- * `beforePopoverOpens` is fired after the link has been clicked.
7756
+ * Event is fired before the navigation popover opens and before navigation target links are getting retrieved.
7757
+ * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink
7758
+ * control, the `beforePopoverOpens` is fired after the link has been clicked.
7604
7759
  *
7605
7760
  * @since 1.28.0
7606
7761
  *
@@ -7615,25 +7770,22 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7615
7770
  /**
7616
7771
  * The function to be called when the event occurs
7617
7772
  */
7618
- fnFunction: (
7619
- p1: SemanticObjectController$BeforePopoverOpensEvent
7620
- ) => void,
7773
+ fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void,
7621
7774
  /**
7622
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7623
- * itself
7775
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
7624
7776
  */
7625
7777
  oListener?: object
7626
7778
  ): this;
7627
7779
  /**
7628
7780
  * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event
7629
- * of this `sap.ui.comp.navpopover.SemanticObjectController`.
7781
+ * of this `sap.ui.comp.navpopover.SmartLink`.
7630
7782
  *
7631
7783
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7632
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7784
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
7633
7785
  *
7634
- * Event is fired before the navigation popover opens and before navigation target links are retrieved.
7635
- * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink,
7636
- * `beforePopoverOpens` is fired after the link has been clicked.
7786
+ * Event is fired before the navigation popover opens and before navigation target links are getting retrieved.
7787
+ * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink
7788
+ * control, the `beforePopoverOpens` is fired after the link has been clicked.
7637
7789
  *
7638
7790
  * @since 1.28.0
7639
7791
  *
@@ -7643,20 +7795,17 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7643
7795
  /**
7644
7796
  * The function to be called when the event occurs
7645
7797
  */
7646
- fnFunction: (
7647
- p1: SemanticObjectController$BeforePopoverOpensEvent
7648
- ) => void,
7798
+ fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void,
7649
7799
  /**
7650
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7651
- * itself
7800
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
7652
7801
  */
7653
7802
  oListener?: object
7654
7803
  ): this;
7655
7804
  /**
7656
- * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7805
+ * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.SmartLink`.
7657
7806
  *
7658
7807
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7659
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7808
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
7660
7809
  *
7661
7810
  * This event is fired after a navigation link on the navigation popover has been clicked. This event is
7662
7811
  * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window'
@@ -7666,7 +7815,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7666
7815
  *
7667
7816
  * @returns Reference to `this` in order to allow method chaining
7668
7817
  */
7669
- attachNavigate(
7818
+ attachInnerNavigate(
7670
7819
  /**
7671
7820
  * An application-specific payload object that will be passed to the event handler along with the event
7672
7821
  * object when firing the event
@@ -7675,18 +7824,17 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7675
7824
  /**
7676
7825
  * The function to be called when the event occurs
7677
7826
  */
7678
- fnFunction: (p1: SemanticObjectController$NavigateEvent) => void,
7827
+ fnFunction: (p1: SmartLink$InnerNavigateEvent) => void,
7679
7828
  /**
7680
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7681
- * itself
7829
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
7682
7830
  */
7683
7831
  oListener?: object
7684
7832
  ): this;
7685
7833
  /**
7686
- * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7834
+ * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.SmartLink`.
7687
7835
  *
7688
7836
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7689
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7837
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
7690
7838
  *
7691
7839
  * This event is fired after a navigation link on the navigation popover has been clicked. This event is
7692
7840
  * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window'
@@ -7696,28 +7844,28 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7696
7844
  *
7697
7845
  * @returns Reference to `this` in order to allow method chaining
7698
7846
  */
7699
- attachNavigate(
7847
+ attachInnerNavigate(
7700
7848
  /**
7701
7849
  * The function to be called when the event occurs
7702
7850
  */
7703
- fnFunction: (p1: SemanticObjectController$NavigateEvent) => void,
7851
+ fnFunction: (p1: SmartLink$InnerNavigateEvent) => void,
7704
7852
  /**
7705
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7706
- * itself
7853
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
7707
7854
  */
7708
7855
  oListener?: object
7709
7856
  ): this;
7710
7857
  /**
7711
7858
  * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained }
7712
- * event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7859
+ * event of this `sap.ui.comp.navpopover.SmartLink`.
7713
7860
  *
7714
7861
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7715
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7862
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
7716
7863
  *
7717
- * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible
7718
- * you to change the targets.
7864
+ * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility
7865
+ * to change the targets.
7719
7866
  *
7720
7867
  * @since 1.28.0
7868
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
7721
7869
  *
7722
7870
  * @returns Reference to `this` in order to allow method chaining
7723
7871
  */
@@ -7730,26 +7878,24 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7730
7878
  /**
7731
7879
  * The function to be called when the event occurs
7732
7880
  */
7733
- fnFunction: (
7734
- p1: SemanticObjectController$NavigationTargetsObtainedEvent
7735
- ) => void,
7881
+ fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void,
7736
7882
  /**
7737
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7738
- * itself
7883
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
7739
7884
  */
7740
7885
  oListener?: object
7741
7886
  ): this;
7742
7887
  /**
7743
7888
  * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained }
7744
- * event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7889
+ * event of this `sap.ui.comp.navpopover.SmartLink`.
7745
7890
  *
7746
7891
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7747
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7892
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
7748
7893
  *
7749
- * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible
7750
- * you to change the targets.
7894
+ * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility
7895
+ * to change the targets.
7751
7896
  *
7752
7897
  * @since 1.28.0
7898
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
7753
7899
  *
7754
7900
  * @returns Reference to `this` in order to allow method chaining
7755
7901
  */
@@ -7757,75 +7903,23 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7757
7903
  /**
7758
7904
  * The function to be called when the event occurs
7759
7905
  */
7760
- fnFunction: (
7761
- p1: SemanticObjectController$NavigationTargetsObtainedEvent
7762
- ) => void,
7763
- /**
7764
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7765
- * itself
7766
- */
7767
- oListener?: object
7768
- ): this;
7769
- /**
7770
- * Attaches event handler `fnFunction` to the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7771
- *
7772
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7773
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7774
- *
7775
- * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all
7776
- * navigation targets have been retrieved.
7777
- *
7778
- * @since 1.28.0
7779
- * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
7780
- * `prefetchNavigationTargets` which has been deprecated.
7781
- *
7782
- * @returns Reference to `this` in order to allow method chaining
7783
- */
7784
- attachPrefetchDone(
7785
- /**
7786
- * An application-specific payload object that will be passed to the event handler along with the event
7787
- * object when firing the event
7788
- */
7789
- oData: object,
7790
- /**
7791
- * The function to be called when the event occurs
7792
- */
7793
- fnFunction: (p1: SemanticObjectController$PrefetchDoneEvent) => void,
7906
+ fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void,
7794
7907
  /**
7795
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7796
- * itself
7908
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
7797
7909
  */
7798
7910
  oListener?: object
7799
7911
  ): this;
7800
7912
  /**
7801
- * Attaches event handler `fnFunction` to the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7802
- *
7803
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7804
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
7805
- *
7806
- * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all
7807
- * navigation targets have been retrieved.
7913
+ * Destroys the innerControl in the aggregation {@link #getInnerControl innerControl}.
7808
7914
  *
7809
7915
  * @since 1.28.0
7810
- * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
7811
- * `prefetchNavigationTargets` which has been deprecated.
7812
7916
  *
7813
7917
  * @returns Reference to `this` in order to allow method chaining
7814
7918
  */
7815
- attachPrefetchDone(
7816
- /**
7817
- * The function to be called when the event occurs
7818
- */
7819
- fnFunction: (p1: SemanticObjectController$PrefetchDoneEvent) => void,
7820
- /**
7821
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
7822
- * itself
7823
- */
7824
- oListener?: object
7825
- ): this;
7919
+ destroyInnerControl(): this;
7826
7920
  /**
7827
7921
  * Detaches event handler `fnFunction` from the {@link #event:beforePopoverOpens beforePopoverOpens} event
7828
- * of this `sap.ui.comp.navpopover.SemanticObjectController`.
7922
+ * of this `sap.ui.comp.navpopover.SmartLink`.
7829
7923
  *
7830
7924
  * The passed function and listener object must match the ones used for event registration.
7831
7925
  *
@@ -7837,16 +7931,15 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7837
7931
  /**
7838
7932
  * The function to be called, when the event occurs
7839
7933
  */
7840
- fnFunction: (
7841
- p1: SemanticObjectController$BeforePopoverOpensEvent
7842
- ) => void,
7934
+ fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void,
7843
7935
  /**
7844
7936
  * Context object on which the given function had to be called
7845
7937
  */
7846
7938
  oListener?: object
7847
7939
  ): this;
7848
7940
  /**
7849
- * Detaches event handler `fnFunction` from the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7941
+ * Detaches event handler `fnFunction` from the {@link #event:innerNavigate innerNavigate} event of this
7942
+ * `sap.ui.comp.navpopover.SmartLink`.
7850
7943
  *
7851
7944
  * The passed function and listener object must match the ones used for event registration.
7852
7945
  *
@@ -7854,11 +7947,11 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7854
7947
  *
7855
7948
  * @returns Reference to `this` in order to allow method chaining
7856
7949
  */
7857
- detachNavigate(
7950
+ detachInnerNavigate(
7858
7951
  /**
7859
7952
  * The function to be called, when the event occurs
7860
7953
  */
7861
- fnFunction: (p1: SemanticObjectController$NavigateEvent) => void,
7954
+ fnFunction: (p1: SmartLink$InnerNavigateEvent) => void,
7862
7955
  /**
7863
7956
  * Context object on which the given function had to be called
7864
7957
  */
@@ -7866,11 +7959,12 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7866
7959
  ): this;
7867
7960
  /**
7868
7961
  * Detaches event handler `fnFunction` from the {@link #event:navigationTargetsObtained navigationTargetsObtained }
7869
- * event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7962
+ * event of this `sap.ui.comp.navpopover.SmartLink`.
7870
7963
  *
7871
7964
  * The passed function and listener object must match the ones used for event registration.
7872
7965
  *
7873
7966
  * @since 1.28.0
7967
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
7874
7968
  *
7875
7969
  * @returns Reference to `this` in order to allow method chaining
7876
7970
  */
@@ -7878,30 +7972,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7878
7972
  /**
7879
7973
  * The function to be called, when the event occurs
7880
7974
  */
7881
- fnFunction: (
7882
- p1: SemanticObjectController$NavigationTargetsObtainedEvent
7883
- ) => void,
7884
- /**
7885
- * Context object on which the given function had to be called
7886
- */
7887
- oListener?: object
7888
- ): this;
7889
- /**
7890
- * Detaches event handler `fnFunction` from the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
7891
- *
7892
- * The passed function and listener object must match the ones used for event registration.
7893
- *
7894
- * @since 1.28.0
7895
- * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
7896
- * `prefetchNavigationTargets` which has been deprecated.
7897
- *
7898
- * @returns Reference to `this` in order to allow method chaining
7899
- */
7900
- detachPrefetchDone(
7901
- /**
7902
- * The function to be called, when the event occurs
7903
- */
7904
- fnFunction: (p1: SemanticObjectController$PrefetchDoneEvent) => void,
7975
+ fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void,
7905
7976
  /**
7906
7977
  * Context object on which the given function had to be called
7907
7978
  */
@@ -7919,26 +7990,27 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7919
7990
  /**
7920
7991
  * Parameters to pass along with the event
7921
7992
  */
7922
- mParameters?: SemanticObjectController$BeforePopoverOpensEventParameters
7993
+ mParameters?: SmartLink$BeforePopoverOpensEventParameters
7923
7994
  ): this;
7924
7995
  /**
7925
- * Fires event {@link #event:navigate navigate} to attached listeners.
7996
+ * Fires event {@link #event:innerNavigate innerNavigate} to attached listeners.
7926
7997
  *
7927
7998
  * @since 1.28.0
7928
7999
  * @ui5-protected Do not call from applications (only from related classes in the framework)
7929
8000
  *
7930
8001
  * @returns Reference to `this` in order to allow method chaining
7931
8002
  */
7932
- fireNavigate(
8003
+ fireInnerNavigate(
7933
8004
  /**
7934
8005
  * Parameters to pass along with the event
7935
8006
  */
7936
- mParameters?: SemanticObjectController$NavigateEventParameters
8007
+ mParameters?: SmartLink$InnerNavigateEventParameters
7937
8008
  ): this;
7938
8009
  /**
7939
8010
  * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners.
7940
8011
  *
7941
8012
  * @since 1.28.0
8013
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
7942
8014
  * @ui5-protected Do not call from applications (only from related classes in the framework)
7943
8015
  *
7944
8016
  * @returns Reference to `this` in order to allow method chaining
@@ -7947,24 +8019,21 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7947
8019
  /**
7948
8020
  * Parameters to pass along with the event
7949
8021
  */
7950
- mParameters?: SemanticObjectController$NavigationTargetsObtainedEventParameters
8022
+ mParameters?: SmartLink$NavigationTargetsObtainedEventParameters
7951
8023
  ): this;
7952
8024
  /**
7953
- * Fires event {@link #event:prefetchDone prefetchDone} to attached listeners.
8025
+ * Gets current value of property {@link #getAdditionalSemanticObjects additionalSemanticObjects}.
7954
8026
  *
7955
- * @since 1.28.0
7956
- * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
7957
- * `prefetchNavigationTargets` which has been deprecated.
7958
- * @ui5-protected Do not call from applications (only from related classes in the framework)
8027
+ * Semantic object names which can be used additional to the default `semanticObject` property in order
8028
+ * to get navigation targets links.
7959
8029
  *
7960
- * @returns Reference to `this` in order to allow method chaining
8030
+ * Default value is `[]`.
8031
+ *
8032
+ * @since 1.42.0
8033
+ *
8034
+ * @returns Value of property `additionalSemanticObjects`
7961
8035
  */
7962
- firePrefetchDone(
7963
- /**
7964
- * Parameters to pass along with the event
7965
- */
7966
- mParameters?: SemanticObjectController$PrefetchDoneEventParameters
7967
- ): this;
8036
+ getAdditionalSemanticObjects(): string[];
7968
8037
  /**
7969
8038
  * Gets current value of property {@link #getBeforeNavigationCallback beforeNavigationCallback}.
7970
8039
  *
@@ -7985,155 +8054,218 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
7985
8054
  */
7986
8055
  getBeforeNavigationCallback(): Function;
7987
8056
  /**
7988
- * Gets current value of property {@link #getContactAnnotationPaths contactAnnotationPaths}.
8057
+ * Gets current value of property {@link #getContactAnnotationPath contactAnnotationPath}.
7989
8058
  *
7990
- * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact`
7991
- * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An
7992
- * empty string means that the related entity type is the current one.
8059
+ * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact
8060
+ * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type
8061
+ * is the current one.
8062
+ *
8063
+ * Default value is `undefined`.
7993
8064
  *
7994
8065
  * @since 1.40.0
7995
8066
  *
7996
- * @returns Value of property `contactAnnotationPaths`
8067
+ * @returns Value of property `contactAnnotationPath`
7997
8068
  */
7998
- getContactAnnotationPaths(): object;
8069
+ getContactAnnotationPath(): string;
8070
+ /**
8071
+ * Gets current value of property {@link #getCreateControlCallback createControlCallback}.
8072
+ *
8073
+ * Function that enables the SmartLink control to create an alternative control, which is displayed if no
8074
+ * navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.
8075
+ *
8076
+ * @since 1.28.0
8077
+ *
8078
+ * @returns Value of property `createControlCallback`
8079
+ */
8080
+ getCreateControlCallback(): Function;
7999
8081
  /**
8000
8082
  * Gets current value of property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}.
8001
8083
  *
8002
- * Determines whether the personalization link is shown inside the NavigationPopover control. For example,
8003
- * ` '\{"Supplier":false, "CompanyName":true\}' `.
8084
+ * Determines whether the personalization link is shown inside the NavigationPopover control.
8085
+ *
8086
+ * Default value is `true`.
8004
8087
  *
8005
8088
  * @since 1.44.0
8006
8089
  *
8007
8090
  * @returns Value of property `enableAvailableActionsPersonalization`
8008
8091
  */
8009
- getEnableAvailableActionsPersonalization(): object;
8092
+ getEnableAvailableActionsPersonalization(): boolean;
8010
8093
  /**
8011
- * Gets current value of property {@link #getEntitySet entitySet}.
8094
+ * Gets current value of property {@link #getEnabled enabled}.
8012
8095
  *
8013
- * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries
8014
- * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property.
8096
+ * Determines whether the link can be triggered by the user.
8015
8097
  *
8016
- * @since 1.28.0
8098
+ * Default value is `true`.
8017
8099
  *
8018
- * @returns Value of property `entitySet`
8100
+ *
8101
+ * @returns Value of property `enabled`
8019
8102
  */
8020
- getEntitySet(): string;
8103
+ getEnabled(): boolean;
8021
8104
  /**
8022
- * Gets current value of property {@link #getFieldSemanticObjectMap fieldSemanticObjectMap}.
8105
+ * Gets current value of property {@link #getFieldName fieldName}.
8023
8106
  *
8024
- * Maps the fields to the related semantic objects. When accessing this property for the first time, the
8025
- * mapping will be calculated from the metadata within the provided model.
8107
+ * The metadata field name for this SmartLink control.
8026
8108
  *
8027
8109
  * @since 1.28.0
8028
8110
  *
8029
- * @returns Value of property `fieldSemanticObjectMap`
8111
+ * @returns Value of property `fieldName`
8030
8112
  */
8031
- getFieldSemanticObjectMap(): object;
8113
+ getFieldName(): string;
8032
8114
  /**
8033
8115
  * Gets current value of property {@link #getForceLinkRendering forceLinkRendering}.
8034
8116
  *
8035
- * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if
8036
- * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true`
8037
- * allows the application, for example, to modify the `SmartLink` control in the event handler, after the
8038
- * user has clicked on a link and the registered event handler has been called.\n
8117
+ * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not
8118
+ * set and navigation targets do not exist. Setting this property to `true` allows the application, for
8119
+ * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link
8120
+ * and the registered event handler has been called.
8039
8121
  *
8040
- * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control
8041
- * take precedence over `forceLinkRendering`.\n
8122
+ * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController`
8123
+ * take precedence over `forceLinkRendering`.
8042
8124
  *
8043
- * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' `
8125
+ * Default value is `false`.
8044
8126
  *
8045
8127
  * @since 1.58.0
8046
8128
  *
8047
8129
  * @returns Value of property `forceLinkRendering`
8048
8130
  */
8049
- getForceLinkRendering(): object;
8131
+ getForceLinkRendering(): boolean;
8050
8132
  /**
8051
- * Gets current value of property {@link #getIgnoredFields ignoredFields}.
8133
+ * Gets current value of property {@link #getIgnoreLinkRendering ignoreLinkRendering}.
8052
8134
  *
8053
- * Comma-separated list of fields that must not be displayed as links.
8135
+ * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback`
8136
+ * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink
8137
+ * is listed in its `ignoredFields` or no navigation targets were found during prefetch.
8138
+ *
8139
+ * Default value is `false`.
8054
8140
  *
8055
8141
  * @since 1.28.0
8056
8142
  *
8057
- * @returns Value of property `ignoredFields`
8143
+ * @returns Value of property `ignoreLinkRendering`
8058
8144
  */
8059
- getIgnoredFields(): string;
8145
+ getIgnoreLinkRendering(): boolean;
8146
+ /**
8147
+ * Gets content of aggregation {@link #getInnerControl innerControl}.
8148
+ *
8149
+ * Control that is displayed instead of SmartLink control, if the SmartLink is disabled (for example, if
8150
+ * no navigation targets are available). If `innerControl` is not provided, the SmartLink control tries
8151
+ * to create one with property `createControlCallback`.
8152
+ *
8153
+ * @since 1.28.0
8154
+ */
8155
+ getInnerControl(): Control;
8156
+ /**
8157
+ * Gets the value of the `innerControl` aggregate if available, otherwise the text of SmartLink control
8158
+ * will be returned.
8159
+ *
8160
+ *
8161
+ * @returns The value of `innerControl` aggregate or the text of the SmartLink
8162
+ */
8163
+ getInnerControlValue(): object;
8060
8164
  /**
8061
8165
  * Gets current value of property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}.
8062
8166
  *
8063
8167
  * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
8064
- * property during the calculation of the semantic attributes.
8168
+ * property during the calculation of the semantic attributes. This enables the usage of several SmartLink
8169
+ * controls on the same semantic object.
8170
+ *
8171
+ * Default value is `true`.
8065
8172
  *
8066
- * @since 1.48.0
8067
8173
  *
8068
8174
  * @returns Value of property `mapFieldToSemanticObject`
8069
8175
  */
8070
8176
  getMapFieldToSemanticObject(): boolean;
8071
8177
  /**
8072
- * Gets current value of property {@link #getPrefetchNavigationTargets prefetchNavigationTargets}.
8178
+ * Gets current value of property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}.
8073
8179
  *
8074
- * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable
8075
- * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip.
8180
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
8181
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
8182
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
8183
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
8184
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
8185
+ * event. The event handling is ignored if this callback is set.
8076
8186
  *
8077
- * Default value is `false`.
8187
+ * @since 1.126
8188
+ *
8189
+ * @returns Value of property `navigationTargetsObtainedCallback`
8190
+ */
8191
+ getNavigationTargetsObtainedCallback(): Function;
8192
+ /**
8193
+ * Gets current value of property {@link #getSemanticObject semanticObject}.
8194
+ *
8195
+ * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers
8196
+ * an asynchronous determination, so the effect can be delayed.
8078
8197
  *
8079
8198
  * @since 1.28.0
8080
- * @deprecated (since 1.42.0) - The property `prefetchNavigationTargets` is obsolete as navigation targets
8081
- * are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous determination
8082
- * of navigation targets has been completed.
8083
8199
  *
8084
- * @returns Value of property `prefetchNavigationTargets`
8200
+ * @returns Value of property `semanticObject`
8085
8201
  */
8086
- getPrefetchNavigationTargets(): boolean;
8202
+ getSemanticObject(): string;
8087
8203
  /**
8088
- * Gets current value of property {@link #getReplaceSmartLinkNavigationTargetsObtained replaceSmartLinkNavigationTargetsObtained}.
8089
- *
8090
- * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when
8091
- * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink.
8204
+ * Gets current value of property {@link #getSemanticObjectController semanticObjectController}.
8092
8205
  *
8093
- * Default value is `false`.
8206
+ * The semantic object controller controls events for several SmartLink controls. If the controller is not
8207
+ * set manually, it tries to find a SemanticObjectController in its parent hierarchy.
8094
8208
  *
8095
- * @since 1.97
8209
+ * @since 1.28.0
8096
8210
  *
8097
- * @returns Value of property `replaceSmartLinkNavigationTargetsObtained`
8211
+ * @returns Value of property `semanticObjectController`
8098
8212
  */
8099
- getReplaceSmartLinkNavigationTargetsObtained(): boolean;
8213
+ getSemanticObjectController(): any;
8100
8214
  /**
8101
- * Checks if the given semantic object name has a navigation link. **Note**: this method returns a valid
8102
- * value only after the event `prefetchDone` has been raised. The event `prefetchDone` is raised if the
8103
- * property `prefetchNavigationTargets` is set to `true`.
8215
+ * Gets current value of property {@link #getSemanticObjectLabel semanticObjectLabel}.
8104
8216
  *
8105
- * @deprecated (since 1.42.0) - The method `hasSemanticObjectLinks` is obsolete because it depends on the
8106
- * property `prefetchNavigationTargets` which has been deprecated.
8217
+ * Shown label of semantic object.
8107
8218
  *
8108
- * @returns true if the semantic object has any navigation links
8219
+ * @since 1.28.0
8220
+ * @deprecated (since 1.40.0) - Title section with `semanticObjectLabel` has been removed due to new UI
8221
+ * design
8222
+ *
8223
+ * @returns Value of property `semanticObjectLabel`
8109
8224
  */
8110
- hasSemanticObjectLinks(
8111
- /**
8112
- * Name of semantic object
8113
- */
8114
- sSemanticObject: string
8115
- ): boolean;
8225
+ getSemanticObjectLabel(): string;
8116
8226
  /**
8117
- * Returns whether the given control has been registered by the SemanticObjectController.
8227
+ * Gets current value of property {@link #getUom uom}.
8118
8228
  *
8229
+ * Additionally to the `text` property the Unit of Measure can be displayed.
8119
8230
  *
8120
- * @returns `true` if the given control has been registered
8121
- */
8122
- isControlRegistered(
8123
- /**
8124
- * Control registered by `SemanticObjectController`
8125
- */
8126
- oControl: SmartLink | NavigationPopoverHandler
8127
- ): boolean;
8231
+ * Default value is `undefined`.
8232
+ *
8233
+ * @since 1.48.0
8234
+ *
8235
+ * @returns Value of property `uom`
8236
+ */
8237
+ getUom(): string;
8128
8238
  /**
8129
- * Adds the given control to the SemanticObjectController and registers all relevant events.
8239
+ * Gets current value of property {@link #getWrapping wrapping}.
8240
+ *
8241
+ * Determines whether the link text is allowed to wrap when there is no sufficient space.
8242
+ *
8243
+ * Default value is `false`.
8244
+ *
8245
+ *
8246
+ * @returns Value of property `wrapping`
8130
8247
  */
8131
- registerControl(
8248
+ getWrapping(): boolean;
8249
+ /**
8250
+ * Sets a new value for property {@link #getAdditionalSemanticObjects additionalSemanticObjects}.
8251
+ *
8252
+ * Semantic object names which can be used additional to the default `semanticObject` property in order
8253
+ * to get navigation targets links.
8254
+ *
8255
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8256
+ *
8257
+ * Default value is `[]`.
8258
+ *
8259
+ * @since 1.42.0
8260
+ *
8261
+ * @returns Reference to `this` in order to allow method chaining
8262
+ */
8263
+ setAdditionalSemanticObjects(
8132
8264
  /**
8133
- * Control to be registered by `SemanticObjectController`
8265
+ * New value for property `additionalSemanticObjects`
8134
8266
  */
8135
- oControl: SmartLink | NavigationPopoverHandler
8136
- ): void;
8267
+ sAdditionalSemanticObjects?: string[]
8268
+ ): this;
8137
8269
  /**
8138
8270
  * Sets a new value for property {@link #getBeforeNavigationCallback beforeNavigationCallback}.
8139
8271
  *
@@ -8161,32 +8293,53 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8161
8293
  fnBeforeNavigationCallback: Function
8162
8294
  ): this;
8163
8295
  /**
8164
- * Sets a new value for property {@link #getContactAnnotationPaths contactAnnotationPaths}.
8296
+ * Sets a new value for property {@link #getContactAnnotationPath contactAnnotationPath}.
8165
8297
  *
8166
- * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact`
8167
- * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An
8168
- * empty string means that the related entity type is the current one.
8298
+ * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact
8299
+ * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type
8300
+ * is the current one.
8169
8301
  *
8170
8302
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8171
8303
  *
8304
+ * Default value is `undefined`.
8305
+ *
8172
8306
  * @since 1.40.0
8173
8307
  *
8174
8308
  * @returns Reference to `this` in order to allow method chaining
8175
8309
  */
8176
- setContactAnnotationPaths(
8310
+ setContactAnnotationPath(
8177
8311
  /**
8178
- * New value for property `contactAnnotationPaths`
8312
+ * New value for property `contactAnnotationPath`
8179
8313
  */
8180
- oContactAnnotationPaths?: object
8314
+ sContactAnnotationPath?: string
8315
+ ): this;
8316
+ /**
8317
+ * Sets a new value for property {@link #getCreateControlCallback createControlCallback}.
8318
+ *
8319
+ * Function that enables the SmartLink control to create an alternative control, which is displayed if no
8320
+ * navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.
8321
+ *
8322
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8323
+ *
8324
+ * @since 1.28.0
8325
+ *
8326
+ * @returns Reference to `this` in order to allow method chaining
8327
+ */
8328
+ setCreateControlCallback(
8329
+ /**
8330
+ * New value for property `createControlCallback`
8331
+ */
8332
+ fnCreateControlCallback?: Function
8181
8333
  ): this;
8182
8334
  /**
8183
8335
  * Sets a new value for property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}.
8184
8336
  *
8185
- * Determines whether the personalization link is shown inside the NavigationPopover control. For example,
8186
- * ` '\{"Supplier":false, "CompanyName":true\}' `.
8337
+ * Determines whether the personalization link is shown inside the NavigationPopover control.
8187
8338
  *
8188
8339
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8189
8340
  *
8341
+ * Default value is `true`.
8342
+ *
8190
8343
  * @since 1.44.0
8191
8344
  *
8192
8345
  * @returns Reference to `this` in order to allow method chaining
@@ -8195,31 +8348,30 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8195
8348
  /**
8196
8349
  * New value for property `enableAvailableActionsPersonalization`
8197
8350
  */
8198
- oEnableAvailableActionsPersonalization?: object
8351
+ bEnableAvailableActionsPersonalization?: boolean
8199
8352
  ): this;
8200
8353
  /**
8201
- * Sets a new value for property {@link #getEntitySet entitySet}.
8354
+ * Sets a new value for property {@link #getEnabled enabled}.
8202
8355
  *
8203
- * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries
8204
- * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property.
8356
+ * Determines whether the link can be triggered by the user.
8205
8357
  *
8206
8358
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8207
8359
  *
8208
- * @since 1.28.0
8360
+ * Default value is `true`.
8361
+ *
8209
8362
  *
8210
8363
  * @returns Reference to `this` in order to allow method chaining
8211
8364
  */
8212
- setEntitySet(
8365
+ setEnabled(
8213
8366
  /**
8214
- * New value for property `entitySet`
8367
+ * New value for property `enabled`
8215
8368
  */
8216
- sEntitySet?: string
8369
+ bEnabled?: boolean
8217
8370
  ): this;
8218
8371
  /**
8219
- * Sets a new value for property {@link #getFieldSemanticObjectMap fieldSemanticObjectMap}.
8372
+ * Sets a new value for property {@link #getFieldName fieldName}.
8220
8373
  *
8221
- * Maps the fields to the related semantic objects. When accessing this property for the first time, the
8222
- * mapping will be calculated from the metadata within the provided model.
8374
+ * The metadata field name for this SmartLink control.
8223
8375
  *
8224
8376
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8225
8377
  *
@@ -8227,27 +8379,27 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8227
8379
  *
8228
8380
  * @returns Reference to `this` in order to allow method chaining
8229
8381
  */
8230
- setFieldSemanticObjectMap(
8382
+ setFieldName(
8231
8383
  /**
8232
- * New value for property `fieldSemanticObjectMap`
8384
+ * New value for property `fieldName`
8233
8385
  */
8234
- oFieldSemanticObjectMap?: object
8386
+ sFieldName?: string
8235
8387
  ): this;
8236
8388
  /**
8237
8389
  * Sets a new value for property {@link #getForceLinkRendering forceLinkRendering}.
8238
8390
  *
8239
- * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if
8240
- * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true`
8241
- * allows the application, for example, to modify the `SmartLink` control in the event handler, after the
8242
- * user has clicked on a link and the registered event handler has been called.\n
8243
- *
8244
- * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control
8245
- * take precedence over `forceLinkRendering`.\n
8391
+ * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not
8392
+ * set and navigation targets do not exist. Setting this property to `true` allows the application, for
8393
+ * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link
8394
+ * and the registered event handler has been called.
8246
8395
  *
8247
- * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' `
8396
+ * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController`
8397
+ * take precedence over `forceLinkRendering`.
8248
8398
  *
8249
8399
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8250
8400
  *
8401
+ * Default value is `false`.
8402
+ *
8251
8403
  * @since 1.58.0
8252
8404
  *
8253
8405
  * @returns Reference to `this` in order to allow method chaining
@@ -8256,46 +8408,53 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8256
8408
  /**
8257
8409
  * New value for property `forceLinkRendering`
8258
8410
  */
8259
- oForceLinkRendering?: object
8411
+ bForceLinkRendering?: boolean
8260
8412
  ): this;
8261
8413
  /**
8262
- * Sets a new value for property {@link #getIgnoredFields ignoredFields}.
8414
+ * Sets a new value for property {@link #getIgnoreLinkRendering ignoreLinkRendering}.
8263
8415
  *
8264
- * Comma-separated list of fields that must not be displayed as links.
8416
+ * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback`
8417
+ * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink
8418
+ * is listed in its `ignoredFields` or no navigation targets were found during prefetch.
8265
8419
  *
8266
8420
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8267
8421
  *
8422
+ * Default value is `false`.
8423
+ *
8268
8424
  * @since 1.28.0
8269
8425
  *
8270
8426
  * @returns Reference to `this` in order to allow method chaining
8271
8427
  */
8272
- setIgnoredFields(
8428
+ setIgnoreLinkRendering(
8273
8429
  /**
8274
- * New value for property `ignoredFields`
8430
+ * New value for property `ignoreLinkRendering`
8275
8431
  */
8276
- sIgnoredFields?: string
8432
+ bIgnoreLinkRendering?: boolean
8277
8433
  ): this;
8278
8434
  /**
8279
- * Checks if the given SmartLink has to be enabled or disabled and sets the state.
8435
+ * Sets the aggregated {@link #getInnerControl innerControl}.
8280
8436
  *
8281
- * @deprecated (since 1.42.0) - The method `setIgnoredState` is obsolete as SmartLink is processing the
8282
- * internal state on its own.
8437
+ * @since 1.28.0
8438
+ *
8439
+ * @returns Reference to `this` in order to allow method chaining
8283
8440
  */
8284
- setIgnoredState(
8441
+ setInnerControl(
8285
8442
  /**
8286
- * the SmartLink which should be enabled or disabled.
8443
+ * The innerControl to set
8287
8444
  */
8288
- oSmartLink: SmartLink
8289
- ): void;
8445
+ oInnerControl: Control
8446
+ ): this;
8290
8447
  /**
8291
8448
  * Sets a new value for property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}.
8292
8449
  *
8293
8450
  * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
8294
- * property during the calculation of the semantic attributes.
8451
+ * property during the calculation of the semantic attributes. This enables the usage of several SmartLink
8452
+ * controls on the same semantic object.
8295
8453
  *
8296
8454
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8297
8455
  *
8298
- * @since 1.48.0
8456
+ * Default value is `true`.
8457
+ *
8299
8458
  *
8300
8459
  * @returns Reference to `this` in order to allow method chaining
8301
8460
  */
@@ -8303,141 +8462,229 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8303
8462
  /**
8304
8463
  * New value for property `mapFieldToSemanticObject`
8305
8464
  */
8306
- bMapFieldToSemanticObject: boolean
8465
+ bMapFieldToSemanticObject?: boolean
8307
8466
  ): this;
8308
8467
  /**
8309
- * Sets a new value for property {@link #getPrefetchNavigationTargets prefetchNavigationTargets}.
8468
+ * Sets a new value for property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}.
8310
8469
  *
8311
- * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable
8312
- * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip.
8470
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
8471
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
8472
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
8473
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
8474
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
8475
+ * event. The event handling is ignored if this callback is set.
8313
8476
  *
8314
8477
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8315
8478
  *
8316
- * Default value is `false`.
8479
+ * @since 1.126
8480
+ *
8481
+ * @returns Reference to `this` in order to allow method chaining
8482
+ */
8483
+ setNavigationTargetsObtainedCallback(
8484
+ /**
8485
+ * New value for property `navigationTargetsObtainedCallback`
8486
+ */
8487
+ fnNavigationTargetsObtainedCallback: Function
8488
+ ): this;
8489
+ /**
8490
+ * Sets a new value for property {@link #getSemanticObject semanticObject}.
8491
+ *
8492
+ * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers
8493
+ * an asynchronous determination, so the effect can be delayed.
8494
+ *
8495
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8317
8496
  *
8318
8497
  * @since 1.28.0
8319
- * @deprecated (since 1.42.0) - The property `prefetchNavigationTargets` is obsolete as navigation targets
8320
- * are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous determination
8321
- * of navigation targets has been completed.
8322
8498
  *
8323
8499
  * @returns Reference to `this` in order to allow method chaining
8324
8500
  */
8325
- setPrefetchNavigationTargets(
8501
+ setSemanticObject(
8326
8502
  /**
8327
- * New value for property `prefetchNavigationTargets`
8503
+ * New value for property `semanticObject`
8328
8504
  */
8329
- bPrefetchNavigationTargets?: boolean
8505
+ sSemanticObject?: string
8330
8506
  ): this;
8331
8507
  /**
8332
- * Sets a new value for property {@link #getReplaceSmartLinkNavigationTargetsObtained replaceSmartLinkNavigationTargetsObtained}.
8508
+ * Sets a new value for property {@link #getSemanticObjectController semanticObjectController}.
8333
8509
  *
8334
- * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when
8335
- * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink.
8510
+ * The semantic object controller controls events for several SmartLink controls. If the controller is not
8511
+ * set manually, it tries to find a SemanticObjectController in its parent hierarchy.
8336
8512
  *
8337
8513
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8338
8514
  *
8339
- * Default value is `false`.
8515
+ * @since 1.28.0
8340
8516
  *
8341
- * @since 1.97
8517
+ * @returns Reference to `this` in order to allow method chaining
8518
+ */
8519
+ setSemanticObjectController(
8520
+ /**
8521
+ * New value for property `semanticObjectController`
8522
+ */
8523
+ oSemanticObjectController?: any
8524
+ ): this;
8525
+ /**
8526
+ * Sets a new value for property {@link #getSemanticObjectLabel semanticObjectLabel}.
8527
+ *
8528
+ * Shown label of semantic object.
8529
+ *
8530
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8531
+ *
8532
+ * @since 1.28.0
8533
+ * @deprecated (since 1.40.0) - Title section with `semanticObjectLabel` has been removed due to new UI
8534
+ * design
8342
8535
  *
8343
8536
  * @returns Reference to `this` in order to allow method chaining
8344
8537
  */
8345
- setReplaceSmartLinkNavigationTargetsObtained(
8538
+ setSemanticObjectLabel(
8346
8539
  /**
8347
- * New value for property `replaceSmartLinkNavigationTargetsObtained`
8540
+ * New value for property `semanticObjectLabel`
8348
8541
  */
8349
- bReplaceSmartLinkNavigationTargetsObtained?: boolean
8542
+ sSemanticObjectLabel?: string
8350
8543
  ): this;
8351
8544
  /**
8352
- * Removes the given control from the SemanticObjectController and unregisters all relevant events.
8545
+ * Sets a new value for property {@link #getUom uom}.
8546
+ *
8547
+ * Additionally to the `text` property the Unit of Measure can be displayed.
8548
+ *
8549
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8550
+ *
8551
+ * Default value is `undefined`.
8552
+ *
8553
+ * @since 1.48.0
8554
+ *
8555
+ * @returns Reference to `this` in order to allow method chaining
8353
8556
  */
8354
- unregisterControl(
8557
+ setUom(
8355
8558
  /**
8356
- * Control to be unregistered by `SemanticObjectController`
8559
+ * New value for property `uom`
8357
8560
  */
8358
- oControl: SmartLink | NavigationPopoverHandler
8359
- ): void;
8561
+ sUom?: string
8562
+ ): this;
8563
+ /**
8564
+ * Sets a new value for property {@link #getWrapping wrapping}.
8565
+ *
8566
+ * Determines whether the link text is allowed to wrap when there is no sufficient space.
8567
+ *
8568
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8569
+ *
8570
+ * Default value is `false`.
8571
+ *
8572
+ *
8573
+ * @returns Reference to `this` in order to allow method chaining
8574
+ */
8575
+ setWrapping(
8576
+ /**
8577
+ * New value for property `wrapping`
8578
+ */
8579
+ bWrapping?: boolean
8580
+ ): this;
8360
8581
  }
8361
8582
  /**
8362
- * Describes the settings that can be provided to the SemanticObjectController constructor.
8583
+ * Describes the settings that can be provided to the SmartLink constructor.
8363
8584
  */
8364
- export interface $SemanticObjectControllerSettings extends $ElementSettings {
8585
+ export interface $SmartLinkSettings extends $LinkSettings {
8365
8586
  /**
8366
- * Comma-separated list of fields that must not be displayed as links.
8587
+ * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers
8588
+ * an asynchronous determination, so the effect can be delayed.
8367
8589
  *
8368
8590
  * @since 1.28.0
8369
8591
  */
8370
- ignoredFields?: string | PropertyBindingInfo;
8592
+ semanticObject?: string | PropertyBindingInfo;
8371
8593
 
8372
8594
  /**
8373
- * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable
8374
- * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip.
8595
+ * Semantic object names which can be used additional to the default `semanticObject` property in order
8596
+ * to get navigation targets links.
8597
+ *
8598
+ * @since 1.42.0
8599
+ */
8600
+ additionalSemanticObjects?: string[] | PropertyBindingInfo | `{${string}}`;
8601
+
8602
+ /**
8603
+ * The semantic object controller controls events for several SmartLink controls. If the controller is not
8604
+ * set manually, it tries to find a SemanticObjectController in its parent hierarchy.
8375
8605
  *
8376
8606
  * @since 1.28.0
8377
- * @deprecated (since 1.42.0) - The property `prefetchNavigationTargets` is obsolete as navigation targets
8378
- * are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous determination
8379
- * of navigation targets has been completed.
8380
8607
  */
8381
- prefetchNavigationTargets?: boolean | PropertyBindingInfo | `{${string}}`;
8608
+ semanticObjectController?: any | PropertyBindingInfo | `{${string}}`;
8382
8609
 
8383
8610
  /**
8384
- * Maps the fields to the related semantic objects. When accessing this property for the first time, the
8385
- * mapping will be calculated from the metadata within the provided model.
8611
+ * The metadata field name for this SmartLink control.
8386
8612
  *
8387
8613
  * @since 1.28.0
8388
8614
  */
8389
- fieldSemanticObjectMap?: object | PropertyBindingInfo | `{${string}}`;
8615
+ fieldName?: string | PropertyBindingInfo;
8390
8616
 
8391
8617
  /**
8392
- * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries
8393
- * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property.
8618
+ * Shown label of semantic object.
8394
8619
  *
8395
8620
  * @since 1.28.0
8621
+ * @deprecated (since 1.40.0) - Title section with `semanticObjectLabel` has been removed due to new UI
8622
+ * design
8396
8623
  */
8397
- entitySet?: string | PropertyBindingInfo;
8624
+ semanticObjectLabel?: string | PropertyBindingInfo;
8398
8625
 
8399
8626
  /**
8400
- * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact`
8401
- * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An
8402
- * empty string means that the related entity type is the current one.
8627
+ * Function that enables the SmartLink control to create an alternative control, which is displayed if no
8628
+ * navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.
8629
+ *
8630
+ * @since 1.28.0
8631
+ */
8632
+ createControlCallback?: Function | PropertyBindingInfo | `{${string}}`;
8633
+
8634
+ /**
8635
+ * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
8636
+ * property during the calculation of the semantic attributes. This enables the usage of several SmartLink
8637
+ * controls on the same semantic object.
8638
+ */
8639
+ mapFieldToSemanticObject?: boolean | PropertyBindingInfo | `{${string}}`;
8640
+
8641
+ /**
8642
+ * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact
8643
+ * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type
8644
+ * is the current one.
8403
8645
  *
8404
8646
  * @since 1.40.0
8405
8647
  */
8406
- contactAnnotationPaths?: object | PropertyBindingInfo | `{${string}}`;
8648
+ contactAnnotationPath?: string | PropertyBindingInfo;
8407
8649
 
8408
8650
  /**
8409
- * Determines whether the personalization link is shown inside the NavigationPopover control. For example,
8410
- * ` '\{"Supplier":false, "CompanyName":true\}' `.
8651
+ * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback`
8652
+ * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink
8653
+ * is listed in its `ignoredFields` or no navigation targets were found during prefetch.
8654
+ *
8655
+ * @since 1.28.0
8656
+ */
8657
+ ignoreLinkRendering?: boolean | PropertyBindingInfo | `{${string}}`;
8658
+
8659
+ /**
8660
+ * Determines whether the personalization link is shown inside the NavigationPopover control.
8411
8661
  *
8412
8662
  * @since 1.44.0
8413
8663
  */
8414
8664
  enableAvailableActionsPersonalization?:
8415
- | object
8665
+ | boolean
8416
8666
  | PropertyBindingInfo
8417
8667
  | `{${string}}`;
8418
8668
 
8419
8669
  /**
8420
- * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
8421
- * property during the calculation of the semantic attributes.
8670
+ * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not
8671
+ * set and navigation targets do not exist. Setting this property to `true` allows the application, for
8672
+ * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link
8673
+ * and the registered event handler has been called.
8422
8674
  *
8423
- * @since 1.48.0
8675
+ * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController`
8676
+ * take precedence over `forceLinkRendering`.
8677
+ *
8678
+ * @since 1.58.0
8424
8679
  */
8425
- mapFieldToSemanticObject?: boolean | PropertyBindingInfo | `{${string}}`;
8680
+ forceLinkRendering?: boolean | PropertyBindingInfo | `{${string}}`;
8426
8681
 
8427
8682
  /**
8428
- * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if
8429
- * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true`
8430
- * allows the application, for example, to modify the `SmartLink` control in the event handler, after the
8431
- * user has clicked on a link and the registered event handler has been called.\n
8432
- *
8433
- * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control
8434
- * take precedence over `forceLinkRendering`.\n
8435
- *
8436
- * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' `
8683
+ * Additionally to the `text` property the Unit of Measure can be displayed.
8437
8684
  *
8438
- * @since 1.58.0
8685
+ * @since 1.48.0
8439
8686
  */
8440
- forceLinkRendering?: object | PropertyBindingInfo | `{${string}}`;
8687
+ uom?: string | PropertyBindingInfo;
8441
8688
 
8442
8689
  /**
8443
8690
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
@@ -8456,61 +8703,73 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8456
8703
  beforeNavigationCallback?: Function | PropertyBindingInfo | `{${string}}`;
8457
8704
 
8458
8705
  /**
8459
- * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when
8460
- * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink.
8706
+ * Determines whether the link can be triggered by the user.
8707
+ */
8708
+ enabled?: boolean | PropertyBindingInfo | `{${string}}`;
8709
+
8710
+ /**
8711
+ * Determines whether the link text is allowed to wrap when there is no sufficient space.
8712
+ */
8713
+ wrapping?: boolean | PropertyBindingInfo | `{${string}}`;
8714
+
8715
+ /**
8716
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
8717
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
8718
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
8719
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
8720
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
8721
+ * event. The event handling is ignored if this callback is set.
8461
8722
  *
8462
- * @since 1.97
8723
+ * @since 1.126
8463
8724
  */
8464
- replaceSmartLinkNavigationTargetsObtained?:
8465
- | boolean
8725
+ navigationTargetsObtainedCallback?:
8726
+ | Function
8466
8727
  | PropertyBindingInfo
8467
8728
  | `{${string}}`;
8468
8729
 
8469
8730
  /**
8470
- * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible
8471
- * you to change the targets.
8731
+ * Control that is displayed instead of SmartLink control, if the SmartLink is disabled (for example, if
8732
+ * no navigation targets are available). If `innerControl` is not provided, the SmartLink control tries
8733
+ * to create one with property `createControlCallback`.
8472
8734
  *
8473
8735
  * @since 1.28.0
8474
8736
  */
8475
- navigationTargetsObtained?: (
8476
- oEvent: SemanticObjectController$NavigationTargetsObtainedEvent
8477
- ) => void;
8737
+ innerControl?: Control;
8478
8738
 
8479
8739
  /**
8480
- * Event is fired before the navigation popover opens and before navigation target links are retrieved.
8481
- * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink,
8482
- * `beforePopoverOpens` is fired after the link has been clicked.
8740
+ * Event is fired before the navigation popover opens and before navigation target links are getting retrieved.
8741
+ * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink
8742
+ * control, the `beforePopoverOpens` is fired after the link has been clicked.
8483
8743
  *
8484
8744
  * @since 1.28.0
8485
8745
  */
8486
- beforePopoverOpens?: (
8487
- oEvent: SemanticObjectController$BeforePopoverOpensEvent
8488
- ) => void;
8746
+ beforePopoverOpens?: (oEvent: SmartLink$BeforePopoverOpensEvent) => void;
8489
8747
 
8490
8748
  /**
8491
- * This event is fired after a navigation link on the navigation popover has been clicked. This event is
8492
- * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window'
8493
- * etc. in the context menu does not fire the event.
8749
+ * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility
8750
+ * to change the targets.
8494
8751
  *
8495
8752
  * @since 1.28.0
8753
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
8496
8754
  */
8497
- navigate?: (oEvent: SemanticObjectController$NavigateEvent) => void;
8755
+ navigationTargetsObtained?: (
8756
+ oEvent: SmartLink$NavigationTargetsObtainedEvent
8757
+ ) => void;
8498
8758
 
8499
8759
  /**
8500
- * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all
8501
- * navigation targets have been retrieved.
8760
+ * This event is fired after a navigation link on the navigation popover has been clicked. This event is
8761
+ * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window'
8762
+ * etc. in the context menu does not fire the event.
8502
8763
  *
8503
8764
  * @since 1.28.0
8504
- * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
8505
- * `prefetchNavigationTargets` which has been deprecated.
8506
8765
  */
8507
- prefetchDone?: (oEvent: SemanticObjectController$PrefetchDoneEvent) => void;
8766
+ innerNavigate?: (oEvent: SmartLink$InnerNavigateEvent) => void;
8508
8767
  }
8509
8768
 
8510
8769
  /**
8511
- * Parameters of the SemanticObjectController#beforePopoverOpens event.
8770
+ * Parameters of the SmartLink#beforePopoverOpens event.
8512
8771
  */
8513
- export interface SemanticObjectController$BeforePopoverOpensEventParameters {
8772
+ export interface SmartLink$BeforePopoverOpensEventParameters {
8514
8773
  /**
8515
8774
  * The semantic object for which the navigation targets will be retrieved.
8516
8775
  */
@@ -8545,33 +8804,30 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8545
8804
  setAppStateKey?: Function;
8546
8805
 
8547
8806
  /**
8548
- * The ID of the control that fires this event. If `beforePopoverOpens` is registered on the SmartLink,
8549
- * `originalId` is the same as the event's source ID which is also the SmartLink's ID. If the `beforePopoverOpens`
8550
- * is registered on the SemanticObjectController, `originalId` helps to identify the original SmartLink
8551
- * control which triggered the event.
8807
+ * The ID of the SmartLink control.
8552
8808
  */
8553
8809
  originalId?: string;
8554
8810
 
8555
8811
  /**
8556
8812
  * This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation
8557
- * popover. Signatures: `open()` If `beforePopoverOpens` has been registered, `open` function has to be
8558
- * called manually in order to open the navigation popover.
8813
+ * popover. Signatures: `open()` If the `beforePopoverOpens` has been registered, the `open` function has
8814
+ * to be called manually in order to open the navigation popover.
8559
8815
  */
8560
8816
  open?: Function;
8561
8817
  }
8562
8818
 
8563
8819
  /**
8564
- * Event object of the SemanticObjectController#beforePopoverOpens event.
8820
+ * Event object of the SmartLink#beforePopoverOpens event.
8565
8821
  */
8566
- export type SemanticObjectController$BeforePopoverOpensEvent = Event<
8567
- SemanticObjectController$BeforePopoverOpensEventParameters,
8568
- SemanticObjectController
8822
+ export type SmartLink$BeforePopoverOpensEvent = Event<
8823
+ SmartLink$BeforePopoverOpensEventParameters,
8824
+ SmartLink
8569
8825
  >;
8570
8826
 
8571
8827
  /**
8572
- * Parameters of the SemanticObjectController#navigate event.
8828
+ * Parameters of the SmartLink#innerNavigate event.
8573
8829
  */
8574
- export interface SemanticObjectController$NavigateEventParameters {
8830
+ export interface SmartLink$InnerNavigateEventParameters {
8575
8831
  /**
8576
8832
  * The UI text shown in the clicked link.
8577
8833
  */
@@ -8593,26 +8849,25 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8593
8849
  semanticAttributes?: object;
8594
8850
 
8595
8851
  /**
8596
- * The ID of the control that fires this event. If `navigate` is registered on the SmartLink, `originalId`
8597
- * is the same as the event's source ID which is the SmartLink's ID. If `navigate` is registered on the
8598
- * SemanticObjectController, `originalId` helps to identify the original SmartLink control which triggered
8599
- * the event.
8852
+ * The ID of the SmartLink control.
8600
8853
  */
8601
8854
  originalId?: string;
8602
8855
  }
8603
8856
 
8604
8857
  /**
8605
- * Event object of the SemanticObjectController#navigate event.
8858
+ * Event object of the SmartLink#innerNavigate event.
8606
8859
  */
8607
- export type SemanticObjectController$NavigateEvent = Event<
8608
- SemanticObjectController$NavigateEventParameters,
8609
- SemanticObjectController
8860
+ export type SmartLink$InnerNavigateEvent = Event<
8861
+ SmartLink$InnerNavigateEventParameters,
8862
+ SmartLink
8610
8863
  >;
8611
8864
 
8612
8865
  /**
8613
- * Parameters of the SemanticObjectController#navigationTargetsObtained event.
8866
+ * Parameters of the SmartLink#navigationTargetsObtained event.
8867
+ *
8868
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
8614
8869
  */
8615
- export interface SemanticObjectController$NavigationTargetsObtainedEventParameters {
8870
+ export interface SmartLink$NavigationTargetsObtainedEventParameters {
8616
8871
  /**
8617
8872
  * The main navigation object.
8618
8873
  */
@@ -8645,10 +8900,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8645
8900
  semanticAttributes?: object;
8646
8901
 
8647
8902
  /**
8648
- * The ID of the control that fires this event. If `navigationTargetsObtained` is registered on the SmartLink,
8649
- * `originalId` is the same as the event's source ID which is also the SmartLink's ID. If `navigationTargetsObtained`
8650
- * is registered on the SemanticObjectController, `originalId` helps to identify the original SmartLink
8651
- * control which triggered the event.
8903
+ * The ID of the SmartLink control.
8652
8904
  */
8653
8905
  originalId?: string;
8654
8906
 
@@ -8659,9 +8911,9 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8659
8911
  * - `show(oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters:
8660
8912
  * {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. With
8661
8913
  * `null` the main navigation object will be removed. With `undefined` the old object will remain.
8662
- * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application
8663
- * navigation links. With empty array all available links will be removed. With `undefined` the old links
8664
- * will remain.
8914
+ * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross
8915
+ * application navigation links. With empty array all available links will be removed. With `undefined`
8916
+ * the old links will remain.
8665
8917
  * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
8666
8918
  * content section on the popover. With `null` the main extra content object will be removed. With `undefined`
8667
8919
  * the old object still remains.
@@ -8672,9 +8924,9 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8672
8924
  * - {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object.
8673
8925
  * With `null` the main navigation object will be removed. With `undefined` the old object will remain.
8674
8926
  *
8675
- * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application
8676
- * navigation links. With empty array all available links will be removed. With `undefined` the old links
8677
- * will remain.
8927
+ * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross
8928
+ * application navigation links. With empty array all available links will be removed. With `undefined`
8929
+ * the old links will remain.
8678
8930
  * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
8679
8931
  * content section on the popover. With `null` the main extra content object will be removed. With `undefined`
8680
8932
  * the old object still remains.
@@ -8683,47 +8935,25 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8683
8935
  }
8684
8936
 
8685
8937
  /**
8686
- * Event object of the SemanticObjectController#navigationTargetsObtained event.
8687
- */
8688
- export type SemanticObjectController$NavigationTargetsObtainedEvent = Event<
8689
- SemanticObjectController$NavigationTargetsObtainedEventParameters,
8690
- SemanticObjectController
8691
- >;
8692
-
8693
- /**
8694
- * Parameters of the SemanticObjectController#prefetchDone event.
8695
- *
8696
- * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
8697
- * `prefetchNavigationTargets` which has been deprecated.
8698
- */
8699
- export interface SemanticObjectController$PrefetchDoneEventParameters {
8700
- /**
8701
- * A map containing all semantic objects as keys for which at least one navigation target has been found.
8702
- * The value for each semantic object key is an array containing the available actions found for this semantic
8703
- * object.
8704
- */
8705
- semanticObjects?: object;
8706
- }
8707
-
8708
- /**
8709
- * Event object of the SemanticObjectController#prefetchDone event.
8938
+ * Event object of the SmartLink#navigationTargetsObtained event.
8710
8939
  *
8711
- * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
8712
- * `prefetchNavigationTargets` which has been deprecated.
8940
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
8713
8941
  */
8714
- export type SemanticObjectController$PrefetchDoneEvent = Event<
8715
- SemanticObjectController$PrefetchDoneEventParameters,
8716
- SemanticObjectController
8942
+ export type SmartLink$NavigationTargetsObtainedEvent = Event<
8943
+ SmartLink$NavigationTargetsObtainedEventParameters,
8944
+ SmartLink
8717
8945
  >;
8718
8946
  }
8719
8947
 
8720
- declare module "sap/ui/comp/navpopover/SmartLink" {
8721
- import { default as Link, $LinkSettings } from "sap/m/Link";
8722
-
8723
- import Control from "sap/ui/core/Control";
8948
+ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
8949
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
8724
8950
 
8725
8951
  import ElementMetadata from "sap/ui/core/ElementMetadata";
8726
8952
 
8953
+ import SmartLink from "sap/ui/comp/navpopover/SmartLink";
8954
+
8955
+ import NavigationPopoverHandler from "sap/ui/comp/navpopover/NavigationPopoverHandler";
8956
+
8727
8957
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
8728
8958
 
8729
8959
  import Event from "sap/ui/base/Event";
@@ -8733,58 +8963,46 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8733
8963
  import SimpleForm from "sap/ui/layout/form/SimpleForm";
8734
8964
 
8735
8965
  /**
8736
- * The `SmartLink` control uses a semantic object to display {@link sap.ui.comp.navpopover.NavigationPopover NavigationPopover }
8737
- * for further navigation steps.
8738
- * **Note:** Navigation targets are determined using {@link sap.ushell.services.CrossApplicationNavigation CrossApplicationNavigation }
8739
- * of the unified shell service.
8740
- *
8741
- * **Important:** Keep in mind that `SmartLink`, like all SAPUI5 smart controls, retrieves and analyzes
8742
- * the metadata and annotations of OData services. **The OData metadata is its primary API. These OData
8743
- * services are not part of the SAPUI5 framework and are usually maintained by the backend developers of
8744
- * your application.**
8745
- *
8746
- * With time, `SmartLink` can evolve and acquire new features. This means that its behavior or functionalities
8747
- * may change if the annotations that define this change are maintained in your backend metadata. To benefit
8748
- * from the new functionalities, your application should be able to adapt the backend metadata. **Therefore,
8749
- * we recommend using `SmartLink` only if you have control over the metadata of your application.**
8966
+ * The `SemanticObjectController` control operates as a single entry point for `SmartLink` controls created
8967
+ * automatically by {@link sap.ui.comp.smarttable.SmartTable SmartTable} control, {@link sap.ui.comp.smartchart.SmartChart SmartChart }
8968
+ * control, {@link sap.ui.comp.smartform.SmartForm SmartForm} control and {@link sap.ui.comp.smartfield.SmartField SmartField }
8969
+ * control based on OData metadata. Additionally, all events provided by the `SmartLink` control are registered
8970
+ * by the SemanticObjectController and can be consumed there in a single place. As usual, the SemanticObjectController
8971
+ * can be defined within the XML view as well as in the code.
8750
8972
  */
8751
- export default class SmartLink extends Link {
8973
+ export default class SemanticObjectController extends UI5Element {
8752
8974
  /**
8753
8975
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
8754
8976
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
8755
8977
  * of the syntax of the settings object.
8756
- * See:
8757
- * {@link https://ui5.sap.com/#/topic/f638884d0d624ad8a243f4005f8e9972 Smart Link}
8758
8978
  */
8759
8979
  constructor(
8760
8980
  /**
8761
- * Initial settings for the new control
8981
+ * initial settings for the new control
8762
8982
  */
8763
- mSettings?: $SmartLinkSettings
8983
+ mSettings?: $SemanticObjectControllerSettings
8764
8984
  );
8765
8985
  /**
8766
8986
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
8767
8987
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
8768
8988
  * of the syntax of the settings object.
8769
- * See:
8770
- * {@link https://ui5.sap.com/#/topic/f638884d0d624ad8a243f4005f8e9972 Smart Link}
8771
8989
  */
8772
8990
  constructor(
8773
8991
  /**
8774
8992
  * ID for the new control, generated automatically if no ID is given
8775
8993
  */
8776
- sId?: string,
8994
+ sID?: string,
8777
8995
  /**
8778
- * Initial settings for the new control
8996
+ * initial settings for the new control
8779
8997
  */
8780
- mSettings?: $SmartLinkSettings
8998
+ mSettings?: $SemanticObjectControllerSettings
8781
8999
  );
8782
9000
 
8783
9001
  /**
8784
- * Creates a new subclass of class sap.ui.comp.navpopover.SmartLink with name `sClassName` and enriches
8785
- * it with the information contained in `oClassInfo`.
9002
+ * Creates a new subclass of class sap.ui.comp.navpopover.SemanticObjectController with name `sClassName`
9003
+ * and enriches it with the information contained in `oClassInfo`.
8786
9004
  *
8787
- * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Link.extend}.
9005
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
8788
9006
  *
8789
9007
  *
8790
9008
  * @returns Created class / constructor function
@@ -8797,7 +9015,7 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8797
9015
  /**
8798
9016
  * Object literal with information about the class
8799
9017
  */
8800
- oClassInfo?: sap.ClassInfo<T, SmartLink>,
9018
+ oClassInfo?: sap.ClassInfo<T, SemanticObjectController>,
8801
9019
  /**
8802
9020
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
8803
9021
  * used by this class
@@ -8805,7 +9023,7 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8805
9023
  FNMetaImpl?: Function
8806
9024
  ): Function;
8807
9025
  /**
8808
- * Returns a metadata object for class sap.ui.comp.navpopover.SmartLink.
9026
+ * Returns a metadata object for class sap.ui.comp.navpopover.SemanticObjectController.
8809
9027
  *
8810
9028
  *
8811
9029
  * @returns Metadata object describing this class
@@ -8813,14 +9031,14 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8813
9031
  static getMetadata(): ElementMetadata;
8814
9032
  /**
8815
9033
  * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event
8816
- * of this `sap.ui.comp.navpopover.SmartLink`.
9034
+ * of this `sap.ui.comp.navpopover.SemanticObjectController`.
8817
9035
  *
8818
9036
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8819
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
9037
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
8820
9038
  *
8821
- * Event is fired before the navigation popover opens and before navigation target links are getting retrieved.
8822
- * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink
8823
- * control, the `beforePopoverOpens` is fired after the link has been clicked.
9039
+ * Event is fired before the navigation popover opens and before navigation target links are retrieved.
9040
+ * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink,
9041
+ * `beforePopoverOpens` is fired after the link has been clicked.
8824
9042
  *
8825
9043
  * @since 1.28.0
8826
9044
  *
@@ -8835,22 +9053,25 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8835
9053
  /**
8836
9054
  * The function to be called when the event occurs
8837
9055
  */
8838
- fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void,
9056
+ fnFunction: (
9057
+ p1: SemanticObjectController$BeforePopoverOpensEvent
9058
+ ) => void,
8839
9059
  /**
8840
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
9060
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9061
+ * itself
8841
9062
  */
8842
9063
  oListener?: object
8843
9064
  ): this;
8844
9065
  /**
8845
9066
  * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event
8846
- * of this `sap.ui.comp.navpopover.SmartLink`.
9067
+ * of this `sap.ui.comp.navpopover.SemanticObjectController`.
8847
9068
  *
8848
9069
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8849
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
9070
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
8850
9071
  *
8851
- * Event is fired before the navigation popover opens and before navigation target links are getting retrieved.
8852
- * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink
8853
- * control, the `beforePopoverOpens` is fired after the link has been clicked.
9072
+ * Event is fired before the navigation popover opens and before navigation target links are retrieved.
9073
+ * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink,
9074
+ * `beforePopoverOpens` is fired after the link has been clicked.
8854
9075
  *
8855
9076
  * @since 1.28.0
8856
9077
  *
@@ -8860,17 +9081,20 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8860
9081
  /**
8861
9082
  * The function to be called when the event occurs
8862
9083
  */
8863
- fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void,
9084
+ fnFunction: (
9085
+ p1: SemanticObjectController$BeforePopoverOpensEvent
9086
+ ) => void,
8864
9087
  /**
8865
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
9088
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9089
+ * itself
8866
9090
  */
8867
9091
  oListener?: object
8868
9092
  ): this;
8869
9093
  /**
8870
- * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.SmartLink`.
9094
+ * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
8871
9095
  *
8872
9096
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8873
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
9097
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
8874
9098
  *
8875
9099
  * This event is fired after a navigation link on the navigation popover has been clicked. This event is
8876
9100
  * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window'
@@ -8880,7 +9104,7 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8880
9104
  *
8881
9105
  * @returns Reference to `this` in order to allow method chaining
8882
9106
  */
8883
- attachInnerNavigate(
9107
+ attachNavigate(
8884
9108
  /**
8885
9109
  * An application-specific payload object that will be passed to the event handler along with the event
8886
9110
  * object when firing the event
@@ -8889,17 +9113,18 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8889
9113
  /**
8890
9114
  * The function to be called when the event occurs
8891
9115
  */
8892
- fnFunction: (p1: SmartLink$InnerNavigateEvent) => void,
9116
+ fnFunction: (p1: SemanticObjectController$NavigateEvent) => void,
8893
9117
  /**
8894
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
9118
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9119
+ * itself
8895
9120
  */
8896
9121
  oListener?: object
8897
9122
  ): this;
8898
9123
  /**
8899
- * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.SmartLink`.
9124
+ * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
8900
9125
  *
8901
9126
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8902
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
9127
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
8903
9128
  *
8904
9129
  * This event is fired after a navigation link on the navigation popover has been clicked. This event is
8905
9130
  * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window'
@@ -8909,27 +9134,29 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8909
9134
  *
8910
9135
  * @returns Reference to `this` in order to allow method chaining
8911
9136
  */
8912
- attachInnerNavigate(
9137
+ attachNavigate(
8913
9138
  /**
8914
9139
  * The function to be called when the event occurs
8915
9140
  */
8916
- fnFunction: (p1: SmartLink$InnerNavigateEvent) => void,
9141
+ fnFunction: (p1: SemanticObjectController$NavigateEvent) => void,
8917
9142
  /**
8918
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
9143
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9144
+ * itself
8919
9145
  */
8920
9146
  oListener?: object
8921
9147
  ): this;
8922
9148
  /**
8923
9149
  * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained }
8924
- * event of this `sap.ui.comp.navpopover.SmartLink`.
9150
+ * event of this `sap.ui.comp.navpopover.SemanticObjectController`.
8925
9151
  *
8926
9152
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8927
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
9153
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
8928
9154
  *
8929
- * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility
8930
- * to change the targets.
9155
+ * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible
9156
+ * you to change the targets.
8931
9157
  *
8932
9158
  * @since 1.28.0
9159
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
8933
9160
  *
8934
9161
  * @returns Reference to `this` in order to allow method chaining
8935
9162
  */
@@ -8942,23 +9169,27 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8942
9169
  /**
8943
9170
  * The function to be called when the event occurs
8944
9171
  */
8945
- fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void,
9172
+ fnFunction: (
9173
+ p1: SemanticObjectController$NavigationTargetsObtainedEvent
9174
+ ) => void,
8946
9175
  /**
8947
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
9176
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9177
+ * itself
8948
9178
  */
8949
9179
  oListener?: object
8950
9180
  ): this;
8951
9181
  /**
8952
9182
  * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained }
8953
- * event of this `sap.ui.comp.navpopover.SmartLink`.
9183
+ * event of this `sap.ui.comp.navpopover.SemanticObjectController`.
8954
9184
  *
8955
9185
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8956
- * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself.
9186
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
8957
9187
  *
8958
- * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility
8959
- * to change the targets.
9188
+ * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible
9189
+ * you to change the targets.
8960
9190
  *
8961
9191
  * @since 1.28.0
9192
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
8962
9193
  *
8963
9194
  * @returns Reference to `this` in order to allow method chaining
8964
9195
  */
@@ -8966,23 +9197,75 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8966
9197
  /**
8967
9198
  * The function to be called when the event occurs
8968
9199
  */
8969
- fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void,
9200
+ fnFunction: (
9201
+ p1: SemanticObjectController$NavigationTargetsObtainedEvent
9202
+ ) => void,
8970
9203
  /**
8971
- * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself
9204
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9205
+ * itself
8972
9206
  */
8973
9207
  oListener?: object
8974
9208
  ): this;
8975
9209
  /**
8976
- * Destroys the innerControl in the aggregation {@link #getInnerControl innerControl}.
9210
+ * Attaches event handler `fnFunction` to the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
9211
+ *
9212
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
9213
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
9214
+ *
9215
+ * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all
9216
+ * navigation targets have been retrieved.
8977
9217
  *
8978
9218
  * @since 1.28.0
9219
+ * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
9220
+ * `prefetchNavigationTargets` which has been deprecated.
8979
9221
  *
8980
9222
  * @returns Reference to `this` in order to allow method chaining
8981
9223
  */
8982
- destroyInnerControl(): this;
9224
+ attachPrefetchDone(
9225
+ /**
9226
+ * An application-specific payload object that will be passed to the event handler along with the event
9227
+ * object when firing the event
9228
+ */
9229
+ oData: object,
9230
+ /**
9231
+ * The function to be called when the event occurs
9232
+ */
9233
+ fnFunction: (p1: SemanticObjectController$PrefetchDoneEvent) => void,
9234
+ /**
9235
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9236
+ * itself
9237
+ */
9238
+ oListener?: object
9239
+ ): this;
9240
+ /**
9241
+ * Attaches event handler `fnFunction` to the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
9242
+ *
9243
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
9244
+ * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself.
9245
+ *
9246
+ * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all
9247
+ * navigation targets have been retrieved.
9248
+ *
9249
+ * @since 1.28.0
9250
+ * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
9251
+ * `prefetchNavigationTargets` which has been deprecated.
9252
+ *
9253
+ * @returns Reference to `this` in order to allow method chaining
9254
+ */
9255
+ attachPrefetchDone(
9256
+ /**
9257
+ * The function to be called when the event occurs
9258
+ */
9259
+ fnFunction: (p1: SemanticObjectController$PrefetchDoneEvent) => void,
9260
+ /**
9261
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController`
9262
+ * itself
9263
+ */
9264
+ oListener?: object
9265
+ ): this;
8983
9266
  /**
8984
9267
  * Detaches event handler `fnFunction` from the {@link #event:beforePopoverOpens beforePopoverOpens} event
8985
- * of this `sap.ui.comp.navpopover.SmartLink`.
9268
+ * of this `sap.ui.comp.navpopover.SemanticObjectController`.
8986
9269
  *
8987
9270
  * The passed function and listener object must match the ones used for event registration.
8988
9271
  *
@@ -8994,15 +9277,16 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
8994
9277
  /**
8995
9278
  * The function to be called, when the event occurs
8996
9279
  */
8997
- fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void,
9280
+ fnFunction: (
9281
+ p1: SemanticObjectController$BeforePopoverOpensEvent
9282
+ ) => void,
8998
9283
  /**
8999
9284
  * Context object on which the given function had to be called
9000
9285
  */
9001
9286
  oListener?: object
9002
9287
  ): this;
9003
9288
  /**
9004
- * Detaches event handler `fnFunction` from the {@link #event:innerNavigate innerNavigate} event of this
9005
- * `sap.ui.comp.navpopover.SmartLink`.
9289
+ * Detaches event handler `fnFunction` from the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
9006
9290
  *
9007
9291
  * The passed function and listener object must match the ones used for event registration.
9008
9292
  *
@@ -9010,11 +9294,11 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9010
9294
  *
9011
9295
  * @returns Reference to `this` in order to allow method chaining
9012
9296
  */
9013
- detachInnerNavigate(
9297
+ detachNavigate(
9014
9298
  /**
9015
9299
  * The function to be called, when the event occurs
9016
9300
  */
9017
- fnFunction: (p1: SmartLink$InnerNavigateEvent) => void,
9301
+ fnFunction: (p1: SemanticObjectController$NavigateEvent) => void,
9018
9302
  /**
9019
9303
  * Context object on which the given function had to be called
9020
9304
  */
@@ -9022,11 +9306,12 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9022
9306
  ): this;
9023
9307
  /**
9024
9308
  * Detaches event handler `fnFunction` from the {@link #event:navigationTargetsObtained navigationTargetsObtained }
9025
- * event of this `sap.ui.comp.navpopover.SmartLink`.
9309
+ * event of this `sap.ui.comp.navpopover.SemanticObjectController`.
9026
9310
  *
9027
9311
  * The passed function and listener object must match the ones used for event registration.
9028
9312
  *
9029
9313
  * @since 1.28.0
9314
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
9030
9315
  *
9031
9316
  * @returns Reference to `this` in order to allow method chaining
9032
9317
  */
@@ -9034,7 +9319,30 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9034
9319
  /**
9035
9320
  * The function to be called, when the event occurs
9036
9321
  */
9037
- fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void,
9322
+ fnFunction: (
9323
+ p1: SemanticObjectController$NavigationTargetsObtainedEvent
9324
+ ) => void,
9325
+ /**
9326
+ * Context object on which the given function had to be called
9327
+ */
9328
+ oListener?: object
9329
+ ): this;
9330
+ /**
9331
+ * Detaches event handler `fnFunction` from the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`.
9332
+ *
9333
+ * The passed function and listener object must match the ones used for event registration.
9334
+ *
9335
+ * @since 1.28.0
9336
+ * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
9337
+ * `prefetchNavigationTargets` which has been deprecated.
9338
+ *
9339
+ * @returns Reference to `this` in order to allow method chaining
9340
+ */
9341
+ detachPrefetchDone(
9342
+ /**
9343
+ * The function to be called, when the event occurs
9344
+ */
9345
+ fnFunction: (p1: SemanticObjectController$PrefetchDoneEvent) => void,
9038
9346
  /**
9039
9347
  * Context object on which the given function had to be called
9040
9348
  */
@@ -9052,26 +9360,27 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9052
9360
  /**
9053
9361
  * Parameters to pass along with the event
9054
9362
  */
9055
- mParameters?: SmartLink$BeforePopoverOpensEventParameters
9363
+ mParameters?: SemanticObjectController$BeforePopoverOpensEventParameters
9056
9364
  ): this;
9057
9365
  /**
9058
- * Fires event {@link #event:innerNavigate innerNavigate} to attached listeners.
9366
+ * Fires event {@link #event:navigate navigate} to attached listeners.
9059
9367
  *
9060
9368
  * @since 1.28.0
9061
9369
  * @ui5-protected Do not call from applications (only from related classes in the framework)
9062
9370
  *
9063
9371
  * @returns Reference to `this` in order to allow method chaining
9064
9372
  */
9065
- fireInnerNavigate(
9373
+ fireNavigate(
9066
9374
  /**
9067
9375
  * Parameters to pass along with the event
9068
9376
  */
9069
- mParameters?: SmartLink$InnerNavigateEventParameters
9377
+ mParameters?: SemanticObjectController$NavigateEventParameters
9070
9378
  ): this;
9071
9379
  /**
9072
9380
  * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners.
9073
9381
  *
9074
9382
  * @since 1.28.0
9383
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
9075
9384
  * @ui5-protected Do not call from applications (only from related classes in the framework)
9076
9385
  *
9077
9386
  * @returns Reference to `this` in order to allow method chaining
@@ -9080,21 +9389,24 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9080
9389
  /**
9081
9390
  * Parameters to pass along with the event
9082
9391
  */
9083
- mParameters?: SmartLink$NavigationTargetsObtainedEventParameters
9392
+ mParameters?: SemanticObjectController$NavigationTargetsObtainedEventParameters
9084
9393
  ): this;
9085
9394
  /**
9086
- * Gets current value of property {@link #getAdditionalSemanticObjects additionalSemanticObjects}.
9087
- *
9088
- * Semantic object names which can be used additional to the default `semanticObject` property in order
9089
- * to get navigation targets links.
9090
- *
9091
- * Default value is `[]`.
9395
+ * Fires event {@link #event:prefetchDone prefetchDone} to attached listeners.
9092
9396
  *
9093
- * @since 1.42.0
9397
+ * @since 1.28.0
9398
+ * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
9399
+ * `prefetchNavigationTargets` which has been deprecated.
9400
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
9094
9401
  *
9095
- * @returns Value of property `additionalSemanticObjects`
9402
+ * @returns Reference to `this` in order to allow method chaining
9096
9403
  */
9097
- getAdditionalSemanticObjects(): string[];
9404
+ firePrefetchDone(
9405
+ /**
9406
+ * Parameters to pass along with the event
9407
+ */
9408
+ mParameters?: SemanticObjectController$PrefetchDoneEventParameters
9409
+ ): this;
9098
9410
  /**
9099
9411
  * Gets current value of property {@link #getBeforeNavigationCallback beforeNavigationCallback}.
9100
9412
  *
@@ -9115,243 +9427,256 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9115
9427
  */
9116
9428
  getBeforeNavigationCallback(): Function;
9117
9429
  /**
9118
- * Gets current value of property {@link #getContactAnnotationPath contactAnnotationPath}.
9119
- *
9120
- * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact
9121
- * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type
9122
- * is the current one.
9430
+ * Gets current value of property {@link #getContactAnnotationPaths contactAnnotationPaths}.
9123
9431
  *
9124
- * Default value is `undefined`.
9432
+ * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact`
9433
+ * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An
9434
+ * empty string means that the related entity type is the current one.
9125
9435
  *
9126
9436
  * @since 1.40.0
9127
9437
  *
9128
- * @returns Value of property `contactAnnotationPath`
9438
+ * @returns Value of property `contactAnnotationPaths`
9129
9439
  */
9130
- getContactAnnotationPath(): string;
9440
+ getContactAnnotationPaths(): object;
9131
9441
  /**
9132
- * Gets current value of property {@link #getCreateControlCallback createControlCallback}.
9442
+ * Gets current value of property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}.
9133
9443
  *
9134
- * Function that enables the SmartLink control to create an alternative control, which is displayed if no
9135
- * navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.
9444
+ * Determines whether the personalization link is shown inside the NavigationPopover control. For example,
9445
+ * ` '\{"Supplier":false, "CompanyName":true\}' `.
9136
9446
  *
9137
- * @since 1.28.0
9447
+ * @since 1.44.0
9138
9448
  *
9139
- * @returns Value of property `createControlCallback`
9449
+ * @returns Value of property `enableAvailableActionsPersonalization`
9140
9450
  */
9141
- getCreateControlCallback(): object;
9451
+ getEnableAvailableActionsPersonalization(): object;
9142
9452
  /**
9143
- * Gets current value of property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}.
9144
- *
9145
- * Determines whether the personalization link is shown inside the NavigationPopover control.
9453
+ * Gets current value of property {@link #getEntitySet entitySet}.
9146
9454
  *
9147
- * Default value is `true`.
9455
+ * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries
9456
+ * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property.
9148
9457
  *
9149
- * @since 1.44.0
9458
+ * @since 1.28.0
9150
9459
  *
9151
- * @returns Value of property `enableAvailableActionsPersonalization`
9460
+ * @returns Value of property `entitySet`
9152
9461
  */
9153
- getEnableAvailableActionsPersonalization(): boolean;
9462
+ getEntitySet(): string;
9154
9463
  /**
9155
- * Gets current value of property {@link #getFieldName fieldName}.
9464
+ * Gets current value of property {@link #getFieldSemanticObjectMap fieldSemanticObjectMap}.
9156
9465
  *
9157
- * The metadata field name for this SmartLink control.
9466
+ * Maps the fields to the related semantic objects. When accessing this property for the first time, the
9467
+ * mapping will be calculated from the metadata within the provided model.
9158
9468
  *
9159
9469
  * @since 1.28.0
9160
9470
  *
9161
- * @returns Value of property `fieldName`
9471
+ * @returns Value of property `fieldSemanticObjectMap`
9162
9472
  */
9163
- getFieldName(): string;
9473
+ getFieldSemanticObjectMap(): object;
9164
9474
  /**
9165
9475
  * Gets current value of property {@link #getForceLinkRendering forceLinkRendering}.
9166
9476
  *
9167
- * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not
9168
- * set and navigation targets do not exist. Setting this property to `true` allows the application, for
9169
- * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link
9170
- * and the registered event handler has been called.
9477
+ * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if
9478
+ * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true`
9479
+ * allows the application, for example, to modify the `SmartLink` control in the event handler, after the
9480
+ * user has clicked on a link and the registered event handler has been called.\n
9171
9481
  *
9172
- * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController`
9173
- * take precedence over `forceLinkRendering`.
9482
+ * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control
9483
+ * take precedence over `forceLinkRendering`.\n
9174
9484
  *
9175
- * Default value is `false`.
9485
+ * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' `
9176
9486
  *
9177
9487
  * @since 1.58.0
9178
9488
  *
9179
9489
  * @returns Value of property `forceLinkRendering`
9180
9490
  */
9181
- getForceLinkRendering(): boolean;
9182
- /**
9183
- * Gets current value of property {@link #getIgnoreLinkRendering ignoreLinkRendering}.
9184
- *
9185
- * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback`
9186
- * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink
9187
- * is listed in its `ignoredFields` or no navigation targets were found during prefetch.
9188
- *
9189
- * Default value is `false`.
9190
- *
9191
- * @since 1.28.0
9192
- *
9193
- * @returns Value of property `ignoreLinkRendering`
9194
- */
9195
- getIgnoreLinkRendering(): boolean;
9491
+ getForceLinkRendering(): object;
9196
9492
  /**
9197
- * Gets content of aggregation {@link #getInnerControl innerControl}.
9493
+ * Gets current value of property {@link #getIgnoredFields ignoredFields}.
9198
9494
  *
9199
- * Control that is displayed instead of SmartLink control, if the SmartLink is disabled (for example, if
9200
- * no navigation targets are available). If `innerControl` is not provided, the SmartLink control tries
9201
- * to create one with property `createControlCallback`.
9495
+ * Comma-separated list of fields that must not be displayed as links.
9202
9496
  *
9203
9497
  * @since 1.28.0
9204
- */
9205
- getInnerControl(): Control;
9206
- /**
9207
- * Gets the inner control's value, if no inner control is available, the text of SmartLink control will
9208
- * be returned.
9209
- *
9210
9498
  *
9211
- * @returns the value
9499
+ * @returns Value of property `ignoredFields`
9212
9500
  */
9213
- getInnerControlValue(): object;
9501
+ getIgnoredFields(): string;
9214
9502
  /**
9215
9503
  * Gets current value of property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}.
9216
9504
  *
9217
9505
  * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
9218
- * property during the calculation of the semantic attributes. This enables the usage of several SmartLink
9219
- * controls on the same semantic object.
9220
- *
9221
- * Default value is `true`.
9506
+ * property during the calculation of the semantic attributes.
9222
9507
  *
9508
+ * @since 1.48.0
9223
9509
  *
9224
9510
  * @returns Value of property `mapFieldToSemanticObject`
9225
9511
  */
9226
9512
  getMapFieldToSemanticObject(): boolean;
9227
9513
  /**
9228
- * Gets current value of property {@link #getSemanticObject semanticObject}.
9514
+ * Gets current value of property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}.
9229
9515
  *
9230
- * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers
9231
- * an asynchronous determination, so the effect can be delayed.
9516
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
9517
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
9518
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
9519
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
9520
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
9521
+ * event. The event handling is ignored if this callback is set.
9232
9522
  *
9233
- * @since 1.28.0
9523
+ * @since 1.126
9234
9524
  *
9235
- * @returns Value of property `semanticObject`
9525
+ * @returns Value of property `navigationTargetsObtainedCallback`
9236
9526
  */
9237
- getSemanticObject(): string;
9527
+ getNavigationTargetsObtainedCallback(): Function;
9238
9528
  /**
9239
- * Gets current value of property {@link #getSemanticObjectController semanticObjectController}.
9529
+ * Gets current value of property {@link #getPrefetchNavigationTargets prefetchNavigationTargets}.
9240
9530
  *
9241
- * The semantic object controller controls events for several SmartLink controls. If the controller is not
9242
- * set manually, it tries to find a SemanticObjectController in its parent hierarchy.
9531
+ * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable
9532
+ * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip.
9533
+ *
9534
+ * Default value is `false`.
9243
9535
  *
9244
9536
  * @since 1.28.0
9537
+ * @deprecated (since 1.42.0) - The property `prefetchNavigationTargets` is obsolete as navigation targets
9538
+ * are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous determination
9539
+ * of navigation targets has been completed.
9245
9540
  *
9246
- * @returns Value of property `semanticObjectController`
9541
+ * @returns Value of property `prefetchNavigationTargets`
9247
9542
  */
9248
- getSemanticObjectController(): any;
9543
+ getPrefetchNavigationTargets(): boolean;
9249
9544
  /**
9250
- * Gets current value of property {@link #getSemanticObjectLabel semanticObjectLabel}.
9545
+ * Gets current value of property {@link #getReplaceSmartLinkNavigationTargetsObtained replaceSmartLinkNavigationTargetsObtained}.
9251
9546
  *
9252
- * Shown label of semantic object.
9547
+ * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when
9548
+ * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink.
9253
9549
  *
9254
- * @since 1.28.0
9255
- * @deprecated (since 1.40.0) - Title section with `semanticObjectLabel` has been removed due to new UI
9256
- * design
9550
+ * Default value is `false`.
9257
9551
  *
9258
- * @returns Value of property `semanticObjectLabel`
9552
+ * @since 1.97
9553
+ *
9554
+ * @returns Value of property `replaceSmartLinkNavigationTargetsObtained`
9259
9555
  */
9260
- getSemanticObjectLabel(): string;
9556
+ getReplaceSmartLinkNavigationTargetsObtained(): boolean;
9557
+ /**
9558
+ * Checks if the given semantic object name has a navigation link. **Note**: this method returns a valid
9559
+ * value only after the event `prefetchDone` has been raised. The event `prefetchDone` is raised if the
9560
+ * property `prefetchNavigationTargets` is set to `true`.
9561
+ *
9562
+ * @deprecated (since 1.42.0) - The method `hasSemanticObjectLinks` is obsolete because it depends on the
9563
+ * property `prefetchNavigationTargets` which has been deprecated.
9564
+ *
9565
+ * @returns true if the semantic object has any navigation links
9566
+ */
9567
+ hasSemanticObjectLinks(
9568
+ /**
9569
+ * Name of semantic object
9570
+ */
9571
+ sSemanticObject: string
9572
+ ): boolean;
9261
9573
  /**
9262
- * Gets current value of property {@link #getUom uom}.
9263
- *
9264
- * Additionally to the `text` property the Unit of Measure can be displayed.
9265
- *
9266
- * Default value is `undefined`.
9574
+ * Returns whether the given control has been registered by the SemanticObjectController.
9267
9575
  *
9268
- * @since 1.48.0
9269
9576
  *
9270
- * @returns Value of property `uom`
9577
+ * @returns `true` if the given control has been registered
9271
9578
  */
9272
- getUom(): string;
9579
+ isControlRegistered(
9580
+ /**
9581
+ * Control registered by `SemanticObjectController`
9582
+ */
9583
+ oControl: SmartLink | NavigationPopoverHandler
9584
+ ): boolean;
9273
9585
  /**
9274
- * Sets a new value for property {@link #getAdditionalSemanticObjects additionalSemanticObjects}.
9586
+ * Adds the given control to the SemanticObjectController and registers all relevant events.
9587
+ */
9588
+ registerControl(
9589
+ /**
9590
+ * Control to be registered by `SemanticObjectController`
9591
+ */
9592
+ oControl: SmartLink | NavigationPopoverHandler
9593
+ ): void;
9594
+ /**
9595
+ * Sets a new value for property {@link #getBeforeNavigationCallback beforeNavigationCallback}.
9275
9596
  *
9276
- * Semantic object names which can be used additional to the default `semanticObject` property in order
9277
- * to get navigation targets links.
9597
+ * Function that is called before the actual navigation happens. This function has to return a promise resolving
9598
+ * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
9599
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
9278
9600
  *
9279
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9601
+ * - {String} text: Text of the navigation intent
9602
+ * - {String} href: HREF of the navigation intent
9603
+ * - {String} originalId: ID of the control that fires the navigation intent
9604
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
9605
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
9280
9606
  *
9281
- * Default value is `[]`.
9282
9607
  *
9283
- * @since 1.42.0
9608
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9609
+ *
9610
+ * @since 1.75.0
9284
9611
  *
9285
9612
  * @returns Reference to `this` in order to allow method chaining
9286
9613
  */
9287
- setAdditionalSemanticObjects(
9614
+ setBeforeNavigationCallback(
9288
9615
  /**
9289
- * New value for property `additionalSemanticObjects`
9616
+ * New value for property `beforeNavigationCallback`
9290
9617
  */
9291
- sAdditionalSemanticObjects?: string[]
9618
+ fnBeforeNavigationCallback: Function
9292
9619
  ): this;
9293
9620
  /**
9294
- * Sets a new value for property {@link #getContactAnnotationPath contactAnnotationPath}.
9621
+ * Sets a new value for property {@link #getContactAnnotationPaths contactAnnotationPaths}.
9295
9622
  *
9296
- * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact
9297
- * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type
9298
- * is the current one.
9623
+ * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact`
9624
+ * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An
9625
+ * empty string means that the related entity type is the current one.
9299
9626
  *
9300
9627
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9301
9628
  *
9302
- * Default value is `undefined`.
9303
- *
9304
9629
  * @since 1.40.0
9305
9630
  *
9306
9631
  * @returns Reference to `this` in order to allow method chaining
9307
9632
  */
9308
- setContactAnnotationPath(
9633
+ setContactAnnotationPaths(
9309
9634
  /**
9310
- * New value for property `contactAnnotationPath`
9635
+ * New value for property `contactAnnotationPaths`
9311
9636
  */
9312
- sContactAnnotationPath?: string
9637
+ oContactAnnotationPaths?: object
9313
9638
  ): this;
9314
9639
  /**
9315
- * Sets a new value for property {@link #getCreateControlCallback createControlCallback}.
9640
+ * Sets a new value for property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}.
9316
9641
  *
9317
- * Function that enables the SmartLink control to create an alternative control, which is displayed if no
9318
- * navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.
9642
+ * Determines whether the personalization link is shown inside the NavigationPopover control. For example,
9643
+ * ` '\{"Supplier":false, "CompanyName":true\}' `.
9319
9644
  *
9320
9645
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9321
9646
  *
9322
- * @since 1.28.0
9647
+ * @since 1.44.0
9323
9648
  *
9324
9649
  * @returns Reference to `this` in order to allow method chaining
9325
9650
  */
9326
- setCreateControlCallback(
9651
+ setEnableAvailableActionsPersonalization(
9327
9652
  /**
9328
- * New value for property `createControlCallback`
9653
+ * New value for property `enableAvailableActionsPersonalization`
9329
9654
  */
9330
- oCreateControlCallback?: object
9655
+ oEnableAvailableActionsPersonalization?: object
9331
9656
  ): this;
9332
9657
  /**
9333
- * Sets a new value for property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}.
9658
+ * Sets a new value for property {@link #getEntitySet entitySet}.
9334
9659
  *
9335
- * Determines whether the personalization link is shown inside the NavigationPopover control.
9660
+ * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries
9661
+ * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property.
9336
9662
  *
9337
9663
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9338
9664
  *
9339
- * Default value is `true`.
9340
- *
9341
- * @since 1.44.0
9665
+ * @since 1.28.0
9342
9666
  *
9343
9667
  * @returns Reference to `this` in order to allow method chaining
9344
9668
  */
9345
- setEnableAvailableActionsPersonalization(
9669
+ setEntitySet(
9346
9670
  /**
9347
- * New value for property `enableAvailableActionsPersonalization`
9671
+ * New value for property `entitySet`
9348
9672
  */
9349
- bEnableAvailableActionsPersonalization?: boolean
9673
+ sEntitySet?: string
9350
9674
  ): this;
9351
9675
  /**
9352
- * Sets a new value for property {@link #getFieldName fieldName}.
9676
+ * Sets a new value for property {@link #getFieldSemanticObjectMap fieldSemanticObjectMap}.
9353
9677
  *
9354
- * The metadata field name for this SmartLink control.
9678
+ * Maps the fields to the related semantic objects. When accessing this property for the first time, the
9679
+ * mapping will be calculated from the metadata within the provided model.
9355
9680
  *
9356
9681
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9357
9682
  *
@@ -9359,26 +9684,26 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9359
9684
  *
9360
9685
  * @returns Reference to `this` in order to allow method chaining
9361
9686
  */
9362
- setFieldName(
9687
+ setFieldSemanticObjectMap(
9363
9688
  /**
9364
- * New value for property `fieldName`
9689
+ * New value for property `fieldSemanticObjectMap`
9365
9690
  */
9366
- sFieldName?: string
9691
+ oFieldSemanticObjectMap?: object
9367
9692
  ): this;
9368
9693
  /**
9369
9694
  * Sets a new value for property {@link #getForceLinkRendering forceLinkRendering}.
9370
9695
  *
9371
- * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not
9372
- * set and navigation targets do not exist. Setting this property to `true` allows the application, for
9373
- * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link
9374
- * and the registered event handler has been called.
9696
+ * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if
9697
+ * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true`
9698
+ * allows the application, for example, to modify the `SmartLink` control in the event handler, after the
9699
+ * user has clicked on a link and the registered event handler has been called.\n
9375
9700
  *
9376
- * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController`
9377
- * take precedence over `forceLinkRendering`.
9701
+ * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control
9702
+ * take precedence over `forceLinkRendering`.\n
9378
9703
  *
9379
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9704
+ * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' `
9380
9705
  *
9381
- * Default value is `false`.
9706
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9382
9707
  *
9383
9708
  * @since 1.58.0
9384
9709
  *
@@ -9388,53 +9713,46 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9388
9713
  /**
9389
9714
  * New value for property `forceLinkRendering`
9390
9715
  */
9391
- bForceLinkRendering?: boolean
9716
+ oForceLinkRendering?: object
9392
9717
  ): this;
9393
9718
  /**
9394
- * Sets a new value for property {@link #getIgnoreLinkRendering ignoreLinkRendering}.
9719
+ * Sets a new value for property {@link #getIgnoredFields ignoredFields}.
9395
9720
  *
9396
- * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback`
9397
- * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink
9398
- * is listed in its `ignoredFields` or no navigation targets were found during prefetch.
9721
+ * Comma-separated list of fields that must not be displayed as links.
9399
9722
  *
9400
9723
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9401
9724
  *
9402
- * Default value is `false`.
9403
- *
9404
9725
  * @since 1.28.0
9405
9726
  *
9406
9727
  * @returns Reference to `this` in order to allow method chaining
9407
9728
  */
9408
- setIgnoreLinkRendering(
9729
+ setIgnoredFields(
9409
9730
  /**
9410
- * New value for property `ignoreLinkRendering`
9731
+ * New value for property `ignoredFields`
9411
9732
  */
9412
- bIgnoreLinkRendering?: boolean
9733
+ sIgnoredFields?: string
9413
9734
  ): this;
9414
9735
  /**
9415
- * Sets the aggregated {@link #getInnerControl innerControl}.
9416
- *
9417
- * @since 1.28.0
9736
+ * Checks if the given SmartLink has to be enabled or disabled and sets the state.
9418
9737
  *
9419
- * @returns Reference to `this` in order to allow method chaining
9738
+ * @deprecated (since 1.42.0) - The method `setIgnoredState` is obsolete as SmartLink is processing the
9739
+ * internal state on its own.
9420
9740
  */
9421
- setInnerControl(
9741
+ setIgnoredState(
9422
9742
  /**
9423
- * The innerControl to set
9743
+ * the SmartLink which should be enabled or disabled.
9424
9744
  */
9425
- oInnerControl: Control
9426
- ): this;
9745
+ oSmartLink: SmartLink
9746
+ ): void;
9427
9747
  /**
9428
9748
  * Sets a new value for property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}.
9429
9749
  *
9430
9750
  * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
9431
- * property during the calculation of the semantic attributes. This enables the usage of several SmartLink
9432
- * controls on the same semantic object.
9751
+ * property during the calculation of the semantic attributes.
9433
9752
  *
9434
9753
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9435
9754
  *
9436
- * Default value is `true`.
9437
- *
9755
+ * @since 1.48.0
9438
9756
  *
9439
9757
  * @returns Reference to `this` in order to allow method chaining
9440
9758
  */
@@ -9442,189 +9760,163 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9442
9760
  /**
9443
9761
  * New value for property `mapFieldToSemanticObject`
9444
9762
  */
9445
- bMapFieldToSemanticObject?: boolean
9763
+ bMapFieldToSemanticObject: boolean
9446
9764
  ): this;
9447
9765
  /**
9448
- * Sets a new value for property {@link #getSemanticObject semanticObject}.
9766
+ * Sets a new value for property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}.
9449
9767
  *
9450
- * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers
9451
- * an asynchronous determination, so the effect can be delayed.
9768
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
9769
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
9770
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
9771
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
9772
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
9773
+ * event. The event handling is ignored if this callback is set.
9452
9774
  *
9453
9775
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9454
9776
  *
9455
- * @since 1.28.0
9777
+ * @since 1.126
9456
9778
  *
9457
9779
  * @returns Reference to `this` in order to allow method chaining
9458
9780
  */
9459
- setSemanticObject(
9781
+ setNavigationTargetsObtainedCallback(
9460
9782
  /**
9461
- * New value for property `semanticObject`
9783
+ * New value for property `navigationTargetsObtainedCallback`
9462
9784
  */
9463
- sSemanticObject?: string
9785
+ fnNavigationTargetsObtainedCallback: Function
9464
9786
  ): this;
9465
9787
  /**
9466
- * Sets a new value for property {@link #getSemanticObjectController semanticObjectController}.
9788
+ * Sets a new value for property {@link #getPrefetchNavigationTargets prefetchNavigationTargets}.
9467
9789
  *
9468
- * The semantic object controller controls events for several SmartLink controls. If the controller is not
9469
- * set manually, it tries to find a SemanticObjectController in its parent hierarchy.
9790
+ * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable
9791
+ * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip.
9470
9792
  *
9471
9793
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9472
9794
  *
9795
+ * Default value is `false`.
9796
+ *
9473
9797
  * @since 1.28.0
9798
+ * @deprecated (since 1.42.0) - The property `prefetchNavigationTargets` is obsolete as navigation targets
9799
+ * are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous determination
9800
+ * of navigation targets has been completed.
9474
9801
  *
9475
9802
  * @returns Reference to `this` in order to allow method chaining
9476
9803
  */
9477
- setSemanticObjectController(
9804
+ setPrefetchNavigationTargets(
9478
9805
  /**
9479
- * New value for property `semanticObjectController`
9806
+ * New value for property `prefetchNavigationTargets`
9480
9807
  */
9481
- oSemanticObjectController?: any
9808
+ bPrefetchNavigationTargets?: boolean
9482
9809
  ): this;
9483
9810
  /**
9484
- * Sets a new value for property {@link #getSemanticObjectLabel semanticObjectLabel}.
9811
+ * Sets a new value for property {@link #getReplaceSmartLinkNavigationTargetsObtained replaceSmartLinkNavigationTargetsObtained}.
9485
9812
  *
9486
- * Shown label of semantic object.
9813
+ * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when
9814
+ * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink.
9487
9815
  *
9488
9816
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9489
9817
  *
9490
- * @since 1.28.0
9491
- * @deprecated (since 1.40.0) - Title section with `semanticObjectLabel` has been removed due to new UI
9492
- * design
9818
+ * Default value is `false`.
9819
+ *
9820
+ * @since 1.97
9493
9821
  *
9494
9822
  * @returns Reference to `this` in order to allow method chaining
9495
9823
  */
9496
- setSemanticObjectLabel(
9824
+ setReplaceSmartLinkNavigationTargetsObtained(
9497
9825
  /**
9498
- * New value for property `semanticObjectLabel`
9826
+ * New value for property `replaceSmartLinkNavigationTargetsObtained`
9499
9827
  */
9500
- sSemanticObjectLabel?: string
9828
+ bReplaceSmartLinkNavigationTargetsObtained?: boolean
9501
9829
  ): this;
9502
9830
  /**
9503
- * Sets a new value for property {@link #getUom uom}.
9504
- *
9505
- * Additionally to the `text` property the Unit of Measure can be displayed.
9506
- *
9507
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9508
- *
9509
- * Default value is `undefined`.
9510
- *
9511
- * @since 1.48.0
9512
- *
9513
- * @returns Reference to `this` in order to allow method chaining
9831
+ * Removes the given control from the SemanticObjectController and unregisters all relevant events.
9514
9832
  */
9515
- setUom(
9833
+ unregisterControl(
9516
9834
  /**
9517
- * New value for property `uom`
9835
+ * Control to be unregistered by `SemanticObjectController`
9518
9836
  */
9519
- sUom?: string
9520
- ): this;
9837
+ oControl: SmartLink | NavigationPopoverHandler
9838
+ ): void;
9521
9839
  }
9522
9840
  /**
9523
- * Describes the settings that can be provided to the SmartLink constructor.
9841
+ * Describes the settings that can be provided to the SemanticObjectController constructor.
9524
9842
  */
9525
- export interface $SmartLinkSettings extends $LinkSettings {
9526
- /**
9527
- * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers
9528
- * an asynchronous determination, so the effect can be delayed.
9529
- *
9530
- * @since 1.28.0
9531
- */
9532
- semanticObject?: string | PropertyBindingInfo;
9533
-
9534
- /**
9535
- * Semantic object names which can be used additional to the default `semanticObject` property in order
9536
- * to get navigation targets links.
9537
- *
9538
- * @since 1.42.0
9539
- */
9540
- additionalSemanticObjects?: string[] | PropertyBindingInfo | `{${string}}`;
9541
-
9843
+ export interface $SemanticObjectControllerSettings extends $ElementSettings {
9542
9844
  /**
9543
- * The semantic object controller controls events for several SmartLink controls. If the controller is not
9544
- * set manually, it tries to find a SemanticObjectController in its parent hierarchy.
9845
+ * Comma-separated list of fields that must not be displayed as links.
9545
9846
  *
9546
9847
  * @since 1.28.0
9547
9848
  */
9548
- semanticObjectController?: any | PropertyBindingInfo | `{${string}}`;
9849
+ ignoredFields?: string | PropertyBindingInfo;
9549
9850
 
9550
9851
  /**
9551
- * The metadata field name for this SmartLink control.
9852
+ * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable
9853
+ * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip.
9552
9854
  *
9553
9855
  * @since 1.28.0
9856
+ * @deprecated (since 1.42.0) - The property `prefetchNavigationTargets` is obsolete as navigation targets
9857
+ * are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous determination
9858
+ * of navigation targets has been completed.
9554
9859
  */
9555
- fieldName?: string | PropertyBindingInfo;
9860
+ prefetchNavigationTargets?: boolean | PropertyBindingInfo | `{${string}}`;
9556
9861
 
9557
9862
  /**
9558
- * Shown label of semantic object.
9863
+ * Maps the fields to the related semantic objects. When accessing this property for the first time, the
9864
+ * mapping will be calculated from the metadata within the provided model.
9559
9865
  *
9560
9866
  * @since 1.28.0
9561
- * @deprecated (since 1.40.0) - Title section with `semanticObjectLabel` has been removed due to new UI
9562
- * design
9563
9867
  */
9564
- semanticObjectLabel?: string | PropertyBindingInfo;
9868
+ fieldSemanticObjectMap?: object | PropertyBindingInfo | `{${string}}`;
9565
9869
 
9566
9870
  /**
9567
- * Function that enables the SmartLink control to create an alternative control, which is displayed if no
9568
- * navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.
9871
+ * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries
9872
+ * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property.
9569
9873
  *
9570
9874
  * @since 1.28.0
9571
9875
  */
9572
- createControlCallback?: object | PropertyBindingInfo | `{${string}}`;
9573
-
9574
- /**
9575
- * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
9576
- * property during the calculation of the semantic attributes. This enables the usage of several SmartLink
9577
- * controls on the same semantic object.
9578
- */
9579
- mapFieldToSemanticObject?: boolean | PropertyBindingInfo | `{${string}}`;
9876
+ entitySet?: string | PropertyBindingInfo;
9580
9877
 
9581
9878
  /**
9582
- * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact
9583
- * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type
9584
- * is the current one.
9879
+ * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact`
9880
+ * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An
9881
+ * empty string means that the related entity type is the current one.
9585
9882
  *
9586
9883
  * @since 1.40.0
9587
9884
  */
9588
- contactAnnotationPath?: string | PropertyBindingInfo;
9589
-
9590
- /**
9591
- * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback`
9592
- * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink
9593
- * is listed in its `ignoredFields` or no navigation targets were found during prefetch.
9594
- *
9595
- * @since 1.28.0
9596
- */
9597
- ignoreLinkRendering?: boolean | PropertyBindingInfo | `{${string}}`;
9885
+ contactAnnotationPaths?: object | PropertyBindingInfo | `{${string}}`;
9598
9886
 
9599
9887
  /**
9600
- * Determines whether the personalization link is shown inside the NavigationPopover control.
9888
+ * Determines whether the personalization link is shown inside the NavigationPopover control. For example,
9889
+ * ` '\{"Supplier":false, "CompanyName":true\}' `.
9601
9890
  *
9602
9891
  * @since 1.44.0
9603
9892
  */
9604
9893
  enableAvailableActionsPersonalization?:
9605
- | boolean
9894
+ | object
9606
9895
  | PropertyBindingInfo
9607
9896
  | `{${string}}`;
9608
9897
 
9609
9898
  /**
9610
- * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not
9611
- * set and navigation targets do not exist. Setting this property to `true` allows the application, for
9612
- * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link
9613
- * and the registered event handler has been called.
9614
- *
9615
- * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController`
9616
- * take precedence over `forceLinkRendering`.
9899
+ * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject`
9900
+ * property during the calculation of the semantic attributes.
9617
9901
  *
9618
- * @since 1.58.0
9902
+ * @since 1.48.0
9619
9903
  */
9620
- forceLinkRendering?: boolean | PropertyBindingInfo | `{${string}}`;
9904
+ mapFieldToSemanticObject?: boolean | PropertyBindingInfo | `{${string}}`;
9621
9905
 
9622
9906
  /**
9623
- * Additionally to the `text` property the Unit of Measure can be displayed.
9907
+ * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if
9908
+ * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true`
9909
+ * allows the application, for example, to modify the `SmartLink` control in the event handler, after the
9910
+ * user has clicked on a link and the registered event handler has been called.\n
9624
9911
  *
9625
- * @since 1.48.0
9912
+ * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control
9913
+ * take precedence over `forceLinkRendering`.\n
9914
+ *
9915
+ * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' `
9916
+ *
9917
+ * @since 1.58.0
9626
9918
  */
9627
- uom?: string | PropertyBindingInfo;
9919
+ forceLinkRendering?: object | PropertyBindingInfo | `{${string}}`;
9628
9920
 
9629
9921
  /**
9630
9922
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
@@ -9643,31 +9935,51 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9643
9935
  beforeNavigationCallback?: Function | PropertyBindingInfo | `{${string}}`;
9644
9936
 
9645
9937
  /**
9646
- * Control that is displayed instead of SmartLink control, if the SmartLink is disabled (for example, if
9647
- * no navigation targets are available). If `innerControl` is not provided, the SmartLink control tries
9648
- * to create one with property `createControlCallback`.
9938
+ * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when
9939
+ * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink.
9649
9940
  *
9650
- * @since 1.28.0
9941
+ * @since 1.97
9651
9942
  */
9652
- innerControl?: Control;
9943
+ replaceSmartLinkNavigationTargetsObtained?:
9944
+ | boolean
9945
+ | PropertyBindingInfo
9946
+ | `{${string}}`;
9653
9947
 
9654
9948
  /**
9655
- * Event is fired before the navigation popover opens and before navigation target links are getting retrieved.
9656
- * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink
9657
- * control, the `beforePopoverOpens` is fired after the link has been clicked.
9949
+ * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
9950
+ * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
9951
+ * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
9952
+ * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`.
9953
+ * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
9954
+ * event. The event handling is ignored if this callback is set.
9658
9955
  *
9659
- * @since 1.28.0
9956
+ * @since 1.126
9660
9957
  */
9661
- beforePopoverOpens?: (oEvent: SmartLink$BeforePopoverOpensEvent) => void;
9958
+ navigationTargetsObtainedCallback?:
9959
+ | Function
9960
+ | PropertyBindingInfo
9961
+ | `{${string}}`;
9662
9962
 
9663
9963
  /**
9664
- * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility
9665
- * to change the targets.
9964
+ * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible
9965
+ * you to change the targets.
9666
9966
  *
9667
9967
  * @since 1.28.0
9968
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
9668
9969
  */
9669
9970
  navigationTargetsObtained?: (
9670
- oEvent: SmartLink$NavigationTargetsObtainedEvent
9971
+ oEvent: SemanticObjectController$NavigationTargetsObtainedEvent
9972
+ ) => void;
9973
+
9974
+ /**
9975
+ * Event is fired before the navigation popover opens and before navigation target links are retrieved.
9976
+ * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink,
9977
+ * `beforePopoverOpens` is fired after the link has been clicked.
9978
+ *
9979
+ * @since 1.28.0
9980
+ */
9981
+ beforePopoverOpens?: (
9982
+ oEvent: SemanticObjectController$BeforePopoverOpensEvent
9671
9983
  ) => void;
9672
9984
 
9673
9985
  /**
@@ -9677,13 +9989,23 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9677
9989
  *
9678
9990
  * @since 1.28.0
9679
9991
  */
9680
- innerNavigate?: (oEvent: SmartLink$InnerNavigateEvent) => void;
9992
+ navigate?: (oEvent: SemanticObjectController$NavigateEvent) => void;
9993
+
9994
+ /**
9995
+ * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all
9996
+ * navigation targets have been retrieved.
9997
+ *
9998
+ * @since 1.28.0
9999
+ * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
10000
+ * `prefetchNavigationTargets` which has been deprecated.
10001
+ */
10002
+ prefetchDone?: (oEvent: SemanticObjectController$PrefetchDoneEvent) => void;
9681
10003
  }
9682
10004
 
9683
10005
  /**
9684
- * Parameters of the SmartLink#beforePopoverOpens event.
10006
+ * Parameters of the SemanticObjectController#beforePopoverOpens event.
9685
10007
  */
9686
- export interface SmartLink$BeforePopoverOpensEventParameters {
10008
+ export interface SemanticObjectController$BeforePopoverOpensEventParameters {
9687
10009
  /**
9688
10010
  * The semantic object for which the navigation targets will be retrieved.
9689
10011
  */
@@ -9718,30 +10040,33 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9718
10040
  setAppStateKey?: Function;
9719
10041
 
9720
10042
  /**
9721
- * The ID of the SmartLink control.
10043
+ * The ID of the control that fires this event. If `beforePopoverOpens` is registered on the SmartLink,
10044
+ * `originalId` is the same as the event's source ID which is also the SmartLink's ID. If the `beforePopoverOpens`
10045
+ * is registered on the SemanticObjectController, `originalId` helps to identify the original SmartLink
10046
+ * control which triggered the event.
9722
10047
  */
9723
10048
  originalId?: string;
9724
10049
 
9725
10050
  /**
9726
10051
  * This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation
9727
- * popover. Signatures: `open()` If the `beforePopoverOpens` has been registered, the `open` function has
9728
- * to be called manually in order to open the navigation popover.
10052
+ * popover. Signatures: `open()` If `beforePopoverOpens` has been registered, `open` function has to be
10053
+ * called manually in order to open the navigation popover.
9729
10054
  */
9730
10055
  open?: Function;
9731
10056
  }
9732
10057
 
9733
10058
  /**
9734
- * Event object of the SmartLink#beforePopoverOpens event.
10059
+ * Event object of the SemanticObjectController#beforePopoverOpens event.
9735
10060
  */
9736
- export type SmartLink$BeforePopoverOpensEvent = Event<
9737
- SmartLink$BeforePopoverOpensEventParameters,
9738
- SmartLink
10061
+ export type SemanticObjectController$BeforePopoverOpensEvent = Event<
10062
+ SemanticObjectController$BeforePopoverOpensEventParameters,
10063
+ SemanticObjectController
9739
10064
  >;
9740
10065
 
9741
10066
  /**
9742
- * Parameters of the SmartLink#innerNavigate event.
10067
+ * Parameters of the SemanticObjectController#navigate event.
9743
10068
  */
9744
- export interface SmartLink$InnerNavigateEventParameters {
10069
+ export interface SemanticObjectController$NavigateEventParameters {
9745
10070
  /**
9746
10071
  * The UI text shown in the clicked link.
9747
10072
  */
@@ -9763,23 +10088,28 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9763
10088
  semanticAttributes?: object;
9764
10089
 
9765
10090
  /**
9766
- * The ID of the SmartLink control.
10091
+ * The ID of the control that fires this event. If `navigate` is registered on the SmartLink, `originalId`
10092
+ * is the same as the event's source ID which is the SmartLink's ID. If `navigate` is registered on the
10093
+ * SemanticObjectController, `originalId` helps to identify the original SmartLink control which triggered
10094
+ * the event.
9767
10095
  */
9768
10096
  originalId?: string;
9769
10097
  }
9770
10098
 
9771
10099
  /**
9772
- * Event object of the SmartLink#innerNavigate event.
10100
+ * Event object of the SemanticObjectController#navigate event.
9773
10101
  */
9774
- export type SmartLink$InnerNavigateEvent = Event<
9775
- SmartLink$InnerNavigateEventParameters,
9776
- SmartLink
10102
+ export type SemanticObjectController$NavigateEvent = Event<
10103
+ SemanticObjectController$NavigateEventParameters,
10104
+ SemanticObjectController
9777
10105
  >;
9778
10106
 
9779
10107
  /**
9780
- * Parameters of the SmartLink#navigationTargetsObtained event.
10108
+ * Parameters of the SemanticObjectController#navigationTargetsObtained event.
10109
+ *
10110
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
9781
10111
  */
9782
- export interface SmartLink$NavigationTargetsObtainedEventParameters {
10112
+ export interface SemanticObjectController$NavigationTargetsObtainedEventParameters {
9783
10113
  /**
9784
10114
  * The main navigation object.
9785
10115
  */
@@ -9812,7 +10142,10 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9812
10142
  semanticAttributes?: object;
9813
10143
 
9814
10144
  /**
9815
- * The ID of the SmartLink control.
10145
+ * The ID of the control that fires this event. If `navigationTargetsObtained` is registered on the SmartLink,
10146
+ * `originalId` is the same as the event's source ID which is also the SmartLink's ID. If `navigationTargetsObtained`
10147
+ * is registered on the SemanticObjectController, `originalId` helps to identify the original SmartLink
10148
+ * control which triggered the event.
9816
10149
  */
9817
10150
  originalId?: string;
9818
10151
 
@@ -9823,9 +10156,9 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9823
10156
  * - `show(oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters:
9824
10157
  * {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. With
9825
10158
  * `null` the main navigation object will be removed. With `undefined` the old object will remain.
9826
- * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross
9827
- * application navigation links. With empty array all available links will be removed. With `undefined`
9828
- * the old links will remain.
10159
+ * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application
10160
+ * navigation links. With empty array all available links will be removed. With `undefined` the old links
10161
+ * will remain.
9829
10162
  * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
9830
10163
  * content section on the popover. With `null` the main extra content object will be removed. With `undefined`
9831
10164
  * the old object still remains.
@@ -9836,9 +10169,9 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9836
10169
  * - {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object.
9837
10170
  * With `null` the main navigation object will be removed. With `undefined` the old object will remain.
9838
10171
  *
9839
- * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross
9840
- * application navigation links. With empty array all available links will be removed. With `undefined`
9841
- * the old links will remain.
10172
+ * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application
10173
+ * navigation links. With empty array all available links will be removed. With `undefined` the old links
10174
+ * will remain.
9842
10175
  * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
9843
10176
  * content section on the popover. With `null` the main extra content object will be removed. With `undefined`
9844
10177
  * the old object still remains.
@@ -9847,11 +10180,39 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
9847
10180
  }
9848
10181
 
9849
10182
  /**
9850
- * Event object of the SmartLink#navigationTargetsObtained event.
10183
+ * Event object of the SemanticObjectController#navigationTargetsObtained event.
10184
+ *
10185
+ * @deprecated (since 1.126) - replaced by `navigationTargetsObtainedCallback` property.
9851
10186
  */
9852
- export type SmartLink$NavigationTargetsObtainedEvent = Event<
9853
- SmartLink$NavigationTargetsObtainedEventParameters,
9854
- SmartLink
10187
+ export type SemanticObjectController$NavigationTargetsObtainedEvent = Event<
10188
+ SemanticObjectController$NavigationTargetsObtainedEventParameters,
10189
+ SemanticObjectController
10190
+ >;
10191
+
10192
+ /**
10193
+ * Parameters of the SemanticObjectController#prefetchDone event.
10194
+ *
10195
+ * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
10196
+ * `prefetchNavigationTargets` which has been deprecated.
10197
+ */
10198
+ export interface SemanticObjectController$PrefetchDoneEventParameters {
10199
+ /**
10200
+ * A map containing all semantic objects as keys for which at least one navigation target has been found.
10201
+ * The value for each semantic object key is an array containing the available actions found for this semantic
10202
+ * object.
10203
+ */
10204
+ semanticObjects?: object;
10205
+ }
10206
+
10207
+ /**
10208
+ * Event object of the SemanticObjectController#prefetchDone event.
10209
+ *
10210
+ * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
10211
+ * `prefetchNavigationTargets` which has been deprecated.
10212
+ */
10213
+ export type SemanticObjectController$PrefetchDoneEvent = Event<
10214
+ SemanticObjectController$PrefetchDoneEventParameters,
10215
+ SemanticObjectController
9855
10216
  >;
9856
10217
  }
9857
10218
 
@@ -9955,7 +10316,6 @@ declare module "sap/ui/comp/odata/ComboBox" {
9955
10316
  * This event is fired when the selected key has changed only when: The key is valid. The control is visible
9956
10317
  * There is a change when the control gets visible.
9957
10318
  *
9958
- * @ui5-protected Do not call from applications (only from related classes in the framework)
9959
10319
  *
9960
10320
  * @returns Reference to `this` in order to allow method chaining
9961
10321
  */
@@ -9984,7 +10344,6 @@ declare module "sap/ui/comp/odata/ComboBox" {
9984
10344
  * This event is fired when the selected key has changed only when: The key is valid. The control is visible
9985
10345
  * There is a change when the control gets visible.
9986
10346
  *
9987
- * @ui5-protected Do not call from applications (only from related classes in the framework)
9988
10347
  *
9989
10348
  * @returns Reference to `this` in order to allow method chaining
9990
10349
  */
@@ -10004,7 +10363,6 @@ declare module "sap/ui/comp/odata/ComboBox" {
10004
10363
  *
10005
10364
  * The passed function and listener object must match the ones used for event registration.
10006
10365
  *
10007
- * @ui5-protected Do not call from applications (only from related classes in the framework)
10008
10366
  *
10009
10367
  * @returns Reference to `this` in order to allow method chaining
10010
10368
  */
@@ -10039,7 +10397,6 @@ declare module "sap/ui/comp/odata/ComboBox" {
10039
10397
  *
10040
10398
  * Default value is `empty string`.
10041
10399
  *
10042
- * @ui5-protected Do not call from applications (only from related classes in the framework)
10043
10400
  *
10044
10401
  * @returns Value of property `textArrangement`
10045
10402
  */
@@ -10054,7 +10411,6 @@ declare module "sap/ui/comp/odata/ComboBox" {
10054
10411
  *
10055
10412
  * Default value is `empty string`.
10056
10413
  *
10057
- * @ui5-protected Do not call from applications (only from related classes in the framework)
10058
10414
  *
10059
10415
  * @returns Reference to `this` in order to allow method chaining
10060
10416
  */
@@ -15132,18 +15488,6 @@ declare module "sap/ui/comp/smartfield/SmartField" {
15132
15488
  * @returns Value of property `uomEditable`
15133
15489
  */
15134
15490
  getUomEditable(): boolean;
15135
- /**
15136
- * Gets current value of property {@link #getUomEditState uomEditState}.
15137
- *
15138
- * This property is for internal use only.
15139
- *
15140
- * Default value is `-1`.
15141
- *
15142
- * @since 1.32.0
15143
- *
15144
- * @returns Value of property `uomEditState`
15145
- */
15146
- getUomEditState(): int;
15147
15491
  /**
15148
15492
  * Gets current value of property {@link #getUomEnabled uomEnabled}.
15149
15493
  *
@@ -16509,13 +16853,6 @@ declare module "sap/ui/comp/smartfield/SmartField" {
16509
16853
  */
16510
16854
  url?: string | PropertyBindingInfo;
16511
16855
 
16512
- /**
16513
- * This property is for internal use only.
16514
- *
16515
- * @since 1.32.0
16516
- */
16517
- uomEditState?: int | PropertyBindingInfo | `{${string}}`;
16518
-
16519
16856
  /**
16520
16857
  * Defines the context in which the layout of the `SmartField` control has to be interpreted.
16521
16858
  *
@@ -17126,7 +17463,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17126
17463
  /**
17127
17464
  * Gets current value of property {@link #getEnteredValue enteredValue}.
17128
17465
  *
17129
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17130
17466
  *
17131
17467
  * @returns Value of property `enteredValue`
17132
17468
  */
@@ -17136,7 +17472,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17136
17472
  *
17137
17473
  * Property works the same as sap.m.Input control `value`
17138
17474
  *
17139
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17140
17475
  *
17141
17476
  * @returns Value of property `realValue`
17142
17477
  */
@@ -17148,7 +17483,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17148
17483
  *
17149
17484
  * **Note:** If duplicate keys exist, the first item matching the key is used.
17150
17485
  *
17151
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17152
17486
  *
17153
17487
  * @returns Value of property `selectedKey`
17154
17488
  */
@@ -17161,7 +17495,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17161
17495
  *
17162
17496
  * Default value is `empty string`.
17163
17497
  *
17164
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17165
17498
  *
17166
17499
  * @returns Value of property `valueTextArrangement`
17167
17500
  */
@@ -17171,7 +17504,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17171
17504
  *
17172
17505
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
17173
17506
  *
17174
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17175
17507
  *
17176
17508
  * @returns Reference to `this` in order to allow method chaining
17177
17509
  */
@@ -17188,7 +17520,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17188
17520
  *
17189
17521
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
17190
17522
  *
17191
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17192
17523
  *
17193
17524
  * @returns Reference to `this` in order to allow method chaining
17194
17525
  */
@@ -17207,7 +17538,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17207
17538
  *
17208
17539
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
17209
17540
  *
17210
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17211
17541
  *
17212
17542
  * @returns Reference to `this` in order to allow method chaining
17213
17543
  */
@@ -17227,7 +17557,6 @@ declare module "sap/ui/comp/smartfield/ComboBox" {
17227
17557
  *
17228
17558
  * Default value is `empty string`.
17229
17559
  *
17230
- * @ui5-protected Do not call from applications (only from related classes in the framework)
17231
17560
  *
17232
17561
  * @returns Reference to `this` in order to allow method chaining
17233
17562
  */
@@ -17803,7 +18132,10 @@ declare module "sap/ui/comp/smartfield/ObjectStatus" {
17803
18132
  }
17804
18133
 
17805
18134
  declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
17806
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
18135
+ import {
18136
+ default as ControlConfigurationBase,
18137
+ $ControlConfigurationBaseSettings,
18138
+ } from "sap/ui/comp/config/ControlConfigurationBase";
17807
18139
 
17808
18140
  import SelectOption from "sap/ui/comp/smartfilterbar/SelectOption";
17809
18141
 
@@ -17825,7 +18157,7 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
17825
18157
  * control, in order to overwrite the default settings from the OData metadata. For instance, it is possible
17826
18158
  * to change the label, index or control type of a filter field.
17827
18159
  */
17828
- export default class ControlConfiguration extends UI5Element {
18160
+ export default class ControlConfiguration extends ControlConfigurationBase {
17829
18161
  /**
17830
18162
  * Constructor for a new smartfilterbar/ControlConfiguration.
17831
18163
  *
@@ -17861,7 +18193,7 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
17861
18193
  * Creates a new subclass of class sap.ui.comp.smartfilterbar.ControlConfiguration with name `sClassName`
17862
18194
  * and enriches it with the information contained in `oClassInfo`.
17863
18195
  *
17864
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
18196
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.comp.config.ControlConfigurationBase.extend}.
17865
18197
  *
17866
18198
  *
17867
18199
  * @returns Created class / constructor function
@@ -18007,15 +18339,6 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
18007
18339
  getConditionPanelDefaultOperation():
18008
18340
  | valuehelpdialog.ValueHelpRangeOperation
18009
18341
  | keyof typeof valuehelpdialog.ValueHelpRangeOperation;
18010
- /**
18011
- * Gets current value of property {@link #getConditionType conditionType}.
18012
- *
18013
- * The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type
18014
- *
18015
- *
18016
- * @returns Value of property `conditionType`
18017
- */
18018
- getConditionType(): any;
18019
18342
  /**
18020
18343
  * Gets current value of property {@link #getControlType controlType}.
18021
18344
  *
@@ -18158,15 +18481,6 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
18158
18481
  * @returns Value of property `index`
18159
18482
  */
18160
18483
  getIndex(): int;
18161
- /**
18162
- * Gets current value of property {@link #getKey key}.
18163
- *
18164
- * The key property corresponds to the field name from the OData service $metadata document.
18165
- *
18166
- *
18167
- * @returns Value of property `key`
18168
- */
18169
- getKey(): string;
18170
18484
  /**
18171
18485
  * Gets current value of property {@link #getLabel label}.
18172
18486
  *
@@ -18321,22 +18635,6 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
18321
18635
  | valuehelpdialog.ValueHelpRangeOperation
18322
18636
  | keyof typeof valuehelpdialog.ValueHelpRangeOperation
18323
18637
  ): this;
18324
- /**
18325
- * Sets a new value for property {@link #getConditionType conditionType}.
18326
- *
18327
- * The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type
18328
- *
18329
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
18330
- *
18331
- *
18332
- * @returns Reference to `this` in order to allow method chaining
18333
- */
18334
- setConditionType(
18335
- /**
18336
- * New value for property `conditionType`
18337
- */
18338
- oConditionType?: any
18339
- ): this;
18340
18638
  /**
18341
18639
  * Sets a new value for property {@link #getControlType controlType}.
18342
18640
  *
@@ -18528,22 +18826,6 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
18528
18826
  */
18529
18827
  iIndex?: int
18530
18828
  ): this;
18531
- /**
18532
- * Sets a new value for property {@link #getKey key}.
18533
- *
18534
- * The key property corresponds to the field name from the OData service $metadata document.
18535
- *
18536
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
18537
- *
18538
- *
18539
- * @returns Reference to `this` in order to allow method chaining
18540
- */
18541
- setKey(
18542
- /**
18543
- * New value for property `key`
18544
- */
18545
- sKey?: string
18546
- ): this;
18547
18829
  /**
18548
18830
  * Sets a new value for property {@link #getLabel label}.
18549
18831
  *
@@ -18679,12 +18961,8 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
18679
18961
  /**
18680
18962
  * Describes the settings that can be provided to the ControlConfiguration constructor.
18681
18963
  */
18682
- export interface $ControlConfigurationSettings extends $ElementSettings {
18683
- /**
18684
- * The key property corresponds to the field name from the OData service $metadata document.
18685
- */
18686
- key?: string | PropertyBindingInfo;
18687
-
18964
+ export interface $ControlConfigurationSettings
18965
+ extends $ControlConfigurationBaseSettings {
18688
18966
  /**
18689
18967
  * The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName
18690
18968
  * from the OData metadata. It is also possible to move a field from the advanced area to the basic area
@@ -18790,11 +19068,6 @@ declare module "sap/ui/comp/smartfilterbar/ControlConfiguration" {
18790
19068
  | PropertyBindingInfo
18791
19069
  | `{${string}}`;
18792
19070
 
18793
- /**
18794
- * The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type
18795
- */
18796
- conditionType?: any | PropertyBindingInfo | `{${string}}`;
18797
-
18798
19071
  /**
18799
19072
  * If set to `false` history values are disabled.
18800
19073
  *
@@ -19462,7 +19735,6 @@ declare module "sap/ui/comp/smartfilterbar/SFBMultiComboBox" {
19462
19735
  *
19463
19736
  * Default value is `empty string`.
19464
19737
  *
19465
- * @ui5-protected Do not call from applications (only from related classes in the framework)
19466
19738
  *
19467
19739
  * @returns Value of property `textArrangement`
19468
19740
  */
@@ -19477,7 +19749,6 @@ declare module "sap/ui/comp/smartfilterbar/SFBMultiComboBox" {
19477
19749
  *
19478
19750
  * Default value is `empty string`.
19479
19751
  *
19480
- * @ui5-protected Do not call from applications (only from related classes in the framework)
19481
19752
  *
19482
19753
  * @returns Reference to `this` in order to allow method chaining
19483
19754
  */
@@ -28646,13 +28917,16 @@ declare module "sap/ui/comp/smartmultiinput/SmartMultiInput" {
28646
28917
  $SmartFieldSettings,
28647
28918
  } from "sap/ui/comp/smartfield/SmartField";
28648
28919
 
28920
+ import Token from "sap/m/Token";
28921
+
28649
28922
  import Filter from "sap/ui/model/Filter";
28650
28923
 
28651
28924
  import ElementMetadata from "sap/ui/core/ElementMetadata";
28652
28925
 
28653
- import Token from "sap/m/Token";
28654
-
28655
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
28926
+ import {
28927
+ PropertyBindingInfo,
28928
+ AggregationBindingInfo,
28929
+ } from "sap/ui/base/ManagedObject";
28656
28930
 
28657
28931
  import Event from "sap/ui/base/Event";
28658
28932
 
@@ -28752,6 +29026,20 @@ declare module "sap/ui/comp/smartmultiinput/SmartMultiInput" {
28752
29026
  * @returns Metadata object describing this class
28753
29027
  */
28754
29028
  static getMetadata(): ElementMetadata;
29029
+ /**
29030
+ * Adds some initialToken to the aggregation {@link #getInitialTokens initialTokens}.
29031
+ *
29032
+ * @since 1.101
29033
+ * @experimental (since 1.101)
29034
+ *
29035
+ * @returns Reference to `this` in order to allow method chaining
29036
+ */
29037
+ addInitialToken(
29038
+ /**
29039
+ * The initialToken to add; if empty, nothing is inserted
29040
+ */
29041
+ oInitialToken: Token
29042
+ ): this;
28755
29043
  /**
28756
29044
  * Attaches event handler `fnFunction` to the {@link #event:beforeCreate beforeCreate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`.
28757
29045
  *
@@ -29019,6 +29307,15 @@ declare module "sap/ui/comp/smartmultiinput/SmartMultiInput" {
29019
29307
  * @returns `true`, if a client error has been detected, `false` otherwise
29020
29308
  */
29021
29309
  checkClientError(): boolean;
29310
+ /**
29311
+ * Destroys all the initialTokens in the aggregation {@link #getInitialTokens initialTokens}.
29312
+ *
29313
+ * @since 1.101
29314
+ * @experimental (since 1.101)
29315
+ *
29316
+ * @returns Reference to `this` in order to allow method chaining
29317
+ */
29318
+ destroyInitialTokens(): this;
29022
29319
  /**
29023
29320
  * Detaches event handler `fnFunction` from the {@link #event:beforeCreate beforeCreate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`.
29024
29321
  *
@@ -29200,6 +29497,15 @@ declare module "sap/ui/comp/smartmultiinput/SmartMultiInput" {
29200
29497
  * @returns filter object based on current SmartMultiInput values
29201
29498
  */
29202
29499
  getFilter(): Filter;
29500
+ /**
29501
+ * Gets content of aggregation {@link #getInitialTokens initialTokens}.
29502
+ *
29503
+ * Aggregation for storing the tokens. Works only in No Data Binding Scenario.
29504
+ *
29505
+ * @since 1.101
29506
+ * @experimental (since 1.101)
29507
+ */
29508
+ getInitialTokens(): Token[];
29203
29509
  /**
29204
29510
  * Returns an array of token values in range format.
29205
29511
  *
@@ -29268,6 +29574,66 @@ declare module "sap/ui/comp/smartmultiinput/SmartMultiInput" {
29268
29574
  * @returns Selected tokens
29269
29575
  */
29270
29576
  getValue(): Token[];
29577
+ /**
29578
+ * Checks for the provided `sap.m.Token` in the aggregation {@link #getInitialTokens initialTokens}. and
29579
+ * returns its index if found or -1 otherwise.
29580
+ *
29581
+ * @since 1.101
29582
+ * @experimental (since 1.101)
29583
+ *
29584
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
29585
+ */
29586
+ indexOfInitialToken(
29587
+ /**
29588
+ * The initialToken whose index is looked for
29589
+ */
29590
+ oInitialToken: Token
29591
+ ): int;
29592
+ /**
29593
+ * Inserts a initialToken into the aggregation {@link #getInitialTokens initialTokens}.
29594
+ *
29595
+ * @since 1.101
29596
+ * @experimental (since 1.101)
29597
+ *
29598
+ * @returns Reference to `this` in order to allow method chaining
29599
+ */
29600
+ insertInitialToken(
29601
+ /**
29602
+ * The initialToken to insert; if empty, nothing is inserted
29603
+ */
29604
+ oInitialToken: Token,
29605
+ /**
29606
+ * The `0`-based index the initialToken should be inserted at; for a negative value of `iIndex`, the initialToken
29607
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the initialToken
29608
+ * is inserted at the last position
29609
+ */
29610
+ iIndex: int
29611
+ ): this;
29612
+ /**
29613
+ * Removes all the controls from the aggregation {@link #getInitialTokens initialTokens}.
29614
+ *
29615
+ * Additionally, it unregisters them from the hosting UIArea.
29616
+ *
29617
+ * @since 1.101
29618
+ * @experimental (since 1.101)
29619
+ *
29620
+ * @returns An array of the removed elements (might be empty)
29621
+ */
29622
+ removeAllInitialTokens(): Token[];
29623
+ /**
29624
+ * Removes a initialToken from the aggregation {@link #getInitialTokens initialTokens}.
29625
+ *
29626
+ * @since 1.101
29627
+ * @experimental (since 1.101)
29628
+ *
29629
+ * @returns The removed initialToken or `null`
29630
+ */
29631
+ removeInitialToken(
29632
+ /**
29633
+ * The initialToken to remove or its index or id
29634
+ */
29635
+ vInitialToken: int | string | Token
29636
+ ): Token | null;
29271
29637
  /**
29272
29638
  * Sets a new value for property {@link #getEnableODataSelect enableODataSelect}.
29273
29639
  *
@@ -29429,6 +29795,14 @@ declare module "sap/ui/comp/smartmultiinput/SmartMultiInput" {
29429
29795
  */
29430
29796
  singleTokenMode?: boolean | PropertyBindingInfo | `{${string}}`;
29431
29797
 
29798
+ /**
29799
+ * Aggregation for storing the tokens. Works only in No Data Binding Scenario.
29800
+ *
29801
+ * @since 1.101
29802
+ * @experimental (since 1.101)
29803
+ */
29804
+ initialTokens?: Token[] | Token | AggregationBindingInfo | `{${string}}`;
29805
+
29432
29806
  /**
29433
29807
  * This event is fired before the OData model's `create` method is called. Provides object with parameters
29434
29808
  * of the call for editing.
@@ -29581,6 +29955,8 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
29581
29955
 
29582
29956
  import { default as VBox, $VBoxSettings } from "sap/m/VBox";
29583
29957
 
29958
+ import FilterControlConfiguration from "sap/ui/comp/config/FilterControlConfiguration";
29959
+
29584
29960
  import Event from "sap/ui/base/Event";
29585
29961
 
29586
29962
  import CopyProvider from "sap/m/plugins/CopyProvider";
@@ -29601,7 +29977,10 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
29601
29977
 
29602
29978
  import UIState from "sap/ui/comp/state/UIState";
29603
29979
 
29604
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
29980
+ import {
29981
+ PropertyBindingInfo,
29982
+ AggregationBindingInfo,
29983
+ } from "sap/ui/base/ManagedObject";
29605
29984
 
29606
29985
  /**
29607
29986
  * Paste-related column information
@@ -29725,6 +30104,19 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
29725
30104
  * @returns Metadata object describing this class
29726
30105
  */
29727
30106
  static getMetadata(): ElementMetadata;
30107
+ /**
30108
+ * Adds some filterControlConfiguration to the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
30109
+ *
30110
+ * @since 1.126
30111
+ *
30112
+ * @returns Reference to `this` in order to allow method chaining
30113
+ */
30114
+ addFilterControlConfiguration(
30115
+ /**
30116
+ * The filterControlConfiguration to add; if empty, nothing is inserted
30117
+ */
30118
+ oFilterControlConfiguration: FilterControlConfiguration
30119
+ ): this;
29728
30120
  /**
29729
30121
  * Interface function for SmartVariantManagement control, sets the current variant. **Note:** If an application
29730
30122
  * default variant exists, then all other variants are extended from this application default variant.
@@ -30546,6 +30938,14 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
30546
30938
  * @returns Reference to `this` in order to allow method chaining
30547
30939
  */
30548
30940
  destroyDataStateIndicator(): this;
30941
+ /**
30942
+ * Destroys all the filterControlConfiguration in the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
30943
+ *
30944
+ * @since 1.126
30945
+ *
30946
+ * @returns Reference to `this` in order to allow method chaining
30947
+ */
30948
+ destroyFilterControlConfiguration(): this;
30549
30949
  /**
30550
30950
  * Destroys the noData in the aggregation {@link #getNoData noData}.
30551
30951
  *
@@ -31454,6 +31854,14 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
31454
31854
  * @returns Value of property `exportType`
31455
31855
  */
31456
31856
  getExportType(): smarttable.ExportType | keyof typeof smarttable.ExportType;
31857
+ /**
31858
+ * Gets content of aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
31859
+ *
31860
+ * Allows the user to configure filters for the table personalization
31861
+ *
31862
+ * @since 1.126
31863
+ */
31864
+ getFilterControlConfiguration(): FilterControlConfiguration[];
31457
31865
  /**
31458
31866
  * Gets current value of property {@link #getHeader header}.
31459
31867
  *
@@ -31476,17 +31884,6 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
31476
31884
  * @returns Value of property `headerLevel`
31477
31885
  */
31478
31886
  getHeaderLevel(): TitleLevel | keyof typeof TitleLevel;
31479
- /**
31480
- * Gets current value of property {@link #getHeaderStyle headerStyle}.
31481
- *
31482
- * Defines style of the header. For more information, see {@link sap.m.Title#setTitle}.
31483
- *
31484
- * @since 1.116
31485
- * @experimental - Internal use only
31486
- *
31487
- * @returns Value of property `headerStyle`
31488
- */
31489
- getHeaderStyle(): TitleLevel | keyof typeof TitleLevel;
31490
31887
  /**
31491
31888
  * Gets current value of property {@link #getIgnoredFields ignoredFields}.
31492
31889
  *
@@ -31841,6 +32238,23 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
31841
32238
  * @returns Value of property `useColumnLabelsAsTooltips`
31842
32239
  */
31843
32240
  getUseColumnLabelsAsTooltips(): boolean;
32241
+ /**
32242
+ * Gets current value of property {@link #getUseDateRangeType useDateRangeType}.
32243
+ *
32244
+ * If set to `true`, all date fields in the Filter Panel of the settings dialog with filter restriction
32245
+ * `interval` will be treated as `DateTimeRange` filters. The `useDateRangeType` can be set only once during
32246
+ * initialization. **Note:** If this property is set to `true` and any date filters with filter restriction
32247
+ * `interval` were stored as part of a variant, the values of these filters cannot be applied. If this property
32248
+ * is set to `false`, any previously stored filters which were treated as type `DateTimeRange` based on
32249
+ * the former setting, cannot be converted back to the standard date interval.
32250
+ *
32251
+ * Default value is `false`.
32252
+ *
32253
+ * @since 1.126.0
32254
+ *
32255
+ * @returns Value of property `useDateRangeType`
32256
+ */
32257
+ getUseDateRangeType(): boolean;
31844
32258
  /**
31845
32259
  * Gets current value of property {@link #getUseExportToExcel useExportToExcel}.
31846
32260
  *
@@ -31931,6 +32345,39 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
31931
32345
  * @returns Value of property `useVariantManagement`
31932
32346
  */
31933
32347
  getUseVariantManagement(): boolean;
32348
+ /**
32349
+ * Checks for the provided `sap.ui.comp.config.FilterControlConfiguration` in the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
32350
+ * and returns its index if found or -1 otherwise.
32351
+ *
32352
+ * @since 1.126
32353
+ *
32354
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
32355
+ */
32356
+ indexOfFilterControlConfiguration(
32357
+ /**
32358
+ * The filterControlConfiguration whose index is looked for
32359
+ */
32360
+ oFilterControlConfiguration: FilterControlConfiguration
32361
+ ): int;
32362
+ /**
32363
+ * Inserts a filterControlConfiguration into the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
32364
+ *
32365
+ * @since 1.126
32366
+ *
32367
+ * @returns Reference to `this` in order to allow method chaining
32368
+ */
32369
+ insertFilterControlConfiguration(
32370
+ /**
32371
+ * The filterControlConfiguration to insert; if empty, nothing is inserted
32372
+ */
32373
+ oFilterControlConfiguration: FilterControlConfiguration,
32374
+ /**
32375
+ * The `0`-based index the filterControlConfiguration should be inserted at; for a negative value of `iIndex`,
32376
+ * the filterControlConfiguration is inserted at position 0; for a value greater than the current size of
32377
+ * the aggregation, the filterControlConfiguration is inserted at the last position
32378
+ */
32379
+ iIndex: int
32380
+ ): this;
31934
32381
  /**
31935
32382
  * Checks whether the control is initialised
31936
32383
  *
@@ -31960,6 +32407,29 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
31960
32407
  */
31961
32408
  bForceRebind: boolean
31962
32409
  ): void;
32410
+ /**
32411
+ * Removes all the controls from the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
32412
+ *
32413
+ * Additionally, it unregisters them from the hosting UIArea.
32414
+ *
32415
+ * @since 1.126
32416
+ *
32417
+ * @returns An array of the removed elements (might be empty)
32418
+ */
32419
+ removeAllFilterControlConfiguration(): FilterControlConfiguration[];
32420
+ /**
32421
+ * Removes a filterControlConfiguration from the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
32422
+ *
32423
+ * @since 1.126
32424
+ *
32425
+ * @returns The removed filterControlConfiguration or `null`
32426
+ */
32427
+ removeFilterControlConfiguration(
32428
+ /**
32429
+ * The filterControlConfiguration to remove or its index or id
32430
+ */
32431
+ vFilterControlConfiguration: int | string | FilterControlConfiguration
32432
+ ): FilterControlConfiguration | null;
31963
32433
  /**
31964
32434
  * Sets the aggregated {@link #getCopyProvider copyProvider}.
31965
32435
  *
@@ -32888,6 +33358,30 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
32888
33358
  */
32889
33359
  bUseColumnLabelsAsTooltips?: boolean
32890
33360
  ): this;
33361
+ /**
33362
+ * Sets a new value for property {@link #getUseDateRangeType useDateRangeType}.
33363
+ *
33364
+ * If set to `true`, all date fields in the Filter Panel of the settings dialog with filter restriction
33365
+ * `interval` will be treated as `DateTimeRange` filters. The `useDateRangeType` can be set only once during
33366
+ * initialization. **Note:** If this property is set to `true` and any date filters with filter restriction
33367
+ * `interval` were stored as part of a variant, the values of these filters cannot be applied. If this property
33368
+ * is set to `false`, any previously stored filters which were treated as type `DateTimeRange` based on
33369
+ * the former setting, cannot be converted back to the standard date interval.
33370
+ *
33371
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
33372
+ *
33373
+ * Default value is `false`.
33374
+ *
33375
+ * @since 1.126.0
33376
+ *
33377
+ * @returns Reference to `this` in order to allow method chaining
33378
+ */
33379
+ setUseDateRangeType(
33380
+ /**
33381
+ * New value for property `useDateRangeType`
33382
+ */
33383
+ bUseDateRangeType?: boolean
33384
+ ): this;
32891
33385
  /**
32892
33386
  * Sets the `useExportToExcel` property which enables export of data. The export type can be defined using
32893
33387
  * `exportType` property.
@@ -33304,17 +33798,6 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
33304
33798
  | PropertyBindingInfo
33305
33799
  | `{${string}}`;
33306
33800
 
33307
- /**
33308
- * Defines style of the header. For more information, see {@link sap.m.Title#setTitle}.
33309
- *
33310
- * @since 1.116
33311
- * @experimental - Internal use only
33312
- */
33313
- headerStyle?:
33314
- | (TitleLevel | keyof typeof TitleLevel)
33315
- | PropertyBindingInfo
33316
- | `{${string}}`;
33317
-
33318
33801
  /**
33319
33802
  * A style class which is defined for the toolbar of the table.
33320
33803
  *
@@ -33570,6 +34053,18 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
33570
34053
  */
33571
34054
  enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
33572
34055
 
34056
+ /**
34057
+ * If set to `true`, all date fields in the Filter Panel of the settings dialog with filter restriction
34058
+ * `interval` will be treated as `DateTimeRange` filters. The `useDateRangeType` can be set only once during
34059
+ * initialization. **Note:** If this property is set to `true` and any date filters with filter restriction
34060
+ * `interval` were stored as part of a variant, the values of these filters cannot be applied. If this property
34061
+ * is set to `false`, any previously stored filters which were treated as type `DateTimeRange` based on
34062
+ * the former setting, cannot be converted back to the standard date interval.
34063
+ *
34064
+ * @since 1.126.0
34065
+ */
34066
+ useDateRangeType?: boolean | PropertyBindingInfo | `{${string}}`;
34067
+
33573
34068
  /**
33574
34069
  * A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified,
33575
34070
  * the SmartTable control does not create an additional toolbar, but makes use of this one.
@@ -33640,6 +34135,17 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
33640
34135
  */
33641
34136
  copyProvider?: CopyProvider;
33642
34137
 
34138
+ /**
34139
+ * Allows the user to configure filters for the table personalization
34140
+ *
34141
+ * @since 1.126
34142
+ */
34143
+ filterControlConfiguration?:
34144
+ | FilterControlConfiguration[]
34145
+ | FilterControlConfiguration
34146
+ | AggregationBindingInfo
34147
+ | `{${string}}`;
34148
+
33643
34149
  /**
33644
34150
  * Identifies the SmartVariant control which should be used for the personalization. Will be ignored if
33645
34151
  * the advanced mode is set.
@@ -38276,17 +38782,6 @@ declare module "sap/ui/comp/valuehelpdialog/ValueHelpDialog" {
38276
38782
  * @returns Value of property `basicSearchText`
38277
38783
  */
38278
38784
  getBasicSearchText(): string;
38279
- /**
38280
- * Gets current value of property {@link #getConditionPanelDefaultOperation conditionPanelDefaultOperation}.
38281
- *
38282
- * Sets default operation for Condition Panel of the value help dialog. In case the newly set default operation
38283
- * is not valid for the filter's EDM data type, then it is ignored. expected sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation
38284
- *
38285
- * @since 1.99
38286
- *
38287
- * @returns Value of property `conditionPanelDefaultOperation`
38288
- */
38289
- getConditionPanelDefaultOperation(): string;
38290
38785
  /**
38291
38786
  * Gets current value of property {@link #getDescriptionKey descriptionKey}.
38292
38787
  *
@@ -38495,24 +38990,6 @@ declare module "sap/ui/comp/valuehelpdialog/ValueHelpDialog" {
38495
38990
  */
38496
38991
  sBasicSearchText?: string
38497
38992
  ): this;
38498
- /**
38499
- * Sets a new value for property {@link #getConditionPanelDefaultOperation conditionPanelDefaultOperation}.
38500
- *
38501
- * Sets default operation for Condition Panel of the value help dialog. In case the newly set default operation
38502
- * is not valid for the filter's EDM data type, then it is ignored. expected sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation
38503
- *
38504
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
38505
- *
38506
- * @since 1.99
38507
- *
38508
- * @returns Reference to `this` in order to allow method chaining
38509
- */
38510
- setConditionPanelDefaultOperation(
38511
- /**
38512
- * New value for property `conditionPanelDefaultOperation`
38513
- */
38514
- sConditionPanelDefaultOperation?: string
38515
- ): this;
38516
38993
  /**
38517
38994
  * Sets a new value for property {@link #getDescriptionKey descriptionKey}.
38518
38995
  *
@@ -38964,14 +39441,6 @@ declare module "sap/ui/comp/valuehelpdialog/ValueHelpDialog" {
38964
39441
  */
38965
39442
  filterMode?: boolean | PropertyBindingInfo | `{${string}}`;
38966
39443
 
38967
- /**
38968
- * Sets default operation for Condition Panel of the value help dialog. In case the newly set default operation
38969
- * is not valid for the filter's EDM data type, then it is ignored. expected sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation
38970
- *
38971
- * @since 1.99
38972
- */
38973
- conditionPanelDefaultOperation?: string | PropertyBindingInfo;
38974
-
38975
39444
  /**
38976
39445
  * Sets usage of `MultiSelectionPlugin`. If enabled the default behaviour is changed and the `ValueHelpDialog`
38977
39446
  * table uses the plugin which provides only "Deselect all" option and the ability for range selection.
@@ -41381,6 +41850,10 @@ declare module "sap/ui/comp/variants/VariantManagement" {
41381
41850
 
41382
41851
  declare namespace sap {
41383
41852
  interface IUI5DefineDependencyNames {
41853
+ "sap/ui/comp/config/ControlConfigurationBase": undefined;
41854
+
41855
+ "sap/ui/comp/config/FilterControlConfiguration": undefined;
41856
+
41384
41857
  "sap/ui/comp/filterbar/FilterBar": undefined;
41385
41858
 
41386
41859
  "sap/ui/comp/filterbar/FilterGroupItem": undefined;