@sapui5/ts-types-esm 1.140.0 → 1.141.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare module "sap/ui/richtexteditor/library" {
   /**
@@ -12,10 +12,6 @@ declare module "sap/ui/richtexteditor/library" {
      * 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
      */
@@ -36,6 +32,8 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
 
   import { ID, CSSSize, TextDirection } from "sap/ui/core/library";
 
+  import RichTextEditorFontFamily from "sap/ui/richtexteditor/RichTextEditorFontFamily";
+
   import Event from "sap/ui/base/Event";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -263,6 +261,19 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
        */
       oCustomButton: 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: RichTextEditorFontFamily
+    ): this;
     /**
      * Allows to add a plugin (that must already be installed on the server) to the RichTextEditor.
      *
@@ -497,6 +508,14 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
      * @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}.
      *
@@ -659,12 +678,21 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
      * 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(): 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(): RichTextEditorFontFamily[];
     /**
      * Gets current value of property {@link #getCustomToolbar customToolbar}.
      *
@@ -996,6 +1024,20 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
        */
       oCustomButton: 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: RichTextEditorFontFamily
+    ): int;
     /**
      * Inserts a customButton into the aggregation {@link #getCustomButtons customButtons}.
      *
@@ -1015,6 +1057,25 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
        */
       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: 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}.
      *
@@ -1033,6 +1094,16 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
      * @returns An array of the removed elements (might be empty)
      */
     removeAllCustomButtons(): 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(): RichTextEditorFontFamily[];
     /**
      * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
      *
@@ -1071,6 +1142,19 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
        */
       vCustomButton: int | string | Control
     ): 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 | RichTextEditorFontFamily
+    ): RichTextEditorFontFamily | null;
     /**
      * Removes the plugin with the given name/ID from the list of plugins to load
      *
@@ -1737,8 +1821,8 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
 
     /**
      * 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
      */
@@ -1748,6 +1832,18 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
       | 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?:
+      | RichTextEditorFontFamily[]
+      | RichTextEditorFontFamily
+      | AggregationBindingInfo
+      | `{${string}}`;
+
     /**
      * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
      *
@@ -1841,10 +1937,214 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
   >;
 }
 
+declare module "sap/ui/richtexteditor/RichTextEditorFontFamily" {
+  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
+
+  import { URI } from "sap/ui/core/library";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * Represents a font family option for `RichTextEditor`.
+   */
+  export default class RichTextEditorFontFamily extends UI5Element {
+    /**
+     * 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?: $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?: $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, 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(): 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(): 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?: 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;
+  }
+  /**
+   * Describes the settings that can be provided to the RichTextEditorFontFamily constructor.
+   */
+  export interface $RichTextEditorFontFamilySettings extends $ElementSettings {
+    /**
+     * Used to identify the font in the editor. Names should be unique and descriptive.
+     */
+    name?: string | PropertyBindingInfo;
+
+    /**
+     * The text displayed in the font family dropdown.
+     */
+    text?: string | PropertyBindingInfo;
+
+    /**
+     * The value of the font family. CSS font-family value that will be applied to the text.
+     */
+    value?: string | PropertyBindingInfo;
+
+    /**
+     * Used to load the font. The URL should point to a CSS file that defines the font-face.
+     */
+    url?: URI | PropertyBindingInfo | `{${string}}`;
+  }
+}
+
 declare namespace sap {
   interface IUI5DefineDependencyNames {
     "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" {
   import Control from "sap/ui/core/Control";

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

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare module "sap/ui/table/library" {
   import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -619,9 +619,11 @@ declare module "sap/ui/table/AnalyticalTable" {
   import Event from "sap/ui/base/Event";
 
   /**
-   * 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.
    */
   export default class AnalyticalTable extends Table {
     /**
@@ -632,6 +634,7 @@ declare module "sap/ui/table/AnalyticalTable" {
      * 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}
      */
@@ -649,6 +652,7 @@ declare module "sap/ui/table/AnalyticalTable" {
      * 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}
      */
@@ -3584,6 +3588,10 @@ declare module "sap/ui/table/plugins/ODataV4Aggregation" {
    *
    * 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
    */
   export default class ODataV4Aggregation extends UI5Element {
@@ -3748,6 +3756,9 @@ declare module "sap/ui/table/plugins/ODataV4Hierarchy" {
    *
    * 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
    */
   export default class ODataV4Hierarchy extends UI5Element {
@@ -11231,7 +11242,10 @@ declare module "sap/ui/table/TreeTable" {
   import Event from "sap/ui/base/Event";
 
   /**
-   * 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.
    */
   export default class TreeTable extends 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 module "sap/ui/testrecorder/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.140.0
+// For Library Version: 1.141.0
 
 declare module "sap/ui/unified/library" {
   /**
@@ -7657,9 +7657,9 @@ declare module "sap/ui/unified/CalendarAppointment" {
     $DateTypeRangeSettings,
   } from "sap/ui/unified/DateTypeRange";
 
-  import Control from "sap/ui/core/Control";
+  import { ID, CSSColor, URI } from "sap/ui/core/library";
 
-  import { CSSColor, URI } from "sap/ui/core/library";
+  import Control from "sap/ui/core/Control";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
@@ -7739,6 +7739,18 @@ declare module "sap/ui/unified/CalendarAppointment" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): 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: ID | Control
+    ): this;
     /**
      * Adds some customContent to the aggregation {@link #getCustomContent customContent}.
      *
@@ -7760,6 +7772,10 @@ declare module "sap/ui/unified/CalendarAppointment" {
      * @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(): ID[];
     /**
      * Gets current value of property {@link #getColor color}.
      *
@@ -7785,6 +7801,12 @@ declare module "sap/ui/unified/CalendarAppointment" {
      * 	 - 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(): Control[];
@@ -7891,6 +7913,13 @@ declare module "sap/ui/unified/CalendarAppointment" {
        */
       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(): ID[];
     /**
      * Removes all the controls from the aggregation {@link #getCustomContent customContent}.
      *
@@ -7901,6 +7930,18 @@ declare module "sap/ui/unified/CalendarAppointment" {
      * @returns An array of the removed elements (might be empty)
      */
     removeAllCustomContent(): 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 | ID | Control
+    ): ID | null;
     /**
      * Removes a customContent from the aggregation {@link #getCustomContent customContent}.
      *
@@ -8115,6 +8156,12 @@ declare module "sap/ui/unified/CalendarAppointment" {
      * 	 - 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?:
@@ -8122,6 +8169,11 @@ declare module "sap/ui/unified/CalendarAppointment" {
       | Control
       | AggregationBindingInfo
       | `{${string}}`;
+
+    /**
+     * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledBy).
+     */
+    ariaLabelledBy?: Array<Control | string>;
   }
 }
 

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

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

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

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