@openui5/ts-types 1.130.0 → 1.131.0

package/types/sap.m.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare namespace sap {
   /**
@@ -721,7 +721,6 @@ declare namespace sap {
          * Applies a state to a control by passing an object that contains the registered controller key and an
          * object matching the inner subcontroller logic.
          *
-         * @experimental (since 1.104) - Please note that the API of this control is not yet finalized!
          *
          * @returns A Promise resolving after the state has been applied
          */
@@ -803,7 +802,6 @@ declare namespace sap {
          * modification handler appliance). After the returned `Promise` has been resolved, the returned state is
          * in sync with the related state object of the control.
          *
-         * @experimental (since 1.104) - Please note that the API of this control is not yet finalized!
          *
          * @returns A Promise resolving in the current control state
          */
@@ -32089,7 +32087,8 @@ declare namespace sap {
        * Defines the highlight state of the list items.
        *
        * Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
-       * or {@link sap.ui.core.IndicationColor}.
+       * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
+       * for accessibility contrast reasons).
        *
        * Accessibility support is provided through the associated {@link sap.m.ListItemBase#setHighlightText highlightText }
        * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -32208,6 +32207,18 @@ declare namespace sap {
        * @since 1.104.0
        */
       liveChange?: (oEvent: MaskInput$LiveChangeEvent) => void;
+
+      /**
+       * This event is fired when user presses the Enter key on the Mask input.
+       *
+       * **Notes:**
+       * 	 - The event is fired independent of whether there was a change before or not. If a change was performed,
+       *     the event is fired after the change event.
+       * 	 - The event is only fired on an input which allows text input (`editable` and `enabled`).
+       *
+       * @since 1.131.0
+       */
+      submit?: (oEvent: MaskInput$SubmitEvent) => void;
     }
 
     /**
@@ -32252,6 +32263,14 @@ declare namespace sap {
        * Fired when the menu is closed.
        */
       closed?: (oEvent: sap.ui.base.Event) => void;
+
+      /**
+       * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
+       * closing.
+       *
+       * @since 1.131
+       */
+      beforeClose?: (oEvent: sap.ui.base.Event) => void;
     }
 
     /**
@@ -32450,6 +32469,19 @@ declare namespace sap {
         | sap.ui.base.ManagedObject.AggregationBindingInfo
         | `{${string}}`;
 
+      /**
+       * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
+       * of custom elements, such as icons and buttons.
+       *
+       * @since 1.131
+       * @experimental
+       */
+      endContent?:
+        | sap.ui.core.Control[]
+        | sap.ui.core.Control
+        | sap.ui.base.ManagedObject.AggregationBindingInfo
+        | `{${string}}`;
+
       /**
        * Fired after the item has been pressed.
        */
@@ -34888,7 +34920,6 @@ declare namespace sap {
      * Describes the settings that can be provided to the P13nConditionPanel constructor.
      *
      * @deprecated (since 1.124) - replaced by the artifacts in {@link sap.m.p13n}.
-     * @experimental (since 1.26) - !!! THIS CONTROL IS ONLY FOR INTERNAL USE !!!
      */
     interface $P13nConditionPanelSettings extends sap.ui.core.$ControlSettings {
       /**
@@ -35246,8 +35277,6 @@ declare namespace sap {
 
       /**
        * Event raised if a filter item has been changed. reason can be added, updated or removed.
-       *
-       * @experimental (since 1.56)
        */
       filterItemChanged?: (
         oEvent: P13nFilterPanel$FilterItemChangedEvent
@@ -37448,6 +37477,8 @@ declare namespace sap {
     interface $ProgressIndicatorSettings extends sap.ui.core.$ControlSettings {
       /**
        * Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.
+       *
+       * @deprecated (since 1.130) - with no replacement.
        */
       enabled?:
         | boolean
@@ -45273,6 +45304,21 @@ declare namespace sap {
       previousValue?: string;
     }
 
+    /**
+     * Parameters of the MaskInput#submit event.
+     */
+    interface MaskInput$SubmitEventParameters {
+      /**
+       * The new value of the Mask input.
+       */
+      value?: string;
+    }
+
+    /**
+     * Parameters of the Menu#beforeClose event.
+     */
+    interface Menu$BeforeCloseEventParameters {}
+
     /**
      * Parameters of the Menu#closed event.
      */
@@ -45933,8 +45979,6 @@ declare namespace sap {
 
     /**
      * Parameters of the P13nFilterPanel#filterItemChanged event.
-     *
-     * @experimental (since 1.56)
      */
     interface P13nFilterPanel$FilterItemChangedEventParameters {
       /**
@@ -65279,29 +65323,35 @@ declare namespace sap {
       /**
        * Fires event {@link #event:beforeClose beforeClose} to attached listeners.
        *
+       * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+       * event object. The return value of this method indicates whether the default action should be executed.
+       *
        * @ui5-protected Do not call from applications (only from related classes in the framework)
        *
-       * @returns Reference to `this` in order to allow method chaining
+       * @returns Whether or not to prevent the default action
        */
       fireBeforeClose(
         /**
          * Parameters to pass along with the event
          */
         mParameters?: sap.m.Dialog$BeforeCloseEventParameters
-      ): this;
+      ): boolean;
       /**
        * Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
        *
+       * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+       * event object. The return value of this method indicates whether the default action should be executed.
+       *
        * @ui5-protected Do not call from applications (only from related classes in the framework)
        *
-       * @returns Reference to `this` in order to allow method chaining
+       * @returns Whether or not to prevent the default action
        */
       fireBeforeOpen(
         /**
          * Parameters to pass along with the event
          */
         mParameters?: object
-      ): this;
+      ): boolean;
       /**
        * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
        */
@@ -88418,7 +88468,8 @@ declare namespace sap {
        * Defines the highlight state of the list items.
        *
        * Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
-       * or {@link sap.ui.core.IndicationColor}.
+       * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
+       * for accessibility contrast reasons).
        *
        * Accessibility support is provided through the associated {@link sap.m.ListItemBase#setHighlightText highlightText }
        * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -88571,7 +88622,8 @@ declare namespace sap {
        * Defines the highlight state of the list items.
        *
        * Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
-       * or {@link sap.ui.core.IndicationColor}.
+       * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
+       * for accessibility contrast reasons).
        *
        * Accessibility support is provided through the associated {@link sap.m.ListItemBase#setHighlightText highlightText }
        * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -88860,6 +88912,65 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:submit submit} event of this `sap.m.MaskInput`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.MaskInput` itself.
+       *
+       * This event is fired when user presses the Enter key on the Mask input.
+       *
+       * **Notes:**
+       * 	 - The event is fired independent of whether there was a change before or not. If a change was performed,
+       *     the event is fired after the change event.
+       * 	 - The event is only fired on an input which allows text input (`editable` and `enabled`).
+       *
+       * @since 1.131.0
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachSubmit(
+        /**
+         * An application-specific payload object that will be passed to the event handler along with the event
+         * object when firing the event
+         */
+        oData: object,
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: MaskInput$SubmitEvent) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.MaskInput` itself
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:submit submit} event of this `sap.m.MaskInput`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.MaskInput` itself.
+       *
+       * This event is fired when user presses the Enter key on the Mask input.
+       *
+       * **Notes:**
+       * 	 - The event is fired independent of whether there was a change before or not. If a change was performed,
+       *     the event is fired after the change event.
+       * 	 - The event is only fired on an input which allows text input (`editable` and `enabled`).
+       *
+       * @since 1.131.0
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachSubmit(
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: MaskInput$SubmitEvent) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.MaskInput` itself
+         */
+        oListener?: object
+      ): this;
       /**
        * Destroys all the rules in the aggregation {@link #getRules rules}.
        *
@@ -88886,6 +88997,25 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Detaches event handler `fnFunction` from the {@link #event:submit submit} event of this `sap.m.MaskInput`.
+       *
+       * The passed function and listener object must match the ones used for event registration.
+       *
+       * @since 1.131.0
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      detachSubmit(
+        /**
+         * The function to be called, when the event occurs
+         */
+        fnFunction: (p1: MaskInput$SubmitEvent) => void,
+        /**
+         * Context object on which the given function had to be called
+         */
+        oListener?: object
+      ): this;
       /**
        * Fires event {@link #event:liveChange liveChange} to attached listeners.
        *
@@ -88900,6 +89030,20 @@ declare namespace sap {
          */
         mParameters?: sap.m.MaskInput$LiveChangeEventParameters
       ): this;
+      /**
+       * Fires event {@link #event:submit submit} to attached listeners.
+       *
+       * @since 1.131.0
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      fireSubmit(
+        /**
+         * Parameters to pass along with the event
+         */
+        mParameters?: sap.m.MaskInput$SubmitEventParameters
+      ): this;
       /**
        * Gets current value of property {@link #getMask mask}.
        *
@@ -89273,6 +89417,57 @@ declare namespace sap {
          */
         oItem: sap.m.IMenuItem
       ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:beforeClose beforeClose} event of this `sap.m.Menu`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.Menu` itself.
+       *
+       * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
+       * closing.
+       *
+       * @since 1.131
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachBeforeClose(
+        /**
+         * An application-specific payload object that will be passed to the event handler along with the event
+         * object when firing the event
+         */
+        oData: object,
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.Menu` itself
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:beforeClose beforeClose} event of this `sap.m.Menu`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.Menu` itself.
+       *
+       * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
+       * closing.
+       *
+       * @since 1.131
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachBeforeClose(
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.Menu` itself
+         */
+        oListener?: object
+      ): this;
       /**
        * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.m.Menu`.
        *
@@ -89393,6 +89588,25 @@ declare namespace sap {
        * @returns Reference to `this` in order to allow method chaining
        */
       destroyItems(): this;
+      /**
+       * Detaches event handler `fnFunction` from the {@link #event:beforeClose beforeClose} event of this `sap.m.Menu`.
+       *
+       * The passed function and listener object must match the ones used for event registration.
+       *
+       * @since 1.131
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      detachBeforeClose(
+        /**
+         * The function to be called, when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object on which the given function had to be called
+         */
+        oListener?: object
+      ): this;
       /**
        * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.m.Menu`.
        *
@@ -89429,6 +89643,23 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Fires event {@link #event:beforeClose beforeClose} to attached listeners.
+       *
+       * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+       * event object. The return value of this method indicates whether the default action should be executed.
+       *
+       * @since 1.131
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
+       * @returns Whether or not to prevent the default action
+       */
+      fireBeforeClose(
+        /**
+         * Parameters to pass along with the event
+         */
+        mParameters?: object
+      ): boolean;
       /**
        * Fires event {@link #event:closed closed} to attached listeners.
        *
@@ -90378,6 +90609,20 @@ declare namespace sap {
        * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.core.ElementMetadata;
+      /**
+       * Adds some endContent to the aggregation {@link #getEndContent endContent}.
+       *
+       * @since 1.131
+       * @experimental
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      addEndContent(
+        /**
+         * The endContent to add; if empty, nothing is inserted
+         */
+        oEndContent: sap.ui.core.Control
+      ): this;
       /**
        * Adds some item to the aggregation {@link #getItems items}.
        *
@@ -90550,6 +90795,15 @@ declare namespace sap {
          */
         oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo
       ): this;
+      /**
+       * Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
+       *
+       * @since 1.131
+       * @experimental
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      destroyEndContent(): this;
       /**
        * Destroys all the items in the aggregation {@link #getItems items}.
        *
@@ -90652,6 +90906,16 @@ declare namespace sap {
          */
         mParameters?: sap.m.MenuItem$PropertyChangedEventParameters
       ): this;
+      /**
+       * Gets content of aggregation {@link #getEndContent endContent}.
+       *
+       * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
+       * of custom elements, such as icons and buttons.
+       *
+       * @since 1.131
+       * @experimental
+       */
+      getEndContent(): sap.ui.core.Control[];
       /**
        * Gets current value of property {@link #getIcon icon}.
        *
@@ -90717,6 +90981,21 @@ declare namespace sap {
        * @returns Value of property `visible`
        */
       getVisible(): boolean;
+      /**
+       * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
+       * returns its index if found or -1 otherwise.
+       *
+       * @since 1.131
+       * @experimental
+       *
+       * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+       */
+      indexOfEndContent(
+        /**
+         * The endContent whose index is looked for
+         */
+        oEndContent: sap.ui.core.Control
+      ): int;
       /**
        * Checks for the provided `sap.m.IMenuItem` in the aggregation {@link #getItems items}. and returns its
        * index if found or -1 otherwise.
@@ -90730,6 +91009,26 @@ declare namespace sap {
          */
         oItem: sap.m.IMenuItem
       ): int;
+      /**
+       * Inserts a endContent into the aggregation {@link #getEndContent endContent}.
+       *
+       * @since 1.131
+       * @experimental
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      insertEndContent(
+        /**
+         * The endContent to insert; if empty, nothing is inserted
+         */
+        oEndContent: sap.ui.core.Control,
+        /**
+         * The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
+         * is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
+         * is inserted at the last position
+         */
+        iIndex: int
+      ): this;
       /**
        * Inserts a item into the aggregation {@link #getItems items}.
        *
@@ -90748,6 +91047,17 @@ declare namespace sap {
          */
         iIndex: int
       ): this;
+      /**
+       * Removes all the controls from the aggregation {@link #getEndContent endContent}.
+       *
+       * Additionally, it unregisters them from the hosting UIArea.
+       *
+       * @since 1.131
+       * @experimental
+       *
+       * @returns An array of the removed elements (might be empty)
+       */
+      removeAllEndContent(): sap.ui.core.Control[];
       /**
        * Removes all the controls from the aggregation {@link #getItems items}.
        *
@@ -90757,6 +91067,20 @@ declare namespace sap {
        * @returns An array of the removed elements (might be empty)
        */
       removeAllItems(): sap.m.IMenuItem[];
+      /**
+       * Removes a endContent from the aggregation {@link #getEndContent endContent}.
+       *
+       * @since 1.131
+       * @experimental
+       *
+       * @returns The removed endContent or `null`
+       */
+      removeEndContent(
+        /**
+         * The endContent to remove or its index or id
+         */
+        vEndContent: int | string | sap.ui.core.Control
+      ): sap.ui.core.Control | null;
       /**
        * Removes a item from the aggregation {@link #getItems items}.
        *
@@ -103671,7 +103995,6 @@ declare namespace sap {
      * 	 - {@link sap.m.ComboBox}
      * 	 - {@link sap.m.DatePicker}
      * 	 - {@link sap.m.DateRangeSelection}
-     * 	 - {@link sap.m.DateTimeInput}
      * 	 - {@link sap.m.DateTimePicker}
      * 	 - {@link sap.m.GenericTag}
      * 	 - {@link sap.m.Input}
@@ -105005,7 +105328,6 @@ declare namespace sap {
      *
      * @since 1.26.0
      * @deprecated (since 1.124) - replaced by the artifacts in {@link sap.m.p13n}.
-     * @experimental (since 1.26) - !!! THIS CONTROL IS ONLY FOR INTERNAL USE !!!
      */
     class P13nConditionPanel extends sap.ui.core.Control {
       /**
@@ -107112,7 +107434,6 @@ declare namespace sap {
        *
        * Event raised if a filter item has been changed. reason can be added, updated or removed.
        *
-       * @experimental (since 1.56)
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -107140,7 +107461,6 @@ declare namespace sap {
        *
        * Event raised if a filter item has been changed. reason can be added, updated or removed.
        *
-       * @experimental (since 1.56)
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -107306,7 +107626,6 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
-       * @experimental (since 1.56)
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -107374,7 +107693,6 @@ declare namespace sap {
       /**
        * Fires event {@link #event:filterItemChanged filterItemChanged} to attached listeners.
        *
-       * @experimental (since 1.56)
        * @ui5-protected Do not call from applications (only from related classes in the framework)
        *
        * @returns Reference to `this` in order to allow method chaining
@@ -118744,6 +119062,7 @@ declare namespace sap {
        *
        * Default value is `true`.
        *
+       * @deprecated (since 1.130) - with no replacement.
        *
        * @returns Value of property `enabled`
        */
@@ -118926,6 +119245,7 @@ declare namespace sap {
        *
        * Default value is `true`.
        *
+       * @deprecated (since 1.130) - with no replacement.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -162992,8 +163312,6 @@ declare namespace sap {
      * undefined
      *
      * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'P13nConditionOperation'.
-     *
-     * @experimental (since 1.26) - !!! THIS TYPE IS ONLY FOR INTERNAL USE !!!
      */
     enum P13nConditionOperation {
       Ascending = "Ascending",
@@ -165477,6 +165795,22 @@ declare namespace sap {
       MaskInput
     >;
 
+    /**
+     * Event object of the MaskInput#submit event.
+     */
+    type MaskInput$SubmitEvent = sap.ui.base.Event<
+      MaskInput$SubmitEventParameters,
+      MaskInput
+    >;
+
+    /**
+     * Event object of the Menu#beforeClose event.
+     */
+    type Menu$BeforeCloseEvent = sap.ui.base.Event<
+      Menu$BeforeCloseEventParameters,
+      Menu
+    >;
+
     /**
      * Event object of the Menu#closed event.
      */
@@ -165916,8 +166250,6 @@ declare namespace sap {
 
     /**
      * Event object of the P13nFilterPanel#filterItemChanged event.
-     *
-     * @experimental (since 1.56)
      */
     type P13nFilterPanel$FilterItemChangedEvent = sap.ui.base.Event<
       P13nFilterPanel$FilterItemChangedEventParameters,

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare namespace sap {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare namespace sap {
   namespace ui {