@sapui5/types 1.113.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,1666 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/ui/richtexteditor/library" {
4
+ /**
5
+ * Determines which editor component should be used for editing the text.
6
+ */
7
+ export enum EditorType {
8
+ /**
9
+ * Uses latest recommended TinyMCE version Current one is TinyMCE 6
10
+ */
11
+ TinyMCE = "TinyMCE",
12
+ /**
13
+ * Uses TinyMCE version 5 as editor
14
+ */
15
+ TinyMCE5 = "TinyMCE5",
16
+ /**
17
+ * Uses TinyMCE version 6 as editor
18
+ */
19
+ TinyMCE6 = "TinyMCE6",
20
+ }
21
+ /**
22
+ * @SINCE 1.50
23
+ *
24
+ * Interface for controls which are suitable as a Toolbar for RichTextEditor.
25
+ */
26
+ export interface IToolbar {
27
+ __implements__sap_ui_richtexteditor_IToolbar: boolean;
28
+ }
29
+ }
30
+
31
+ declare module "sap/ui/richtexteditor/RichTextEditor" {
32
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
33
+
34
+ import { ID, CSSSize, TextDirection } from "sap/ui/core/library";
35
+
36
+ import Event from "sap/ui/base/Event";
37
+
38
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
39
+
40
+ import {
41
+ PropertyBindingInfo,
42
+ AggregationBindingInfo,
43
+ } from "sap/ui/base/ManagedObject";
44
+
45
+ /**
46
+ * The RichTextEditor-Control is used to enter formatted text. It uses the third-party component called
47
+ * TinyMCE. In addition to the native toolbar, you can also use a toolbar built with SAPUI5 controls. Overview:
48
+ *
49
+ * With version 1.48 onward, aside from the native toolbar of the TinyMCE, the `RichTextEditor` can also
50
+ * use a toolbar built with SAPUI5 controls. Which toolbar is used is taken into consideration only while
51
+ * the control is being initialized and it will not be possible to change it during runtime, because of
52
+ * lifecycle incompatibilities between the SAPUI5 and the third-party library. The custom toolbar acts like
53
+ * a wrapper to the native toolbar and takes care of synchronizing the state of its internal controls with
54
+ * the current state of the selection in the editor (bold, italics, font styles etc.).
55
+ *
56
+ * Restrictions:
57
+ *
58
+ * **Note: The `RichTextEditor` uses a third-party component and therefore some additional restrictions
59
+ * apply for its proper usage and support. For more information see the Preamble section in {@link topic:d4f3f1598373452bb73f2120930c133c
60
+ * sap.ui.richtexteditor}. **
61
+ *
62
+ * Guidelines:
63
+ * - The `RichTextEditor` should be used for desktop apps only. However, if it is essential for your
64
+ * use case, you can enable the mobile version of TinyMCE, whilst having in mind the restrictions. For more
65
+ * information see the {@link topic:d4f3f1598373452bb73f2120930c133c sap.ui.richtexteditor documentation}.
66
+ *
67
+ * - In order to be usable, the control needs a minimum width 17.5 rem and height of 12.5 rem.
68
+ * - Do not instantiate the `RichTextEditor` from a hidden container.
69
+ * - Make sure you destroy the `RichTextEditor` instance instead of hiding it and create a new one when
70
+ * you show it again.
71
+ *
72
+ * Usage:
73
+ *
74
+ * When to use:
75
+ * - You want to enable users to enter text and other elements (tables, images) with different styles
76
+ * and colors.
77
+ * - You need to provide a tool for texts that require additional formatting.
78
+ *
79
+ * When not to use:
80
+ * - You want to let users add simple text that doesn’t require formatting. Use {@link sap.m.TextArea
81
+ * text area} instead.
82
+ * - Use callbacks to the native third-party API with care, as there may be compatibility issues with
83
+ * later versions.
84
+ *
85
+ * Custom toolbar - adding and removing buttons: With version 1.102 it is possible to redefine the button
86
+ * groups configuration in order to show only particular set of buttons in the custom toolbar of the `RichTextEditor`.
87
+ * This is possible in few ways:
88
+ * - By providing the buttons group configurations as a whole by setting the `buttonGroups` property of
89
+ * the control.
90
+ * - By providing individual button group configuration via `addButtonGroup` method.
91
+ *
92
+ * Consider the following when choosing your approach:
93
+ * - Setting `buttonGroups` will override all current custom toolbar button group configurations. This
94
+ * method allows for total redefining of the custom toolbar groups.
95
+ * - Using `addButtonGroups` will try to add non-existing group into the configuration array, however,
96
+ * if such group configuration exists already, a warning will be logged and the new configuration will not
97
+ * be added. In order to replace the existing configuration you will need to remove it first via `removeButtonGroup`.
98
+ *
99
+ *
100
+ * Below is a list of supported groups and buttons, which can be specified in the configuration objects
101
+ * (format is <>: <>):
102
+ * - font-style: bold, italic, underline, strikethrough
103
+ * - font: fontfamily (fontselect in TinyMCE5), fontsize (fontsizeselect in TinyMCE5), forecolor, backcolor
104
+ *
105
+ * - clipboard: cut, copy, paste
106
+ * - structure: bullist, numlist, outdent, indent
107
+ * - undo: undo, redo
108
+ * - insert: image, emoticons
109
+ * - link: link, unlink
110
+ * - text-align: alignleft, aligncenter, alignright, alignjustify Additional supported groups, which
111
+ * can be added only after the editor is loaded (they can not be specified in the above mentioned configuration):
112
+ *
113
+ * - table: table
114
+ * - styleselect: styleselect **Note!** Adding configuration for "text-align" group with any buttons
115
+ * will still render a menu button with all available options inside. Removing/hiding the group can be achieved
116
+ * by invoking `removeButtonGroup` or `setShowGroupTextAlign(false)` depending on the desired result.
117
+ *
118
+ * **Note!** There is no synchronization between the `setShowGroup*` properties and the configuration object
119
+ * that the application can specifying via `buttonGroups` in the constructor or on a later stage. This means
120
+ * that in case new configuration is provided and for particular group the passed object contains property
121
+ * `visible: true`, this group property will be respected no matter if the `RichTextEditor`'s property for
122
+ * this particular group is set to `false`. Example: Providing the following object as group configuration:
123
+ * { name: "font" visible: true } Will make the "font" group visible, no matter that calling `RichTextEditor.getShowGroupFont()`
124
+ * returns `false`.
125
+ */
126
+ export default class RichTextEditor extends Control {
127
+ /**
128
+ * Constructor for a new RichTextEditor.
129
+ *
130
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
131
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
132
+ * of the syntax of the settings object.
133
+ * See:
134
+ * {@link fiori:https://experience.sap.com/fiori-design-web/rich-text-editor/ Rich Text Editor}
135
+ * {@link topic:d4f3f1598373452bb73f2120930c133c}
136
+ */
137
+ constructor(
138
+ /**
139
+ * Initial settings for the new control
140
+ */
141
+ mSettings?: $RichTextEditorSettings
142
+ );
143
+ /**
144
+ * Constructor for a new RichTextEditor.
145
+ *
146
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
147
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
148
+ * of the syntax of the settings object.
149
+ * See:
150
+ * {@link fiori:https://experience.sap.com/fiori-design-web/rich-text-editor/ Rich Text Editor}
151
+ * {@link topic:d4f3f1598373452bb73f2120930c133c}
152
+ */
153
+ constructor(
154
+ /**
155
+ * ID for the new control, generated automatically if no ID is given
156
+ */
157
+ sId?: string,
158
+ /**
159
+ * Initial settings for the new control
160
+ */
161
+ mSettings?: $RichTextEditorSettings
162
+ );
163
+
164
+ /**
165
+ * Creates a new subclass of class sap.ui.richtexteditor.RichTextEditor with name `sClassName` and enriches
166
+ * it with the information contained in `oClassInfo`.
167
+ *
168
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
169
+ *
170
+ * @returns Created class / constructor function
171
+ */
172
+ static extend<T extends Record<string, unknown>>(
173
+ /**
174
+ * Name of the class being created
175
+ */
176
+ sClassName: string,
177
+ /**
178
+ * Object literal with information about the class
179
+ */
180
+ oClassInfo?: sap.ClassInfo<T, RichTextEditor>,
181
+ /**
182
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
183
+ * used by this class
184
+ */
185
+ FNMetaImpl?: Function
186
+ ): Function;
187
+ /**
188
+ * Returns a metadata object for class sap.ui.richtexteditor.RichTextEditor.
189
+ *
190
+ * @returns Metadata object describing this class
191
+ */
192
+ static getMetadata(): ElementMetadata;
193
+ /**
194
+ * @SINCE 1.76.0
195
+ *
196
+ * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
197
+ *
198
+ * @returns Reference to `this` in order to allow method chaining
199
+ */
200
+ addAriaLabelledBy(
201
+ /**
202
+ * The ariaLabelledBy to add; if empty, nothing is inserted
203
+ */
204
+ vAriaLabelledBy: ID | Control
205
+ ): this;
206
+ /**
207
+ * Adds a button group to the editor. **Note**: Adding already existing group will not do anything. If a
208
+ * button group needs to be changed, it first needs to be removed and then added by providing its name or
209
+ * map object, containing its desired configuration.
210
+ *
211
+ * @returns Control instance (for method chaining)
212
+ */
213
+ addButtonGroup(
214
+ /**
215
+ * Name/ID of a single button or object containing the group information
216
+ */
217
+ vGroup?:
218
+ | {
219
+ /**
220
+ * Array of name/IDs of the buttons in the group
221
+ */
222
+ buttons?: string[];
223
+ /**
224
+ * Name/ID of the group.
225
+ */
226
+ name?: string;
227
+ /**
228
+ * (optional) The priority of the button group. Lower priorities are added first.
229
+ */
230
+ visible?: boolean;
231
+ /**
232
+ * (optional) Row number in which the button should be
233
+ */
234
+ row?: int;
235
+ /**
236
+ * (optional) The priority of the button group. Lower priorities are added first.
237
+ */
238
+ priority?: int;
239
+ /**
240
+ * (optional) The priority of the button group in the custom toolbar. Each default group in the custom toolbar
241
+ * has a predefined `customToolbarPriority`. Lower priorities are added in first.
242
+ */
243
+ customToolbarPriority?: int;
244
+ }
245
+ | string
246
+ ): RichTextEditor;
247
+ /**
248
+ * @SINCE 1.48
249
+ *
250
+ * Adds some customButton to the aggregation {@link #getCustomButtons customButtons}.
251
+ *
252
+ * @returns Reference to `this` in order to allow method chaining
253
+ */
254
+ addCustomButton(
255
+ /**
256
+ * The customButton to add; if empty, nothing is inserted
257
+ */
258
+ oCustomButton: Control
259
+ ): this;
260
+ /**
261
+ * Allows to add a plugin (that must already be installed on the server) to the RichTextEditor.
262
+ *
263
+ * @returns Control instance (for method chaining)
264
+ */
265
+ addPlugin(
266
+ /**
267
+ * The plugin ID/name or an object with property "name", containing the ID/name of the plugin
268
+ */
269
+ mPlugin?: object | string
270
+ ): RichTextEditor;
271
+ /**
272
+ * Attaches event handler `fnFunction` to the {@link #event:beforeEditorInit beforeEditorInit} event of
273
+ * this `sap.ui.richtexteditor.RichTextEditor`.
274
+ *
275
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
276
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
277
+ *
278
+ * This event is fired right before the TinyMCE instance is created and can be used to change the settings
279
+ * object that will be given to TinyMCE. The parameter "configuration" is the javascript object that will
280
+ * be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
281
+ * changed in the case of TinyMCE. **Note:** In order to add plugins to the `RichTextEditor` control, you
282
+ * have to use the `addPlugin` method. Adding plugins through the settings object may lead to synchronizing
283
+ * issues between TinyMCE and `RichTextEditor` control.
284
+ *
285
+ * @returns Reference to `this` in order to allow method chaining
286
+ */
287
+ attachBeforeEditorInit(
288
+ /**
289
+ * An application-specific payload object that will be passed to the event handler along with the event
290
+ * object when firing the event
291
+ */
292
+ oData: object,
293
+ /**
294
+ * The function to be called when the event occurs
295
+ */
296
+ fnFunction: (p1: Event) => void,
297
+ /**
298
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
299
+ * itself
300
+ */
301
+ oListener?: object
302
+ ): this;
303
+ /**
304
+ * Attaches event handler `fnFunction` to the {@link #event:beforeEditorInit beforeEditorInit} event of
305
+ * this `sap.ui.richtexteditor.RichTextEditor`.
306
+ *
307
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
308
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
309
+ *
310
+ * This event is fired right before the TinyMCE instance is created and can be used to change the settings
311
+ * object that will be given to TinyMCE. The parameter "configuration" is the javascript object that will
312
+ * be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
313
+ * changed in the case of TinyMCE. **Note:** In order to add plugins to the `RichTextEditor` control, you
314
+ * have to use the `addPlugin` method. Adding plugins through the settings object may lead to synchronizing
315
+ * issues between TinyMCE and `RichTextEditor` control.
316
+ *
317
+ * @returns Reference to `this` in order to allow method chaining
318
+ */
319
+ attachBeforeEditorInit(
320
+ /**
321
+ * The function to be called when the event occurs
322
+ */
323
+ fnFunction: (p1: Event) => void,
324
+ /**
325
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
326
+ * itself
327
+ */
328
+ oListener?: object
329
+ ): this;
330
+ /**
331
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.richtexteditor.RichTextEditor`.
332
+ *
333
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
334
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
335
+ *
336
+ * Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter
337
+ * key is pressed.
338
+ *
339
+ * @returns Reference to `this` in order to allow method chaining
340
+ */
341
+ attachChange(
342
+ /**
343
+ * An application-specific payload object that will be passed to the event handler along with the event
344
+ * object when firing the event
345
+ */
346
+ oData: object,
347
+ /**
348
+ * The function to be called when the event occurs
349
+ */
350
+ fnFunction: (p1: Event) => void,
351
+ /**
352
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
353
+ * itself
354
+ */
355
+ oListener?: object
356
+ ): this;
357
+ /**
358
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.richtexteditor.RichTextEditor`.
359
+ *
360
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
361
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
362
+ *
363
+ * Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter
364
+ * key is pressed.
365
+ *
366
+ * @returns Reference to `this` in order to allow method chaining
367
+ */
368
+ attachChange(
369
+ /**
370
+ * The function to be called when the event occurs
371
+ */
372
+ fnFunction: (p1: Event) => void,
373
+ /**
374
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
375
+ * itself
376
+ */
377
+ oListener?: object
378
+ ): this;
379
+ /**
380
+ * Attaches event handler `fnFunction` to the {@link #event:ready ready} event of this `sap.ui.richtexteditor.RichTextEditor`.
381
+ *
382
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
383
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
384
+ *
385
+ * Fired when the used editor is loaded and ready (its HTML is also created).
386
+ *
387
+ * @returns Reference to `this` in order to allow method chaining
388
+ */
389
+ attachReady(
390
+ /**
391
+ * An application-specific payload object that will be passed to the event handler along with the event
392
+ * object when firing the event
393
+ */
394
+ oData: object,
395
+ /**
396
+ * The function to be called when the event occurs
397
+ */
398
+ fnFunction: (p1: Event) => void,
399
+ /**
400
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
401
+ * itself
402
+ */
403
+ oListener?: object
404
+ ): this;
405
+ /**
406
+ * Attaches event handler `fnFunction` to the {@link #event:ready ready} event of this `sap.ui.richtexteditor.RichTextEditor`.
407
+ *
408
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
409
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
410
+ *
411
+ * Fired when the used editor is loaded and ready (its HTML is also created).
412
+ *
413
+ * @returns Reference to `this` in order to allow method chaining
414
+ */
415
+ attachReady(
416
+ /**
417
+ * The function to be called when the event occurs
418
+ */
419
+ fnFunction: (p1: Event) => void,
420
+ /**
421
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
422
+ * itself
423
+ */
424
+ oListener?: object
425
+ ): this;
426
+ /**
427
+ * Attaches event handler `fnFunction` to the {@link #event:readyRecurring readyRecurring} event of this
428
+ * `sap.ui.richtexteditor.RichTextEditor`.
429
+ *
430
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
431
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
432
+ *
433
+ * Analogous to the ready event, the event is fired when the used editor is loaded and ready. But the event
434
+ * is fired after every time the control is ready to use and not only once like the ready event.
435
+ *
436
+ * @returns Reference to `this` in order to allow method chaining
437
+ */
438
+ attachReadyRecurring(
439
+ /**
440
+ * An application-specific payload object that will be passed to the event handler along with the event
441
+ * object when firing the event
442
+ */
443
+ oData: object,
444
+ /**
445
+ * The function to be called when the event occurs
446
+ */
447
+ fnFunction: (p1: Event) => void,
448
+ /**
449
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
450
+ * itself
451
+ */
452
+ oListener?: object
453
+ ): this;
454
+ /**
455
+ * Attaches event handler `fnFunction` to the {@link #event:readyRecurring readyRecurring} event of this
456
+ * `sap.ui.richtexteditor.RichTextEditor`.
457
+ *
458
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
459
+ * otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
460
+ *
461
+ * Analogous to the ready event, the event is fired when the used editor is loaded and ready. But the event
462
+ * is fired after every time the control is ready to use and not only once like the ready event.
463
+ *
464
+ * @returns Reference to `this` in order to allow method chaining
465
+ */
466
+ attachReadyRecurring(
467
+ /**
468
+ * The function to be called when the event occurs
469
+ */
470
+ fnFunction: (p1: Event) => void,
471
+ /**
472
+ * Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor`
473
+ * itself
474
+ */
475
+ oListener?: object
476
+ ): this;
477
+ /**
478
+ * @SINCE 1.48
479
+ *
480
+ * Destroys all the customButtons in the aggregation {@link #getCustomButtons customButtons}.
481
+ *
482
+ * @returns Reference to `this` in order to allow method chaining
483
+ */
484
+ destroyCustomButtons(): this;
485
+ /**
486
+ * Detaches event handler `fnFunction` from the {@link #event:beforeEditorInit beforeEditorInit} event of
487
+ * this `sap.ui.richtexteditor.RichTextEditor`.
488
+ *
489
+ * The passed function and listener object must match the ones used for event registration.
490
+ *
491
+ * @returns Reference to `this` in order to allow method chaining
492
+ */
493
+ detachBeforeEditorInit(
494
+ /**
495
+ * The function to be called, when the event occurs
496
+ */
497
+ fnFunction: (p1: Event) => void,
498
+ /**
499
+ * Context object on which the given function had to be called
500
+ */
501
+ oListener?: object
502
+ ): this;
503
+ /**
504
+ * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.richtexteditor.RichTextEditor`.
505
+ *
506
+ * The passed function and listener object must match the ones used for event registration.
507
+ *
508
+ * @returns Reference to `this` in order to allow method chaining
509
+ */
510
+ detachChange(
511
+ /**
512
+ * The function to be called, when the event occurs
513
+ */
514
+ fnFunction: (p1: Event) => void,
515
+ /**
516
+ * Context object on which the given function had to be called
517
+ */
518
+ oListener?: object
519
+ ): this;
520
+ /**
521
+ * Detaches event handler `fnFunction` from the {@link #event:ready ready} event of this `sap.ui.richtexteditor.RichTextEditor`.
522
+ *
523
+ * The passed function and listener object must match the ones used for event registration.
524
+ *
525
+ * @returns Reference to `this` in order to allow method chaining
526
+ */
527
+ detachReady(
528
+ /**
529
+ * The function to be called, when the event occurs
530
+ */
531
+ fnFunction: (p1: Event) => void,
532
+ /**
533
+ * Context object on which the given function had to be called
534
+ */
535
+ oListener?: object
536
+ ): this;
537
+ /**
538
+ * Detaches event handler `fnFunction` from the {@link #event:readyRecurring readyRecurring} event of this
539
+ * `sap.ui.richtexteditor.RichTextEditor`.
540
+ *
541
+ * The passed function and listener object must match the ones used for event registration.
542
+ *
543
+ * @returns Reference to `this` in order to allow method chaining
544
+ */
545
+ detachReadyRecurring(
546
+ /**
547
+ * The function to be called, when the event occurs
548
+ */
549
+ fnFunction: (p1: Event) => void,
550
+ /**
551
+ * Context object on which the given function had to be called
552
+ */
553
+ oListener?: object
554
+ ): this;
555
+ /**
556
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
557
+ *
558
+ * Fires event {@link #event:beforeEditorInit beforeEditorInit} to attached listeners.
559
+ *
560
+ * @returns Reference to `this` in order to allow method chaining
561
+ */
562
+ fireBeforeEditorInit(
563
+ /**
564
+ * Parameters to pass along with the event
565
+ */
566
+ mParameters?: object
567
+ ): this;
568
+ /**
569
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
570
+ *
571
+ * Fires event {@link #event:change change} to attached listeners.
572
+ *
573
+ * @returns Reference to `this` in order to allow method chaining
574
+ */
575
+ fireChange(
576
+ /**
577
+ * Parameters to pass along with the event
578
+ */
579
+ mParameters?: {
580
+ /**
581
+ * The new control value.
582
+ */
583
+ newValue?: string;
584
+ }
585
+ ): this;
586
+ /**
587
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
588
+ *
589
+ * Fires event {@link #event:ready ready} to attached listeners.
590
+ *
591
+ * @returns Reference to `this` in order to allow method chaining
592
+ */
593
+ fireReady(
594
+ /**
595
+ * Parameters to pass along with the event
596
+ */
597
+ mParameters?: object
598
+ ): this;
599
+ /**
600
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
601
+ *
602
+ * Fires event {@link #event:readyRecurring readyRecurring} to attached listeners.
603
+ *
604
+ * @returns Reference to `this` in order to allow method chaining
605
+ */
606
+ fireReadyRecurring(
607
+ /**
608
+ * Parameters to pass along with the event
609
+ */
610
+ mParameters?: object
611
+ ): this;
612
+ /**
613
+ * @SINCE 1.76.0
614
+ *
615
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
616
+ * ariaLabelledBy}.
617
+ */
618
+ getAriaLabelledBy(): ID[];
619
+ /**
620
+ * Gets current value of property {@link #getButtonGroups buttonGroups}.
621
+ *
622
+ * An array of button configurations. These configurations contain the names of buttons as array in the
623
+ * property "buttons" and the name of the group in "name", they can also contain the "row" where the buttons
624
+ * should be placed, a "priority" and whether the buttons are "visible". See method addButtonGroup() for
625
+ * more details on the structure of the objects in this array. **Note:** `buttonGroups` is a feature from
626
+ * the native editor. Its supported scope with `customToolbar` is limited up to the grouping- the user could
627
+ * turn on/off a whole group, but modifying buttons within a group is not possible. In order to achieve
628
+ * that functionality with `customToolbar`, the developer needs to turn the group off and instantiate their
629
+ * own `sap.m.Button`(s) with the desired functionality.
630
+ *
631
+ * Default value is `[]`.
632
+ *
633
+ * @returns Value of property `buttonGroups`
634
+ */
635
+ getButtonGroups(): object[];
636
+ /**
637
+ * @SINCE 1.48
638
+ *
639
+ * Gets content of aggregation {@link #getCustomButtons customButtons}.
640
+ *
641
+ * Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
642
+ * only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is enabled
643
+ * and all the requirements are fulfilled.
644
+ */
645
+ getCustomButtons(): Control[];
646
+ /**
647
+ * @SINCE 1.48
648
+ *
649
+ * Gets current value of property {@link #getCustomToolbar customToolbar}.
650
+ *
651
+ * Determines whether a Fiori Toolbar is used instead of the TinyMCE default toolbar one. It is applied
652
+ * only when the EditorType is TinyMCE5 or TinyMCE6 and sap.m library is loaded. **Note:** The `customToolbar`
653
+ * property will have effect only on initial loading. Changing it during runtime will not affect the initially
654
+ * loaded toolbar.
655
+ *
656
+ * Default value is `false`.
657
+ *
658
+ * @returns Value of property `customToolbar`
659
+ */
660
+ getCustomToolbar(): boolean;
661
+ /**
662
+ * Gets current value of property {@link #getEditable editable}.
663
+ *
664
+ * Determines whether the editor content can be modified by the user. When set to "false" there might not
665
+ * be any editor toolbar.
666
+ *
667
+ * Default value is `true`.
668
+ *
669
+ * @returns Value of property `editable`
670
+ */
671
+ getEditable(): boolean;
672
+ /**
673
+ * @deprecated (since 1.25.0) - The editorLocation is set implicitly when choosing the editorType.
674
+ *
675
+ * Gets current value of property {@link #getEditorLocation editorLocation}.
676
+ *
677
+ * Relative or absolute URL where the editor is available. Must be on the same server. **Note:** Any attempts
678
+ * to set this property after the first rendering will not have any effect.
679
+ *
680
+ * Default value is `'js/tiny_mce4/tinymce.js'`.
681
+ *
682
+ * @returns Value of property `editorLocation`
683
+ */
684
+ getEditorLocation(): string;
685
+ /**
686
+ * Gets current value of property {@link #getEditorType editorType}.
687
+ *
688
+ * The editor implementation to use.
689
+ *
690
+ * Valid values are the ones found under sap.ui.richtexteditor.EditorType and any other editor identifier
691
+ * that may be introduced by other groups (hence this is not an enumeration).
692
+ *
693
+ * **Notes:**
694
+ * - TinyMCE version 3 and 4 are no longer supported and cannot be used. If you set the property to TinyMCE,
695
+ * it will load TinyMCE version 6.
696
+ * - Any attempts to set this property after the first rendering will not have any effect.
697
+ * - The default value of the property will always resolve to the recommended version by UI5. Due to the
698
+ * different support cycles, we will be constantly getting newer TinyMCE versions and update the default
699
+ * value accordingly.
700
+ * - Usage of internal TinyMCE APIs is not recommended, since it might lead to issues upon TinyMCE version
701
+ * update.
702
+ * - Have in mind when choosing a specific TinyMCE version that there might be differences in the support
703
+ * rules compared to UI5, therefore we might be forced to remove any TinyMCE version.
704
+ * - TinyMCE 4 is out of support and by using it, application developers are accepting all the risks comming
705
+ * from that fact. In addition TinyMCE 4 will be removed in future releases.
706
+ * - TinyMCE 5 will be removed in future releases.
707
+ *
708
+ * Default value is `'TinyMCE'`.
709
+ *
710
+ * @returns Value of property `editorType`
711
+ */
712
+ getEditorType(): string;
713
+ /**
714
+ * Gets current value of property {@link #getHeight height}.
715
+ *
716
+ * Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
717
+ * than 200px, the minimum height of 200px will be applied. **Note:** If the "autoresize" TinyMCE plugin
718
+ * is used, the height property is not taken into account.
719
+ *
720
+ * @returns Value of property `height`
721
+ */
722
+ getHeight(): CSSSize;
723
+ /**
724
+ * Returns the current editor's instance. CAUTION: using the native editor introduces a dependency to that
725
+ * editor and breaks the wrapping character of the RichTextEditor control, so it should only be done in
726
+ * justified cases.
727
+ *
728
+ * @returns The native editor object (here: The TinyMCE editor instance)
729
+ */
730
+ getNativeApi(): object;
731
+ /**
732
+ * Gets current value of property {@link #getPlugins plugins}.
733
+ *
734
+ * An array of plugin configuration objects with the obligatory property "name". Each object has to contain
735
+ * a property "name" which then contains the plugin name/ID.
736
+ *
737
+ * Default value is `[]`.
738
+ *
739
+ * @returns Value of property `plugins`
740
+ */
741
+ getPlugins(): object[];
742
+ /**
743
+ * Gets current value of property {@link #getRequired required}.
744
+ *
745
+ * Determines whether a value is required.
746
+ *
747
+ * Default value is `false`.
748
+ *
749
+ * @returns Value of property `required`
750
+ */
751
+ getRequired(): boolean;
752
+ /**
753
+ * Gets current value of property {@link #getSanitizeValue sanitizeValue}.
754
+ *
755
+ * Determines whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure
756
+ * allowed URLs please use the validator API via {@link module:sap/base/security/URLListValidator#add URLListValidator
757
+ * API}.
758
+ *
759
+ * Default value is `true`.
760
+ *
761
+ * @returns Value of property `sanitizeValue`
762
+ */
763
+ getSanitizeValue(): boolean;
764
+ /**
765
+ * Gets current value of property {@link #getShowGroupClipboard showGroupClipboard}.
766
+ *
767
+ * Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
768
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
769
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
770
+ * are added on a later stage.
771
+ *
772
+ * Default value is `true`.
773
+ *
774
+ * @returns Value of property `showGroupClipboard`
775
+ */
776
+ getShowGroupClipboard(): boolean;
777
+ /**
778
+ * Gets current value of property {@link #getShowGroupFont showGroupFont}.
779
+ *
780
+ * Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
781
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
782
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
783
+ * are added on a later stage.
784
+ *
785
+ * Default value is `false`.
786
+ *
787
+ * @returns Value of property `showGroupFont`
788
+ */
789
+ getShowGroupFont(): boolean;
790
+ /**
791
+ * Gets current value of property {@link #getShowGroupFontStyle showGroupFontStyle}.
792
+ *
793
+ * Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
794
+ * is available. Changing this after the initial rendering will result in some visible redrawing. Note:
795
+ * This property will not be synchronized with group configuration provided via the buttonGroups property
796
+ * or when groups are added on a later stage.
797
+ *
798
+ * Default value is `true`.
799
+ *
800
+ * @returns Value of property `showGroupFontStyle`
801
+ */
802
+ getShowGroupFontStyle(): boolean;
803
+ /**
804
+ * Gets current value of property {@link #getShowGroupInsert showGroupInsert}.
805
+ *
806
+ * Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
807
+ * available. Changing this after the initial rendering will result in some visible redrawing. Note: This
808
+ * property will not be synchronized with group configuration provided via the buttonGroups property or
809
+ * when groups are added on a later stage.
810
+ *
811
+ * Default value is `false`.
812
+ *
813
+ * @returns Value of property `showGroupInsert`
814
+ */
815
+ getShowGroupInsert(): boolean;
816
+ /**
817
+ * Gets current value of property {@link #getShowGroupLink showGroupLink}.
818
+ *
819
+ * Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
820
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
821
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
822
+ * are added on a later stage.
823
+ *
824
+ * Default value is `false`.
825
+ *
826
+ * @returns Value of property `showGroupLink`
827
+ */
828
+ getShowGroupLink(): boolean;
829
+ /**
830
+ * Gets current value of property {@link #getShowGroupStructure showGroupStructure}.
831
+ *
832
+ * Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
833
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
834
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
835
+ * are added on a later stage.
836
+ *
837
+ * Default value is `true`.
838
+ *
839
+ * @returns Value of property `showGroupStructure`
840
+ */
841
+ getShowGroupStructure(): boolean;
842
+ /**
843
+ * Gets current value of property {@link #getShowGroupTextAlign showGroupTextAlign}.
844
+ *
845
+ * Determines whether the toolbar button group containing text alignment commands is available. Changing
846
+ * this after the initial rendering will result in some visible redrawing. Note: This property will not
847
+ * be synchronized with group configuration provided via the buttonGroups property or when groups are added
848
+ * on a later stage.
849
+ *
850
+ * Default value is `true`.
851
+ *
852
+ * @returns Value of property `showGroupTextAlign`
853
+ */
854
+ getShowGroupTextAlign(): boolean;
855
+ /**
856
+ * Gets current value of property {@link #getShowGroupUndo showGroupUndo}.
857
+ *
858
+ * Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
859
+ * this after the initial rendering will result in some visible redrawing. Note: This property will not
860
+ * be synchronized with group configuration provided via the buttonGroups property or when groups are added
861
+ * on a later stage.
862
+ *
863
+ * Default value is `false`.
864
+ *
865
+ * @returns Value of property `showGroupUndo`
866
+ */
867
+ getShowGroupUndo(): boolean;
868
+ /**
869
+ * Gets current value of property {@link #getTextDirection textDirection}.
870
+ *
871
+ * The text direction
872
+ *
873
+ * Default value is `Inherit`.
874
+ *
875
+ * @returns Value of property `textDirection`
876
+ */
877
+ getTextDirection(): TextDirection | keyof typeof TextDirection;
878
+ /**
879
+ * @deprecated (since 1.97.0) - This property became obsolete after the deprecation of TinyMCE v3.
880
+ *
881
+ * Gets current value of property {@link #getUseLegacyTheme useLegacyTheme}.
882
+ *
883
+ * Determines whether or not to use the legacy theme for the toolbar buttons. If this is set to false, the
884
+ * default theme for the editor will be used (which might change slightly with every update). The legacy
885
+ * theme has the disadvantage that not all functionality has its own icon, so using non default buttons
886
+ * might lead to invisible buttons with the legacy theme - use the default editor theme in this case.
887
+ *
888
+ * Default value is `true`.
889
+ *
890
+ * @returns Value of property `useLegacyTheme`
891
+ */
892
+ getUseLegacyTheme(): boolean;
893
+ /**
894
+ * Gets current value of property {@link #getValue value}.
895
+ *
896
+ * An HTML string representing the editor content. Because this is HTML, the value cannot be generically
897
+ * escaped to prevent cross-site scripting, so the application is responsible for doing so. Overwriting
898
+ * this property would also reset editor's Undo manager and buttons "Undo"/"Redo" would be set to their
899
+ * initial state.
900
+ *
901
+ * Default value is `empty string`.
902
+ *
903
+ * @returns Value of property `value`
904
+ */
905
+ getValue(): string;
906
+ /**
907
+ * Gets current value of property {@link #getWidth width}.
908
+ *
909
+ * Width of RichTextEditor control in CSS units.
910
+ *
911
+ * @returns Value of property `width`
912
+ */
913
+ getWidth(): CSSSize;
914
+ /**
915
+ * Gets current value of property {@link #getWrapping wrapping}.
916
+ *
917
+ * Determines whether the text in the editor is wrapped. This does not affect the editor's value, only the
918
+ * representation in the control.
919
+ *
920
+ * Default value is `true`.
921
+ *
922
+ * @returns Value of property `wrapping`
923
+ */
924
+ getWrapping(): boolean;
925
+ /**
926
+ * @SINCE 1.48
927
+ *
928
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getCustomButtons customButtons}.
929
+ * and returns its index if found or -1 otherwise.
930
+ *
931
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
932
+ */
933
+ indexOfCustomButton(
934
+ /**
935
+ * The customButton whose index is looked for
936
+ */
937
+ oCustomButton: Control
938
+ ): int;
939
+ /**
940
+ * @SINCE 1.48
941
+ *
942
+ * Inserts a customButton into the aggregation {@link #getCustomButtons customButtons}.
943
+ *
944
+ * @returns Reference to `this` in order to allow method chaining
945
+ */
946
+ insertCustomButton(
947
+ /**
948
+ * The customButton to insert; if empty, nothing is inserted
949
+ */
950
+ oCustomButton: Control,
951
+ /**
952
+ * The `0`-based index the customButton should be inserted at; for a negative value of `iIndex`, the customButton
953
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the customButton
954
+ * is inserted at the last position
955
+ */
956
+ iIndex: int
957
+ ): this;
958
+ /**
959
+ * @SINCE 1.76.0
960
+ *
961
+ * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
962
+ *
963
+ * @returns An array of the removed elements (might be empty)
964
+ */
965
+ removeAllAriaLabelledBy(): ID[];
966
+ /**
967
+ * @SINCE 1.48
968
+ *
969
+ * Removes all the controls from the aggregation {@link #getCustomButtons customButtons}.
970
+ *
971
+ * Additionally, it unregisters them from the hosting UIArea.
972
+ *
973
+ * @returns An array of the removed elements (might be empty)
974
+ */
975
+ removeAllCustomButtons(): Control[];
976
+ /**
977
+ * @SINCE 1.76.0
978
+ *
979
+ * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
980
+ *
981
+ * @returns The removed ariaLabelledBy or `null`
982
+ */
983
+ removeAriaLabelledBy(
984
+ /**
985
+ * The ariaLabelledBy to be removed or its index or ID
986
+ */
987
+ vAriaLabelledBy: int | ID | Control
988
+ ): ID | null;
989
+ /**
990
+ * Removes a button group from the editor.
991
+ *
992
+ * @returns Control instance (for method chaining)
993
+ */
994
+ removeButtonGroup(
995
+ /**
996
+ * The name of the group to be removed.
997
+ */
998
+ sGroupName?: string
999
+ ): RichTextEditor;
1000
+ /**
1001
+ * @SINCE 1.48
1002
+ *
1003
+ * Removes a customButton from the aggregation {@link #getCustomButtons customButtons}.
1004
+ *
1005
+ * @returns The removed customButton or `null`
1006
+ */
1007
+ removeCustomButton(
1008
+ /**
1009
+ * The customButton to remove or its index or id
1010
+ */
1011
+ vCustomButton: int | string | Control
1012
+ ): Control | null;
1013
+ /**
1014
+ * Removes the plugin with the given name/ID from the list of plugins to load
1015
+ *
1016
+ * @returns Control instance (for method chaining)
1017
+ */
1018
+ removePlugin(
1019
+ /**
1020
+ * The name/ID of the plugin to remove
1021
+ */
1022
+ sPluginName?: string
1023
+ ): RichTextEditor;
1024
+ /**
1025
+ * Sets the button groups to the editor.
1026
+ *
1027
+ * @returns Control instance (for method chaining)
1028
+ */
1029
+ setButtonGroups(
1030
+ /**
1031
+ * Array of names or objects containing the group information
1032
+ */
1033
+ aGroups?: any[]
1034
+ ): RichTextEditor;
1035
+ /**
1036
+ * @SINCE 1.48
1037
+ *
1038
+ * Sets a new value for property {@link #getCustomToolbar customToolbar}.
1039
+ *
1040
+ * Determines whether a Fiori Toolbar is used instead of the TinyMCE default toolbar one. It is applied
1041
+ * only when the EditorType is TinyMCE5 or TinyMCE6 and sap.m library is loaded. **Note:** The `customToolbar`
1042
+ * property will have effect only on initial loading. Changing it during runtime will not affect the initially
1043
+ * loaded toolbar.
1044
+ *
1045
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1046
+ *
1047
+ * Default value is `false`.
1048
+ *
1049
+ * @returns Reference to `this` in order to allow method chaining
1050
+ */
1051
+ setCustomToolbar(
1052
+ /**
1053
+ * New value for property `customToolbar`
1054
+ */
1055
+ bCustomToolbar?: boolean
1056
+ ): this;
1057
+ /**
1058
+ * Sets a new value for property {@link #getEditable editable}.
1059
+ *
1060
+ * Determines whether the editor content can be modified by the user. When set to "false" there might not
1061
+ * be any editor toolbar.
1062
+ *
1063
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1064
+ *
1065
+ * Default value is `true`.
1066
+ *
1067
+ * @returns Reference to `this` in order to allow method chaining
1068
+ */
1069
+ setEditable(
1070
+ /**
1071
+ * New value for property `editable`
1072
+ */
1073
+ bEditable?: boolean
1074
+ ): this;
1075
+ /**
1076
+ * @deprecated (since 1.25.0) - The editorLocation is set implicitly when choosing the editorType.
1077
+ *
1078
+ * Sets a new value for property {@link #getEditorLocation editorLocation}.
1079
+ *
1080
+ * Relative or absolute URL where the editor is available. Must be on the same server. **Note:** Any attempts
1081
+ * to set this property after the first rendering will not have any effect.
1082
+ *
1083
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1084
+ *
1085
+ * Default value is `'js/tiny_mce4/tinymce.js'`.
1086
+ *
1087
+ * @returns Reference to `this` in order to allow method chaining
1088
+ */
1089
+ setEditorLocation(
1090
+ /**
1091
+ * New value for property `editorLocation`
1092
+ */
1093
+ sEditorLocation?: string
1094
+ ): this;
1095
+ /**
1096
+ * Switches the editor type and sets the default settings for the editor. All plugins and button groups
1097
+ * should be set after this has been invoked
1098
+ *
1099
+ * @returns Control instance (for method chaining)
1100
+ */
1101
+ setEditorType(
1102
+ /**
1103
+ * Which editor type to be used (currently only TinyMCE 4, 5 and 6)
1104
+ */
1105
+ sEditorType?: string
1106
+ ): RichTextEditor;
1107
+ /**
1108
+ * Sets a new value for property {@link #getHeight height}.
1109
+ *
1110
+ * Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
1111
+ * than 200px, the minimum height of 200px will be applied. **Note:** If the "autoresize" TinyMCE plugin
1112
+ * is used, the height property is not taken into account.
1113
+ *
1114
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1115
+ *
1116
+ * @returns Reference to `this` in order to allow method chaining
1117
+ */
1118
+ setHeight(
1119
+ /**
1120
+ * New value for property `height`
1121
+ */
1122
+ sHeight?: CSSSize
1123
+ ): this;
1124
+ /**
1125
+ * Sets the plugins to the editor.
1126
+ *
1127
+ * @returns Control instance (for method chaining)
1128
+ */
1129
+ setPlugins(
1130
+ /**
1131
+ * Array of names or objects containing the plugin information
1132
+ */
1133
+ aPlugins?: any[]
1134
+ ): RichTextEditor;
1135
+ /**
1136
+ * Sets a new value for property {@link #getRequired required}.
1137
+ *
1138
+ * Determines whether a value is required.
1139
+ *
1140
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1141
+ *
1142
+ * Default value is `false`.
1143
+ *
1144
+ * @returns Reference to `this` in order to allow method chaining
1145
+ */
1146
+ setRequired(
1147
+ /**
1148
+ * New value for property `required`
1149
+ */
1150
+ bRequired?: boolean
1151
+ ): this;
1152
+ /**
1153
+ * Sets a new value for property {@link #getSanitizeValue sanitizeValue}.
1154
+ *
1155
+ * Determines whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure
1156
+ * allowed URLs please use the validator API via {@link module:sap/base/security/URLListValidator#add URLListValidator
1157
+ * API}.
1158
+ *
1159
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1160
+ *
1161
+ * Default value is `true`.
1162
+ *
1163
+ * @returns Reference to `this` in order to allow method chaining
1164
+ */
1165
+ setSanitizeValue(
1166
+ /**
1167
+ * New value for property `sanitizeValue`
1168
+ */
1169
+ bSanitizeValue?: boolean
1170
+ ): this;
1171
+ /**
1172
+ * Sets a new value for property {@link #getShowGroupClipboard showGroupClipboard}.
1173
+ *
1174
+ * Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
1175
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1176
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1177
+ * are added on a later stage.
1178
+ *
1179
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1180
+ *
1181
+ * Default value is `true`.
1182
+ *
1183
+ * @returns Reference to `this` in order to allow method chaining
1184
+ */
1185
+ setShowGroupClipboard(
1186
+ /**
1187
+ * New value for property `showGroupClipboard`
1188
+ */
1189
+ bShowGroupClipboard?: boolean
1190
+ ): this;
1191
+ /**
1192
+ * Sets a new value for property {@link #getShowGroupFont showGroupFont}.
1193
+ *
1194
+ * Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
1195
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1196
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1197
+ * are added on a later stage.
1198
+ *
1199
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1200
+ *
1201
+ * Default value is `false`.
1202
+ *
1203
+ * @returns Reference to `this` in order to allow method chaining
1204
+ */
1205
+ setShowGroupFont(
1206
+ /**
1207
+ * New value for property `showGroupFont`
1208
+ */
1209
+ bShowGroupFont?: boolean
1210
+ ): this;
1211
+ /**
1212
+ * Sets a new value for property {@link #getShowGroupFontStyle showGroupFontStyle}.
1213
+ *
1214
+ * Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
1215
+ * is available. Changing this after the initial rendering will result in some visible redrawing. Note:
1216
+ * This property will not be synchronized with group configuration provided via the buttonGroups property
1217
+ * or when groups are added on a later stage.
1218
+ *
1219
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1220
+ *
1221
+ * Default value is `true`.
1222
+ *
1223
+ * @returns Reference to `this` in order to allow method chaining
1224
+ */
1225
+ setShowGroupFontStyle(
1226
+ /**
1227
+ * New value for property `showGroupFontStyle`
1228
+ */
1229
+ bShowGroupFontStyle?: boolean
1230
+ ): this;
1231
+ /**
1232
+ * Sets a new value for property {@link #getShowGroupInsert showGroupInsert}.
1233
+ *
1234
+ * Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
1235
+ * available. Changing this after the initial rendering will result in some visible redrawing. Note: This
1236
+ * property will not be synchronized with group configuration provided via the buttonGroups property or
1237
+ * when groups are added on a later stage.
1238
+ *
1239
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1240
+ *
1241
+ * Default value is `false`.
1242
+ *
1243
+ * @returns Reference to `this` in order to allow method chaining
1244
+ */
1245
+ setShowGroupInsert(
1246
+ /**
1247
+ * New value for property `showGroupInsert`
1248
+ */
1249
+ bShowGroupInsert?: boolean
1250
+ ): this;
1251
+ /**
1252
+ * Sets a new value for property {@link #getShowGroupLink showGroupLink}.
1253
+ *
1254
+ * Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
1255
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1256
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1257
+ * are added on a later stage.
1258
+ *
1259
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1260
+ *
1261
+ * Default value is `false`.
1262
+ *
1263
+ * @returns Reference to `this` in order to allow method chaining
1264
+ */
1265
+ setShowGroupLink(
1266
+ /**
1267
+ * New value for property `showGroupLink`
1268
+ */
1269
+ bShowGroupLink?: boolean
1270
+ ): this;
1271
+ /**
1272
+ * Sets a new value for property {@link #getShowGroupStructure showGroupStructure}.
1273
+ *
1274
+ * Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
1275
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1276
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1277
+ * are added on a later stage.
1278
+ *
1279
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1280
+ *
1281
+ * Default value is `true`.
1282
+ *
1283
+ * @returns Reference to `this` in order to allow method chaining
1284
+ */
1285
+ setShowGroupStructure(
1286
+ /**
1287
+ * New value for property `showGroupStructure`
1288
+ */
1289
+ bShowGroupStructure?: boolean
1290
+ ): this;
1291
+ /**
1292
+ * Sets a new value for property {@link #getShowGroupTextAlign showGroupTextAlign}.
1293
+ *
1294
+ * Determines whether the toolbar button group containing text alignment commands is available. Changing
1295
+ * this after the initial rendering will result in some visible redrawing. Note: This property will not
1296
+ * be synchronized with group configuration provided via the buttonGroups property or when groups are added
1297
+ * on a later stage.
1298
+ *
1299
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1300
+ *
1301
+ * Default value is `true`.
1302
+ *
1303
+ * @returns Reference to `this` in order to allow method chaining
1304
+ */
1305
+ setShowGroupTextAlign(
1306
+ /**
1307
+ * New value for property `showGroupTextAlign`
1308
+ */
1309
+ bShowGroupTextAlign?: boolean
1310
+ ): this;
1311
+ /**
1312
+ * Sets a new value for property {@link #getShowGroupUndo showGroupUndo}.
1313
+ *
1314
+ * Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
1315
+ * this after the initial rendering will result in some visible redrawing. Note: This property will not
1316
+ * be synchronized with group configuration provided via the buttonGroups property or when groups are added
1317
+ * on a later stage.
1318
+ *
1319
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1320
+ *
1321
+ * Default value is `false`.
1322
+ *
1323
+ * @returns Reference to `this` in order to allow method chaining
1324
+ */
1325
+ setShowGroupUndo(
1326
+ /**
1327
+ * New value for property `showGroupUndo`
1328
+ */
1329
+ bShowGroupUndo?: boolean
1330
+ ): this;
1331
+ /**
1332
+ * Sets a new value for property {@link #getTextDirection textDirection}.
1333
+ *
1334
+ * The text direction
1335
+ *
1336
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1337
+ *
1338
+ * Default value is `Inherit`.
1339
+ *
1340
+ * @returns Reference to `this` in order to allow method chaining
1341
+ */
1342
+ setTextDirection(
1343
+ /**
1344
+ * New value for property `textDirection`
1345
+ */
1346
+ sTextDirection?: TextDirection | keyof typeof TextDirection
1347
+ ): this;
1348
+ /**
1349
+ * @deprecated (since 1.97.0) - This property became obsolete after the deprecation of TinyMCE v3.
1350
+ *
1351
+ * Sets a new value for property {@link #getUseLegacyTheme useLegacyTheme}.
1352
+ *
1353
+ * Determines whether or not to use the legacy theme for the toolbar buttons. If this is set to false, the
1354
+ * default theme for the editor will be used (which might change slightly with every update). The legacy
1355
+ * theme has the disadvantage that not all functionality has its own icon, so using non default buttons
1356
+ * might lead to invisible buttons with the legacy theme - use the default editor theme in this case.
1357
+ *
1358
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1359
+ *
1360
+ * Default value is `true`.
1361
+ *
1362
+ * @returns Reference to `this` in order to allow method chaining
1363
+ */
1364
+ setUseLegacyTheme(
1365
+ /**
1366
+ * New value for property `useLegacyTheme`
1367
+ */
1368
+ bUseLegacyTheme?: boolean
1369
+ ): this;
1370
+ /**
1371
+ * Sets a new value for property {@link #getValue value}.
1372
+ *
1373
+ * An HTML string representing the editor content. Because this is HTML, the value cannot be generically
1374
+ * escaped to prevent cross-site scripting, so the application is responsible for doing so. Overwriting
1375
+ * this property would also reset editor's Undo manager and buttons "Undo"/"Redo" would be set to their
1376
+ * initial state.
1377
+ *
1378
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1379
+ *
1380
+ * Default value is `empty string`.
1381
+ *
1382
+ * @returns Reference to `this` in order to allow method chaining
1383
+ */
1384
+ setValue(
1385
+ /**
1386
+ * New value for property `value`
1387
+ */
1388
+ sValue?: string
1389
+ ): this;
1390
+ /**
1391
+ * Sets a new value for property {@link #getWidth width}.
1392
+ *
1393
+ * Width of RichTextEditor control in CSS units.
1394
+ *
1395
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1396
+ *
1397
+ * @returns Reference to `this` in order to allow method chaining
1398
+ */
1399
+ setWidth(
1400
+ /**
1401
+ * New value for property `width`
1402
+ */
1403
+ sWidth?: CSSSize
1404
+ ): this;
1405
+ /**
1406
+ * Sets a new value for property {@link #getWrapping wrapping}.
1407
+ *
1408
+ * Determines whether the text in the editor is wrapped. This does not affect the editor's value, only the
1409
+ * representation in the control.
1410
+ *
1411
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1412
+ *
1413
+ * Default value is `true`.
1414
+ *
1415
+ * @returns Reference to `this` in order to allow method chaining
1416
+ */
1417
+ setWrapping(
1418
+ /**
1419
+ * New value for property `wrapping`
1420
+ */
1421
+ bWrapping?: boolean
1422
+ ): this;
1423
+ }
1424
+
1425
+ export interface $RichTextEditorSettings extends $ControlSettings {
1426
+ /**
1427
+ * An HTML string representing the editor content. Because this is HTML, the value cannot be generically
1428
+ * escaped to prevent cross-site scripting, so the application is responsible for doing so. Overwriting
1429
+ * this property would also reset editor's Undo manager and buttons "Undo"/"Redo" would be set to their
1430
+ * initial state.
1431
+ */
1432
+ value?: string | PropertyBindingInfo;
1433
+
1434
+ /**
1435
+ * The text direction
1436
+ */
1437
+ textDirection?:
1438
+ | (TextDirection | keyof typeof TextDirection)
1439
+ | PropertyBindingInfo
1440
+ | `{${string}}`;
1441
+
1442
+ /**
1443
+ * Width of RichTextEditor control in CSS units.
1444
+ */
1445
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
1446
+
1447
+ /**
1448
+ * Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
1449
+ * than 200px, the minimum height of 200px will be applied. **Note:** If the "autoresize" TinyMCE plugin
1450
+ * is used, the height property is not taken into account.
1451
+ */
1452
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
1453
+
1454
+ /**
1455
+ * The editor implementation to use.
1456
+ *
1457
+ * Valid values are the ones found under sap.ui.richtexteditor.EditorType and any other editor identifier
1458
+ * that may be introduced by other groups (hence this is not an enumeration).
1459
+ *
1460
+ * **Notes:**
1461
+ * - TinyMCE version 3 and 4 are no longer supported and cannot be used. If you set the property to TinyMCE,
1462
+ * it will load TinyMCE version 6.
1463
+ * - Any attempts to set this property after the first rendering will not have any effect.
1464
+ * - The default value of the property will always resolve to the recommended version by UI5. Due to the
1465
+ * different support cycles, we will be constantly getting newer TinyMCE versions and update the default
1466
+ * value accordingly.
1467
+ * - Usage of internal TinyMCE APIs is not recommended, since it might lead to issues upon TinyMCE version
1468
+ * update.
1469
+ * - Have in mind when choosing a specific TinyMCE version that there might be differences in the support
1470
+ * rules compared to UI5, therefore we might be forced to remove any TinyMCE version.
1471
+ * - TinyMCE 4 is out of support and by using it, application developers are accepting all the risks comming
1472
+ * from that fact. In addition TinyMCE 4 will be removed in future releases.
1473
+ * - TinyMCE 5 will be removed in future releases.
1474
+ */
1475
+ editorType?: string | PropertyBindingInfo;
1476
+
1477
+ /**
1478
+ * @deprecated (since 1.25.0) - The editorLocation is set implicitly when choosing the editorType.
1479
+ *
1480
+ * Relative or absolute URL where the editor is available. Must be on the same server. **Note:** Any attempts
1481
+ * to set this property after the first rendering will not have any effect.
1482
+ */
1483
+ editorLocation?: string | PropertyBindingInfo;
1484
+
1485
+ /**
1486
+ * Determines whether the editor content can be modified by the user. When set to "false" there might not
1487
+ * be any editor toolbar.
1488
+ */
1489
+ editable?: boolean | PropertyBindingInfo | `{${string}}`;
1490
+
1491
+ /**
1492
+ * Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
1493
+ * is available. Changing this after the initial rendering will result in some visible redrawing. Note:
1494
+ * This property will not be synchronized with group configuration provided via the buttonGroups property
1495
+ * or when groups are added on a later stage.
1496
+ */
1497
+ showGroupFontStyle?: boolean | PropertyBindingInfo | `{${string}}`;
1498
+
1499
+ /**
1500
+ * Determines whether the toolbar button group containing text alignment commands is available. Changing
1501
+ * this after the initial rendering will result in some visible redrawing. Note: This property will not
1502
+ * be synchronized with group configuration provided via the buttonGroups property or when groups are added
1503
+ * on a later stage.
1504
+ */
1505
+ showGroupTextAlign?: boolean | PropertyBindingInfo | `{${string}}`;
1506
+
1507
+ /**
1508
+ * Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
1509
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1510
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1511
+ * are added on a later stage.
1512
+ */
1513
+ showGroupStructure?: boolean | PropertyBindingInfo | `{${string}}`;
1514
+
1515
+ /**
1516
+ * Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
1517
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1518
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1519
+ * are added on a later stage.
1520
+ */
1521
+ showGroupFont?: boolean | PropertyBindingInfo | `{${string}}`;
1522
+
1523
+ /**
1524
+ * Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
1525
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1526
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1527
+ * are added on a later stage.
1528
+ */
1529
+ showGroupClipboard?: boolean | PropertyBindingInfo | `{${string}}`;
1530
+
1531
+ /**
1532
+ * Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
1533
+ * available. Changing this after the initial rendering will result in some visible redrawing. Note: This
1534
+ * property will not be synchronized with group configuration provided via the buttonGroups property or
1535
+ * when groups are added on a later stage.
1536
+ */
1537
+ showGroupInsert?: boolean | PropertyBindingInfo | `{${string}}`;
1538
+
1539
+ /**
1540
+ * Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
1541
+ * Changing this after the initial rendering will result in some visible redrawing. Note: This property
1542
+ * will not be synchronized with group configuration provided via the buttonGroups property or when groups
1543
+ * are added on a later stage.
1544
+ */
1545
+ showGroupLink?: boolean | PropertyBindingInfo | `{${string}}`;
1546
+
1547
+ /**
1548
+ * Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
1549
+ * this after the initial rendering will result in some visible redrawing. Note: This property will not
1550
+ * be synchronized with group configuration provided via the buttonGroups property or when groups are added
1551
+ * on a later stage.
1552
+ */
1553
+ showGroupUndo?: boolean | PropertyBindingInfo | `{${string}}`;
1554
+
1555
+ /**
1556
+ * Determines whether the text in the editor is wrapped. This does not affect the editor's value, only the
1557
+ * representation in the control.
1558
+ */
1559
+ wrapping?: boolean | PropertyBindingInfo | `{${string}}`;
1560
+
1561
+ /**
1562
+ * Determines whether a value is required.
1563
+ */
1564
+ required?: boolean | PropertyBindingInfo | `{${string}}`;
1565
+
1566
+ /**
1567
+ * Determines whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure
1568
+ * allowed URLs please use the validator API via {@link module:sap/base/security/URLListValidator#add URLListValidator
1569
+ * API}.
1570
+ */
1571
+ sanitizeValue?: boolean | PropertyBindingInfo | `{${string}}`;
1572
+
1573
+ /**
1574
+ * An array of plugin configuration objects with the obligatory property "name". Each object has to contain
1575
+ * a property "name" which then contains the plugin name/ID.
1576
+ */
1577
+ plugins?: object[] | PropertyBindingInfo | `{${string}}`;
1578
+
1579
+ /**
1580
+ * @deprecated (since 1.97.0) - This property became obsolete after the deprecation of TinyMCE v3.
1581
+ *
1582
+ * Determines whether or not to use the legacy theme for the toolbar buttons. If this is set to false, the
1583
+ * default theme for the editor will be used (which might change slightly with every update). The legacy
1584
+ * theme has the disadvantage that not all functionality has its own icon, so using non default buttons
1585
+ * might lead to invisible buttons with the legacy theme - use the default editor theme in this case.
1586
+ */
1587
+ useLegacyTheme?: boolean | PropertyBindingInfo | `{${string}}`;
1588
+
1589
+ /**
1590
+ * An array of button configurations. These configurations contain the names of buttons as array in the
1591
+ * property "buttons" and the name of the group in "name", they can also contain the "row" where the buttons
1592
+ * should be placed, a "priority" and whether the buttons are "visible". See method addButtonGroup() for
1593
+ * more details on the structure of the objects in this array. **Note:** `buttonGroups` is a feature from
1594
+ * the native editor. Its supported scope with `customToolbar` is limited up to the grouping- the user could
1595
+ * turn on/off a whole group, but modifying buttons within a group is not possible. In order to achieve
1596
+ * that functionality with `customToolbar`, the developer needs to turn the group off and instantiate their
1597
+ * own `sap.m.Button`(s) with the desired functionality.
1598
+ */
1599
+ buttonGroups?: object[] | PropertyBindingInfo | `{${string}}`;
1600
+
1601
+ /**
1602
+ * @SINCE 1.48
1603
+ *
1604
+ * Determines whether a Fiori Toolbar is used instead of the TinyMCE default toolbar one. It is applied
1605
+ * only when the EditorType is TinyMCE5 or TinyMCE6 and sap.m library is loaded. **Note:** The `customToolbar`
1606
+ * property will have effect only on initial loading. Changing it during runtime will not affect the initially
1607
+ * loaded toolbar.
1608
+ */
1609
+ customToolbar?: boolean | PropertyBindingInfo | `{${string}}`;
1610
+
1611
+ /**
1612
+ * @SINCE 1.48
1613
+ *
1614
+ * Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
1615
+ * only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is enabled
1616
+ * and all the requirements are fulfilled.
1617
+ */
1618
+ customButtons?:
1619
+ | Control[]
1620
+ | Control
1621
+ | AggregationBindingInfo
1622
+ | `{${string}}`;
1623
+
1624
+ /**
1625
+ * @SINCE 1.76.0
1626
+ *
1627
+ * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
1628
+ */
1629
+ ariaLabelledBy?: Array<Control | string>;
1630
+
1631
+ /**
1632
+ * Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter
1633
+ * key is pressed.
1634
+ */
1635
+ change?: (oEvent: Event) => void;
1636
+
1637
+ /**
1638
+ * Fired when the used editor is loaded and ready (its HTML is also created).
1639
+ */
1640
+ ready?: (oEvent: Event) => void;
1641
+
1642
+ /**
1643
+ * Analogous to the ready event, the event is fired when the used editor is loaded and ready. But the event
1644
+ * is fired after every time the control is ready to use and not only once like the ready event.
1645
+ */
1646
+ readyRecurring?: (oEvent: Event) => void;
1647
+
1648
+ /**
1649
+ * This event is fired right before the TinyMCE instance is created and can be used to change the settings
1650
+ * object that will be given to TinyMCE. The parameter "configuration" is the javascript object that will
1651
+ * be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
1652
+ * changed in the case of TinyMCE. **Note:** In order to add plugins to the `RichTextEditor` control, you
1653
+ * have to use the `addPlugin` method. Adding plugins through the settings object may lead to synchronizing
1654
+ * issues between TinyMCE and `RichTextEditor` control.
1655
+ */
1656
+ beforeEditorInit?: (oEvent: Event) => void;
1657
+ }
1658
+ }
1659
+
1660
+ declare namespace sap {
1661
+ interface IUI5DefineDependencyNames {
1662
+ "sap/ui/richtexteditor/library": undefined;
1663
+
1664
+ "sap/ui/richtexteditor/RichTextEditor": undefined;
1665
+ }
1666
+ }