@sapui5/ts-types 1.101.1 → 1.102.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   namespace ui {
@@ -29,14 +29,16 @@ declare namespace sap {
          */
         textDirection?:
           | sap.ui.core.TextDirection
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Width of RichTextEditor control in CSS units.
          */
         width?:
           | sap.ui.core.CSSSize
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
@@ -44,7 +46,8 @@ declare namespace sap {
          */
         height?:
           | sap.ui.core.CSSSize
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * The editor implementation to use.
@@ -71,89 +74,134 @@ declare namespace sap {
          * Determines whether the editor content can be modified by the user. When set to "false" there might not
          * be any editor toolbar.
          */
-        editable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        editable?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
-         * is available. Changing this after the initial rendering will result in some visible redrawing.
+         * is available. Changing this after the initial rendering will result in some visible redrawing. Note:
+         * This property will not be synchronized with group configuration provided via the buttonGroups property
+         * or when groups are added on a later stage.
          */
         showGroupFontStyle?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing text alignment commands is available. Changing
-         * this after the initial rendering will result in some visible redrawing.
+         * this after the initial rendering will result in some visible redrawing. Note: This property will not
+         * be synchronized with group configuration provided via the buttonGroups property or when groups are added
+         * on a later stage.
          */
         showGroupTextAlign?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          */
         showGroupStructure?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          */
-        showGroupFont?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        showGroupFont?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          */
         showGroupClipboard?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
-         * available. Changing this after the initial rendering will result in some visible redrawing.
+         * available. Changing this after the initial rendering will result in some visible redrawing. Note: This
+         * property will not be synchronized with group configuration provided via the buttonGroups property or
+         * when groups are added on a later stage.
          */
         showGroupInsert?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          */
-        showGroupLink?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        showGroupLink?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
-         * this after the initial rendering will result in some visible redrawing.
+         * this after the initial rendering will result in some visible redrawing. Note: This property will not
+         * be synchronized with group configuration provided via the buttonGroups property or when groups are added
+         * on a later stage.
          */
-        showGroupUndo?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        showGroupUndo?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether the text in the editor is wrapped. This does not affect the editor's value, only the
          * representation in the control.
          */
-        wrapping?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        wrapping?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether a value is required.
          */
-        required?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        required?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Determines whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure
          * allowed URLs please use the validator API via {@link module:sap/base/security/URLListValidator#add URLListValidator
          * API}.
          */
-        sanitizeValue?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        sanitizeValue?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * An array of plugin configuration objects with the obligatory property "name". Each object has to contain
          * a property "name" which then contains the plugin name/ID.
          */
-        plugins?: object[] | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        plugins?:
+          | object[]
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * @deprecated (since 1.97.0) - This property became obsolete after the deprecation of TinyMCE v3.
@@ -165,7 +213,8 @@ declare namespace sap {
          */
         useLegacyTheme?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * An array of button configurations. These configurations contain the names of buttons as array in the
@@ -173,11 +222,14 @@ declare namespace sap {
          * should be placed, a "priority" and whether the buttons are "visible". See method addButtonGroup() for
          * more details on the structure of the objects in this array. **Note:** `buttonGroups` is a feature from
          * the native editor. Its supported scope with `customToolbar` is limited up to the grouping- the user could
-         * turn on/off a whole group, but modifiyng buttons within a group is not possible. In order to achieve
+         * turn on/off a whole group, but modifying buttons within a group is not possible. In order to achieve
          * that functionality with `customToolbar`, the developer needs to turn the group off and instantiate their
          * own `sap.m.Button`(s) with the desired functionality.
          */
-        buttonGroups?: object[] | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        buttonGroups?:
+          | object[]
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * @SINCE 1.48
@@ -187,7 +239,10 @@ declare namespace sap {
          * property will have effect only on initial loading. Changing it during runtime will not affect the initially
          * loaded toolbar.
          */
-        customToolbar?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        customToolbar?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * @SINCE 1.48
@@ -199,7 +254,8 @@ declare namespace sap {
         customButtons?:
           | sap.ui.core.Control[]
           | sap.ui.core.Control
-          | sap.ui.base.ManagedObject.AggregationBindingInfo;
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
 
         /**
          * @SINCE 1.76.0
@@ -273,6 +329,46 @@ declare namespace sap {
        * 			text area} instead.
        * 	 - Use callbacks to the native third-party API with care, as there may be compatibility issues with
        * 			later versions.
+       *
+       * Custom toolbar - adding and removing buttons: With version 1.102 it is possible to redefine the button
+       * groups configuration in order to show only particular set of buttons in the custom toolbar of the `RichTextEditor`.
+       * This is possible in few ways:
+       * 	 - By providing the buttons group configurations as a whole by setting the `buttonGroups` property of
+       * 			the control.
+       * 	 - By providing individual button group configuration via `addButtonGroup` method.
+       *
+       * Consider the following when choosing your approach:
+       * 	 - Setting `buttonGroups` will override all current custom toolbar button group configurations. This
+       * 			method allows for total redefining of the custom toolbar groups.
+       * 	 - Using `addButtonGroups` will try to add non-existing group into the configuration array, however,
+       * 			if such group configuration exists already, a warning will be logged and the new configuration will not
+       * 			be added. In order to replace the existing configuration you will need to remove it first via `removeButtonGroup`.
+       *
+       *
+       * Below is a list of supported groups and buttons, which can be specified in the configuration objects
+       * (format is <>: <>):
+       * 	 - font-style: bold, italic, underline, strikethrough
+       * 	 - font: fontselect, fontsizeselect, forecolor, backcolor
+       * 	 - clipboard: cut, copy, paste
+       * 	 - structure: bullist, numlist, outdent, indent
+       * 	 - undo: undo, redo
+       * 	 - insert: image, emoticons
+       * 	 - link: link, unlink
+       * 	 - text-align: alignleft, aligncenter, alignright, alignjustify  Additional supported groups, which
+       * 			can be added only after the editor is loaded (they can not be specified in the above mentioned configuration):
+       *
+       * 	 - table: table
+       * 	 - styleselect: styleselect  **Note!** Adding configuration for "text-align" group with any buttons
+       * 			will still render a menu button with all available options inside. Removing/hiding the group can be achieved
+       * 			by invoking `removeButtonGroup` or `setShowGroupTextAlign(false)` depending on the desired result.
+       *
+       * **Note!** There is no synchronization between the `setShowGroup*` properties and the configuration object
+       * that the application can specifying via `buttonGroups` in the constructor or on a later stage. This means
+       * that in case new configuration is provided and for particular group the passed object contains property
+       * `visible: true`, this group property will be respected no matter if the `RichTextEditor`'s property for
+       * this particular group is set to `false`. Example: Providing the following object as group configuration:
+       * { name: "font" visible: true } Will make the "font" group visible, no matter that calling `RichTextEditor.getShowGroupFont()`
+       * returns `false`.
        */
       class RichTextEditor extends sap.ui.core.Control {
         /**
@@ -317,6 +413,8 @@ declare namespace sap {
          * it with the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -335,12 +433,16 @@ declare namespace sap {
         ): Function;
         /**
          * Returns a metadata object for class sap.ui.richtexteditor.RichTextEditor.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * @SINCE 1.76.0
          *
          * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         addAriaLabelledBy(
           /**
@@ -349,13 +451,17 @@ declare namespace sap {
           vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control
         ): this;
         /**
-         * Adds a button group to the editor.
+         * Adds a button group to the editor. **Note**: Adding already existing group will not do anything. If a
+         * button group needs to be changed, it first needs to be removed and then added by providing its name or
+         * map object, containing its desired configuration.
+         *
+         * @returns Control instance (for method chaining)
          */
         addButtonGroup(
           /**
            * Name/ID of a single button or object containing the group information
            */
-          mGroup?:
+          vGroup?:
             | {
                 /**
                  * Array of name/IDs of the buttons in the group
@@ -389,6 +495,8 @@ declare namespace sap {
          * @SINCE 1.48
          *
          * Adds some customButton to the aggregation {@link #getCustomButtons customButtons}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         addCustomButton(
           /**
@@ -398,6 +506,8 @@ declare namespace sap {
         ): this;
         /**
          * Allows to add a plugin (that must already be installed on the server) to the RichTextEditor.
+         *
+         * @returns Control instance (for method chaining)
          */
         addPlugin(
           /**
@@ -416,6 +526,8 @@ declare namespace sap {
          * object that will be given to TinyMCE. The parameter "configuration" is the javascript oject that will
          * be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
          * changed in the case of TinyMCE.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachBeforeEditorInit(
           /**
@@ -444,6 +556,8 @@ declare namespace sap {
          * object that will be given to TinyMCE. The parameter "configuration" is the javascript oject that will
          * be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
          * changed in the case of TinyMCE.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachBeforeEditorInit(
           /**
@@ -464,6 +578,8 @@ declare namespace sap {
          *
          * Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter
          * key is pressed.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachChange(
           /**
@@ -489,6 +605,8 @@ declare namespace sap {
          *
          * Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter
          * key is pressed.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachChange(
           /**
@@ -508,6 +626,8 @@ declare namespace sap {
          * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
          *
          * Fired when the used editor is loaded and ready (its HTML is also created).
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachReady(
           /**
@@ -532,6 +652,8 @@ declare namespace sap {
          * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
          *
          * Fired when the used editor is loaded and ready (its HTML is also created).
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachReady(
           /**
@@ -553,6 +675,8 @@ declare namespace sap {
          *
          * Analogous to the ready event, the event is fired when the used editor is loaded and ready. But the event
          * is fired after every time the control is ready to use and not only once like the ready event.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachReadyRecurring(
           /**
@@ -579,6 +703,8 @@ declare namespace sap {
          *
          * Analogous to the ready event, the event is fired when the used editor is loaded and ready. But the event
          * is fired after every time the control is ready to use and not only once like the ready event.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachReadyRecurring(
           /**
@@ -595,6 +721,8 @@ declare namespace sap {
          * @SINCE 1.48
          *
          * Destroys all the customButtons in the aggregation {@link #getCustomButtons customButtons}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         destroyCustomButtons(): this;
         /**
@@ -602,6 +730,8 @@ declare namespace sap {
          * this `sap.ui.richtexteditor.RichTextEditor`.
          *
          * The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachBeforeEditorInit(
           /**
@@ -617,6 +747,8 @@ declare namespace sap {
          * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.richtexteditor.RichTextEditor`.
          *
          * The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachChange(
           /**
@@ -632,6 +764,8 @@ declare namespace sap {
          * Detaches event handler `fnFunction` from the {@link #event:ready ready} event of this `sap.ui.richtexteditor.RichTextEditor`.
          *
          * The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachReady(
           /**
@@ -648,6 +782,8 @@ declare namespace sap {
          * `sap.ui.richtexteditor.RichTextEditor`.
          *
          * The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachReadyRecurring(
           /**
@@ -661,6 +797,8 @@ declare namespace sap {
         ): this;
         /**
          * Fires event {@link #event:beforeEditorInit beforeEditorInit} to attached listeners.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         fireBeforeEditorInit(
           /**
@@ -670,6 +808,8 @@ declare namespace sap {
         ): this;
         /**
          * Fires event {@link #event:change change} to attached listeners.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         fireChange(
           /**
@@ -684,6 +824,8 @@ declare namespace sap {
         ): this;
         /**
          * Fires event {@link #event:ready ready} to attached listeners.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         fireReady(
           /**
@@ -693,6 +835,8 @@ declare namespace sap {
         ): this;
         /**
          * Fires event {@link #event:readyRecurring readyRecurring} to attached listeners.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         fireReadyRecurring(
           /**
@@ -715,11 +859,13 @@ declare namespace sap {
          * should be placed, a "priority" and whether the buttons are "visible". See method addButtonGroup() for
          * more details on the structure of the objects in this array. **Note:** `buttonGroups` is a feature from
          * the native editor. Its supported scope with `customToolbar` is limited up to the grouping- the user could
-         * turn on/off a whole group, but modifiyng buttons within a group is not possible. In order to achieve
+         * turn on/off a whole group, but modifying buttons within a group is not possible. In order to achieve
          * that functionality with `customToolbar`, the developer needs to turn the group off and instantiate their
          * own `sap.m.Button`(s) with the desired functionality.
          *
          * Default value is `[]`.
+         *
+         * @returns Value of property `buttonGroups`
          */
         getButtonGroups(): object[];
         /**
@@ -743,6 +889,8 @@ declare namespace sap {
          * loaded toolbar.
          *
          * Default value is `false`.
+         *
+         * @returns Value of property `customToolbar`
          */
         getCustomToolbar(): boolean;
         /**
@@ -752,6 +900,8 @@ declare namespace sap {
          * be any editor toolbar.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `editable`
          */
         getEditable(): boolean;
         /**
@@ -763,6 +913,8 @@ declare namespace sap {
          * to set this property after the first rendering will not have any effect.
          *
          * Default value is `'js/tiny_mce4/tinymce.js'`.
+         *
+         * @returns Value of property `editorLocation`
          */
         getEditorLocation(): string;
         /**
@@ -779,6 +931,8 @@ declare namespace sap {
          * 	 - Any attempts to set this property after the first rendering will not have any effect.
          *
          * Default value is `'TinyMCE4'`.
+         *
+         * @returns Value of property `editorType`
          */
         getEditorType(): string;
         /**
@@ -786,12 +940,16 @@ declare namespace sap {
          *
          * Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
          * than 200px, the minimum height of 200px will be applied.
+         *
+         * @returns Value of property `height`
          */
         getHeight(): sap.ui.core.CSSSize;
         /**
          * Returns the current editor's instance. CAUTION: using the native editor introduces a dependency to that
          * editor and breaks the wrapping character of the RichTextEditor control, so it should only be done in
          * justified cases.
+         *
+         * @returns The native editor object (here: The TinyMCE editor instance)
          */
         getNativeApi(): object;
         /**
@@ -801,6 +959,8 @@ declare namespace sap {
          * a property "name" which then contains the plugin name/ID.
          *
          * Default value is `[]`.
+         *
+         * @returns Value of property `plugins`
          */
         getPlugins(): object[];
         /**
@@ -809,6 +969,8 @@ declare namespace sap {
          * Determines whether a value is required.
          *
          * Default value is `false`.
+         *
+         * @returns Value of property `required`
          */
         getRequired(): boolean;
         /**
@@ -819,78 +981,112 @@ declare namespace sap {
          * API}.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `sanitizeValue`
          */
         getSanitizeValue(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupClipboard showGroupClipboard}.
          *
          * Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `showGroupClipboard`
          */
         getShowGroupClipboard(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupFont showGroupFont}.
          *
          * Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * Default value is `false`.
+         *
+         * @returns Value of property `showGroupFont`
          */
         getShowGroupFont(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupFontStyle showGroupFontStyle}.
          *
          * Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
-         * is available. Changing this after the initial rendering will result in some visible redrawing.
+         * is available. Changing this after the initial rendering will result in some visible redrawing. Note:
+         * This property will not be synchronized with group configuration provided via the buttonGroups property
+         * or when groups are added on a later stage.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `showGroupFontStyle`
          */
         getShowGroupFontStyle(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupInsert showGroupInsert}.
          *
          * Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
-         * available. Changing this after the initial rendering will result in some visible redrawing.
+         * available. Changing this after the initial rendering will result in some visible redrawing. Note: This
+         * property will not be synchronized with group configuration provided via the buttonGroups property or
+         * when groups are added on a later stage.
          *
          * Default value is `false`.
+         *
+         * @returns Value of property `showGroupInsert`
          */
         getShowGroupInsert(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupLink showGroupLink}.
          *
          * Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * Default value is `false`.
+         *
+         * @returns Value of property `showGroupLink`
          */
         getShowGroupLink(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupStructure showGroupStructure}.
          *
          * Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `showGroupStructure`
          */
         getShowGroupStructure(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupTextAlign showGroupTextAlign}.
          *
          * Determines whether the toolbar button group containing text alignment commands is available. Changing
-         * this after the initial rendering will result in some visible redrawing.
+         * this after the initial rendering will result in some visible redrawing. Note: This property will not
+         * be synchronized with group configuration provided via the buttonGroups property or when groups are added
+         * on a later stage.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `showGroupTextAlign`
          */
         getShowGroupTextAlign(): boolean;
         /**
          * Gets current value of property {@link #getShowGroupUndo showGroupUndo}.
          *
          * Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
-         * this after the initial rendering will result in some visible redrawing.
+         * this after the initial rendering will result in some visible redrawing. Note: This property will not
+         * be synchronized with group configuration provided via the buttonGroups property or when groups are added
+         * on a later stage.
          *
          * Default value is `false`.
+         *
+         * @returns Value of property `showGroupUndo`
          */
         getShowGroupUndo(): boolean;
         /**
@@ -899,6 +1095,8 @@ declare namespace sap {
          * The text direction
          *
          * Default value is `Inherit`.
+         *
+         * @returns Value of property `textDirection`
          */
         getTextDirection(): sap.ui.core.TextDirection;
         /**
@@ -912,6 +1110,8 @@ declare namespace sap {
          * might lead to invisible buttons with the legacy theme - use the default editor theme in this case.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `useLegacyTheme`
          */
         getUseLegacyTheme(): boolean;
         /**
@@ -923,12 +1123,16 @@ declare namespace sap {
          * initial state.
          *
          * Default value is `empty string`.
+         *
+         * @returns Value of property `value`
          */
         getValue(): string;
         /**
          * Gets current value of property {@link #getWidth width}.
          *
          * Width of RichTextEditor control in CSS units.
+         *
+         * @returns Value of property `width`
          */
         getWidth(): sap.ui.core.CSSSize;
         /**
@@ -938,6 +1142,8 @@ declare namespace sap {
          * representation in the control.
          *
          * Default value is `true`.
+         *
+         * @returns Value of property `wrapping`
          */
         getWrapping(): boolean;
         /**
@@ -945,6 +1151,8 @@ declare namespace sap {
          *
          * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getCustomButtons customButtons}.
          * and returns its index if found or -1 otherwise.
+         *
+         * @returns The index of the provided control in the aggregation if found, or -1 otherwise
          */
         indexOfCustomButton(
           /**
@@ -956,6 +1164,8 @@ declare namespace sap {
          * @SINCE 1.48
          *
          * Inserts a customButton into the aggregation {@link #getCustomButtons customButtons}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         insertCustomButton(
           /**
@@ -973,6 +1183,8 @@ declare namespace sap {
          * @SINCE 1.76.0
          *
          * 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[];
         /**
@@ -981,12 +1193,16 @@ declare namespace sap {
          * Removes all the controls from the aggregation {@link #getCustomButtons customButtons}.
          *
          * Additionally, it unregisters them from the hosting UIArea.
+         *
+         * @returns An array of the removed elements (might be empty)
          */
         removeAllCustomButtons(): sap.ui.core.Control[];
         /**
          * @SINCE 1.76.0
          *
          * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns The removed ariaLabelledBy or `null`
          */
         removeAriaLabelledBy(
           /**
@@ -994,10 +1210,23 @@ declare namespace sap {
            */
           vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
         ): sap.ui.core.ID;
+        /**
+         * Removes a button group from the editor.
+         *
+         * @returns Control instance (for method chaining)
+         */
+        removeButtonGroup(
+          /**
+           * The name of the group to be removed.
+           */
+          sGroupName?: string
+        ): object;
         /**
          * @SINCE 1.48
          *
          * Removes a customButton from the aggregation {@link #getCustomButtons customButtons}.
+         *
+         * @returns The removed customButton or `null`
          */
         removeCustomButton(
           /**
@@ -1007,6 +1236,8 @@ declare namespace sap {
         ): sap.ui.core.Control;
         /**
          * Removes the plugin with the given name/ID from the list of plugins to load
+         *
+         * @returns Control instance (for method chaining)
          */
         removePlugin(
           /**
@@ -1016,6 +1247,8 @@ declare namespace sap {
         ): object;
         /**
          * Sets the button groups to the editor.
+         *
+         * @returns Control instance (for method chaining)
          */
         setButtonGroups(
           /**
@@ -1036,6 +1269,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setCustomToolbar(
           /**
@@ -1052,6 +1287,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setEditable(
           /**
@@ -1070,6 +1307,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `'js/tiny_mce4/tinymce.js'`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setEditorLocation(
           /**
@@ -1080,6 +1319,8 @@ declare namespace sap {
         /**
          * Switches the editor type and sets the default settings for the editor. All plugins and button groups
          * should be set after this has been invoked
+         *
+         * @returns Control instance (for method chaining)
          */
         setEditorType(
           /**
@@ -1094,6 +1335,8 @@ declare namespace sap {
          * than 200px, the minimum height of 200px will be applied.
          *
          * 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
          */
         setHeight(
           /**
@@ -1103,6 +1346,8 @@ declare namespace sap {
         ): this;
         /**
          * Sets the plugins to the editor.
+         *
+         * @returns Control instance (for method chaining)
          */
         setPlugins(
           /**
@@ -1118,6 +1363,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setRequired(
           /**
@@ -1135,6 +1382,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setSanitizeValue(
           /**
@@ -1146,11 +1395,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupClipboard showGroupClipboard}.
          *
          * Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupClipboard(
           /**
@@ -1162,11 +1415,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupFont showGroupFont}.
          *
          * Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupFont(
           /**
@@ -1178,11 +1435,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupFontStyle showGroupFontStyle}.
          *
          * Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
-         * is available. Changing this after the initial rendering will result in some visible redrawing.
+         * is available. Changing this after the initial rendering will result in some visible redrawing. Note:
+         * This property will not be synchronized with group configuration provided via the buttonGroups property
+         * or when groups are added on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupFontStyle(
           /**
@@ -1194,11 +1455,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupInsert showGroupInsert}.
          *
          * Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
-         * available. Changing this after the initial rendering will result in some visible redrawing.
+         * available. Changing this after the initial rendering will result in some visible redrawing. Note: This
+         * property will not be synchronized with group configuration provided via the buttonGroups property or
+         * when groups are added on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupInsert(
           /**
@@ -1210,11 +1475,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupLink showGroupLink}.
          *
          * Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupLink(
           /**
@@ -1226,11 +1495,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupStructure showGroupStructure}.
          *
          * Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
-         * Changing this after the initial rendering will result in some visible redrawing.
+         * Changing this after the initial rendering will result in some visible redrawing. Note: This property
+         * will not be synchronized with group configuration provided via the buttonGroups property or when groups
+         * are added on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupStructure(
           /**
@@ -1242,11 +1515,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupTextAlign showGroupTextAlign}.
          *
          * Determines whether the toolbar button group containing text alignment commands is available. Changing
-         * this after the initial rendering will result in some visible redrawing.
+         * this after the initial rendering will result in some visible redrawing. Note: This property will not
+         * be synchronized with group configuration provided via the buttonGroups property or when groups are added
+         * on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupTextAlign(
           /**
@@ -1258,11 +1535,15 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowGroupUndo showGroupUndo}.
          *
          * Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
-         * this after the initial rendering will result in some visible redrawing.
+         * this after the initial rendering will result in some visible redrawing. Note: This property will not
+         * be synchronized with group configuration provided via the buttonGroups property or when groups are added
+         * on a later stage.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setShowGroupUndo(
           /**
@@ -1278,6 +1559,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `Inherit`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setTextDirection(
           /**
@@ -1298,6 +1581,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setUseLegacyTheme(
           /**
@@ -1316,6 +1601,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `empty string`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setValue(
           /**
@@ -1329,6 +1616,8 @@ declare namespace sap {
          * Width of RichTextEditor control in CSS units.
          *
          * 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
          */
         setWidth(
           /**
@@ -1345,6 +1634,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setWrapping(
           /**