@openui5/ts-types 1.112.2 → 1.114.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.112.2",
+  "version": "1.114.0",
   "description": "OpenUI5 TypeScript Definitions",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.112.2
+// For Library Version: 1.114.0
 
 declare namespace sap {
   /**
@@ -537,6 +537,8 @@ declare namespace sap {
           oListener?: object
         ): this;
         /**
+         * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         *
          * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
          * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
          */
@@ -555,6 +557,8 @@ declare namespace sap {
           }
         ): void;
         /**
+         * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         *
          * Fires event {@link #event:press press} to attached listeners.
          *
          * @returns Reference to `this` in order to allow method chaining
@@ -1041,6 +1045,8 @@ declare namespace sap {
           oListener?: object
         ): this;
         /**
+         * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         *
          * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
          * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
          */
@@ -1059,6 +1065,8 @@ declare namespace sap {
           }
         ): void;
         /**
+         * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         *
          * Fires event {@link #event:press press} to attached listeners.
          *
          * @returns Reference to `this` in order to allow method chaining
@@ -2775,8 +2783,6 @@ declare namespace sap {
          *
          * If all the areas have assigned values greater than 1, the numbers are scaled so that at least one of
          * them is equal to 1. For example, value of `2:4:8` is equal to `1:2:4`.
-         *
-         *  When this property is set the `titlePrimaryArea` property has no effect.
          */
         titleAreaShrinkRatio?:
           | sap.f.DynamicPageTitleShrinkRatio
@@ -5428,8 +5434,6 @@ declare namespace sap {
          * If all the areas have assigned values greater than 1, the numbers are scaled so that at least one of
          * them is equal to 1. For example, value of `2:4:8` is equal to `1:2:4`.
          *
-         *  When this property is set the `titlePrimaryArea` property has no effect.
-         *
          * Default value is `"1:1.6:1.6"`.
          *
          * @returns Value of property `titleAreaShrinkRatio`
@@ -6384,8 +6388,6 @@ declare namespace sap {
          * If all the areas have assigned values greater than 1, the numbers are scaled so that at least one of
          * them is equal to 1. For example, value of `2:4:8` is equal to `1:2:4`.
          *
-         *  When this property is set the `titlePrimaryArea` property has no effect.
-         *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `"1:1.6:1.6"`.
@@ -6446,37 +6448,6 @@ declare namespace sap {
            */
           oTitleMainAction: sap.f.semantic.TitleMainAction
         ): this;
-        /**
-         * @SINCE 1.52
-         * @deprecated (since 1.58) - Please use the `titleAreaShrinkRatio` property instead. The value of `titleAreaShrinkRatio`
-         * must be set in `Heading:Content:Actions` format where Heading, Content and Actions are numbers greater
-         * than or equal to 0. The greater value a section has the faster it shrinks when the screen size is being
-         * reduced.
-         *
-         * `titlePrimaryArea=Begin` can be achieved by setting a low number for the Heading area to `titleAreaShrinkRatio`,
-         * for example `1:1.6:1.6`.
-         *
-         * `titlePrimaryArea=Middle` can be achieved by setting a low number for the Content area to `titleAreaShrinkRatio`,
-         * for example `1.6:1:1.6`.
-         *
-         * Sets a new value for property {@link #getTitlePrimaryArea titlePrimaryArea}.
-         *
-         * Determines which of the title areas (Begin, Middle) is primary.
-         *
-         * **Note:** The primary area is shrinking at a lower rate, remaining visible as long as it can.
-         *
-         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-         *
-         * Default value is `Begin`.
-         *
-         * @returns Reference to `this` in order to allow method chaining
-         */
-        setTitlePrimaryArea(
-          /**
-           * New value for property `titlePrimaryArea`
-           */
-          sTitlePrimaryArea?: sap.f.DynamicPageTitleArea
-        ): this;
         /**
          * @SINCE 1.58
          *
@@ -8464,6 +8435,14 @@ declare namespace sap {
         | sap.ui.base.ManagedObject.PropertyBindingInfo
         | `{${string}}`;
 
+      /**
+       * Defines where to place the side panel position.
+       */
+      sidePanelPosition?:
+        | sap.f.SidePanelPosition
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * The list of controls for the main content.
        */
@@ -8810,6 +8789,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:press press} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -9411,6 +9392,8 @@ declare namespace sap {
        */
       static getMetadata(): sap.ui.core.ElementMetadata;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Returns the DOM Element that should get the focus.
        *
        * @returns Returns the DOM Element that should get the focus
@@ -9692,6 +9675,7 @@ declare namespace sap {
       ): this;
       /**
        * @SINCE 1.93
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Fires event {@link #event:pinnedStateChange pinnedStateChange} to attached listeners.
        *
@@ -10967,6 +10951,7 @@ declare namespace sap {
       ): this;
       /**
        * @SINCE 1.54
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Fires event {@link #event:stateChange stateChange} to attached listeners.
        *
@@ -12469,6 +12454,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:afterBeginColumnNavigate afterBeginColumnNavigate} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -12522,6 +12509,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:afterEndColumnNavigate afterEndColumnNavigate} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -12575,6 +12564,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:afterMidColumnNavigate afterMidColumnNavigate} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -12628,6 +12619,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:beginColumnNavigate beginColumnNavigate} to attached listeners.
        *
        * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -12685,6 +12678,7 @@ declare namespace sap {
       ): boolean;
       /**
        * @SINCE 1.76
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Fires event {@link #event:columnResize columnResize} to attached listeners.
        *
@@ -12710,6 +12704,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:endColumnNavigate endColumnNavigate} to attached listeners.
        *
        * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -12766,6 +12762,8 @@ declare namespace sap {
         }
       ): boolean;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:midColumnNavigate midColumnNavigate} to attached listeners.
        *
        * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -12822,6 +12820,8 @@ declare namespace sap {
         }
       ): boolean;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:stateChange stateChange} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -14554,6 +14554,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:borderReached borderReached} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -14582,6 +14584,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:columnsChange columnsChange} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -14598,6 +14602,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:layoutChange layoutChange} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -15687,6 +15693,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:borderReached borderReached} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -15749,12 +15757,16 @@ declare namespace sap {
        */
       getCustomLayout(): sap.ui.layout.cssgrid.GridLayoutBase;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Implements IGridConfigurable interface.
        *
        * @returns An array with the DOM elements
        */
       getGridDomRefs(): HTMLElement[];
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Implements IGridConfigurable interface.
        *
        * @returns The grid layout
@@ -16257,6 +16269,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:change change} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -16837,6 +16851,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:liveChange liveChange} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -16853,6 +16869,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:search search} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -16873,6 +16891,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:suggest suggest} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17168,6 +17188,7 @@ declare namespace sap {
       static getMetadata(): sap.ui.core.ElementMetadata;
       /**
        * @SINCE 1.65
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Sets classes according to the context of the page. Possible contexts are header, footer, and subheader.
        *
@@ -17176,6 +17197,7 @@ declare namespace sap {
       _applyContextClassFor(): sap.m.IBar;
       /**
        * @SINCE 1.65
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Sets the HTML tag according to the context of the page. Possible contexts are header, footer, and subheader.
        *
@@ -17195,6 +17217,7 @@ declare namespace sap {
       ): this;
       /**
        * @SINCE 1.65
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Sets classes and HTML tag according to the context of the page. Possible contexts are header, footer,
        * and subheader
@@ -17747,6 +17770,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:avatarPressed avatarPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17763,6 +17788,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:copilotPressed copilotPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17779,6 +17806,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:homeIconPressed homeIconPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17795,6 +17824,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:menuButtonPressed menuButtonPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17811,6 +17842,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:navButtonPressed navButtonPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17827,6 +17860,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:notificationsPressed notificationsPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17843,6 +17878,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:productSwitcherPressed productSwitcherPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17859,6 +17896,8 @@ declare namespace sap {
         }
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:searchButtonPressed searchButtonPressed} to attached listeners.
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -17884,6 +17923,7 @@ declare namespace sap {
       getAdditionalContent(): sap.f.IShellBar[];
       /**
        * @SINCE 1.65
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Gets the available Bar contexts.
        *
@@ -17914,6 +17954,7 @@ declare namespace sap {
       getHomeIconTooltip(): string;
       /**
        * @SINCE 1.65
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Gets the HTML tag of the root DOM Reference.
        *
@@ -18066,6 +18107,7 @@ declare namespace sap {
       ): this;
       /**
        * @SINCE 1.65
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Returns if the bar is sensitive to the container context. Implementation of the IBar interface
        *
@@ -18129,6 +18171,7 @@ declare namespace sap {
       ): this;
       /**
        * @SINCE 1.65
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        *
        * Sets the HTML tag of the root DOM Reference.
        *
@@ -18563,6 +18606,8 @@ declare namespace sap {
         oListener?: object
       ): this;
       /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       *
        * Fires event {@link #event:toggle toggle} to attached listeners.
        *
        * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -18650,6 +18695,16 @@ declare namespace sap {
        * @returns Value of property `sidePanelMinWidth`
        */
       getSidePanelMinWidth(): sap.ui.core.CSSSize;
+      /**
+       * Gets current value of property {@link #getSidePanelPosition sidePanelPosition}.
+       *
+       * Defines where to place the side panel position.
+       *
+       * Default value is `Right`.
+       *
+       * @returns Value of property `sidePanelPosition`
+       */
+      getSidePanelPosition(): sap.f.SidePanelPosition;
       /**
        * Gets current value of property {@link #getSidePanelResizable sidePanelResizable}.
        *
@@ -18873,6 +18928,23 @@ declare namespace sap {
          */
         sSidePanelMinWidth?: sap.ui.core.CSSSize
       ): this;
+      /**
+       * Sets a new value for property {@link #getSidePanelPosition sidePanelPosition}.
+       *
+       * Defines where to place the side panel position.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `Right`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setSidePanelPosition(
+        /**
+         * New value for property `sidePanelPosition`
+         */
+        sSidePanelPosition?: sap.f.SidePanelPosition
+      ): this;
       /**
        * Sets a new value for property {@link #getSidePanelResizable sidePanelResizable}.
        *
@@ -19271,6 +19343,21 @@ declare namespace sap {
        */
       Up = "Up",
     }
+    /**
+     * @SINCE 1.104
+     *
+     * Enumeration for different SidePanel position.
+     */
+    enum SidePanelPosition {
+      /**
+       * The position is left.
+       */
+      Left = "Left",
+      /**
+       * The position is right.
+       */
+      Right = "Right",
+    }
     /**
      * @SINCE 1.69
      * @deprecated (since 1.73) - Use the {@link sap.m.AvatarColor} instead.