@sapui5/ts-types 1.114.0 → 1.115.1

package/types/sap.ui.fl.d.ts

@@ -1,11 +1,11 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.1
 
 declare namespace sap {
   namespace ui {
     /**
      * This is the library for SAPUI5 flexibility. It includes the handling of changes made on applications,
      * such as descriptor changes, app variants, UI changes, control variants (a.k.a. views), and personalization,
-     * as well as APIs for consumers. In addition, it provides the {@link sap.ui.fl.variants.VariantManagement}
+     * as well as APIs for consumers. In addition, it provides the {@link sap.ui.fl.variants.VariantManagement }
      * control, which enables applications to use control variants (views).
      */
     namespace fl {
@@ -93,7 +93,7 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
           /**
-           * @SINCE 1.104
+           * @since 1.104
            *
            * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
            */
@@ -103,7 +103,7 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * @SINCE 1.109
+           * @since 1.109
            *
            * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
            */
@@ -113,7 +113,7 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * @SINCE 1.109
+           * @since 1.109
            *
            * Sets the maximum width of the control.
            */
@@ -136,7 +136,9 @@ declare namespace sap {
            * This event is fired when the Save View dialog or the Save As dialog is closed with the
            * save button.
            */
-          save?: (oEvent: sap.ui.base.Event) => void;
+          save?: (
+            oEvent: sap.ui.base.Event<sap.ui.fl.variants.VariantManagement$SaveEventParameters>
+          ) => void;
 
           /**
            * This event is fired when users presses the cancel button inside Save As dialog.
@@ -146,16 +148,93 @@ declare namespace sap {
           /**
            * This event is fired when users apply changes to variants in the Manage Views dialog.
            */
-          manage?: (oEvent: sap.ui.base.Event) => void;
+          manage?: (
+            oEvent: sap.ui.base.Event<sap.ui.fl.variants.VariantManagement$ManageEventParameters>
+          ) => void;
 
           /**
            * This event is fired when a new variant is selected.
            */
-          select?: (oEvent: sap.ui.base.Event) => void;
+          select?: (
+            oEvent: sap.ui.base.Event<sap.ui.fl.variants.VariantManagement$SelectEventParameters>
+          ) => void;
+        }
+
+        interface VariantManagement$CancelEventParameters {}
+
+        interface VariantManagement$InitializedEventParameters {}
+
+        interface VariantManagement$ManageEventParameters {
+          /**
+           * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
+           * of the variant
+           */
+          renamed?: object[];
+
+          /**
+           * List of deleted variant keys
+           */
+          deleted?: string[];
+
+          /**
+           * List of variant keys and the associated Execute on Selection indicator
+           */
+          exe?: object[];
+
+          /**
+           * The default variant key
+           */
+          def?: string;
+        }
+
+        interface VariantManagement$SaveEventParameters {
+          /**
+           * Variant title
+           */
+          name?: string;
+
+          /**
+           * Indicates if an existing variant is overwritten or if a new variant is created.
+           */
+          overwrite?: boolean;
+
+          /**
+           * Variant key
+           */
+          key?: string;
+
+          /**
+           * Apply Automatically indicator
+           */
+          execute?: boolean;
+
+          /**
+           * Indicates the check box state for 'Public'.
+           */
+          public?: boolean;
+
+          /**
+           * The default variant indicator
+           */
+          def?: boolean;
+
+          /**
+           * Indicates the check box state for 'Create Tile'.
+           * Note:
+           * This event parameter is used only internally.
+           */
+          tile?: boolean;
+        }
+
+        interface VariantManagement$SelectEventParameters {
+          /**
+           * Variant key
+           */
+          key?: string;
         }
 
         /**
-         * @SINCE 1.56
+         * @since 1.56
          *
          * Can be used to manage variants. You can use this control in most controls that are enabled for key
          * user adaptation.
@@ -177,7 +256,7 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            * See:
-           * 	{@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
+           * 	{@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
            */
           constructor(
             /**
@@ -192,7 +271,7 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            * See:
-           * 	{@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
+           * 	{@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
            */
           constructor(
             /**
@@ -358,7 +437,7 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$ManageEvent) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -379,7 +458,7 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$ManageEvent) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -406,7 +485,7 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$SaveEvent) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -428,7 +507,7 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$SaveEvent) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -454,7 +533,7 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$SelectEvent) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -475,7 +554,7 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$SelectEvent) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -527,7 +606,7 @@ declare namespace sap {
             /**
              * The function to be called, when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$ManageEvent) => void,
             /**
              * Context object on which the given function had to be called
              */
@@ -544,7 +623,7 @@ declare namespace sap {
             /**
              * The function to be called, when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$SaveEvent) => void,
             /**
              * Context object on which the given function had to be called
              */
@@ -561,14 +640,14 @@ declare namespace sap {
             /**
              * The function to be called, when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (p1: VariantManagement$SelectEvent) => void,
             /**
              * Context object on which the given function had to be called
              */
             oListener?: object
           ): this;
           /**
-           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * Fires event {@link #event:cancel cancel} to attached listeners.
            *
@@ -581,7 +660,7 @@ declare namespace sap {
             mParameters?: object
           ): this;
           /**
-           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * Fires event {@link #event:initialized initialized} to attached listeners.
            *
@@ -594,7 +673,7 @@ declare namespace sap {
             mParameters?: object
           ): this;
           /**
-           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * Fires event {@link #event:manage manage} to attached listeners.
            *
@@ -604,28 +683,10 @@ declare namespace sap {
             /**
              * Parameters to pass along with the event
              */
-            mParameters?: {
-              /**
-               * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
-               * of the variant
-               */
-              renamed?: object[];
-              /**
-               * List of deleted variant keys
-               */
-              deleted?: string[];
-              /**
-               * List of variant keys and the associated Execute on Selection indicator
-               */
-              exe?: object[];
-              /**
-               * The default variant key
-               */
-              def?: string;
-            }
+            mParameters?: sap.ui.fl.variants.VariantManagement$ManageEventParameters
           ): this;
           /**
-           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * Fires event {@link #event:save save} to attached listeners.
            *
@@ -635,41 +696,10 @@ declare namespace sap {
             /**
              * Parameters to pass along with the event
              */
-            mParameters?: {
-              /**
-               * Variant title
-               */
-              name?: string;
-              /**
-               * Indicates if an existing variant is overwritten or if a new variant is created.
-               */
-              overwrite?: boolean;
-              /**
-               * Variant key
-               */
-              key?: string;
-              /**
-               * Apply Automatically indicator
-               */
-              execute?: boolean;
-              /**
-               * Indicates the check box state for 'Public'.
-               */
-              public?: boolean;
-              /**
-               * The default variant indicator
-               */
-              def?: boolean;
-              /**
-               * Indicates the check box state for 'Create Tile'.
-               * Note:
-               * This event parameter is used only internally.
-               */
-              tile?: boolean;
-            }
+            mParameters?: sap.ui.fl.variants.VariantManagement$SaveEventParameters
           ): this;
           /**
-           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * Fires event {@link #event:select select} to attached listeners.
            *
@@ -679,12 +709,7 @@ declare namespace sap {
             /**
              * Parameters to pass along with the event
              */
-            mParameters?: {
-              /**
-               * Variant key
-               */
-              key?: string;
-            }
+            mParameters?: sap.ui.fl.variants.VariantManagement$SelectEventParameters
           ): this;
           /**
            * Gets the currently selected variant key.
@@ -725,12 +750,11 @@ declare namespace sap {
            */
           getExecuteOnSelectionForStandardDefault(): boolean;
           /**
-           * Returns array of IDs of the elements which are the current targets of the association {@link #getFor
-           * for}.
+           * Returns array of IDs of the elements which are the current targets of the association {@link #getFor for}.
            */
           getFor(): sap.ui.core.ID[];
           /**
-           * @SINCE 1.104
+           * @since 1.104
            *
            * Gets current value of property {@link #getHeaderLevel headerLevel}.
            *
@@ -764,7 +788,7 @@ declare namespace sap {
            */
           getManualVariantKey(): boolean;
           /**
-           * @SINCE 1.109
+           * @since 1.109
            *
            * Gets current value of property {@link #getMaxWidth maxWidth}.
            *
@@ -792,7 +816,7 @@ declare namespace sap {
            */
           getModified(): boolean;
           /**
-           * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
            * is fired when width of the control is changed.
@@ -827,7 +851,7 @@ declare namespace sap {
            */
           getShowSetAsDefault(): boolean;
           /**
-           * @SINCE 1.109
+           * @since 1.109
            *
            * Gets current value of property {@link #getTitleStyle titleStyle}.
            *
@@ -936,7 +960,7 @@ declare namespace sap {
             bExecuteOnSelectionForStandardDefault?: boolean
           ): this;
           /**
-           * @SINCE 1.104
+           * @since 1.104
            *
            * Sets a new value for property {@link #getHeaderLevel headerLevel}.
            *
@@ -991,7 +1015,7 @@ declare namespace sap {
             bManualVariantKey?: boolean
           ): this;
           /**
-           * @SINCE 1.109
+           * @since 1.109
            *
            * Sets a new value for property {@link #getMaxWidth maxWidth}.
            *
@@ -1063,7 +1087,7 @@ declare namespace sap {
             bShowSetAsDefault?: boolean
           ): this;
           /**
-           * @SINCE 1.109
+           * @since 1.109
            *
            * Sets a new value for property {@link #getTitleStyle titleStyle}.
            *
@@ -1101,6 +1125,46 @@ declare namespace sap {
             bUpdateVariantInURL?: boolean
           ): this;
         }
+
+        /**
+         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$CancelEventParameters'
+         * in 1.115.1 and any later releases.
+         */
+        type $VariantManagementCancelEventParameters = sap.ui.fl.variants.VariantManagement$CancelEventParameters;
+
+        type VariantManagement$CancelEvent = sap.ui.base.Event<VariantManagement$CancelEventParameters>;
+
+        /**
+         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$InitializedEventParameters'
+         * in 1.115.1 and any later releases.
+         */
+        type $VariantManagementInitializedEventParameters = sap.ui.fl.variants.VariantManagement$InitializedEventParameters;
+
+        type VariantManagement$InitializedEvent = sap.ui.base.Event<VariantManagement$InitializedEventParameters>;
+
+        /**
+         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$ManageEventParameters'
+         * in 1.115.1 and any later releases.
+         */
+        type $VariantManagementManageEventParameters = sap.ui.fl.variants.VariantManagement$ManageEventParameters;
+
+        type VariantManagement$ManageEvent = sap.ui.base.Event<VariantManagement$ManageEventParameters>;
+
+        /**
+         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$SaveEventParameters'
+         * in 1.115.1 and any later releases.
+         */
+        type $VariantManagementSaveEventParameters = sap.ui.fl.variants.VariantManagement$SaveEventParameters;
+
+        type VariantManagement$SaveEvent = sap.ui.base.Event<VariantManagement$SaveEventParameters>;
+
+        /**
+         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$SelectEventParameters'
+         * in 1.115.1 and any later releases.
+         */
+        type $VariantManagementSelectEventParameters = sap.ui.fl.variants.VariantManagement$SelectEventParameters;
+
+        type VariantManagement$SelectEvent = sap.ui.base.Event<VariantManagement$SelectEventParameters>;
       }
       /**
        * The `sap.ui.fl.write` namespace contains all code to create, update, and reset flex objects. Additional
@@ -1113,7 +1177,7 @@ declare namespace sap {
          */
         namespace api {
           /**
-           * @SINCE 1.70
+           * @since 1.70
            *
            * Provides an API to determine which features are available for flexibility.
            */
@@ -1127,7 +1191,6 @@ declare namespace sap {
              */
             isKeyUser(): Promise<boolean>;
           }
-          const FeaturesAPI: FeaturesAPI;
         }
       }
 
@@ -1150,8 +1213,8 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            *
-           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
-           * sap.m.Dialog} can be used.
+           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor sap.m.Dialog }
+           * can be used.
            */
           constructor(
             /**
@@ -1166,8 +1229,8 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            *
-           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
-           * sap.m.Dialog} can be used.
+           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor sap.m.Dialog }
+           * can be used.
            */
           constructor(
             /**
@@ -1299,6 +1362,8 @@ declare namespace sap {
 
     "sap/ui/fl/apply/_internal/flexState/UI2Personalization/UI2PersonalizationState": undefined;
 
+    "sap/ui/fl/apply/_internal/preprocessors/ComponentLifecycleHooks": undefined;
+
     "sap/ui/fl/apply/_internal/preprocessors/ControllerExtension": undefined;
 
     "sap/ui/fl/apply/_internal/preprocessors/EventHistory": undefined;