@sapui5/ts-types 1.140.0 → 1.141.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare module "sap/ui/mdc/AggregationBaseDelegate" {
   import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -1830,9 +1830,9 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
      * If an update is not possible, it rebinds the table.
      *
      * Compares the current and previous state of the table to detect whether rebinding is necessary. The diffing
-     * is done for the sorters, filters, aggregation, parameters. Other {@link sap.ui.base.ManagedObject.AggregationBindingInfo binding info }
-     * keys, such as `path`, `events`, or `model`, must be provided in `updateBindingInfo`, and those keys must
-     * not be changed conditionally.
+     * is done for the sorters, filters, aggregation, parameters, and the path of the binding. Other {@link sap.ui.base.ManagedObject.AggregationBindingInfo binding info }
+     * keys, such as `events` or `model`, must be provided in `updateBindingInfo`, and those keys must not be
+     * changed conditionally.
      *
      * **Note:** To remove a binding info parameter, the value must be set to `undefined` in `updateBindingInfo`.
      * For more information, see {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters}.

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare namespace sap {
   namespace ui {
@@ -275,8 +275,8 @@ declare namespace sap {
 
         /**
          * Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
-         * only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is enabled
-         * and all the requirements are fulfilled.
+         * only sap.m.Button is allowed. **Note:** customButtons are available only when the `customToolbar` is
+         * enabled and all the requirements are fulfilled.
          *
          * @since 1.48
          */
@@ -286,6 +286,18 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.AggregationBindingInfo
           | `{${string}}`;
 
+        /**
+         * Custom font families that can be used in the `RichTextEditor`. **Note:** Custom fonts are available only
+         * when the `customToolbar` is enabled.
+         *
+         * @since 1.141
+         */
+        customFonts?:
+          | sap.ui.richtexteditor.RichTextEditorFontFamily[]
+          | sap.ui.richtexteditor.RichTextEditorFontFamily
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
+
         /**
          * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
          *
@@ -321,6 +333,35 @@ declare namespace sap {
         beforeEditorInit?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the RichTextEditorFontFamily constructor.
+       */
+      interface $RichTextEditorFontFamilySettings
+        extends sap.ui.core.$ElementSettings {
+        /**
+         * Used to identify the font in the editor. Names should be unique and descriptive.
+         */
+        name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * The text displayed in the font family dropdown.
+         */
+        text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * The value of the font family. CSS font-family value that will be applied to the text.
+         */
+        value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * Used to load the font. The URL should point to a CSS file that defines the font-face.
+         */
+        url?:
+          | sap.ui.core.URI
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+      }
+
       /**
        * Parameters of the RichTextEditor#beforeEditorInit event.
        */
@@ -564,6 +605,19 @@ declare namespace sap {
            */
           oCustomButton: sap.ui.core.Control
         ): this;
+        /**
+         * Adds some customFont to the aggregation {@link #getCustomFonts customFonts}.
+         *
+         * @since 1.141
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        addCustomFont(
+          /**
+           * The customFont to add; if empty, nothing is inserted
+           */
+          oCustomFont: sap.ui.richtexteditor.RichTextEditorFontFamily
+        ): this;
         /**
          * Allows to add a plugin (that must already be installed on the server) to the RichTextEditor.
          *
@@ -798,6 +852,14 @@ declare namespace sap {
          * @returns Reference to `this` in order to allow method chaining
          */
         destroyCustomButtons(): this;
+        /**
+         * Destroys all the customFonts in the aggregation {@link #getCustomFonts customFonts}.
+         *
+         * @since 1.141
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        destroyCustomFonts(): this;
         /**
          * Destroys the footer in the aggregation {@link #getFooter footer}.
          *
@@ -960,12 +1022,21 @@ declare namespace sap {
          * Gets content of aggregation {@link #getCustomButtons customButtons}.
          *
          * Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
-         * only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is enabled
-         * and all the requirements are fulfilled.
+         * only sap.m.Button is allowed. **Note:** customButtons are available only when the `customToolbar` is
+         * enabled and all the requirements are fulfilled.
          *
          * @since 1.48
          */
         getCustomButtons(): sap.ui.core.Control[];
+        /**
+         * Gets content of aggregation {@link #getCustomFonts customFonts}.
+         *
+         * Custom font families that can be used in the `RichTextEditor`. **Note:** Custom fonts are available only
+         * when the `customToolbar` is enabled.
+         *
+         * @since 1.141
+         */
+        getCustomFonts(): sap.ui.richtexteditor.RichTextEditorFontFamily[];
         /**
          * Gets current value of property {@link #getCustomToolbar customToolbar}.
          *
@@ -1297,6 +1368,20 @@ declare namespace sap {
            */
           oCustomButton: sap.ui.core.Control
         ): int;
+        /**
+         * Checks for the provided `sap.ui.richtexteditor.RichTextEditorFontFamily` in the aggregation {@link #getCustomFonts customFonts}.
+         * and returns its index if found or -1 otherwise.
+         *
+         * @since 1.141
+         *
+         * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+         */
+        indexOfCustomFont(
+          /**
+           * The customFont whose index is looked for
+           */
+          oCustomFont: sap.ui.richtexteditor.RichTextEditorFontFamily
+        ): int;
         /**
          * Inserts a customButton into the aggregation {@link #getCustomButtons customButtons}.
          *
@@ -1316,6 +1401,25 @@ declare namespace sap {
            */
           iIndex: int
         ): this;
+        /**
+         * Inserts a customFont into the aggregation {@link #getCustomFonts customFonts}.
+         *
+         * @since 1.141
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        insertCustomFont(
+          /**
+           * The customFont to insert; if empty, nothing is inserted
+           */
+          oCustomFont: sap.ui.richtexteditor.RichTextEditorFontFamily,
+          /**
+           * The `0`-based index the customFont should be inserted at; for a negative value of `iIndex`, the customFont
+           * is inserted at position 0; for a value greater than the current size of the aggregation, the customFont
+           * is inserted at the last position
+           */
+          iIndex: int
+        ): this;
         /**
          * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
          *
@@ -1334,6 +1438,16 @@ declare namespace sap {
          * @returns An array of the removed elements (might be empty)
          */
         removeAllCustomButtons(): sap.ui.core.Control[];
+        /**
+         * Removes all the controls from the aggregation {@link #getCustomFonts customFonts}.
+         *
+         * Additionally, it unregisters them from the hosting UIArea.
+         *
+         * @since 1.141
+         *
+         * @returns An array of the removed elements (might be empty)
+         */
+        removeAllCustomFonts(): sap.ui.richtexteditor.RichTextEditorFontFamily[];
         /**
          * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
          *
@@ -1372,6 +1486,22 @@ declare namespace sap {
            */
           vCustomButton: int | string | sap.ui.core.Control
         ): sap.ui.core.Control | null;
+        /**
+         * Removes a customFont from the aggregation {@link #getCustomFonts customFonts}.
+         *
+         * @since 1.141
+         *
+         * @returns The removed customFont or `null`
+         */
+        removeCustomFont(
+          /**
+           * The customFont to remove or its index or id
+           */
+          vCustomFont:
+            | int
+            | string
+            | sap.ui.richtexteditor.RichTextEditorFontFamily
+        ): sap.ui.richtexteditor.RichTextEditorFontFamily | null;
         /**
          * Removes the plugin with the given name/ID from the list of plugins to load
          *
@@ -1835,6 +1965,176 @@ declare namespace sap {
           bWrapping?: boolean
         ): this;
       }
+      /**
+       * Represents a font family option for `RichTextEditor`.
+       */
+      class RichTextEditorFontFamily extends sap.ui.core.Element {
+        /**
+         * Constructor for a new `RichTextEditorFontFamily`.
+         *
+         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+         * of the syntax of the settings object.
+         */
+        constructor(
+          /**
+           * initial settings for the new control
+           */
+          mSettings?: sap.ui.richtexteditor.$RichTextEditorFontFamilySettings
+        );
+        /**
+         * Constructor for a new `RichTextEditorFontFamily`.
+         *
+         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+         * of the syntax of the settings object.
+         */
+        constructor(
+          /**
+           * id for the new control, generated automatically if no id is given
+           */
+          sId?: string,
+          /**
+           * initial settings for the new control
+           */
+          mSettings?: sap.ui.richtexteditor.$RichTextEditorFontFamilySettings
+        );
+
+        /**
+         * Creates a new subclass of class sap.ui.richtexteditor.RichTextEditorFontFamily with name `sClassName`
+         * and enriches it with the information contained in `oClassInfo`.
+         *
+         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
+         *
+         *
+         * @returns Created class / constructor function
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<
+            T,
+            sap.ui.richtexteditor.RichTextEditorFontFamily
+          >,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Returns a metadata object for class sap.ui.richtexteditor.RichTextEditorFontFamily.
+         *
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.core.ElementMetadata;
+        /**
+         * Gets current value of property {@link #getName name}.
+         *
+         * Used to identify the font in the editor. Names should be unique and descriptive.
+         *
+         *
+         * @returns Value of property `name`
+         */
+        getName(): string;
+        /**
+         * Gets current value of property {@link #getText text}.
+         *
+         * The text displayed in the font family dropdown.
+         *
+         *
+         * @returns Value of property `text`
+         */
+        getText(): string;
+        /**
+         * Gets current value of property {@link #getUrl url}.
+         *
+         * Used to load the font. The URL should point to a CSS file that defines the font-face.
+         *
+         *
+         * @returns Value of property `url`
+         */
+        getUrl(): sap.ui.core.URI;
+        /**
+         * Gets current value of property {@link #getValue value}.
+         *
+         * The value of the font family. CSS font-family value that will be applied to the text.
+         *
+         *
+         * @returns Value of property `value`
+         */
+        getValue(): string;
+        /**
+         * Sets a new value for property {@link #getName name}.
+         *
+         * Used to identify the font in the editor. Names should be unique and descriptive.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setName(
+          /**
+           * New value for property `name`
+           */
+          sName?: string
+        ): this;
+        /**
+         * Sets a new value for property {@link #getText text}.
+         *
+         * The text displayed in the font family dropdown.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setText(
+          /**
+           * New value for property `text`
+           */
+          sText?: string
+        ): this;
+        /**
+         * Sets a new value for property {@link #getUrl url}.
+         *
+         * Used to load the font. The URL should point to a CSS file that defines the font-face.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setUrl(
+          /**
+           * New value for property `url`
+           */
+          sUrl?: sap.ui.core.URI
+        ): this;
+        /**
+         * Sets a new value for property {@link #getValue value}.
+         *
+         * The value of the font family. CSS font-family value that will be applied to the text.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setValue(
+          /**
+           * New value for property `value`
+           */
+          sValue?: string
+        ): this;
+      }
       /**
        * Determines which editor component should be used for editing the text.
        *
@@ -1846,10 +2146,6 @@ declare namespace sap {
          * Uses latest recommended TinyMCE version Current one is TinyMCE 7
          */
         TinyMCE = "TinyMCE",
-        /**
-         * Uses TinyMCE version 6 as editor
-         */
-        TinyMCE6 = "TinyMCE6",
         /**
          * Uses TinyMCE version 7 as editor
          */
@@ -1893,5 +2189,7 @@ declare namespace sap {
     "sap/ui/richtexteditor/library": undefined;
 
     "sap/ui/richtexteditor/RichTextEditor": undefined;
+
+    "sap/ui/richtexteditor/RichTextEditorFontFamily": undefined;
   }
 }

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare module "sap/ui/rta/api/startAdaptation" {
   /**

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

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare namespace sap {
   namespace ui {
@@ -640,6 +640,10 @@ declare namespace sap {
          *
          * For details about data aggregation, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
          *
+         * In combination with the {@link sap.ui.table.Table Table} control, this plugin offers a UI for OData V4
+         * that is similar to the one the {@link sap.ui.table.AnalyticalTable AnalyticalTable} offers for OData
+         * V2.
+         *
          * @since 1.140
          */
         class ODataV4Aggregation extends sap.ui.core.Element {
@@ -775,6 +779,9 @@ declare namespace sap {
          *
          * For details about hierarchies, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
          *
+         * In combination with the {@link sap.ui.table.Table Table} control, this plugin offers a UI for OData V4
+         * that is similar to the one the {@link sap.ui.table.TreeTable TreeTable} offers for other models.
+         *
          * @since 1.140
          */
         class ODataV4Hierarchy extends sap.ui.core.Element {
@@ -4383,9 +4390,11 @@ declare namespace sap {
         static getMetadata(): sap.ui.core.ElementMetadata;
       }
       /**
-       * Table that handles analytical OData back-end scenarios. The `AnalyticalTable` only works with {@link sap.ui.model.analytics.AnalyticalBinding AnalyticalBinding }
+       * Table that handles analytical OData V2 back-end scenarios. The `AnalyticalTable` only works with {@link sap.ui.model.analytics.AnalyticalBinding AnalyticalBinding }
        * and correctly annotated OData services. Please check out the functionality of analytical binding and
-       * the SAP Annotations for OData Version 2.0 documentation for further details.
+       * the SAP Annotations for OData Version 2.0 documentation for further details. For an analytical-table-like
+       * behavior with OData V4 services, use the {@link sap.ui.table.Table Table} control with the {@link sap.ui.table.plugins.ODataV4Aggregation ODataV4Aggregation }
+       * plugin.
        */
       class AnalyticalTable extends sap.ui.table.Table {
         /**
@@ -4396,6 +4405,7 @@ declare namespace sap {
          * of the syntax of the settings object.
          * See:
          * 	https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
+         * 	{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}
          * 	{@link https://ui5.sap.com/#/topic/08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
          * 	{@link fiori:/analytical-table-alv/ Analytical Table}
          */
@@ -4413,6 +4423,7 @@ declare namespace sap {
          * of the syntax of the settings object.
          * See:
          * 	https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
+         * 	{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}
          * 	{@link https://ui5.sap.com/#/topic/08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
          * 	{@link fiori:/analytical-table-alv/ Analytical Table}
          */
@@ -10989,7 +11000,10 @@ declare namespace sap {
         ): this;
       }
       /**
-       * The TreeTable control provides a comprehensive set of features to display hierarchical data.
+       * The TreeTable control provides a comprehensive set of features to display hierarchical data. The control
+       * can be used in combination with {@link sap.ui.model.json.JSONModel JSONModel} and {@link sap.ui.model.odata.v2.ODataModel ODataModel V2}.
+       * For a tree-table-like behavior with OData V4 services, use the {@link sap.ui.table.Table Table} control
+       * with the {@link sap.ui.table.plugins.ODataV4Hierarchy ODataV4Hierarchy} plugin.
        */
       class TreeTable extends sap.ui.table.Table {
         /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare namespace sap {
   namespace ui {
@@ -6158,6 +6158,12 @@ declare namespace sap {
          * 	 - Do not use interactive controls as content, as they may trigger unwanted selection of the appointment
          *     and may lead to unpredictable results.
          *
+         * **Note:** When using the `customContent` aggregation, it is the application developer's responsibility
+         * to add appropriate labels to the `ariaLabelledBy` association to provide accessible information about
+         * this appointment as the standard properties (`title`, `text`, `description`, and `icon`) are ignored,
+         * which means screen readers will have no information about the appointment unless proper ARIA labeling
+         * is implemented.
+         *
          * @since 1.93.0
          */
         customContent?:
@@ -6165,6 +6171,11 @@ declare namespace sap {
           | sap.ui.core.Control
           | sap.ui.base.ManagedObject.AggregationBindingInfo
           | `{${string}}`;
+
+        /**
+         * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledBy).
+         */
+        ariaLabelledBy?: Array<sap.ui.core.Control | string>;
       }
 
       /**
@@ -10145,6 +10156,18 @@ declare namespace sap {
          * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
+        /**
+         * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        addAriaLabelledBy(
+          /**
+           * The ariaLabelledBy to add; if empty, nothing is inserted
+           */
+          vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control
+        ): this;
         /**
          * Adds some customContent to the aggregation {@link #getCustomContent customContent}.
          *
@@ -10166,6 +10189,10 @@ declare namespace sap {
          * @returns Reference to `this` in order to allow method chaining
          */
         destroyCustomContent(): this;
+        /**
+         * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
+         */
+        getAriaLabelledBy(): sap.ui.core.ID[];
         /**
          * Gets current value of property {@link #getColor color}.
          *
@@ -10191,6 +10218,12 @@ declare namespace sap {
          * 	 - Do not use interactive controls as content, as they may trigger unwanted selection of the appointment
          *     and may lead to unpredictable results.
          *
+         * **Note:** When using the `customContent` aggregation, it is the application developer's responsibility
+         * to add appropriate labels to the `ariaLabelledBy` association to provide accessible information about
+         * this appointment as the standard properties (`title`, `text`, `description`, and `icon`) are ignored,
+         * which means screen readers will have no information about the appointment unless proper ARIA labeling
+         * is implemented.
+         *
          * @since 1.93.0
          */
         getCustomContent(): sap.ui.core.Control[];
@@ -10297,6 +10330,13 @@ declare namespace sap {
            */
           iIndex: int
         ): this;
+        /**
+         * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         *
+         * @returns An array of the removed elements (might be empty)
+         */
+        removeAllAriaLabelledBy(): sap.ui.core.ID[];
         /**
          * Removes all the controls from the aggregation {@link #getCustomContent customContent}.
          *
@@ -10307,6 +10347,18 @@ declare namespace sap {
          * @returns An array of the removed elements (might be empty)
          */
         removeAllCustomContent(): sap.ui.core.Control[];
+        /**
+         * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         *
+         * @returns The removed ariaLabelledBy or `null`
+         */
+        removeAriaLabelledBy(
+          /**
+           * The ariaLabelledBy to be removed or its index or ID
+           */
+          vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
+        ): sap.ui.core.ID | null;
         /**
          * Removes a customContent from the aggregation {@link #getCustomContent customContent}.
          *

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

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

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

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