@openui5/ts-types 1.108.24 → 1.108.26

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types",
3
- "version": "1.108.24",
3
+ "version": "1.108.26",
4
4
  "description": "OpenUI5 TypeScript Definitions",
5
5
  "homepage": "https://openui5.org",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  /**
package/types/sap.m.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -647,6 +647,11 @@ declare namespace sap {
647
647
  */
648
648
  FNMetaImpl?: Function
649
649
  ): Function;
650
+ /**
651
+ *
652
+ * @returns The Engine instance
653
+ */
654
+ getInstance(): sap.m.p13n.Engine;
650
655
  /**
651
656
  * Returns a metadata object for class sap.m.p13n.Engine.
652
657
  *
@@ -1042,13 +1047,9 @@ declare namespace sap {
1042
1047
  */
1043
1048
  constructor(
1044
1049
  /**
1045
- * ID for the new control, generated automatically if no ID is given
1046
- */
1047
- sId?: string,
1048
- /**
1049
- * Initial settings for the new control
1050
+ * Initial settings for the new controller
1050
1051
  */
1051
- mSettings?: {
1052
+ mSettings: {
1052
1053
  /**
1053
1054
  * The control instance that is personalized by this controller
1054
1055
  */
@@ -1191,6 +1192,80 @@ declare namespace sap {
1191
1192
  sTitle?: string
1192
1193
  ): this;
1193
1194
  }
1195
+ /**
1196
+ * The `MetadataHelper` entity offers utility functionality for service metadata during the `Engine#register`
1197
+ * process.
1198
+ */
1199
+ class MetadataHelper extends sap.ui.base.Object {
1200
+ /**
1201
+ * See:
1202
+ * {@link topic:75c08fdebf784575947927e052712bab Personalization}
1203
+ */
1204
+ constructor(
1205
+ /**
1206
+ * Array of objects defining available items for personalization
1207
+ */
1208
+ aProperties: sap.m.p13n.MetadataObject[]
1209
+ );
1210
+
1211
+ /**
1212
+ * Creates a new subclass of class sap.m.p13n.MetadataHelper with name `sClassName` and enriches it with
1213
+ * the information contained in `oClassInfo`.
1214
+ *
1215
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1216
+ *
1217
+ * @returns Created class / constructor function
1218
+ */
1219
+ static extend<T extends Record<string, unknown>>(
1220
+ /**
1221
+ * Name of the class being created
1222
+ */
1223
+ sClassName: string,
1224
+ /**
1225
+ * Object literal with information about the class
1226
+ */
1227
+ oClassInfo?: sap.ClassInfo<T, sap.m.p13n.MetadataHelper>,
1228
+ /**
1229
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1230
+ * used by this class
1231
+ */
1232
+ FNMetaImpl?: Function
1233
+ ): Function;
1234
+ /**
1235
+ * Returns a metadata object for class sap.m.p13n.MetadataHelper.
1236
+ *
1237
+ * @returns Metadata object describing this class
1238
+ */
1239
+ static getMetadata(): sap.ui.base.Metadata;
1240
+ /**
1241
+ * Gets a property path based on its key.
1242
+ *
1243
+ * @returns The property path based on its key
1244
+ */
1245
+ getPath(
1246
+ /**
1247
+ * The property key identifying a property entry
1248
+ */
1249
+ sKey: string
1250
+ ): string;
1251
+ /**
1252
+ * Gets the array of properties.
1253
+ *
1254
+ * @returns Array of properties
1255
+ */
1256
+ getProperties(): sap.m.p13n.MetadataObject[];
1257
+ /**
1258
+ * Gets a single property.
1259
+ *
1260
+ * @returns A single property
1261
+ */
1262
+ getProperty(
1263
+ /**
1264
+ * The property key identifying a property entry
1265
+ */
1266
+ sKey: string
1267
+ ): sap.m.p13n.MetadataObject;
1268
+ }
1194
1269
  /**
1195
1270
  * @SINCE 1.97
1196
1271
  * @EXPERIMENTAL (since 1.97)
@@ -1587,17 +1662,20 @@ declare namespace sap {
1587
1662
  */
1588
1663
  constructor(
1589
1664
  /**
1590
- * ID for the new control, generated automatically if no ID is given
1591
- */
1592
- sId?: string,
1593
- /**
1594
- * Initial settings for the new control
1665
+ * Initial settings for the new controller
1595
1666
  */
1596
- mSettings?: {
1667
+ mSettings: {
1597
1668
  /**
1598
1669
  * The control instance that is personalized by this controller
1599
1670
  */
1600
1671
  control: sap.ui.core.Control;
1672
+ /**
1673
+ * By default the SelectionController tries to identify the existing item through the key by checking if
1674
+ * there is an existing item with this id. This behaviour can be overruled by implementing this method which
1675
+ * will provide the according item of the `targetAggregation` to return the according key associated to
1676
+ * this item.
1677
+ */
1678
+ getKeyForItem?: Function;
1601
1679
  /**
1602
1680
  * The name of the aggregation that is now managed by this controller
1603
1681
  */
@@ -1897,13 +1975,9 @@ declare namespace sap {
1897
1975
  */
1898
1976
  constructor(
1899
1977
  /**
1900
- * ID for the new control, generated automatically if no ID is given
1978
+ * Initial settings for the new controller
1901
1979
  */
1902
- sId?: string,
1903
- /**
1904
- * Initial settings for the new control
1905
- */
1906
- mSettings?: {
1980
+ mSettings: {
1907
1981
  /**
1908
1982
  * The control instance that is personalized by this controller
1909
1983
  */
@@ -2081,6 +2155,25 @@ declare namespace sap {
2081
2155
  grouped: boolean;
2082
2156
  };
2083
2157
 
2158
+ /**
2159
+ * Personalization `GroupState` object type. This object describes the state processed by this controller
2160
+ * when accessing it through the {@link sap.m.p13n.Engine Engine}.
2161
+ */
2162
+ type GroupState = {
2163
+ /**
2164
+ * The key for the group state
2165
+ */
2166
+ key: string;
2167
+ /**
2168
+ * Defines whether the item is grouped (if a group state is provided, it's grouped automatically)
2169
+ */
2170
+ grouped?: boolean;
2171
+ /**
2172
+ * Describes the index of the grouping
2173
+ */
2174
+ index?: int;
2175
+ };
2176
+
2084
2177
  /**
2085
2178
  * P13n `Item` object type.
2086
2179
  */
@@ -2099,6 +2192,57 @@ declare namespace sap {
2099
2192
  visible: boolean;
2100
2193
  };
2101
2194
 
2195
+ /**
2196
+ * @EXPERIMENTAL (since 1.104)
2197
+ *
2198
+ * Personalization `MetadataObject` type.
2199
+ */
2200
+ type MetadataObject = {
2201
+ /**
2202
+ * The unique key for the p13n metadata object
2203
+ */
2204
+ key: string;
2205
+ /**
2206
+ * Defines the text that will be displayed in the personalization popup
2207
+ */
2208
+ label: string;
2209
+ /**
2210
+ * Defines the technical path to apply binding-related updates
2211
+ */
2212
+ path: string;
2213
+ /**
2214
+ * Defines whether the metadata object is sortable
2215
+ */
2216
+ sortable?: boolean;
2217
+ /**
2218
+ * Defines whether the metadata object is groupable
2219
+ */
2220
+ groupable?: boolean;
2221
+ /**
2222
+ * Defines whether the metadata object is visible for selection
2223
+ */
2224
+ visible?: boolean;
2225
+ };
2226
+
2227
+ /**
2228
+ * Personalization `SelectionState` object type. This object describes the state processed by this controller
2229
+ * when accessing it through the {@link sap.m.p13n.Engine Engine}.
2230
+ */
2231
+ type SelectionState = {
2232
+ /**
2233
+ * The key for the group state
2234
+ */
2235
+ key: string;
2236
+ /**
2237
+ * Defines whether the item is selected (if a selection state is provided, it's selected automatically)
2238
+ */
2239
+ visible?: boolean;
2240
+ /**
2241
+ * Describes the index of the selection item
2242
+ */
2243
+ index?: int;
2244
+ };
2245
+
2102
2246
  /**
2103
2247
  * P13n `SortItem` object type.
2104
2248
  */
@@ -2120,6 +2264,29 @@ declare namespace sap {
2120
2264
  */
2121
2265
  descending: boolean;
2122
2266
  };
2267
+
2268
+ /**
2269
+ * Personalization `SortState` object type. This object describes the state processed by this controller
2270
+ * when accessing it through the {@link sap.m.p13n.Engine Engine}.
2271
+ */
2272
+ type SortState = {
2273
+ /**
2274
+ * The key for the sort state
2275
+ */
2276
+ key: string;
2277
+ /**
2278
+ * Defines whether the item is sorted (if a sort state is provided, it's sorted automatically)
2279
+ */
2280
+ sorted?: boolean;
2281
+ /**
2282
+ * Defines whether the sorting is processed in a descending order (`false` is the default)
2283
+ */
2284
+ descending?: boolean;
2285
+ /**
2286
+ * Describes the index of the sorter
2287
+ */
2288
+ index?: int;
2289
+ };
2123
2290
  }
2124
2291
 
2125
2292
  namespace PlanningCalendar {
@@ -24692,6 +24859,20 @@ declare namespace sap {
24692
24859
  | sap.ui.base.ManagedObject.PropertyBindingInfo
24693
24860
  | `{${string}}`;
24694
24861
 
24862
+ /**
24863
+ * Parameter to determine if the given PDF is from a trusted source. If the source is valid this property
24864
+ * can be set to true. If isTrustedSource is set to true, the PDFViewer opens with the displayType set to
24865
+ * "Embedded" on desktop devices, which means that the PDF content is directly shown within the PDFViewer.
24866
+ * Set this property to true only when the PDF is generated by the application or the PDF is scanned for
24867
+ * viruses. If isTrustedSource is set to false, the PDFViewer opens with the displayType set to "Link" on
24868
+ * desktop devices, which overrides any configuration that has been provided by the application for the
24869
+ * property displayType. This means that the PDFViewer appears as a toolbar with a download button.
24870
+ */
24871
+ isTrustedSource?:
24872
+ | boolean
24873
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
24874
+ | `{${string}}`;
24875
+
24695
24876
  /**
24696
24877
  * A custom control that can be used instead of the error message specified by the errorPlaceholderMessage
24697
24878
  * property.
@@ -91479,6 +91660,22 @@ declare namespace sap {
91479
91660
  * @returns Value of property `height`
91480
91661
  */
91481
91662
  getHeight(): sap.ui.core.CSSSize;
91663
+ /**
91664
+ * Gets current value of property {@link #getIsTrustedSource isTrustedSource}.
91665
+ *
91666
+ * Parameter to determine if the given PDF is from a trusted source. If the source is valid this property
91667
+ * can be set to true. If isTrustedSource is set to true, the PDFViewer opens with the displayType set to
91668
+ * "Embedded" on desktop devices, which means that the PDF content is directly shown within the PDFViewer.
91669
+ * Set this property to true only when the PDF is generated by the application or the PDF is scanned for
91670
+ * viruses. If isTrustedSource is set to false, the PDFViewer opens with the displayType set to "Link" on
91671
+ * desktop devices, which overrides any configuration that has been provided by the application for the
91672
+ * property displayType. This means that the PDFViewer appears as a toolbar with a download button.
91673
+ *
91674
+ * Default value is `true`.
91675
+ *
91676
+ * @returns Value of property `isTrustedSource`
91677
+ */
91678
+ getIsTrustedSource(): boolean;
91482
91679
  /**
91483
91680
  * Gets content of aggregation {@link #getPopupButtons popupButtons}.
91484
91681
  *
@@ -91686,6 +91883,29 @@ declare namespace sap {
91686
91883
  */
91687
91884
  sHeight?: sap.ui.core.CSSSize
91688
91885
  ): this;
91886
+ /**
91887
+ * Sets a new value for property {@link #getIsTrustedSource isTrustedSource}.
91888
+ *
91889
+ * Parameter to determine if the given PDF is from a trusted source. If the source is valid this property
91890
+ * can be set to true. If isTrustedSource is set to true, the PDFViewer opens with the displayType set to
91891
+ * "Embedded" on desktop devices, which means that the PDF content is directly shown within the PDFViewer.
91892
+ * Set this property to true only when the PDF is generated by the application or the PDF is scanned for
91893
+ * viruses. If isTrustedSource is set to false, the PDFViewer opens with the displayType set to "Link" on
91894
+ * desktop devices, which overrides any configuration that has been provided by the application for the
91895
+ * property displayType. This means that the PDFViewer appears as a toolbar with a download button.
91896
+ *
91897
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
91898
+ *
91899
+ * Default value is `true`.
91900
+ *
91901
+ * @returns Reference to `this` in order to allow method chaining
91902
+ */
91903
+ setIsTrustedSource(
91904
+ /**
91905
+ * New value for property `isTrustedSource`
91906
+ */
91907
+ bIsTrustedSource?: boolean
91908
+ ): this;
91689
91909
  /**
91690
91910
  * @deprecated (since 1.50.0) - replaced by {@link sap.m.PDFViewer#getTitle}.
91691
91911
  *
@@ -139543,6 +139763,8 @@ declare namespace sap {
139543
139763
 
139544
139764
  "sap/m/p13n/GroupPanel": undefined;
139545
139765
 
139766
+ "sap/m/p13n/MetadataHelper": undefined;
139767
+
139546
139768
  "sap/m/p13n/modification/FlexModificationHandler": undefined;
139547
139769
 
139548
139770
  "sap/m/p13n/modification/LocalStorageModificationHandler": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.108.24
267
+ // For Library Version: 1.108.26
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.24
1
+ // For Library Version: 1.108.26
2
2
 
3
3
  declare namespace sap {
4
4
  /**