@openui5/types 1.120.7 → 1.120.8

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.120.7
+// For Library Version: 1.120.8
 
 declare namespace sap {}

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.7
+// For Library Version: 1.120.8
 
 declare module "sap/ui/fl/library" {}
 
@@ -6,14 +6,15 @@ declare module "sap/ui/fl/apply/api/ControlVariantApplyAPI" {
   import ManagedObject from "sap/ui/base/ManagedObject";
 
   /**
-   * @since 1.67
-   *
    * Provides an API for applications to work with control variants. See also {@link sap.ui.fl.variants.VariantManagement}.
+   *
+   * @since 1.67
    */
   interface ControlVariantApplyAPI {
     /**
      * Activates the passed variant applicable to the passed control/component.
      *
+     *
      * @returns Resolves after the variant is activated or rejects if an error occurs
      */
     activateVariant(
@@ -108,12 +109,12 @@ declare module "sap/ui/fl/transport/TransportDialog" {
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   /**
-   * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
-   * library.
-   *
    * The Transport Dialog Control can be used to implement a value help for selecting an ABAP package and
    * transport request. It is not a generic utility, but part of the Variantmanament and therefore cannot
    * be used in any other application.
+   *
+   * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
+   * library.
    */
   export default class TransportDialog extends Dialog {
     /**
@@ -159,6 +160,7 @@ declare module "sap/ui/fl/transport/TransportDialog" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -179,6 +181,7 @@ declare module "sap/ui/fl/transport/TransportDialog" {
     /**
      * Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
@@ -201,11 +204,11 @@ declare module "sap/ui/fl/variants/VariantManagement" {
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
-   * @since 1.56
-   *
    * Can be used to manage variants. You can use this control in most controls that are enabled for key
    * user adaptation.
    *  **Note: **On the user interface, variants are generally referred to as "views".
+   *
+   * @since 1.56
    */
   export default class VariantManagement
     extends Control
@@ -257,6 +260,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -277,12 +281,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
     /**
      * Returns a metadata object for class sap.ui.fl.variants.VariantManagement.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
     /**
      * Adds a control to the association {@link #for for}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     addFor(
@@ -299,6 +305,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when users presses the cancel button inside Save As dialog.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachCancel(
@@ -325,6 +332,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when users presses the cancel button inside Save As dialog.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachCancel(
@@ -346,6 +354,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when the model and context are set.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachInitialized(
@@ -372,6 +381,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when the model and context are set.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachInitialized(
@@ -393,6 +403,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when users apply changes to variants in the Manage Views dialog.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachManage(
@@ -419,6 +430,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when users apply changes to variants in the Manage Views dialog.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachManage(
@@ -441,6 +453,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      * This event is fired when the Save View dialog or the Save As dialog is closed with the
      * save button.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachSave(
@@ -468,6 +481,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      * This event is fired when the Save View dialog or the Save As dialog is closed with the
      * save button.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachSave(
@@ -489,6 +503,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when a new variant is selected.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachSelect(
@@ -515,6 +530,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * This event is fired when a new variant is selected.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachSelect(
@@ -533,6 +549,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachCancel(
@@ -550,6 +567,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachInitialized(
@@ -567,6 +585,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachManage(
@@ -584,6 +603,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachSave(
@@ -601,6 +621,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachSelect(
@@ -614,10 +635,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       oListener?: object
     ): this;
     /**
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
      * Fires event {@link #event:cancel cancel} to attached listeners.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     fireCancel(
@@ -627,10 +648,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       mParameters?: object
     ): this;
     /**
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
      * Fires event {@link #event:initialized initialized} to attached listeners.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     fireInitialized(
@@ -640,10 +661,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       mParameters?: object
     ): this;
     /**
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
      * Fires event {@link #event:manage manage} to attached listeners.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     fireManage(
@@ -653,10 +674,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       mParameters?: VariantManagement$ManageEventParameters
     ): this;
     /**
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
      * Fires event {@link #event:save save} to attached listeners.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     fireSave(
@@ -666,10 +687,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       mParameters?: VariantManagement$SaveEventParameters
     ): this;
     /**
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
      * Fires event {@link #event:select select} to attached listeners.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     fireSelect(
@@ -681,6 +702,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
     /**
      * Gets the currently selected variant key.
      *
+     *
      * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned.
      */
     getCurrentVariantKey(): string | null;
@@ -693,6 +715,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `empty string`.
      *
+     *
      * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
      */
     getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
@@ -703,6 +726,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Value of property `editable`
      */
     getEditable(): boolean;
@@ -713,6 +737,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Value of property `executeOnSelectionForStandardDefault`
      */
     getExecuteOnSelectionForStandardDefault(): boolean;
@@ -721,14 +746,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      */
     getFor(): ID[];
     /**
-     * @since 1.104
-     *
      * Gets current value of property {@link #getHeaderLevel headerLevel}.
      *
      * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
      *
      * Default value is `Auto`.
      *
+     * @since 1.104
+     *
      * @returns Value of property `headerLevel`
      */
     getHeaderLevel(): TitleLevel | keyof typeof TitleLevel;
@@ -740,18 +765,19 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Value of property `inErrorState`
      */
     getInErrorState(): boolean;
     /**
-     * @since 1.109
-     *
      * Gets current value of property {@link #getMaxWidth maxWidth}.
      *
      * Sets the maximum width of the control.
      *
      * Default value is `"100%"`.
      *
+     * @since 1.109
+     *
      * @returns Value of property `maxWidth`
      */
     getMaxWidth(): CSSSize;
@@ -762,21 +788,23 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `empty string`.
      *
+     *
      * @returns Value of property `modelName`
      */
     getModelName(): string;
     /**
      * Determines if the current variant is modified.
      *
+     *
      * @returns If the current variant is modified `true`, otherwise `false`
      */
     getModified(): boolean;
     /**
-     * @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.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface.
      */
     getOverflowToolbarConfig(): {
@@ -793,6 +821,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Value of property `resetOnContextChange`
      */
     getResetOnContextChange(): boolean;
@@ -803,18 +832,19 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Value of property `showSetAsDefault`
      */
     getShowSetAsDefault(): boolean;
     /**
-     * @since 1.109
-     *
      * Gets current value of property {@link #getTitleStyle titleStyle}.
      *
      * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
      *
      * Default value is `Auto`.
      *
+     * @since 1.109
+     *
      * @returns Value of property `titleStyle`
      */
     getTitleStyle(): TitleLevel | keyof typeof TitleLevel;
@@ -827,24 +857,28 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Value of property `updateVariantInURL`
      */
     getUpdateVariantInURL(): boolean;
     /**
      * Retrieves all variants.
      *
+     *
      * @returns All variants. In case the model is not yet set, an empty array will be returned.
      */
     getVariants(): any[];
     /**
      * Removes all the controls in the association named {@link #getFor for}.
      *
+     *
      * @returns An array of the removed elements (might be empty)
      */
     removeAllFor(): ID[];
     /**
      * Removes an for from the association named {@link #getFor for}.
      *
+     *
      * @returns The removed for or `null`
      */
     removeFor(
@@ -873,6 +907,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `empty string`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setDisplayTextForExecuteOnSelectionForStandardVariant(
@@ -890,6 +925,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setEditable(
@@ -907,6 +943,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setExecuteOnSelectionForStandardDefault(
@@ -916,8 +953,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       bExecuteOnSelectionForStandardDefault?: boolean
     ): this;
     /**
-     * @since 1.104
-     *
      * Sets a new value for property {@link #getHeaderLevel headerLevel}.
      *
      * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
@@ -926,6 +961,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `Auto`.
      *
+     * @since 1.104
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setHeaderLevel(
@@ -944,6 +981,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setInErrorState(
@@ -953,8 +991,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       bInErrorState?: boolean
     ): this;
     /**
-     * @since 1.109
-     *
      * Sets a new value for property {@link #getMaxWidth maxWidth}.
      *
      * Sets the maximum width of the control.
@@ -963,6 +999,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `"100%"`.
      *
+     * @since 1.109
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setMaxWidth(
@@ -980,6 +1018,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `empty string`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setModelName(
@@ -999,6 +1038,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setResetOnContextChange(
@@ -1016,6 +1056,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setShowSetAsDefault(
@@ -1025,8 +1066,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       bShowSetAsDefault?: boolean
     ): this;
     /**
-     * @since 1.109
-     *
      * Sets a new value for property {@link #getTitleStyle titleStyle}.
      *
      * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
@@ -1035,6 +1074,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `Auto`.
      *
+     * @since 1.109
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setTitleStyle(
@@ -1054,6 +1095,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setUpdateVariantInURL(
@@ -1118,9 +1160,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       | PropertyBindingInfo;
 
     /**
-     * @since 1.104
-     *
      * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
+     *
+     * @since 1.104
      */
     headerLevel?:
       | (TitleLevel | keyof typeof TitleLevel)
@@ -1128,9 +1170,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       | `{${string}}`;
 
     /**
-     * @since 1.109
-     *
      * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
+     *
+     * @since 1.109
      */
     titleStyle?:
       | (TitleLevel | keyof typeof TitleLevel)
@@ -1138,9 +1180,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
       | `{${string}}`;
 
     /**
-     * @since 1.109
-     *
      * Sets the maximum width of the control.
+     *
+     * @since 1.109
      */
     maxWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
 
@@ -1281,10 +1323,10 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
   import Metadata from "sap/ui/base/Metadata";
 
   /**
-   * @since 1.87
-   *
    * Abstraction providing an API to handle an ABAP extension variant. Serves also as base class and dummy
    * implementation.
+   *
+   * @since 1.87
    */
   interface ABAPExtensibilityVariant extends BaseObject {
     /**
@@ -1293,6 +1335,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     extend(
@@ -1313,6 +1356,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
     /**
      * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.
      *
+     *
      * @returns Metadata object describing this class
      */
     getMetadata(): Metadata;
@@ -1327,9 +1371,9 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
   import Metadata from "sap/ui/base/Metadata";
 
   /**
-   * @since 1.87
-   *
    * Extension variant for ABAP multi tenant environments (via so called Predefined Fields)
+   *
+   * @since 1.87
    */
   interface MultiTenantABAPExtensibilityVariant
     extends ABAPExtensibilityVariant {
@@ -1339,6 +1383,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     extend(
@@ -1359,6 +1404,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
     /**
      * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.MultiTenantABAPExtensibilityVariant.
      *
+     *
      * @returns Metadata object describing this class
      */
     getMetadata(): Metadata;
@@ -1373,9 +1419,9 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
   import Metadata from "sap/ui/base/Metadata";
 
   /**
-   * @since 1.87
-   *
    * Extension variant for ABAP single tenant environnments (via so called Custom Fields)
+   *
+   * @since 1.87
    */
   interface SingleTenantABAPExtensibilityVariant
     extends ABAPExtensibilityVariant {
@@ -1385,6 +1431,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     extend(
@@ -1405,6 +1452,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
     /**
      * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.SingleTenantABAPExtensibilityVariant.
      *
+     *
      * @returns Metadata object describing this class
      */
     getMetadata(): Metadata;
@@ -1415,9 +1463,9 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
 
 declare module "sap/ui/fl/write/api/FeaturesAPI" {
   /**
-   * @since 1.70
-   *
    * Provides an API to determine which features are available for flexibility.
+   *
+   * @since 1.70
    */
   interface FeaturesAPI {
     /**
@@ -1425,6 +1473,7 @@ declare module "sap/ui/fl/write/api/FeaturesAPI" {
      * to decide if the key user adaptation feature should be visible to the current user. This only applies
      * if key user adaptation should be handled standalone without an SAP Fiori launchpad.
      *
+     *
      * @returns Resolves to a boolean indicating if the key user role is assigned to the user
      */
     isKeyUser(): Promise<boolean>;