@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.
- package/LICENSE.txt +35 -0
- package/README.md +35 -0
- package/package.json +23 -0
- package/types/index.d.ts +67 -0
- package/types/sap.apf.d.ts +1026 -0
- package/types/sap.ca.ui.d.ts +14005 -0
- package/types/sap.chart.d.ts +4815 -0
- package/types/sap.collaboration.d.ts +2704 -0
- package/types/sap.esh.search.ui.d.ts +1595 -0
- package/types/sap.f.d.ts +20085 -0
- package/types/sap.fe.core.d.ts +1508 -0
- package/types/sap.fe.macros.d.ts +975 -0
- package/types/sap.fe.navigation.d.ts +917 -0
- package/types/sap.fe.templates.d.ts +522 -0
- package/types/sap.fe.test.d.ts +3533 -0
- package/types/sap.feedback.ui.d.ts +3 -0
- package/types/sap.gantt.d.ts +51684 -0
- package/types/sap.insights.d.ts +23 -0
- package/types/sap.landvisz.d.ts +7952 -0
- package/types/sap.m.d.ts +147796 -0
- package/types/sap.makit.d.ts +4533 -0
- package/types/sap.me.d.ts +3665 -0
- package/types/sap.ndc.d.ts +774 -0
- package/types/sap.ovp.d.ts +176 -0
- package/types/sap.rules.ui.d.ts +1471 -0
- package/types/sap.sac.df.d.ts +2292 -0
- package/types/sap.sac.grid.d.ts +774 -0
- package/types/sap.suite.ui.commons.d.ts +46971 -0
- package/types/sap.suite.ui.generic.template.d.ts +3431 -0
- package/types/sap.suite.ui.microchart.d.ts +12652 -0
- package/types/sap.tnt.d.ts +2227 -0
- package/types/sap.ui.codeeditor.d.ts +693 -0
- package/types/sap.ui.commons.d.ts +30235 -0
- package/types/sap.ui.comp.d.ts +37411 -0
- package/types/sap.ui.core.d.ts +78872 -0
- package/types/sap.ui.dt.d.ts +3 -0
- package/types/sap.ui.export.d.ts +843 -0
- package/types/sap.ui.fl.d.ts +1663 -0
- package/types/sap.ui.generic.app.d.ts +2683 -0
- package/types/sap.ui.generic.template.d.ts +3 -0
- package/types/sap.ui.integration.d.ts +4032 -0
- package/types/sap.ui.layout.d.ts +14472 -0
- package/types/sap.ui.mdc.d.ts +476 -0
- package/types/sap.ui.richtexteditor.d.ts +1666 -0
- package/types/sap.ui.rta.d.ts +124 -0
- package/types/sap.ui.suite.d.ts +685 -0
- package/types/sap.ui.support.d.ts +453 -0
- package/types/sap.ui.table.d.ts +9325 -0
- package/types/sap.ui.testrecorder.d.ts +9 -0
- package/types/sap.ui.unified.d.ts +20640 -0
- package/types/sap.ui.ux3.d.ts +18288 -0
- package/types/sap.ui.vbm.d.ts +17251 -0
- package/types/sap.ui.vk.d.ts +42381 -0
- package/types/sap.ui.vtm.d.ts +10547 -0
- package/types/sap.ui.webc.common.d.ts +113 -0
- package/types/sap.ui.webc.fiori.d.ts +13850 -0
- package/types/sap.ui.webc.main.d.ts +40833 -0
- package/types/sap.uiext.inbox.d.ts +4079 -0
- package/types/sap.ushell.d.ts +10255 -0
- package/types/sap.ushell_abap.d.ts +9 -0
- package/types/sap.uxap.d.ts +7636 -0
- package/types/sap.viz.d.ts +51209 -0
- package/types/sap.webanalytics.core.d.ts +3 -0
- package/types/sap.zen.commons.d.ts +1542 -0
- package/types/sap.zen.crosstab.d.ts +1159 -0
- package/types/sap.zen.dsh.d.ts +2132 -0
|
@@ -0,0 +1,693 @@
|
|
|
1
|
+
// For Library Version: 1.113.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/ui/codeeditor/library" {}
|
|
4
|
+
|
|
5
|
+
declare module "sap/ui/codeeditor/CodeEditor" {
|
|
6
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
7
|
+
|
|
8
|
+
import Event from "sap/ui/base/Event";
|
|
9
|
+
|
|
10
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
11
|
+
|
|
12
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
13
|
+
|
|
14
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* @SINCE 1.46
|
|
18
|
+
*
|
|
19
|
+
* Allows to visualize source code of various types with syntax highlighting, line numbers in editable and
|
|
20
|
+
* read only mode. Use this control in scenarios where the user should be able to inspect and edit source
|
|
21
|
+
* code. The control currently uses the third-party code editor Ace.
|
|
22
|
+
*/
|
|
23
|
+
export default class CodeEditor extends Control {
|
|
24
|
+
/**
|
|
25
|
+
* Constructor for a new CodeEditor.
|
|
26
|
+
*
|
|
27
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
28
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
29
|
+
* of the syntax of the settings object.
|
|
30
|
+
*/
|
|
31
|
+
constructor(
|
|
32
|
+
/**
|
|
33
|
+
* initial settings for the new control
|
|
34
|
+
*/
|
|
35
|
+
mSettings?: $CodeEditorSettings
|
|
36
|
+
);
|
|
37
|
+
/**
|
|
38
|
+
* Constructor for a new CodeEditor.
|
|
39
|
+
*
|
|
40
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
41
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
42
|
+
* of the syntax of the settings object.
|
|
43
|
+
*/
|
|
44
|
+
constructor(
|
|
45
|
+
/**
|
|
46
|
+
* id for the new control, generated automatically if no id is given
|
|
47
|
+
*/
|
|
48
|
+
sId?: string,
|
|
49
|
+
/**
|
|
50
|
+
* initial settings for the new control
|
|
51
|
+
*/
|
|
52
|
+
mSettings?: $CodeEditorSettings
|
|
53
|
+
);
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Creates a new subclass of class sap.ui.codeeditor.CodeEditor with name `sClassName` and enriches it with
|
|
57
|
+
* the information contained in `oClassInfo`.
|
|
58
|
+
*
|
|
59
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
60
|
+
*
|
|
61
|
+
* @returns Created class / constructor function
|
|
62
|
+
*/
|
|
63
|
+
static extend<T extends Record<string, unknown>>(
|
|
64
|
+
/**
|
|
65
|
+
* Name of the class being created
|
|
66
|
+
*/
|
|
67
|
+
sClassName: string,
|
|
68
|
+
/**
|
|
69
|
+
* Object literal with information about the class
|
|
70
|
+
*/
|
|
71
|
+
oClassInfo?: sap.ClassInfo<T, CodeEditor>,
|
|
72
|
+
/**
|
|
73
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
74
|
+
* used by this class
|
|
75
|
+
*/
|
|
76
|
+
FNMetaImpl?: Function
|
|
77
|
+
): Function;
|
|
78
|
+
/**
|
|
79
|
+
* Returns a metadata object for class sap.ui.codeeditor.CodeEditor.
|
|
80
|
+
*
|
|
81
|
+
* @returns Metadata object describing this class
|
|
82
|
+
*/
|
|
83
|
+
static getMetadata(): ElementMetadata;
|
|
84
|
+
/**
|
|
85
|
+
* @SINCE 1.52
|
|
86
|
+
*
|
|
87
|
+
* Defines custom completer - object implementing a getCompletions method. The method has two parameters
|
|
88
|
+
* - fnCallback method and context object. Context object provides details about oPos and sPrefix as provided
|
|
89
|
+
* by the third-party code editor.
|
|
90
|
+
*/
|
|
91
|
+
addCustomCompleter(
|
|
92
|
+
/**
|
|
93
|
+
* Object with getCompletions method
|
|
94
|
+
*/
|
|
95
|
+
oCustomCompleter: {
|
|
96
|
+
getCompletions: Function;
|
|
97
|
+
}
|
|
98
|
+
): void;
|
|
99
|
+
/**
|
|
100
|
+
* Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.codeeditor.CodeEditor`.
|
|
101
|
+
*
|
|
102
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
103
|
+
* otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
|
|
104
|
+
*
|
|
105
|
+
* Fired when the value has changed and the focus leaves the code editor.
|
|
106
|
+
*
|
|
107
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
108
|
+
*/
|
|
109
|
+
attachChange(
|
|
110
|
+
/**
|
|
111
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
112
|
+
* object when firing the event
|
|
113
|
+
*/
|
|
114
|
+
oData: object,
|
|
115
|
+
/**
|
|
116
|
+
* The function to be called when the event occurs
|
|
117
|
+
*/
|
|
118
|
+
fnFunction: (p1: Event) => void,
|
|
119
|
+
/**
|
|
120
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
|
|
121
|
+
*/
|
|
122
|
+
oListener?: object
|
|
123
|
+
): this;
|
|
124
|
+
/**
|
|
125
|
+
* Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.codeeditor.CodeEditor`.
|
|
126
|
+
*
|
|
127
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
128
|
+
* otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
|
|
129
|
+
*
|
|
130
|
+
* Fired when the value has changed and the focus leaves the code editor.
|
|
131
|
+
*
|
|
132
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
133
|
+
*/
|
|
134
|
+
attachChange(
|
|
135
|
+
/**
|
|
136
|
+
* The function to be called when the event occurs
|
|
137
|
+
*/
|
|
138
|
+
fnFunction: (p1: Event) => void,
|
|
139
|
+
/**
|
|
140
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
|
|
141
|
+
*/
|
|
142
|
+
oListener?: object
|
|
143
|
+
): this;
|
|
144
|
+
/**
|
|
145
|
+
* Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.codeeditor.CodeEditor`.
|
|
146
|
+
*
|
|
147
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
148
|
+
* otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
|
|
149
|
+
*
|
|
150
|
+
* Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
|
|
151
|
+
*
|
|
152
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
153
|
+
*/
|
|
154
|
+
attachLiveChange(
|
|
155
|
+
/**
|
|
156
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
157
|
+
* object when firing the event
|
|
158
|
+
*/
|
|
159
|
+
oData: object,
|
|
160
|
+
/**
|
|
161
|
+
* The function to be called when the event occurs
|
|
162
|
+
*/
|
|
163
|
+
fnFunction: (p1: Event) => void,
|
|
164
|
+
/**
|
|
165
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
|
|
166
|
+
*/
|
|
167
|
+
oListener?: object
|
|
168
|
+
): this;
|
|
169
|
+
/**
|
|
170
|
+
* Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.codeeditor.CodeEditor`.
|
|
171
|
+
*
|
|
172
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
173
|
+
* otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
|
|
174
|
+
*
|
|
175
|
+
* Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
|
|
176
|
+
*
|
|
177
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
178
|
+
*/
|
|
179
|
+
attachLiveChange(
|
|
180
|
+
/**
|
|
181
|
+
* The function to be called when the event occurs
|
|
182
|
+
*/
|
|
183
|
+
fnFunction: (p1: Event) => void,
|
|
184
|
+
/**
|
|
185
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
|
|
186
|
+
*/
|
|
187
|
+
oListener?: object
|
|
188
|
+
): this;
|
|
189
|
+
/**
|
|
190
|
+
* Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.codeeditor.CodeEditor`.
|
|
191
|
+
*
|
|
192
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
193
|
+
*
|
|
194
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
195
|
+
*/
|
|
196
|
+
detachChange(
|
|
197
|
+
/**
|
|
198
|
+
* The function to be called, when the event occurs
|
|
199
|
+
*/
|
|
200
|
+
fnFunction: (p1: Event) => void,
|
|
201
|
+
/**
|
|
202
|
+
* Context object on which the given function had to be called
|
|
203
|
+
*/
|
|
204
|
+
oListener?: object
|
|
205
|
+
): this;
|
|
206
|
+
/**
|
|
207
|
+
* Detaches event handler `fnFunction` from the {@link #event:liveChange liveChange} event of this `sap.ui.codeeditor.CodeEditor`.
|
|
208
|
+
*
|
|
209
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
210
|
+
*
|
|
211
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
212
|
+
*/
|
|
213
|
+
detachLiveChange(
|
|
214
|
+
/**
|
|
215
|
+
* The function to be called, when the event occurs
|
|
216
|
+
*/
|
|
217
|
+
fnFunction: (p1: Event) => void,
|
|
218
|
+
/**
|
|
219
|
+
* Context object on which the given function had to be called
|
|
220
|
+
*/
|
|
221
|
+
oListener?: object
|
|
222
|
+
): this;
|
|
223
|
+
/**
|
|
224
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
225
|
+
*
|
|
226
|
+
* Fires event {@link #event:change change} to attached listeners.
|
|
227
|
+
*
|
|
228
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
229
|
+
*/
|
|
230
|
+
fireChange(
|
|
231
|
+
/**
|
|
232
|
+
* Parameters to pass along with the event
|
|
233
|
+
*/
|
|
234
|
+
mParameters?: {
|
|
235
|
+
/**
|
|
236
|
+
* The current value of the code editor.
|
|
237
|
+
*/
|
|
238
|
+
value?: string;
|
|
239
|
+
/**
|
|
240
|
+
* The old value of the code editor.
|
|
241
|
+
*/
|
|
242
|
+
oldValue?: string;
|
|
243
|
+
}
|
|
244
|
+
): this;
|
|
245
|
+
/**
|
|
246
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
247
|
+
*
|
|
248
|
+
* Fires event {@link #event:liveChange liveChange} to attached listeners.
|
|
249
|
+
*
|
|
250
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
251
|
+
*/
|
|
252
|
+
fireLiveChange(
|
|
253
|
+
/**
|
|
254
|
+
* Parameters to pass along with the event
|
|
255
|
+
*/
|
|
256
|
+
mParameters?: {
|
|
257
|
+
/**
|
|
258
|
+
* The current value of the code editor.
|
|
259
|
+
*/
|
|
260
|
+
value?: string;
|
|
261
|
+
/**
|
|
262
|
+
* The underlying change event of the third-party code editor.
|
|
263
|
+
*/
|
|
264
|
+
editorEvent?: object;
|
|
265
|
+
}
|
|
266
|
+
): this;
|
|
267
|
+
/**
|
|
268
|
+
* Sets the focus to the code editor
|
|
269
|
+
*
|
|
270
|
+
* @returns Returns `this` to allow method chaining
|
|
271
|
+
*/
|
|
272
|
+
focus(): this;
|
|
273
|
+
/**
|
|
274
|
+
* Gets current value of property {@link #getColorTheme colorTheme}.
|
|
275
|
+
*
|
|
276
|
+
* Sets the editor color theme. Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
|
|
277
|
+
* chaos, chrome, clouds, clouds_midnight, cobalt, crimson_editor, dawn, dreamweaver, eclipse, github, gob,
|
|
278
|
+
* gruvbox, idle_fingers, iplastic, katzenmilch, kr_theme, kuroir, merbivore, merbivore_soft, mono_industrial,
|
|
279
|
+
* monokai, pastel_on_dark, solarized_dark, solarized_light, sqlserver, terminal, textmate, tomorrow, tomorrow_night,
|
|
280
|
+
* tomorrow_night_blue, tomorrow_night_bright, tomorrow_night_eighties, twilight, dracula vibrant_ink, xcode
|
|
281
|
+
*
|
|
282
|
+
* Default value is `"default"`.
|
|
283
|
+
*
|
|
284
|
+
* @returns Value of property `colorTheme`
|
|
285
|
+
*/
|
|
286
|
+
getColorTheme(): string;
|
|
287
|
+
/**
|
|
288
|
+
* Returns the current value of the code editor
|
|
289
|
+
*
|
|
290
|
+
* @returns Returns the current value of the code editor
|
|
291
|
+
*/
|
|
292
|
+
getCurrentValue(): string;
|
|
293
|
+
/**
|
|
294
|
+
* Gets current value of property {@link #getEditable editable}.
|
|
295
|
+
*
|
|
296
|
+
* Sets whether the code in the editor can be changed by the user.
|
|
297
|
+
*
|
|
298
|
+
* Default value is `true`.
|
|
299
|
+
*
|
|
300
|
+
* @returns Value of property `editable`
|
|
301
|
+
*/
|
|
302
|
+
getEditable(): boolean;
|
|
303
|
+
/**
|
|
304
|
+
* Gets current value of property {@link #getHeight height}.
|
|
305
|
+
*
|
|
306
|
+
* The height of the code editor. A minimal height of 3rem will be applied in case the height is less than
|
|
307
|
+
* 20px.
|
|
308
|
+
*
|
|
309
|
+
* Default value is `"100%"`.
|
|
310
|
+
*
|
|
311
|
+
* @returns Value of property `height`
|
|
312
|
+
*/
|
|
313
|
+
getHeight(): CSSSize;
|
|
314
|
+
/**
|
|
315
|
+
* Returns the DOMNode ID to be used for the "labelFor" attribute of the label.
|
|
316
|
+
*
|
|
317
|
+
* By default, this is the ID of the control itself.
|
|
318
|
+
*
|
|
319
|
+
* @returns ID to be used for the `labelFor`
|
|
320
|
+
*/
|
|
321
|
+
getIdForLabel(): string;
|
|
322
|
+
/**
|
|
323
|
+
* Gets current value of property {@link #getLineNumbers lineNumbers}.
|
|
324
|
+
*
|
|
325
|
+
* Sets whether line numbers should be shown.
|
|
326
|
+
*
|
|
327
|
+
* Default value is `true`.
|
|
328
|
+
*
|
|
329
|
+
* @returns Value of property `lineNumbers`
|
|
330
|
+
*/
|
|
331
|
+
getLineNumbers(): boolean;
|
|
332
|
+
/**
|
|
333
|
+
* @SINCE 1.48.1
|
|
334
|
+
*
|
|
335
|
+
* Gets current value of property {@link #getMaxLines maxLines}.
|
|
336
|
+
*
|
|
337
|
+
* Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
|
|
338
|
+
* number of lines specified, the content of the `CodeEditor` will become scrollable.
|
|
339
|
+
*
|
|
340
|
+
* **Note:** Keep in mind that the auto expand `CodeEditor` behavior requires the `height` property to be
|
|
341
|
+
* set to `auto`.
|
|
342
|
+
*
|
|
343
|
+
* Default value is `0`.
|
|
344
|
+
*
|
|
345
|
+
* @returns Value of property `maxLines`
|
|
346
|
+
*/
|
|
347
|
+
getMaxLines(): int;
|
|
348
|
+
/**
|
|
349
|
+
* Gets current value of property {@link #getSyntaxHints syntaxHints}.
|
|
350
|
+
*
|
|
351
|
+
* Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
|
|
352
|
+
*
|
|
353
|
+
* Default value is `true`.
|
|
354
|
+
*
|
|
355
|
+
* @returns Value of property `syntaxHints`
|
|
356
|
+
*/
|
|
357
|
+
getSyntaxHints(): boolean;
|
|
358
|
+
/**
|
|
359
|
+
* Gets current value of property {@link #getType type}.
|
|
360
|
+
*
|
|
361
|
+
* The type of the code in the editor used for syntax highlighting. Possible types are: abap, abc, actionscript,
|
|
362
|
+
* ada, apache_conf, applescript, asciidoc, assembly_x86, autohotkey, batchfile, bro, c9search, c_cpp, cirru,
|
|
363
|
+
* clojure, cobol, coffee, coldfusion, csharp, css, curly, d, dart, diff, django, dockerfile, dot, drools,
|
|
364
|
+
* eiffel, ejs, elixir, elm, erlang, forth, fortran, ftl, gcode, gherkin, gitignore, glsl, gobstones, golang,
|
|
365
|
+
* groovy, haml, handlebars, haskell, haskell_cabal, haxe, hjson, html, html_elixir, html_ruby, ini, io,
|
|
366
|
+
* jack, jade, java, javascript, json, jsoniq, jsp, jsx, julia, kotlin, latex, lean, less, liquid, lisp,
|
|
367
|
+
* live_script, livescript, logiql, lsl, lua, luapage, lucene, makefile, markdown, mask, matlab, mavens_mate_log,
|
|
368
|
+
* maze, mel, mips_assembler, mipsassembler, mushcode, mysql, nix, nsis, objectivec, ocaml, pascal, perl,
|
|
369
|
+
* pgsql, php, plain_text, powershell, praat, prolog, properties, protobuf, python, r, razor, rdoc, rhtml,
|
|
370
|
+
* rst, ruby, rust, sass, scad, scala, scheme, scss, sh, sjs, smarty, snippets, soy_template, space, sql,
|
|
371
|
+
* sqlserver, stylus, svg, swift, swig, tcl, tex, text, textile, toml, tsx, twig, typescript, vala, vbscript,
|
|
372
|
+
* velocity, verilog, vhdl, wollok, xml, xquery, yaml, terraform, slim, redshift, red, puppet, php_laravel_blade,
|
|
373
|
+
* mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
|
|
374
|
+
*
|
|
375
|
+
* Default value is `"javascript"`.
|
|
376
|
+
*
|
|
377
|
+
* @returns Value of property `type`
|
|
378
|
+
*/
|
|
379
|
+
getType(): string;
|
|
380
|
+
/**
|
|
381
|
+
* Gets current value of property {@link #getValue value}.
|
|
382
|
+
*
|
|
383
|
+
* The value displayed in the code editor.
|
|
384
|
+
*
|
|
385
|
+
* Default value is `empty string`.
|
|
386
|
+
*
|
|
387
|
+
* @returns Value of property `value`
|
|
388
|
+
*/
|
|
389
|
+
getValue(): string;
|
|
390
|
+
/**
|
|
391
|
+
* Gets current value of property {@link #getValueSelection valueSelection}.
|
|
392
|
+
*
|
|
393
|
+
* Sets whether the code is automatically selected if a value is set.
|
|
394
|
+
*
|
|
395
|
+
* Default value is `false`.
|
|
396
|
+
*
|
|
397
|
+
* @returns Value of property `valueSelection`
|
|
398
|
+
*/
|
|
399
|
+
getValueSelection(): boolean;
|
|
400
|
+
/**
|
|
401
|
+
* Gets current value of property {@link #getWidth width}.
|
|
402
|
+
*
|
|
403
|
+
* The width of the code editor.
|
|
404
|
+
*
|
|
405
|
+
* Default value is `"100%"`.
|
|
406
|
+
*
|
|
407
|
+
* @returns Value of property `width`
|
|
408
|
+
*/
|
|
409
|
+
getWidth(): CSSSize;
|
|
410
|
+
/**
|
|
411
|
+
* @SINCE 1.54.1
|
|
412
|
+
*
|
|
413
|
+
* Pretty-prints the content of the editor
|
|
414
|
+
*/
|
|
415
|
+
prettyPrint(): void;
|
|
416
|
+
/**
|
|
417
|
+
* Sets the color theme of the code editor
|
|
418
|
+
*
|
|
419
|
+
* @returns Returns `this` to allow method chaining
|
|
420
|
+
*/
|
|
421
|
+
setColorTheme(
|
|
422
|
+
/**
|
|
423
|
+
* See property documentation for accepted values
|
|
424
|
+
*/
|
|
425
|
+
sTheme: string
|
|
426
|
+
): this;
|
|
427
|
+
/**
|
|
428
|
+
* Sets a new value for property {@link #getEditable editable}.
|
|
429
|
+
*
|
|
430
|
+
* Sets whether the code in the editor can be changed by the user.
|
|
431
|
+
*
|
|
432
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
433
|
+
*
|
|
434
|
+
* Default value is `true`.
|
|
435
|
+
*
|
|
436
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
437
|
+
*/
|
|
438
|
+
setEditable(
|
|
439
|
+
/**
|
|
440
|
+
* New value for property `editable`
|
|
441
|
+
*/
|
|
442
|
+
bEditable?: boolean
|
|
443
|
+
): this;
|
|
444
|
+
/**
|
|
445
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
446
|
+
*
|
|
447
|
+
* The height of the code editor. A minimal height of 3rem will be applied in case the height is less than
|
|
448
|
+
* 20px.
|
|
449
|
+
*
|
|
450
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
451
|
+
*
|
|
452
|
+
* Default value is `"100%"`.
|
|
453
|
+
*
|
|
454
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
455
|
+
*/
|
|
456
|
+
setHeight(
|
|
457
|
+
/**
|
|
458
|
+
* New value for property `height`
|
|
459
|
+
*/
|
|
460
|
+
sHeight?: CSSSize
|
|
461
|
+
): this;
|
|
462
|
+
/**
|
|
463
|
+
* Sets a new value for property {@link #getLineNumbers lineNumbers}.
|
|
464
|
+
*
|
|
465
|
+
* Sets whether line numbers should be shown.
|
|
466
|
+
*
|
|
467
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
468
|
+
*
|
|
469
|
+
* Default value is `true`.
|
|
470
|
+
*
|
|
471
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
472
|
+
*/
|
|
473
|
+
setLineNumbers(
|
|
474
|
+
/**
|
|
475
|
+
* New value for property `lineNumbers`
|
|
476
|
+
*/
|
|
477
|
+
bLineNumbers?: boolean
|
|
478
|
+
): this;
|
|
479
|
+
/**
|
|
480
|
+
* @SINCE 1.48.1
|
|
481
|
+
*
|
|
482
|
+
* Sets a new value for property {@link #getMaxLines maxLines}.
|
|
483
|
+
*
|
|
484
|
+
* Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
|
|
485
|
+
* number of lines specified, the content of the `CodeEditor` will become scrollable.
|
|
486
|
+
*
|
|
487
|
+
* **Note:** Keep in mind that the auto expand `CodeEditor` behavior requires the `height` property to be
|
|
488
|
+
* set to `auto`.
|
|
489
|
+
*
|
|
490
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
491
|
+
*
|
|
492
|
+
* Default value is `0`.
|
|
493
|
+
*
|
|
494
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
495
|
+
*/
|
|
496
|
+
setMaxLines(
|
|
497
|
+
/**
|
|
498
|
+
* New value for property `maxLines`
|
|
499
|
+
*/
|
|
500
|
+
iMaxLines?: int
|
|
501
|
+
): this;
|
|
502
|
+
/**
|
|
503
|
+
* Sets a new value for property {@link #getSyntaxHints syntaxHints}.
|
|
504
|
+
*
|
|
505
|
+
* Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
|
|
506
|
+
*
|
|
507
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
508
|
+
*
|
|
509
|
+
* Default value is `true`.
|
|
510
|
+
*
|
|
511
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
512
|
+
*/
|
|
513
|
+
setSyntaxHints(
|
|
514
|
+
/**
|
|
515
|
+
* New value for property `syntaxHints`
|
|
516
|
+
*/
|
|
517
|
+
bSyntaxHints?: boolean
|
|
518
|
+
): this;
|
|
519
|
+
/**
|
|
520
|
+
* Sets a new value for property {@link #getType type}.
|
|
521
|
+
*
|
|
522
|
+
* The type of the code in the editor used for syntax highlighting. Possible types are: abap, abc, actionscript,
|
|
523
|
+
* ada, apache_conf, applescript, asciidoc, assembly_x86, autohotkey, batchfile, bro, c9search, c_cpp, cirru,
|
|
524
|
+
* clojure, cobol, coffee, coldfusion, csharp, css, curly, d, dart, diff, django, dockerfile, dot, drools,
|
|
525
|
+
* eiffel, ejs, elixir, elm, erlang, forth, fortran, ftl, gcode, gherkin, gitignore, glsl, gobstones, golang,
|
|
526
|
+
* groovy, haml, handlebars, haskell, haskell_cabal, haxe, hjson, html, html_elixir, html_ruby, ini, io,
|
|
527
|
+
* jack, jade, java, javascript, json, jsoniq, jsp, jsx, julia, kotlin, latex, lean, less, liquid, lisp,
|
|
528
|
+
* live_script, livescript, logiql, lsl, lua, luapage, lucene, makefile, markdown, mask, matlab, mavens_mate_log,
|
|
529
|
+
* maze, mel, mips_assembler, mipsassembler, mushcode, mysql, nix, nsis, objectivec, ocaml, pascal, perl,
|
|
530
|
+
* pgsql, php, plain_text, powershell, praat, prolog, properties, protobuf, python, r, razor, rdoc, rhtml,
|
|
531
|
+
* rst, ruby, rust, sass, scad, scala, scheme, scss, sh, sjs, smarty, snippets, soy_template, space, sql,
|
|
532
|
+
* sqlserver, stylus, svg, swift, swig, tcl, tex, text, textile, toml, tsx, twig, typescript, vala, vbscript,
|
|
533
|
+
* velocity, verilog, vhdl, wollok, xml, xquery, yaml, terraform, slim, redshift, red, puppet, php_laravel_blade,
|
|
534
|
+
* mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
|
|
535
|
+
*
|
|
536
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
537
|
+
*
|
|
538
|
+
* Default value is `"javascript"`.
|
|
539
|
+
*
|
|
540
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
541
|
+
*/
|
|
542
|
+
setType(
|
|
543
|
+
/**
|
|
544
|
+
* New value for property `type`
|
|
545
|
+
*/
|
|
546
|
+
sType?: string
|
|
547
|
+
): this;
|
|
548
|
+
/**
|
|
549
|
+
* Sets a new value for property {@link #getValue value}.
|
|
550
|
+
*
|
|
551
|
+
* The value displayed in the code editor.
|
|
552
|
+
*
|
|
553
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
554
|
+
*
|
|
555
|
+
* Default value is `empty string`.
|
|
556
|
+
*
|
|
557
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
558
|
+
*/
|
|
559
|
+
setValue(
|
|
560
|
+
/**
|
|
561
|
+
* New value for property `value`
|
|
562
|
+
*/
|
|
563
|
+
sValue?: string
|
|
564
|
+
): this;
|
|
565
|
+
/**
|
|
566
|
+
* Sets a new value for property {@link #getValueSelection valueSelection}.
|
|
567
|
+
*
|
|
568
|
+
* Sets whether the code is automatically selected if a value is set.
|
|
569
|
+
*
|
|
570
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
571
|
+
*
|
|
572
|
+
* Default value is `false`.
|
|
573
|
+
*
|
|
574
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
575
|
+
*/
|
|
576
|
+
setValueSelection(
|
|
577
|
+
/**
|
|
578
|
+
* New value for property `valueSelection`
|
|
579
|
+
*/
|
|
580
|
+
bValueSelection?: boolean
|
|
581
|
+
): this;
|
|
582
|
+
/**
|
|
583
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
584
|
+
*
|
|
585
|
+
* The width of the code editor.
|
|
586
|
+
*
|
|
587
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
588
|
+
*
|
|
589
|
+
* Default value is `"100%"`.
|
|
590
|
+
*
|
|
591
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
592
|
+
*/
|
|
593
|
+
setWidth(
|
|
594
|
+
/**
|
|
595
|
+
* New value for property `width`
|
|
596
|
+
*/
|
|
597
|
+
sWidth?: CSSSize
|
|
598
|
+
): this;
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
export interface $CodeEditorSettings extends $ControlSettings {
|
|
602
|
+
/**
|
|
603
|
+
* The value displayed in the code editor.
|
|
604
|
+
*/
|
|
605
|
+
value?: string | PropertyBindingInfo;
|
|
606
|
+
|
|
607
|
+
/**
|
|
608
|
+
* The type of the code in the editor used for syntax highlighting. Possible types are: abap, abc, actionscript,
|
|
609
|
+
* ada, apache_conf, applescript, asciidoc, assembly_x86, autohotkey, batchfile, bro, c9search, c_cpp, cirru,
|
|
610
|
+
* clojure, cobol, coffee, coldfusion, csharp, css, curly, d, dart, diff, django, dockerfile, dot, drools,
|
|
611
|
+
* eiffel, ejs, elixir, elm, erlang, forth, fortran, ftl, gcode, gherkin, gitignore, glsl, gobstones, golang,
|
|
612
|
+
* groovy, haml, handlebars, haskell, haskell_cabal, haxe, hjson, html, html_elixir, html_ruby, ini, io,
|
|
613
|
+
* jack, jade, java, javascript, json, jsoniq, jsp, jsx, julia, kotlin, latex, lean, less, liquid, lisp,
|
|
614
|
+
* live_script, livescript, logiql, lsl, lua, luapage, lucene, makefile, markdown, mask, matlab, mavens_mate_log,
|
|
615
|
+
* maze, mel, mips_assembler, mipsassembler, mushcode, mysql, nix, nsis, objectivec, ocaml, pascal, perl,
|
|
616
|
+
* pgsql, php, plain_text, powershell, praat, prolog, properties, protobuf, python, r, razor, rdoc, rhtml,
|
|
617
|
+
* rst, ruby, rust, sass, scad, scala, scheme, scss, sh, sjs, smarty, snippets, soy_template, space, sql,
|
|
618
|
+
* sqlserver, stylus, svg, swift, swig, tcl, tex, text, textile, toml, tsx, twig, typescript, vala, vbscript,
|
|
619
|
+
* velocity, verilog, vhdl, wollok, xml, xquery, yaml, terraform, slim, redshift, red, puppet, php_laravel_blade,
|
|
620
|
+
* mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
|
|
621
|
+
*/
|
|
622
|
+
type?: string | PropertyBindingInfo;
|
|
623
|
+
|
|
624
|
+
/**
|
|
625
|
+
* The width of the code editor.
|
|
626
|
+
*/
|
|
627
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* The height of the code editor. A minimal height of 3rem will be applied in case the height is less than
|
|
631
|
+
* 20px.
|
|
632
|
+
*/
|
|
633
|
+
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
634
|
+
|
|
635
|
+
/**
|
|
636
|
+
* Sets whether the code in the editor can be changed by the user.
|
|
637
|
+
*/
|
|
638
|
+
editable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
639
|
+
|
|
640
|
+
/**
|
|
641
|
+
* Sets whether line numbers should be shown.
|
|
642
|
+
*/
|
|
643
|
+
lineNumbers?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
644
|
+
|
|
645
|
+
/**
|
|
646
|
+
* Sets whether the code is automatically selected if a value is set.
|
|
647
|
+
*/
|
|
648
|
+
valueSelection?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
649
|
+
|
|
650
|
+
/**
|
|
651
|
+
* @SINCE 1.48.1
|
|
652
|
+
*
|
|
653
|
+
* Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
|
|
654
|
+
* number of lines specified, the content of the `CodeEditor` will become scrollable.
|
|
655
|
+
*
|
|
656
|
+
* **Note:** Keep in mind that the auto expand `CodeEditor` behavior requires the `height` property to be
|
|
657
|
+
* set to `auto`.
|
|
658
|
+
*/
|
|
659
|
+
maxLines?: int | PropertyBindingInfo | `{${string}}`;
|
|
660
|
+
|
|
661
|
+
/**
|
|
662
|
+
* Sets the editor color theme. Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
|
|
663
|
+
* chaos, chrome, clouds, clouds_midnight, cobalt, crimson_editor, dawn, dreamweaver, eclipse, github, gob,
|
|
664
|
+
* gruvbox, idle_fingers, iplastic, katzenmilch, kr_theme, kuroir, merbivore, merbivore_soft, mono_industrial,
|
|
665
|
+
* monokai, pastel_on_dark, solarized_dark, solarized_light, sqlserver, terminal, textmate, tomorrow, tomorrow_night,
|
|
666
|
+
* tomorrow_night_blue, tomorrow_night_bright, tomorrow_night_eighties, twilight, dracula vibrant_ink, xcode
|
|
667
|
+
*/
|
|
668
|
+
colorTheme?: string | PropertyBindingInfo;
|
|
669
|
+
|
|
670
|
+
/**
|
|
671
|
+
* Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
|
|
672
|
+
*/
|
|
673
|
+
syntaxHints?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
674
|
+
|
|
675
|
+
/**
|
|
676
|
+
* Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
|
|
677
|
+
*/
|
|
678
|
+
liveChange?: (oEvent: Event) => void;
|
|
679
|
+
|
|
680
|
+
/**
|
|
681
|
+
* Fired when the value has changed and the focus leaves the code editor.
|
|
682
|
+
*/
|
|
683
|
+
change?: (oEvent: Event) => void;
|
|
684
|
+
}
|
|
685
|
+
}
|
|
686
|
+
|
|
687
|
+
declare namespace sap {
|
|
688
|
+
interface IUI5DefineDependencyNames {
|
|
689
|
+
"sap/ui/codeeditor/CodeEditor": undefined;
|
|
690
|
+
|
|
691
|
+
"sap/ui/codeeditor/library": undefined;
|
|
692
|
+
}
|
|
693
|
+
}
|