@sapui5/ts-types 1.84.41 → 1.84.42
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.
- package/package.json +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.core.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +1 -1
- package/types/sap.fe.plugins.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.gantt.d.ts +8 -2
- package/types/sap.m.d.ts +53 -1
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +1 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1 -1
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +3 -3
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +1 -1
- package/types/sap.ui.richtexteditor.d.ts +208 -69
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -6
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +22 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
package/package.json
CHANGED
package/types/sap.chart.d.ts
CHANGED
package/types/sap.f.d.ts
CHANGED
package/types/sap.fe.core.d.ts
CHANGED
package/types/sap.fe.macros.d.ts
CHANGED
package/types/sap.fe.test.d.ts
CHANGED
package/types/sap.fe.tools.d.ts
CHANGED
package/types/sap.gantt.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.84.
|
|
1
|
+
// For Library Version: 1.84.28
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -27150,7 +27150,13 @@ declare namespace sap {
|
|
|
27150
27150
|
/**
|
|
27151
27151
|
* Opens the print dialog.
|
|
27152
27152
|
*/
|
|
27153
|
-
open(
|
|
27153
|
+
open(
|
|
27154
|
+
/**
|
|
27155
|
+
* Optional function which takes cloned gantt chart's table for modification. Applications can loop through
|
|
27156
|
+
* the table columns and update certain properties like maxLines to overcome html2canvas limitations.
|
|
27157
|
+
*/
|
|
27158
|
+
fnUpdateTable: Function
|
|
27159
|
+
): any;
|
|
27154
27160
|
/**
|
|
27155
27161
|
* Sets the Gantt chart to be exported as PDF.
|
|
27156
27162
|
*/
|
package/types/sap.m.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.84.
|
|
1
|
+
// For Library Version: 1.84.42
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -16869,6 +16869,19 @@ declare namespace sap {
|
|
|
16869
16869
|
*/
|
|
16870
16870
|
displayType?: sap.m.PDFViewerDisplayType;
|
|
16871
16871
|
|
|
16872
|
+
/**
|
|
16873
|
+
* @SINCE 1.121.0
|
|
16874
|
+
*
|
|
16875
|
+
* Parameter to determine if the given PDF is from a trusted source. If the source is valid this property
|
|
16876
|
+
* can be set to true. If isTrustedSource is set to true, the PDFViewer opens with the displayType set to
|
|
16877
|
+
* "Embedded" on desktop devices, which means that the PDF content is directly shown within the PDFViewer.
|
|
16878
|
+
* Set this property to true only when the PDF is generated by the application or the PDF is scanned for
|
|
16879
|
+
* viruses. If isTrustedSource is set to false, the PDFViewer opens with the displayType set to "Link" on
|
|
16880
|
+
* desktop devices, which overrides any configuration that has been provided by the application for the
|
|
16881
|
+
* property displayType. This means that the PDFViewer appears as a toolbar with a download button.
|
|
16882
|
+
*/
|
|
16883
|
+
isTrustedSource?: boolean;
|
|
16884
|
+
|
|
16872
16885
|
/**
|
|
16873
16886
|
* This event is fired when a PDF file is loaded. If the PDF is loaded in smaller chunks, this event is
|
|
16874
16887
|
* fired as often as defined by the browser's plugin. This may happen after a couple chunks are processed.
|
|
@@ -66872,6 +66885,22 @@ declare namespace sap {
|
|
|
66872
66885
|
* Default value is `"100%"`.
|
|
66873
66886
|
*/
|
|
66874
66887
|
getHeight(): sap.ui.core.CSSSize;
|
|
66888
|
+
/**
|
|
66889
|
+
* @SINCE 1.121.0
|
|
66890
|
+
*
|
|
66891
|
+
* Gets current value of property {@link #getIsTrustedSource isTrustedSource}.
|
|
66892
|
+
*
|
|
66893
|
+
* Parameter to determine if the given PDF is from a trusted source. If the source is valid this property
|
|
66894
|
+
* can be set to true. If isTrustedSource is set to true, the PDFViewer opens with the displayType set to
|
|
66895
|
+
* "Embedded" on desktop devices, which means that the PDF content is directly shown within the PDFViewer.
|
|
66896
|
+
* Set this property to true only when the PDF is generated by the application or the PDF is scanned for
|
|
66897
|
+
* viruses. If isTrustedSource is set to false, the PDFViewer opens with the displayType set to "Link" on
|
|
66898
|
+
* desktop devices, which overrides any configuration that has been provided by the application for the
|
|
66899
|
+
* property displayType. This means that the PDFViewer appears as a toolbar with a download button.
|
|
66900
|
+
*
|
|
66901
|
+
* Default value is `false`.
|
|
66902
|
+
*/
|
|
66903
|
+
getIsTrustedSource(): boolean;
|
|
66875
66904
|
/**
|
|
66876
66905
|
* Returns a metadata object for class sap.m.PDFViewer.
|
|
66877
66906
|
*/
|
|
@@ -67057,6 +67086,29 @@ declare namespace sap {
|
|
|
67057
67086
|
*/
|
|
67058
67087
|
sHeight?: sap.ui.core.CSSSize
|
|
67059
67088
|
): sap.m.PDFViewer;
|
|
67089
|
+
/**
|
|
67090
|
+
* @SINCE 1.121.0
|
|
67091
|
+
*
|
|
67092
|
+
* Sets a new value for property {@link #getIsTrustedSource isTrustedSource}.
|
|
67093
|
+
*
|
|
67094
|
+
* Parameter to determine if the given PDF is from a trusted source. If the source is valid this property
|
|
67095
|
+
* can be set to true. If isTrustedSource is set to true, the PDFViewer opens with the displayType set to
|
|
67096
|
+
* "Embedded" on desktop devices, which means that the PDF content is directly shown within the PDFViewer.
|
|
67097
|
+
* Set this property to true only when the PDF is generated by the application or the PDF is scanned for
|
|
67098
|
+
* viruses. If isTrustedSource is set to false, the PDFViewer opens with the displayType set to "Link" on
|
|
67099
|
+
* desktop devices, which overrides any configuration that has been provided by the application for the
|
|
67100
|
+
* property displayType. This means that the PDFViewer appears as a toolbar with a download button.
|
|
67101
|
+
*
|
|
67102
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
67103
|
+
*
|
|
67104
|
+
* Default value is `false`.
|
|
67105
|
+
*/
|
|
67106
|
+
setIsTrustedSource(
|
|
67107
|
+
/**
|
|
67108
|
+
* New value for property `isTrustedSource`
|
|
67109
|
+
*/
|
|
67110
|
+
bIsTrustedSource?: boolean
|
|
67111
|
+
): sap.m.PDFViewer;
|
|
67060
67112
|
/**
|
|
67061
67113
|
* @deprecated (since 1.50.0) - replaced by {@link sap.m.PDFViewer#getTitle}.
|
|
67062
67114
|
*
|
package/types/sap.makit.d.ts
CHANGED
package/types/sap.me.d.ts
CHANGED
package/types/sap.ndc.d.ts
CHANGED
package/types/sap.tnt.d.ts
CHANGED
package/types/sap.ui.comp.d.ts
CHANGED
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -18,7 +18,7 @@ declare module "sap/base/util/Version";
|
|
|
18
18
|
declare module "sap/ui/performance/Measurement.Entry";
|
|
19
19
|
|
|
20
20
|
declare module "sap/ui/util/Storage.Type";
|
|
21
|
-
// For Library Version: 1.84.
|
|
21
|
+
// For Library Version: 1.84.42
|
|
22
22
|
/**
|
|
23
23
|
* Root namespace for JavaScript functionality provided by SAP SE.
|
|
24
24
|
*
|
package/types/sap.ui.dt.d.ts
CHANGED
package/types/sap.ui.export.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.84.
|
|
1
|
+
// For Library Version: 1.84.42
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
|
|
@@ -75,7 +75,7 @@ class Spreadsheet{
|
|
|
75
75
|
* - `workbook.context` - Context object that will be applied to the generated file. It may contain the
|
|
76
76
|
* following fields:
|
|
77
77
|
* - `application` (string) - The application that creates the XLSX document (default: "SAP UI5")
|
|
78
|
-
* - `version` (string) - Application version that creates the XLSX document (default: "1.84.
|
|
78
|
+
* - `version` (string) - Application version that creates the XLSX document (default: "1.84.42")
|
|
79
79
|
* - `title` (string) - Title of the XLSX document (NOT the filename)
|
|
80
80
|
* - `modifiedBy` (string) - User context for the XLSX document
|
|
81
81
|
* - `sheetName` (string) - The label of the data sheet
|
|
@@ -161,7 +161,7 @@ class Spreadsheet{
|
|
|
161
161
|
* columns: aColumns,
|
|
162
162
|
* context: {
|
|
163
163
|
* application: 'Debug Test Application',
|
|
164
|
-
* version: '1.84.
|
|
164
|
+
* version: '1.84.42',
|
|
165
165
|
* title: 'Some random title',
|
|
166
166
|
* modifiedBy: 'John Doe',
|
|
167
167
|
* metaSheetName: 'Custom metadata',
|
package/types/sap.ui.fl.d.ts
CHANGED
package/types/sap.ui.layout.d.ts
CHANGED
package/types/sap.ui.mdc.d.ts
CHANGED
|
@@ -1,10 +1,7 @@
|
|
|
1
|
-
// For Library Version: 1.84.
|
|
1
|
+
// For Library Version: 1.84.42
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
5
|
-
/**
|
|
6
|
-
* A rich text editor (RTE) control. Requires installation of an additional rich text editor library.
|
|
7
|
-
*/
|
|
8
5
|
namespace richtexteditor {
|
|
9
6
|
/**
|
|
10
7
|
* @SINCE 1.50
|
|
@@ -34,7 +31,8 @@ declare namespace sap {
|
|
|
34
31
|
|
|
35
32
|
/**
|
|
36
33
|
* Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
|
|
37
|
-
* than 200px, the minimum height of 200px will be applied.
|
|
34
|
+
* than 200px, the minimum height of 200px will be applied. **Note:** If the "autoresize" TinyMCE plugin
|
|
35
|
+
* is used, the height property is not taken into account.
|
|
38
36
|
*/
|
|
39
37
|
height?: sap.ui.core.CSSSize;
|
|
40
38
|
|
|
@@ -45,9 +43,15 @@ declare namespace sap {
|
|
|
45
43
|
* that may be introduced by other groups (hence this is not an enumeration).
|
|
46
44
|
*
|
|
47
45
|
* **Notes:**
|
|
48
|
-
* - TinyMCE version 3 is no longer supported and cannot be used. If you set the property to TinyMCE,
|
|
49
|
-
* it will load TinyMCE version 4.
|
|
50
46
|
* - Any attempts to set this property after the first rendering will not have any effect.
|
|
47
|
+
* - Usage of internal TinyMCE APIs is not recommended, since it might lead to issues upon TinyMCE version
|
|
48
|
+
* update.
|
|
49
|
+
* - TinyMCE version 3 and 4 are no longer supported and cannot be used.
|
|
50
|
+
* - TinyMCE 4 is out of support and by using it, application developers are accepting all the risks comming
|
|
51
|
+
* from that fact. In addition TinyMCE 4 will be removed in future releases.
|
|
52
|
+
* - TinyMCE 5 will be removed in future releases.
|
|
53
|
+
* - Have in mind when choosing a specific TinyMCE version that there might be differences in the support
|
|
54
|
+
* rules compared to UI5, therefore we might be forced to remove any TinyMCE version.
|
|
51
55
|
*/
|
|
52
56
|
editorType?: string;
|
|
53
57
|
|
|
@@ -67,49 +71,65 @@ declare namespace sap {
|
|
|
67
71
|
|
|
68
72
|
/**
|
|
69
73
|
* Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
|
|
70
|
-
* is available. Changing this after the initial rendering will result in some visible redrawing.
|
|
74
|
+
* is available. Changing this after the initial rendering will result in some visible redrawing. Note:
|
|
75
|
+
* This property will not be synchronized with group configuration provided via the buttonGroups property
|
|
76
|
+
* or when groups are added on a later stage.
|
|
71
77
|
*/
|
|
72
78
|
showGroupFontStyle?: boolean;
|
|
73
79
|
|
|
74
80
|
/**
|
|
75
81
|
* Determines whether the toolbar button group containing text alignment commands is available. Changing
|
|
76
|
-
* this after the initial rendering will result in some visible redrawing.
|
|
82
|
+
* this after the initial rendering will result in some visible redrawing. Note: This property will not
|
|
83
|
+
* be synchronized with group configuration provided via the buttonGroups property or when groups are added
|
|
84
|
+
* on a later stage.
|
|
77
85
|
*/
|
|
78
86
|
showGroupTextAlign?: boolean;
|
|
79
87
|
|
|
80
88
|
/**
|
|
81
89
|
* Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
|
|
82
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
90
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
91
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
92
|
+
* are added on a later stage.
|
|
83
93
|
*/
|
|
84
94
|
showGroupStructure?: boolean;
|
|
85
95
|
|
|
86
96
|
/**
|
|
87
97
|
* Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
|
|
88
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
98
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
99
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
100
|
+
* are added on a later stage.
|
|
89
101
|
*/
|
|
90
102
|
showGroupFont?: boolean;
|
|
91
103
|
|
|
92
104
|
/**
|
|
93
105
|
* Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
|
|
94
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
106
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
107
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
108
|
+
* are added on a later stage.
|
|
95
109
|
*/
|
|
96
110
|
showGroupClipboard?: boolean;
|
|
97
111
|
|
|
98
112
|
/**
|
|
99
113
|
* Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
|
|
100
|
-
* available. Changing this after the initial rendering will result in some visible redrawing.
|
|
114
|
+
* available. Changing this after the initial rendering will result in some visible redrawing. Note: This
|
|
115
|
+
* property will not be synchronized with group configuration provided via the buttonGroups property or
|
|
116
|
+
* when groups are added on a later stage.
|
|
101
117
|
*/
|
|
102
118
|
showGroupInsert?: boolean;
|
|
103
119
|
|
|
104
120
|
/**
|
|
105
121
|
* Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
|
|
106
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
122
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
123
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
124
|
+
* are added on a later stage.
|
|
107
125
|
*/
|
|
108
126
|
showGroupLink?: boolean;
|
|
109
127
|
|
|
110
128
|
/**
|
|
111
129
|
* Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
|
|
112
|
-
* this after the initial rendering will result in some visible redrawing.
|
|
130
|
+
* this after the initial rendering will result in some visible redrawing. Note: This property will not
|
|
131
|
+
* be synchronized with group configuration provided via the buttonGroups property or when groups are added
|
|
132
|
+
* on a later stage.
|
|
113
133
|
*/
|
|
114
134
|
showGroupUndo?: boolean;
|
|
115
135
|
|
|
@@ -126,7 +146,8 @@ declare namespace sap {
|
|
|
126
146
|
|
|
127
147
|
/**
|
|
128
148
|
* Determines whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure
|
|
129
|
-
* allowed URLs please use the
|
|
149
|
+
* allowed URLs please use the validator API via {@link module:sap/base/security/URLListValidator#add URLListValidator
|
|
150
|
+
* API}.
|
|
130
151
|
*/
|
|
131
152
|
sanitizeValue?: boolean;
|
|
132
153
|
|
|
@@ -137,6 +158,8 @@ declare namespace sap {
|
|
|
137
158
|
plugins?: object[];
|
|
138
159
|
|
|
139
160
|
/**
|
|
161
|
+
* @deprecated (since 1.84.40) - This property became obsolete after the deprecation of TinyMCE v3.
|
|
162
|
+
*
|
|
140
163
|
* Determines whether or not to use the legacy theme for the toolbar buttons. If this is set to false, the
|
|
141
164
|
* default theme for the editor will be used (which might change slightly with every update). The legacy
|
|
142
165
|
* theme has the disadvantage that not all functionality has its own icon, so using non default buttons
|
|
@@ -148,7 +171,11 @@ declare namespace sap {
|
|
|
148
171
|
* An array of button configurations. These configurations contain the names of buttons as array in the
|
|
149
172
|
* property "buttons" and the name of the group in "name", they can also contain the "row" where the buttons
|
|
150
173
|
* should be placed, a "priority" and whether the buttons are "visible". See method addButtonGroup() for
|
|
151
|
-
* more details on the structure of the objects in this array.
|
|
174
|
+
* more details on the structure of the objects in this array. **Note:** `buttonGroups` is a feature from
|
|
175
|
+
* the native editor. Its supported scope with `customToolbar` is limited up to the grouping- the user could
|
|
176
|
+
* turn on/off a whole group, but modifying buttons within a group is not possible. In order to achieve
|
|
177
|
+
* that functionality with `customToolbar`, the developer needs to turn the group off and instantiate their
|
|
178
|
+
* own `sap.m.Button`(s) with the desired functionality.
|
|
152
179
|
*/
|
|
153
180
|
buttonGroups?: object[];
|
|
154
181
|
|
|
@@ -156,7 +183,7 @@ declare namespace sap {
|
|
|
156
183
|
* @SINCE 1.48
|
|
157
184
|
*
|
|
158
185
|
* Determines whether a Fiori Toolbar is used instead of the TinyMCE default toolbar one. It is applied
|
|
159
|
-
* only when the EditorType is
|
|
186
|
+
* only when the EditorType is TinyMCE6 and sap.m library is loaded. **Note:** The `customToolbar` property
|
|
160
187
|
* will have effect only on initial loading. Changing it during runtime will not affect the initially loaded
|
|
161
188
|
* toolbar.
|
|
162
189
|
*/
|
|
@@ -181,9 +208,11 @@ declare namespace sap {
|
|
|
181
208
|
|
|
182
209
|
/**
|
|
183
210
|
* This event is fired right before the TinyMCE instance is created and can be used to change the settings
|
|
184
|
-
* object that will be given to TinyMCE. The parameter "configuration" is the javascript
|
|
211
|
+
* object that will be given to TinyMCE. The parameter "configuration" is the javascript object that will
|
|
185
212
|
* be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
|
|
186
|
-
* changed in the case of TinyMCE.
|
|
213
|
+
* changed in the case of TinyMCE. **Note:** In order to add plugins to the `RichTextEditor` control, you
|
|
214
|
+
* have to use the `addPlugin` method. Adding plugins through the settings object may lead to synchronizing
|
|
215
|
+
* issues between TinyMCE and `RichTextEditor` control.
|
|
187
216
|
*/
|
|
188
217
|
beforeEditorInit?: Function;
|
|
189
218
|
|
|
@@ -197,7 +226,7 @@ declare namespace sap {
|
|
|
197
226
|
customButtons?: sap.ui.core.Control[] | sap.ui.core.Control;
|
|
198
227
|
|
|
199
228
|
/**
|
|
200
|
-
* @SINCE 1.
|
|
229
|
+
* @SINCE 1.84.40
|
|
201
230
|
*
|
|
202
231
|
* Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
203
232
|
*/
|
|
@@ -214,15 +243,15 @@ declare namespace sap {
|
|
|
214
243
|
* a wrapper to the native toolbar and takes care of synchronizing the state of its internal controls with
|
|
215
244
|
* the current state of the selection in the editor (bold, italics, font styles etc.).
|
|
216
245
|
*
|
|
217
|
-
*
|
|
246
|
+
* Restrictions:
|
|
218
247
|
*
|
|
219
|
-
* **Note: The `RichTextEditor` uses a third-party component and therefore some additional
|
|
220
|
-
* for its proper usage and support. For more information see the Preamble section in {@link topic:d4f3f1598373452bb73f2120930c133c
|
|
248
|
+
* **Note: The `RichTextEditor` uses a third-party component and therefore some additional restrictions
|
|
249
|
+
* apply for its proper usage and support. For more information see the Preamble section in {@link topic:d4f3f1598373452bb73f2120930c133c
|
|
221
250
|
* sap.ui.richtexteditor}. **
|
|
222
251
|
*
|
|
223
252
|
* Guidelines:
|
|
224
253
|
* - The `RichTextEditor` should be used for desktop apps only. However, if it is essential for your
|
|
225
|
-
* use case, you can enable the mobile version of TinyMCE, whilst having in mind the
|
|
254
|
+
* use case, you can enable the mobile version of TinyMCE, whilst having in mind the restrictions. For more
|
|
226
255
|
* information see the {@link topic:d4f3f1598373452bb73f2120930c133c sap.ui.richtexteditor documentation}.
|
|
227
256
|
*
|
|
228
257
|
* - In order to be usable, the control needs a minimum width 17.5 rem and height of 12.5 rem.
|
|
@@ -242,6 +271,46 @@ declare namespace sap {
|
|
|
242
271
|
* text area} instead.
|
|
243
272
|
* - Use callbacks to the native third-party API with care, as there may be compatibility issues with
|
|
244
273
|
* later versions.
|
|
274
|
+
*
|
|
275
|
+
* Custom toolbar - adding and removing buttons: With version 1.84.40 it is possible to redefine the button
|
|
276
|
+
* groups configuration in order to show only particular set of buttons in the custom toolbar of the `RichTextEditor`.
|
|
277
|
+
* This is possible in few ways:
|
|
278
|
+
* - By providing the buttons group configurations as a whole by setting the `buttonGroups` property of
|
|
279
|
+
* the control.
|
|
280
|
+
* - By providing individual button group configuration via `addButtonGroup` method.
|
|
281
|
+
*
|
|
282
|
+
* Consider the following when choosing your approach:
|
|
283
|
+
* - Setting `buttonGroups` will override all current custom toolbar button group configurations. This
|
|
284
|
+
* method allows for total redefining of the custom toolbar groups.
|
|
285
|
+
* - Using `addButtonGroups` will try to add non-existing group into the configuration array, however,
|
|
286
|
+
* if such group configuration exists already, a warning will be logged and the new configuration will not
|
|
287
|
+
* be added. In order to replace the existing configuration you will need to remove it first via `removeButtonGroup`.
|
|
288
|
+
*
|
|
289
|
+
*
|
|
290
|
+
* Below is a list of supported groups and buttons, which can be specified in the configuration objects
|
|
291
|
+
* (format is <>: <>):
|
|
292
|
+
* - font-style: bold, italic, underline, strikethrough
|
|
293
|
+
* - font: fontfamily, fontsize, forecolor, backcolor
|
|
294
|
+
* - clipboard: cut, copy, paste
|
|
295
|
+
* - structure: bullist, numlist, outdent, indent
|
|
296
|
+
* - undo: undo, redo
|
|
297
|
+
* - insert: image, emoticons
|
|
298
|
+
* - link: link, unlink
|
|
299
|
+
* - text-align: alignleft, aligncenter, alignright, alignjustify Additional supported groups, which
|
|
300
|
+
* can be added only after the editor is loaded (they can not be specified in the above mentioned configuration):
|
|
301
|
+
*
|
|
302
|
+
* - table: table
|
|
303
|
+
* - styleselect: styleselect **Note!** Adding configuration for "text-align" group with any buttons
|
|
304
|
+
* will still render a menu button with all available options inside. Removing/hiding the group can be achieved
|
|
305
|
+
* by invoking `removeButtonGroup` or `setShowGroupTextAlign(false)` depending on the desired result.
|
|
306
|
+
*
|
|
307
|
+
* **Note!** There is no synchronization between the `setShowGroup*` properties and the configuration object
|
|
308
|
+
* that the application can specifying via `buttonGroups` in the constructor or on a later stage. This means
|
|
309
|
+
* that in case new configuration is provided and for particular group the passed object contains property
|
|
310
|
+
* `visible: true`, this group property will be respected no matter if the `RichTextEditor`'s property for
|
|
311
|
+
* this particular group is set to `false`. Example: Providing the following object as group configuration:
|
|
312
|
+
* { name: "font" visible: true } Will make the "font" group visible, no matter that calling `RichTextEditor.getShowGroupFont()`
|
|
313
|
+
* returns `false`.
|
|
245
314
|
*/
|
|
246
315
|
class RichTextEditor extends sap.ui.core.Control {
|
|
247
316
|
/**
|
|
@@ -266,7 +335,7 @@ declare namespace sap {
|
|
|
266
335
|
);
|
|
267
336
|
|
|
268
337
|
/**
|
|
269
|
-
* @SINCE 1.
|
|
338
|
+
* @SINCE 1.84.40
|
|
270
339
|
*
|
|
271
340
|
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
272
341
|
*/
|
|
@@ -277,13 +346,15 @@ declare namespace sap {
|
|
|
277
346
|
vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control
|
|
278
347
|
): sap.ui.richtexteditor.RichTextEditor;
|
|
279
348
|
/**
|
|
280
|
-
* Adds a button group to the editor.
|
|
349
|
+
* Adds a button group to the editor. **Note**: Adding already existing group will not do anything. If a
|
|
350
|
+
* button group needs to be changed, it first needs to be removed and then added by providing its name or
|
|
351
|
+
* map object, containing its desired configuration.
|
|
281
352
|
*/
|
|
282
353
|
addButtonGroup(
|
|
283
354
|
/**
|
|
284
355
|
* Name/ID of a single button or object containing the group information
|
|
285
356
|
*/
|
|
286
|
-
|
|
357
|
+
vGroup?: {
|
|
287
358
|
/**
|
|
288
359
|
* Array of name/IDs of the buttons in the group
|
|
289
360
|
*/
|
|
@@ -310,7 +381,7 @@ declare namespace sap {
|
|
|
310
381
|
*/
|
|
311
382
|
customToolbarPriority?: number;
|
|
312
383
|
}
|
|
313
|
-
):
|
|
384
|
+
): sap.ui.richtexteditor.RichTextEditor;
|
|
314
385
|
/**
|
|
315
386
|
* @SINCE 1.48
|
|
316
387
|
*
|
|
@@ -330,7 +401,7 @@ declare namespace sap {
|
|
|
330
401
|
* The plugin ID/name or an object with property "name", containing the ID/name of the plugin
|
|
331
402
|
*/
|
|
332
403
|
mPlugin?: object | string
|
|
333
|
-
):
|
|
404
|
+
): sap.ui.richtexteditor.RichTextEditor;
|
|
334
405
|
/**
|
|
335
406
|
* Attaches event handler `fnFunction` to the {@link #event:beforeEditorInit beforeEditorInit} event of
|
|
336
407
|
* this `sap.ui.richtexteditor.RichTextEditor`.
|
|
@@ -339,9 +410,11 @@ declare namespace sap {
|
|
|
339
410
|
* otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
|
|
340
411
|
*
|
|
341
412
|
* This event is fired right before the TinyMCE instance is created and can be used to change the settings
|
|
342
|
-
* object that will be given to TinyMCE. The parameter "configuration" is the javascript
|
|
413
|
+
* object that will be given to TinyMCE. The parameter "configuration" is the javascript object that will
|
|
343
414
|
* be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
|
|
344
|
-
* changed in the case of TinyMCE.
|
|
415
|
+
* changed in the case of TinyMCE. **Note:** In order to add plugins to the `RichTextEditor` control, you
|
|
416
|
+
* have to use the `addPlugin` method. Adding plugins through the settings object may lead to synchronizing
|
|
417
|
+
* issues between TinyMCE and `RichTextEditor` control.
|
|
345
418
|
*/
|
|
346
419
|
attachBeforeEditorInit(
|
|
347
420
|
/**
|
|
@@ -566,7 +639,7 @@ declare namespace sap {
|
|
|
566
639
|
mParameters?: object
|
|
567
640
|
): sap.ui.richtexteditor.RichTextEditor;
|
|
568
641
|
/**
|
|
569
|
-
* @SINCE 1.
|
|
642
|
+
* @SINCE 1.84.40
|
|
570
643
|
*
|
|
571
644
|
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
|
|
572
645
|
* ariaLabelledBy}.
|
|
@@ -578,7 +651,11 @@ declare namespace sap {
|
|
|
578
651
|
* An array of button configurations. These configurations contain the names of buttons as array in the
|
|
579
652
|
* property "buttons" and the name of the group in "name", they can also contain the "row" where the buttons
|
|
580
653
|
* should be placed, a "priority" and whether the buttons are "visible". See method addButtonGroup() for
|
|
581
|
-
* more details on the structure of the objects in this array.
|
|
654
|
+
* more details on the structure of the objects in this array. **Note:** `buttonGroups` is a feature from
|
|
655
|
+
* the native editor. Its supported scope with `customToolbar` is limited up to the grouping- the user could
|
|
656
|
+
* turn on/off a whole group, but modifying buttons within a group is not possible. In order to achieve
|
|
657
|
+
* that functionality with `customToolbar`, the developer needs to turn the group off and instantiate their
|
|
658
|
+
* own `sap.m.Button`(s) with the desired functionality.
|
|
582
659
|
*
|
|
583
660
|
* Default value is `[]`.
|
|
584
661
|
*/
|
|
@@ -599,7 +676,7 @@ declare namespace sap {
|
|
|
599
676
|
* Gets current value of property {@link #getCustomToolbar customToolbar}.
|
|
600
677
|
*
|
|
601
678
|
* Determines whether a Fiori Toolbar is used instead of the TinyMCE default toolbar one. It is applied
|
|
602
|
-
* only when the EditorType is
|
|
679
|
+
* only when the EditorType is TinyMCE6 and sap.m library is loaded. **Note:** The `customToolbar` property
|
|
603
680
|
* will have effect only on initial loading. Changing it during runtime will not affect the initially loaded
|
|
604
681
|
* toolbar.
|
|
605
682
|
*
|
|
@@ -635,9 +712,15 @@ declare namespace sap {
|
|
|
635
712
|
* that may be introduced by other groups (hence this is not an enumeration).
|
|
636
713
|
*
|
|
637
714
|
* **Notes:**
|
|
638
|
-
* - TinyMCE version 3 is no longer supported and cannot be used. If you set the property to TinyMCE,
|
|
639
|
-
* it will load TinyMCE version 4.
|
|
640
715
|
* - Any attempts to set this property after the first rendering will not have any effect.
|
|
716
|
+
* - Usage of internal TinyMCE APIs is not recommended, since it might lead to issues upon TinyMCE version
|
|
717
|
+
* update.
|
|
718
|
+
* - TinyMCE version 3 and 4 are no longer supported and cannot be used.
|
|
719
|
+
* - TinyMCE 4 is out of support and by using it, application developers are accepting all the risks comming
|
|
720
|
+
* from that fact. In addition TinyMCE 4 will be removed in future releases.
|
|
721
|
+
* - TinyMCE 5 will be removed in future releases.
|
|
722
|
+
* - Have in mind when choosing a specific TinyMCE version that there might be differences in the support
|
|
723
|
+
* rules compared to UI5, therefore we might be forced to remove any TinyMCE version.
|
|
641
724
|
*
|
|
642
725
|
* Default value is `'TinyMCE4'`.
|
|
643
726
|
*/
|
|
@@ -646,7 +729,8 @@ declare namespace sap {
|
|
|
646
729
|
* Gets current value of property {@link #getHeight height}.
|
|
647
730
|
*
|
|
648
731
|
* Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
|
|
649
|
-
* than 200px, the minimum height of 200px will be applied.
|
|
732
|
+
* than 200px, the minimum height of 200px will be applied. **Note:** If the "autoresize" TinyMCE plugin
|
|
733
|
+
* is used, the height property is not taken into account.
|
|
650
734
|
*/
|
|
651
735
|
getHeight(): sap.ui.core.CSSSize;
|
|
652
736
|
/**
|
|
@@ -681,7 +765,8 @@ declare namespace sap {
|
|
|
681
765
|
* Gets current value of property {@link #getSanitizeValue sanitizeValue}.
|
|
682
766
|
*
|
|
683
767
|
* Determines whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure
|
|
684
|
-
* allowed URLs please use the
|
|
768
|
+
* allowed URLs please use the validator API via {@link module:sap/base/security/URLListValidator#add URLListValidator
|
|
769
|
+
* API}.
|
|
685
770
|
*
|
|
686
771
|
* Default value is `true`.
|
|
687
772
|
*/
|
|
@@ -690,7 +775,9 @@ declare namespace sap {
|
|
|
690
775
|
* Gets current value of property {@link #getShowGroupClipboard showGroupClipboard}.
|
|
691
776
|
*
|
|
692
777
|
* Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
|
|
693
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
778
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
779
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
780
|
+
* are added on a later stage.
|
|
694
781
|
*
|
|
695
782
|
* Default value is `true`.
|
|
696
783
|
*/
|
|
@@ -699,7 +786,9 @@ declare namespace sap {
|
|
|
699
786
|
* Gets current value of property {@link #getShowGroupFont showGroupFont}.
|
|
700
787
|
*
|
|
701
788
|
* Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
|
|
702
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
789
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
790
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
791
|
+
* are added on a later stage.
|
|
703
792
|
*
|
|
704
793
|
* Default value is `false`.
|
|
705
794
|
*/
|
|
@@ -708,7 +797,9 @@ declare namespace sap {
|
|
|
708
797
|
* Gets current value of property {@link #getShowGroupFontStyle showGroupFontStyle}.
|
|
709
798
|
*
|
|
710
799
|
* Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
|
|
711
|
-
* is available. Changing this after the initial rendering will result in some visible redrawing.
|
|
800
|
+
* is available. Changing this after the initial rendering will result in some visible redrawing. Note:
|
|
801
|
+
* This property will not be synchronized with group configuration provided via the buttonGroups property
|
|
802
|
+
* or when groups are added on a later stage.
|
|
712
803
|
*
|
|
713
804
|
* Default value is `true`.
|
|
714
805
|
*/
|
|
@@ -717,7 +808,9 @@ declare namespace sap {
|
|
|
717
808
|
* Gets current value of property {@link #getShowGroupInsert showGroupInsert}.
|
|
718
809
|
*
|
|
719
810
|
* Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
|
|
720
|
-
* available. Changing this after the initial rendering will result in some visible redrawing.
|
|
811
|
+
* available. Changing this after the initial rendering will result in some visible redrawing. Note: This
|
|
812
|
+
* property will not be synchronized with group configuration provided via the buttonGroups property or
|
|
813
|
+
* when groups are added on a later stage.
|
|
721
814
|
*
|
|
722
815
|
* Default value is `false`.
|
|
723
816
|
*/
|
|
@@ -726,7 +819,9 @@ declare namespace sap {
|
|
|
726
819
|
* Gets current value of property {@link #getShowGroupLink showGroupLink}.
|
|
727
820
|
*
|
|
728
821
|
* Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
|
|
729
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
822
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
823
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
824
|
+
* are added on a later stage.
|
|
730
825
|
*
|
|
731
826
|
* Default value is `false`.
|
|
732
827
|
*/
|
|
@@ -735,7 +830,9 @@ declare namespace sap {
|
|
|
735
830
|
* Gets current value of property {@link #getShowGroupStructure showGroupStructure}.
|
|
736
831
|
*
|
|
737
832
|
* Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
|
|
738
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
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.
|
|
739
836
|
*
|
|
740
837
|
* Default value is `true`.
|
|
741
838
|
*/
|
|
@@ -744,7 +841,9 @@ declare namespace sap {
|
|
|
744
841
|
* Gets current value of property {@link #getShowGroupTextAlign showGroupTextAlign}.
|
|
745
842
|
*
|
|
746
843
|
* Determines whether the toolbar button group containing text alignment commands is available. Changing
|
|
747
|
-
* this after the initial rendering will result in some visible redrawing.
|
|
844
|
+
* this after the initial rendering will result in some visible redrawing. Note: This property will not
|
|
845
|
+
* be synchronized with group configuration provided via the buttonGroups property or when groups are added
|
|
846
|
+
* on a later stage.
|
|
748
847
|
*
|
|
749
848
|
* Default value is `true`.
|
|
750
849
|
*/
|
|
@@ -753,7 +852,9 @@ declare namespace sap {
|
|
|
753
852
|
* Gets current value of property {@link #getShowGroupUndo showGroupUndo}.
|
|
754
853
|
*
|
|
755
854
|
* Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
|
|
756
|
-
* this after the initial rendering will result in some visible redrawing.
|
|
855
|
+
* this after the initial rendering will result in some visible redrawing. Note: This property will not
|
|
856
|
+
* be synchronized with group configuration provided via the buttonGroups property or when groups are added
|
|
857
|
+
* on a later stage.
|
|
757
858
|
*
|
|
758
859
|
* Default value is `false`.
|
|
759
860
|
*/
|
|
@@ -767,6 +868,8 @@ declare namespace sap {
|
|
|
767
868
|
*/
|
|
768
869
|
getTextDirection(): sap.ui.core.TextDirection;
|
|
769
870
|
/**
|
|
871
|
+
* @deprecated (since 1.84.40) - This property became obsolete after the deprecation of TinyMCE v3.
|
|
872
|
+
*
|
|
770
873
|
* Gets current value of property {@link #getUseLegacyTheme useLegacyTheme}.
|
|
771
874
|
*
|
|
772
875
|
* Determines whether or not to use the legacy theme for the toolbar buttons. If this is set to false, the
|
|
@@ -833,7 +936,7 @@ declare namespace sap {
|
|
|
833
936
|
iIndex: number
|
|
834
937
|
): sap.ui.richtexteditor.RichTextEditor;
|
|
835
938
|
/**
|
|
836
|
-
* @SINCE 1.
|
|
939
|
+
* @SINCE 1.84.40
|
|
837
940
|
*
|
|
838
941
|
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
839
942
|
*/
|
|
@@ -847,7 +950,7 @@ declare namespace sap {
|
|
|
847
950
|
*/
|
|
848
951
|
removeAllCustomButtons(): sap.ui.core.Control[];
|
|
849
952
|
/**
|
|
850
|
-
* @SINCE 1.
|
|
953
|
+
* @SINCE 1.84.40
|
|
851
954
|
*
|
|
852
955
|
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
853
956
|
*/
|
|
@@ -857,6 +960,15 @@ declare namespace sap {
|
|
|
857
960
|
*/
|
|
858
961
|
vAriaLabelledBy: number | sap.ui.core.ID | sap.ui.core.Control
|
|
859
962
|
): sap.ui.core.ID;
|
|
963
|
+
/**
|
|
964
|
+
* Removes a button group from the editor.
|
|
965
|
+
*/
|
|
966
|
+
removeButtonGroup(
|
|
967
|
+
/**
|
|
968
|
+
* The name of the group to be removed.
|
|
969
|
+
*/
|
|
970
|
+
sGroupName?: string
|
|
971
|
+
): sap.ui.richtexteditor.RichTextEditor;
|
|
860
972
|
/**
|
|
861
973
|
* @SINCE 1.48
|
|
862
974
|
*
|
|
@@ -876,7 +988,7 @@ declare namespace sap {
|
|
|
876
988
|
* The name/ID of the plugin to remove
|
|
877
989
|
*/
|
|
878
990
|
sPluginName?: string
|
|
879
|
-
):
|
|
991
|
+
): sap.ui.richtexteditor.RichTextEditor;
|
|
880
992
|
/**
|
|
881
993
|
* Sets the button groups to the editor.
|
|
882
994
|
*/
|
|
@@ -885,14 +997,14 @@ declare namespace sap {
|
|
|
885
997
|
* Array of names or objects containing the group information
|
|
886
998
|
*/
|
|
887
999
|
aGroups?: any[]
|
|
888
|
-
):
|
|
1000
|
+
): sap.ui.richtexteditor.RichTextEditor;
|
|
889
1001
|
/**
|
|
890
1002
|
* @SINCE 1.48
|
|
891
1003
|
*
|
|
892
1004
|
* Sets a new value for property {@link #getCustomToolbar customToolbar}.
|
|
893
1005
|
*
|
|
894
1006
|
* Determines whether a Fiori Toolbar is used instead of the TinyMCE default toolbar one. It is applied
|
|
895
|
-
* only when the EditorType is
|
|
1007
|
+
* only when the EditorType is TinyMCE6 and sap.m library is loaded. **Note:** The `customToolbar` property
|
|
896
1008
|
* will have effect only on initial loading. Changing it during runtime will not affect the initially loaded
|
|
897
1009
|
* toolbar.
|
|
898
1010
|
*
|
|
@@ -946,15 +1058,16 @@ declare namespace sap {
|
|
|
946
1058
|
*/
|
|
947
1059
|
setEditorType(
|
|
948
1060
|
/**
|
|
949
|
-
* Which editor type to be used (currently only TinyMCE
|
|
1061
|
+
* Which editor type to be used (currently only TinyMCE 4, 5 and 6)
|
|
950
1062
|
*/
|
|
951
1063
|
sEditorType?: string
|
|
952
|
-
):
|
|
1064
|
+
): sap.ui.richtexteditor.RichTextEditor;
|
|
953
1065
|
/**
|
|
954
1066
|
* Sets a new value for property {@link #getHeight height}.
|
|
955
1067
|
*
|
|
956
1068
|
* Height of RichTextEditor control in CSS units. **Note:** If the height property results in a value smaller
|
|
957
|
-
* than 200px, the minimum height of 200px will be applied.
|
|
1069
|
+
* than 200px, the minimum height of 200px will be applied. **Note:** If the "autoresize" TinyMCE plugin
|
|
1070
|
+
* is used, the height property is not taken into account.
|
|
958
1071
|
*
|
|
959
1072
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
960
1073
|
*/
|
|
@@ -972,7 +1085,7 @@ declare namespace sap {
|
|
|
972
1085
|
* Array of names or objects containing the plugin information
|
|
973
1086
|
*/
|
|
974
1087
|
aPlugins?: any[]
|
|
975
|
-
):
|
|
1088
|
+
): sap.ui.richtexteditor.RichTextEditor;
|
|
976
1089
|
/**
|
|
977
1090
|
* Sets a new value for property {@link #getRequired required}.
|
|
978
1091
|
*
|
|
@@ -992,7 +1105,8 @@ declare namespace sap {
|
|
|
992
1105
|
* Sets a new value for property {@link #getSanitizeValue sanitizeValue}.
|
|
993
1106
|
*
|
|
994
1107
|
* Determines whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure
|
|
995
|
-
* allowed URLs please use the
|
|
1108
|
+
* allowed URLs please use the validator API via {@link module:sap/base/security/URLListValidator#add URLListValidator
|
|
1109
|
+
* API}.
|
|
996
1110
|
*
|
|
997
1111
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
998
1112
|
*
|
|
@@ -1008,7 +1122,9 @@ declare namespace sap {
|
|
|
1008
1122
|
* Sets a new value for property {@link #getShowGroupClipboard showGroupClipboard}.
|
|
1009
1123
|
*
|
|
1010
1124
|
* Determines whether the toolbar button group containing commands like Cut, Copy and Paste is available.
|
|
1011
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
1125
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
1126
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
1127
|
+
* are added on a later stage.
|
|
1012
1128
|
*
|
|
1013
1129
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1014
1130
|
*
|
|
@@ -1024,7 +1140,9 @@ declare namespace sap {
|
|
|
1024
1140
|
* Sets a new value for property {@link #getShowGroupFont showGroupFont}.
|
|
1025
1141
|
*
|
|
1026
1142
|
* Determines whether the toolbar button group containing commands like Font, Font Size and Colors is available.
|
|
1027
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
1143
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
1144
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
1145
|
+
* are added on a later stage.
|
|
1028
1146
|
*
|
|
1029
1147
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1030
1148
|
*
|
|
@@ -1040,7 +1158,9 @@ declare namespace sap {
|
|
|
1040
1158
|
* Sets a new value for property {@link #getShowGroupFontStyle showGroupFontStyle}.
|
|
1041
1159
|
*
|
|
1042
1160
|
* Determines whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough
|
|
1043
|
-
* is available. Changing this after the initial rendering will result in some visible redrawing.
|
|
1161
|
+
* is available. Changing this after the initial rendering will result in some visible redrawing. Note:
|
|
1162
|
+
* This property will not be synchronized with group configuration provided via the buttonGroups property
|
|
1163
|
+
* or when groups are added on a later stage.
|
|
1044
1164
|
*
|
|
1045
1165
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1046
1166
|
*
|
|
@@ -1056,7 +1176,9 @@ declare namespace sap {
|
|
|
1056
1176
|
* Sets a new value for property {@link #getShowGroupInsert showGroupInsert}.
|
|
1057
1177
|
*
|
|
1058
1178
|
* Determines whether the toolbar button group containing commands like Insert Image and Insert Smiley is
|
|
1059
|
-
* available. Changing this after the initial rendering will result in some visible redrawing.
|
|
1179
|
+
* available. Changing this after the initial rendering will result in some visible redrawing. Note: This
|
|
1180
|
+
* property will not be synchronized with group configuration provided via the buttonGroups property or
|
|
1181
|
+
* when groups are added on a later stage.
|
|
1060
1182
|
*
|
|
1061
1183
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1062
1184
|
*
|
|
@@ -1072,7 +1194,9 @@ declare namespace sap {
|
|
|
1072
1194
|
* Sets a new value for property {@link #getShowGroupLink showGroupLink}.
|
|
1073
1195
|
*
|
|
1074
1196
|
* Determines whether the toolbar button group containing commands like Create Link and Remove Link is available.
|
|
1075
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
1197
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
1198
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
1199
|
+
* are added on a later stage.
|
|
1076
1200
|
*
|
|
1077
1201
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1078
1202
|
*
|
|
@@ -1088,7 +1212,9 @@ declare namespace sap {
|
|
|
1088
1212
|
* Sets a new value for property {@link #getShowGroupStructure showGroupStructure}.
|
|
1089
1213
|
*
|
|
1090
1214
|
* Determines whether the toolbar button group containing commands like Bullets and Indentation is available.
|
|
1091
|
-
* Changing this after the initial rendering will result in some visible redrawing.
|
|
1215
|
+
* Changing this after the initial rendering will result in some visible redrawing. Note: This property
|
|
1216
|
+
* will not be synchronized with group configuration provided via the buttonGroups property or when groups
|
|
1217
|
+
* are added on a later stage.
|
|
1092
1218
|
*
|
|
1093
1219
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1094
1220
|
*
|
|
@@ -1104,7 +1230,9 @@ declare namespace sap {
|
|
|
1104
1230
|
* Sets a new value for property {@link #getShowGroupTextAlign showGroupTextAlign}.
|
|
1105
1231
|
*
|
|
1106
1232
|
* Determines whether the toolbar button group containing text alignment commands is available. Changing
|
|
1107
|
-
* this after the initial rendering will result in some visible redrawing.
|
|
1233
|
+
* this after the initial rendering will result in some visible redrawing. Note: This property will not
|
|
1234
|
+
* be synchronized with group configuration provided via the buttonGroups property or when groups are added
|
|
1235
|
+
* on a later stage.
|
|
1108
1236
|
*
|
|
1109
1237
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1110
1238
|
*
|
|
@@ -1120,7 +1248,9 @@ declare namespace sap {
|
|
|
1120
1248
|
* Sets a new value for property {@link #getShowGroupUndo showGroupUndo}.
|
|
1121
1249
|
*
|
|
1122
1250
|
* Determines whether the toolbar button group containing commands like Undo and Redo is available. Changing
|
|
1123
|
-
* this after the initial rendering will result in some visible redrawing.
|
|
1251
|
+
* this after the initial rendering will result in some visible redrawing. Note: This property will not
|
|
1252
|
+
* be synchronized with group configuration provided via the buttonGroups property or when groups are added
|
|
1253
|
+
* on a later stage.
|
|
1124
1254
|
*
|
|
1125
1255
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1126
1256
|
*
|
|
@@ -1148,6 +1278,8 @@ declare namespace sap {
|
|
|
1148
1278
|
sTextDirection?: sap.ui.core.TextDirection
|
|
1149
1279
|
): sap.ui.richtexteditor.RichTextEditor;
|
|
1150
1280
|
/**
|
|
1281
|
+
* @deprecated (since 1.84.40) - This property became obsolete after the deprecation of TinyMCE v3.
|
|
1282
|
+
*
|
|
1151
1283
|
* Sets a new value for property {@link #getUseLegacyTheme useLegacyTheme}.
|
|
1152
1284
|
*
|
|
1153
1285
|
* Determines whether or not to use the legacy theme for the toolbar buttons. If this is set to false, the
|
|
@@ -1220,9 +1352,11 @@ declare namespace sap {
|
|
|
1220
1352
|
* otherwise it will be bound to this `sap.ui.richtexteditor.RichTextEditor` itself.
|
|
1221
1353
|
*
|
|
1222
1354
|
* This event is fired right before the TinyMCE instance is created and can be used to change the settings
|
|
1223
|
-
* object that will be given to TinyMCE. The parameter "configuration" is the javascript
|
|
1355
|
+
* object that will be given to TinyMCE. The parameter "configuration" is the javascript object that will
|
|
1224
1356
|
* be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be
|
|
1225
|
-
* changed in the case of TinyMCE.
|
|
1357
|
+
* changed in the case of TinyMCE. **Note:** In order to add plugins to the `RichTextEditor` control, you
|
|
1358
|
+
* have to use the `addPlugin` method. Adding plugins through the settings object may lead to synchronizing
|
|
1359
|
+
* issues between TinyMCE and `RichTextEditor` control.
|
|
1226
1360
|
*/
|
|
1227
1361
|
attachBeforeEditorInit(
|
|
1228
1362
|
/**
|
|
@@ -1301,13 +1435,18 @@ declare namespace sap {
|
|
|
1301
1435
|
*/
|
|
1302
1436
|
enum EditorType {
|
|
1303
1437
|
/**
|
|
1304
|
-
* Uses TinyMCE version
|
|
1438
|
+
* Uses latest recommended TinyMCE version Current one is TinyMCE 6
|
|
1305
1439
|
*/
|
|
1306
1440
|
TinyMCE,
|
|
1307
1441
|
/**
|
|
1308
|
-
* Uses TinyMCE version 4 as editor
|
|
1442
|
+
* Uses TinyMCE version 4 as editor TinyMCE 4 is no longer supported, therefore using it is on your own
|
|
1443
|
+
* risk.
|
|
1309
1444
|
*/
|
|
1310
1445
|
TinyMCE4,
|
|
1446
|
+
/**
|
|
1447
|
+
* Uses TinyMCE version 6 as editor
|
|
1448
|
+
*/
|
|
1449
|
+
TinyMCE6,
|
|
1311
1450
|
}
|
|
1312
1451
|
}
|
|
1313
1452
|
}
|
package/types/sap.ui.rta.d.ts
CHANGED
package/types/sap.ui.suite.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.84.
|
|
1
|
+
// For Library Version: 1.84.42
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -237,7 +237,7 @@ declare namespace sap {
|
|
|
237
237
|
static getType(): string;
|
|
238
238
|
}
|
|
239
239
|
/**
|
|
240
|
-
* @SINCE 1.84.
|
|
240
|
+
* @SINCE 1.84.42
|
|
241
241
|
*
|
|
242
242
|
* Defines the Audiences.
|
|
243
243
|
*/
|
|
@@ -256,7 +256,7 @@ declare namespace sap {
|
|
|
256
256
|
Internal,
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
|
-
* @SINCE 1.84.
|
|
259
|
+
* @SINCE 1.84.42
|
|
260
260
|
*
|
|
261
261
|
* Issue Categories.
|
|
262
262
|
*/
|
|
@@ -311,7 +311,7 @@ declare namespace sap {
|
|
|
311
311
|
Usage,
|
|
312
312
|
}
|
|
313
313
|
/**
|
|
314
|
-
* @SINCE 1.84.
|
|
314
|
+
* @SINCE 1.84.42
|
|
315
315
|
*
|
|
316
316
|
* Analysis history formats.
|
|
317
317
|
*/
|
|
@@ -326,7 +326,7 @@ declare namespace sap {
|
|
|
326
326
|
String,
|
|
327
327
|
}
|
|
328
328
|
/**
|
|
329
|
-
* @SINCE 1.84.
|
|
329
|
+
* @SINCE 1.84.42
|
|
330
330
|
*
|
|
331
331
|
* Defines severity types.
|
|
332
332
|
*/
|
|
@@ -345,7 +345,7 @@ declare namespace sap {
|
|
|
345
345
|
Medium,
|
|
346
346
|
}
|
|
347
347
|
/**
|
|
348
|
-
* @SINCE 1.84.
|
|
348
|
+
* @SINCE 1.84.42
|
|
349
349
|
*
|
|
350
350
|
* Contains the available system presets.
|
|
351
351
|
*/
|
package/types/sap.ui.table.d.ts
CHANGED
package/types/sap.ui.ux3.d.ts
CHANGED
package/types/sap.ui.vk.d.ts
CHANGED
package/types/sap.ushell.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.84.
|
|
1
|
+
// For Library Version: 1.84.40
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -6230,6 +6230,8 @@ The design is deliberately restrictive and non-robust.
|
|
|
6230
6230
|
|
|
6231
6231
|
displayFormatHint?: string;
|
|
6232
6232
|
|
|
6233
|
+
dataHelpId?: string;
|
|
6234
|
+
|
|
6233
6235
|
tileActions?: sap.m.Button[] | sap.m.Button;
|
|
6234
6236
|
}
|
|
6235
6237
|
/**
|
|
@@ -8220,6 +8222,12 @@ The design is deliberately restrictive and non-robust.
|
|
|
8220
8222
|
* Default value is `false`.
|
|
8221
8223
|
*/
|
|
8222
8224
|
getActive(): boolean;
|
|
8225
|
+
/**
|
|
8226
|
+
* Gets current value of property {@link #getDataHelpId dataHelpId}.
|
|
8227
|
+
*
|
|
8228
|
+
* Default value is `empty string`.
|
|
8229
|
+
*/
|
|
8230
|
+
getDataHelpId(): string;
|
|
8223
8231
|
/**
|
|
8224
8232
|
* Gets current value of property {@link #getDisplayFormatHint displayFormatHint}.
|
|
8225
8233
|
*
|
|
@@ -8317,6 +8325,19 @@ The design is deliberately restrictive and non-robust.
|
|
|
8317
8325
|
*/
|
|
8318
8326
|
bActive?: boolean
|
|
8319
8327
|
): sap.ushell.ui.launchpad.VizInstanceLink;
|
|
8328
|
+
/**
|
|
8329
|
+
* Sets a new value for property {@link #getDataHelpId dataHelpId}.
|
|
8330
|
+
*
|
|
8331
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
8332
|
+
*
|
|
8333
|
+
* Default value is `empty string`.
|
|
8334
|
+
*/
|
|
8335
|
+
setDataHelpId(
|
|
8336
|
+
/**
|
|
8337
|
+
* New value for property `dataHelpId`
|
|
8338
|
+
*/
|
|
8339
|
+
sDataHelpId?: string
|
|
8340
|
+
): sap.ushell.ui.launchpad.VizInstanceLink;
|
|
8320
8341
|
/**
|
|
8321
8342
|
* Sets a new value for property {@link #getDisplayFormatHint displayFormatHint}.
|
|
8322
8343
|
*
|
package/types/sap.uxap.d.ts
CHANGED
package/types/sap.viz.d.ts
CHANGED