@openui5/ts-types 1.130.0 → 1.131.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -2362,6 +2362,8 @@ declare namespace sap {
2362
2362
 
2363
2363
  /**
2364
2364
  * The type of the action button.
2365
+ *
2366
+ * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
2365
2367
  */
2366
2368
  buttonType?:
2367
2369
  | sap.m.ButtonType
@@ -2393,6 +2395,25 @@ declare namespace sap {
2393
2395
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2394
2396
  | `{${string}}`;
2395
2397
 
2398
+ /**
2399
+ * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
2400
+ * its separator is also not displayed.
2401
+ */
2402
+ startsSection?:
2403
+ | boolean
2404
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2405
+ | `{${string}}`;
2406
+
2407
+ /**
2408
+ * Action Definitions which will appear as nested items in the menu. **Note**: The parent action definition
2409
+ * will not fire a press anymore, it will only be used to hold the subitem.
2410
+ */
2411
+ actionDefinitions?:
2412
+ | sap.ui.integration.ActionDefinition[]
2413
+ | sap.ui.integration.ActionDefinition
2414
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
2415
+ | `{${string}}`;
2416
+
2396
2417
  /**
2397
2418
  * Fired when the action button is pressed.
2398
2419
  */
@@ -2750,6 +2771,18 @@ declare namespace sap {
2750
2771
  * @returns Metadata object describing this class
2751
2772
  */
2752
2773
  static getMetadata(): sap.ui.core.ElementMetadata;
2774
+ /**
2775
+ * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
2776
+ *
2777
+ *
2778
+ * @returns Reference to `this` in order to allow method chaining
2779
+ */
2780
+ addActionDefinition(
2781
+ /**
2782
+ * The actionDefinition to add; if empty, nothing is inserted
2783
+ */
2784
+ oActionDefinition: sap.ui.integration.ActionDefinition
2785
+ ): this;
2753
2786
  /**
2754
2787
  * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
2755
2788
  *
@@ -2799,6 +2832,13 @@ declare namespace sap {
2799
2832
  */
2800
2833
  oListener?: object
2801
2834
  ): this;
2835
+ /**
2836
+ * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
2837
+ *
2838
+ *
2839
+ * @returns Reference to `this` in order to allow method chaining
2840
+ */
2841
+ destroyActionDefinitions(): this;
2802
2842
  /**
2803
2843
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
2804
2844
  *
@@ -2830,6 +2870,13 @@ declare namespace sap {
2830
2870
  */
2831
2871
  mParameters?: object
2832
2872
  ): this;
2873
+ /**
2874
+ * Gets content of aggregation {@link #getActionDefinitions actionDefinitions}.
2875
+ *
2876
+ * Action Definitions which will appear as nested items in the menu. **Note**: The parent action definition
2877
+ * will not fire a press anymore, it will only be used to hold the subitem.
2878
+ */
2879
+ getActionDefinitions(): sap.ui.integration.ActionDefinition[];
2833
2880
  /**
2834
2881
  * Gets current value of property {@link #getButtonType buttonType}.
2835
2882
  *
@@ -2837,6 +2884,7 @@ declare namespace sap {
2837
2884
  *
2838
2885
  * Default value is `Transparent`.
2839
2886
  *
2887
+ * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
2840
2888
  *
2841
2889
  * @returns Value of property `buttonType`
2842
2890
  */
@@ -2871,6 +2919,18 @@ declare namespace sap {
2871
2919
  * @returns Value of property `parameters`
2872
2920
  */
2873
2921
  getParameters(): object;
2922
+ /**
2923
+ * Gets current value of property {@link #getStartsSection startsSection}.
2924
+ *
2925
+ * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
2926
+ * its separator is also not displayed.
2927
+ *
2928
+ * Default value is `false`.
2929
+ *
2930
+ *
2931
+ * @returns Value of property `startsSection`
2932
+ */
2933
+ getStartsSection(): boolean;
2874
2934
  /**
2875
2935
  * Gets current value of property {@link #getText text}.
2876
2936
  *
@@ -2902,6 +2962,58 @@ declare namespace sap {
2902
2962
  * @returns Value of property `visible`
2903
2963
  */
2904
2964
  getVisible(): boolean;
2965
+ /**
2966
+ * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
2967
+ * and returns its index if found or -1 otherwise.
2968
+ *
2969
+ *
2970
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2971
+ */
2972
+ indexOfActionDefinition(
2973
+ /**
2974
+ * The actionDefinition whose index is looked for
2975
+ */
2976
+ oActionDefinition: sap.ui.integration.ActionDefinition
2977
+ ): int;
2978
+ /**
2979
+ * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
2980
+ *
2981
+ *
2982
+ * @returns Reference to `this` in order to allow method chaining
2983
+ */
2984
+ insertActionDefinition(
2985
+ /**
2986
+ * The actionDefinition to insert; if empty, nothing is inserted
2987
+ */
2988
+ oActionDefinition: sap.ui.integration.ActionDefinition,
2989
+ /**
2990
+ * The `0`-based index the actionDefinition should be inserted at; for a negative value of `iIndex`, the
2991
+ * actionDefinition is inserted at position 0; for a value greater than the current size of the aggregation,
2992
+ * the actionDefinition is inserted at the last position
2993
+ */
2994
+ iIndex: int
2995
+ ): this;
2996
+ /**
2997
+ * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
2998
+ *
2999
+ *
3000
+ * @returns The removed actionDefinition or `null`
3001
+ */
3002
+ removeActionDefinition(
3003
+ /**
3004
+ * The actionDefinition to remove or its index or id
3005
+ */
3006
+ vActionDefinition: int | string | sap.ui.integration.ActionDefinition
3007
+ ): sap.ui.integration.ActionDefinition | null;
3008
+ /**
3009
+ * Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
3010
+ *
3011
+ * Additionally, it unregisters them from the hosting UIArea.
3012
+ *
3013
+ *
3014
+ * @returns An array of the removed elements (might be empty)
3015
+ */
3016
+ removeAllActionDefinitions(): sap.ui.integration.ActionDefinition[];
2905
3017
  /**
2906
3018
  * Sets a new value for property {@link #getButtonType buttonType}.
2907
3019
  *
@@ -2911,6 +3023,7 @@ declare namespace sap {
2911
3023
  *
2912
3024
  * Default value is `Transparent`.
2913
3025
  *
3026
+ * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
2914
3027
  *
2915
3028
  * @returns Reference to `this` in order to allow method chaining
2916
3029
  */
@@ -2971,6 +3084,25 @@ declare namespace sap {
2971
3084
  */
2972
3085
  oParameters: object
2973
3086
  ): this;
3087
+ /**
3088
+ * Sets a new value for property {@link #getStartsSection startsSection}.
3089
+ *
3090
+ * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
3091
+ * its separator is also not displayed.
3092
+ *
3093
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3094
+ *
3095
+ * Default value is `false`.
3096
+ *
3097
+ *
3098
+ * @returns Reference to `this` in order to allow method chaining
3099
+ */
3100
+ setStartsSection(
3101
+ /**
3102
+ * New value for property `startsSection`
3103
+ */
3104
+ bStartsSection?: boolean
3105
+ ): this;
2974
3106
  /**
2975
3107
  * Sets a new value for property {@link #getText text}.
2976
3108
  *
@@ -4423,6 +4555,14 @@ declare namespace sap {
4423
4555
  * The parameters of the action.
4424
4556
  */
4425
4557
  parameters: object;
4558
+ /**
4559
+ * If visual separator should be rendered before the item.
4560
+ */
4561
+ startsSection: boolean;
4562
+ /**
4563
+ * The nested actions.
4564
+ */
4565
+ actions: any[];
4426
4566
  };
4427
4567
 
4428
4568
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -3490,8 +3490,6 @@ declare namespace sap {
3490
3490
 
3491
3491
  /**
3492
3492
  * Describes the settings that can be provided to the SemanticFormElement constructor.
3493
- *
3494
- * @experimental (since 1.86)
3495
3493
  */
3496
3494
  interface $SemanticFormElementSettings
3497
3495
  extends sap.ui.layout.form.$FormElementSettings {
@@ -3501,13 +3499,11 @@ declare namespace sap {
3501
3499
  delimiter?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3502
3500
 
3503
3501
  /**
3504
- * Labels of the individual fields. Can either be a `Label` control or a string.
3505
- *
3506
- * If a `Label` control is used, the properties of the `Label` can be set.
3502
+ * Labels of the individual fields.
3507
3503
  *
3508
- * These labels are not rendered directly. If the `Label` property of `SemanticFormElement` is not set,
3509
- * the texts of the labels are concatenated into the `Label` property of `SemanticFormElement`. Otherwise
3510
- * the set `Label` is shown.
3504
+ * These labels are not rendered directly. If the {@link #getLabel label} aggregation of `SemanticFormElement`
3505
+ * is not set, the texts of the labels are concatenated into the {@link #setLabel label} aggregation of
3506
+ * `SemanticFormElement`. Otherwise the set `Label` is shown.
3511
3507
  *
3512
3508
  * **Note:** If this aggregation is used, a label is assigned to every single field of `SemanticFormElement`.
3513
3509
  * The order of the labels and the fields must be the same.
@@ -6763,15 +6759,18 @@ declare namespace sap {
6763
6759
  static getMetadata(): sap.ui.core.ElementMetadata;
6764
6760
  }
6765
6761
  /**
6766
- * A `SemanticFormElement` element is a special `FormElement` that contains semantically connected fields.
6767
- * These field controls are divided by delimiter controls. In display mode, they are rendered as one condensed
6768
- * string, in edit mode as separate fields.
6762
+ * A `SemanticFormElement` element is a special {@link sap.ui.layout.form.FormElement FormElement} that
6763
+ * contains semantically connected fields. These field controls are divided by delimiter controls. In display
6764
+ * mode, they are rendered as one condensed string, in edit mode as separate fields.
6769
6765
  *
6770
- * **Note:** Please use the `ColumnLayout` as `layout` of the `Form`. For other layouts, the field arrangement
6771
- * might not be suitable in every case.
6766
+ * Only controls implementing the {@link sap.ui.core.ISemanticFormContent ISemanticFormContent} interface
6767
+ * are supported.
6768
+ *
6769
+ * **Note:** Please use the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.Form#setLayout layout }
6770
+ * of the {@link sap.ui.layout.form.Form Form}. For other layouts, the field arrangement might not be suitable
6771
+ * in every case.
6772
6772
  *
6773
6773
  * @since 1.86.0
6774
- * @experimental (since 1.86)
6775
6774
  */
6776
6775
  class SemanticFormElement extends sap.ui.layout.form.FormElement {
6777
6776
  /**
@@ -6872,13 +6871,11 @@ declare namespace sap {
6872
6871
  /**
6873
6872
  * Gets content of aggregation {@link #getFieldLabels fieldLabels}.
6874
6873
  *
6875
- * Labels of the individual fields. Can either be a `Label` control or a string.
6876
- *
6877
- * If a `Label` control is used, the properties of the `Label` can be set.
6874
+ * Labels of the individual fields.
6878
6875
  *
6879
- * These labels are not rendered directly. If the `Label` property of `SemanticFormElement` is not set,
6880
- * the texts of the labels are concatenated into the `Label` property of `SemanticFormElement`. Otherwise
6881
- * the set `Label` is shown.
6876
+ * These labels are not rendered directly. If the {@link #getLabel label} aggregation of `SemanticFormElement`
6877
+ * is not set, the texts of the labels are concatenated into the {@link #setLabel label} aggregation of
6878
+ * `SemanticFormElement`. Otherwise the set `Label` is shown.
6882
6879
  *
6883
6880
  * **Note:** If this aggregation is used, a label is assigned to every single field of `SemanticFormElement`.
6884
6881
  * The order of the labels and the fields must be the same.