@openui5/ts-types 1.94.0 → 1.97.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1465,17 +1465,16 @@ declare namespace sap {
1465
1465
  * The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design
1466
1466
  * requirement. However, that's not a dark theme.
1467
1467
  *
1468
- * Only the following controls are supported:
1469
- *
1470
- * Control name Supported Not supported sap.m.Text Single line text, text
1471
- * truncation Wrapping sap.m.Title Single line text, text truncation.
1472
- * Consider using title headings of H4, H5, H6. Wrapping sap.m.Label Single
1473
- * line text, text truncation Wrapping sap.m.ObjectStatus Labels,
1474
- * semantic colors Indication colors sap.ui.core.Icon sap.ui.core.IconColor
1475
- * enumeration for both icons and backgrounds. Interaction state colors sap.m.Button
1476
- * Buttons in their Back, Default, Transparent and Up types. All four types are over-styled to look
1477
- * as transparent buttons. - sap.m.MenuButton Emphasized button type.
1478
- * Should be used for triggering Mega menu. If there is no Mega menu, use Title (H6) instead.
1468
+ * Only the following controls are supported: Control name Supported
1469
+ * Not supported sap.m.Text Single line text, text truncation Wrapping
1470
+ * sap.m.Title Single line text, text truncation. Consider using title headings
1471
+ * of H4, H5, H6. Wrapping sap.m.Label Single line text, text truncation
1472
+ * Wrapping sap.m.ObjectStatus Labels, semantic colors Indication
1473
+ * colors sap.ui.core.Icon sap.ui.core.IconColor enumeration for both icons
1474
+ * and backgrounds. Interaction state colors sap.m.Button Buttons
1475
+ * in their Back, Default, Transparent and Up types. All four types are over-styled to look as transparent
1476
+ * buttons. - sap.m.MenuButton Emphasized button type. Should be used
1477
+ * for triggering Mega menu. If there is no Mega menu, use Title (H6) instead.
1479
1478
  * Default (over-styled as Transparent) and Transparent types are used for standard menu representation.
1480
1479
  * - sap.m.Select Default and IconOnly types. IconOnly looks like a button
1481
1480
  * while Default looks is like an input. Semantic states sap.m.SearchField
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -10,12 +10,12 @@ declare namespace sap {
10
10
  namespace codeeditor {
11
11
  interface $CodeEditorSettings extends sap.ui.core.$ControlSettings {
12
12
  /**
13
- * The value displayed in the code editor
13
+ * The value displayed in the code editor.
14
14
  */
15
15
  value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
16
16
 
17
17
  /**
18
- * The type of the code in the editor used for syntax highlighting Possible types are: abap, abc, actionscript,
18
+ * The type of the code in the editor used for syntax highlighting. Possible types are: abap, abc, actionscript,
19
19
  * ada, apache_conf, applescript, asciidoc, assembly_x86, autohotkey, batchfile, bro, c9search, c_cpp, cirru,
20
20
  * clojure, cobol, coffee, coldfusion, csharp, css, curly, d, dart, diff, django, dockerfile, dot, drools,
21
21
  * eiffel, ejs, elixir, elm, erlang, forth, fortran, ftl, gcode, gherkin, gitignore, glsl, gobstones, golang,
@@ -27,12 +27,12 @@ declare namespace sap {
27
27
  * rst, ruby, rust, sass, scad, scala, scheme, scss, sh, sjs, smarty, snippets, soy_template, space, sql,
28
28
  * sqlserver, stylus, svg, swift, swig, tcl, tex, text, textile, toml, tsx, twig, typescript, vala, vbscript,
29
29
  * velocity, verilog, vhdl, wollok, xml, xquery, yaml, terraform, slim, redshift, red, puppet, php_laravel_blade,
30
- * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document,
30
+ * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
31
31
  */
32
32
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
33
33
 
34
34
  /**
35
- * The width of the code editor
35
+ * The width of the code editor.
36
36
  */
37
37
  width?:
38
38
  | sap.ui.core.CSSSize
@@ -47,17 +47,17 @@ declare namespace sap {
47
47
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
48
48
 
49
49
  /**
50
- * Sets whether the code in the editor can be changed by the user
50
+ * Sets whether the code in the editor can be changed by the user.
51
51
  */
52
52
  editable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
53
53
 
54
54
  /**
55
- * Sets whether line numbers should be shown
55
+ * Sets whether line numbers should be shown.
56
56
  */
57
57
  lineNumbers?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
58
58
 
59
59
  /**
60
- * Sets whether the code is automatically selected if a value is set
60
+ * Sets whether the code is automatically selected if a value is set.
61
61
  */
62
62
  valueSelection?:
63
63
  | boolean
@@ -75,7 +75,7 @@ declare namespace sap {
75
75
  maxLines?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
76
76
 
77
77
  /**
78
- * Sets the editors color theme Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
78
+ * Sets the editor color theme. Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
79
79
  * chaos, chrome, clouds, clouds_midnight, cobalt, crimson_editor, dawn, dreamweaver, eclipse, github, gob,
80
80
  * gruvbox, idle_fingers, iplastic, katzenmilch, kr_theme, kuroir, merbivore, merbivore_soft, mono_industrial,
81
81
  * monokai, pastel_on_dark, solarized_dark, solarized_light, sqlserver, terminal, textmate, tomorrow, tomorrow_night,
@@ -84,7 +84,7 @@ declare namespace sap {
84
84
  colorTheme?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
85
85
 
86
86
  /**
87
- * Sets whether to show syntax hints the editor. This flag is only available if line numbers are shown.
87
+ * Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
88
88
  */
89
89
  syntaxHints?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
90
90
 
@@ -103,10 +103,8 @@ declare namespace sap {
103
103
  * @SINCE 1.46
104
104
  *
105
105
  * Allows to visualize source code of various types with syntax highlighting, line numbers in editable and
106
- * read only mode. Use this controls in scenarios where the user should be able to inspect and edit source
107
- * code. The control currently uses the third-party code editor Ace. NOTE: There is a known limitation where
108
- * CodeEditor won't work within IconTabBar on Internet Explorer. There is a way to achieve the same functionality
109
- * - an example of IconTabHeader and a CodeEditor can be found in the CodeEditor's samples.
106
+ * read only mode. Use this control in scenarios where the user should be able to inspect and edit source
107
+ * code. The control currently uses the third-party code editor Ace.
110
108
  */
111
109
  class CodeEditor extends sap.ui.core.Control {
112
110
  /**
@@ -333,7 +331,7 @@ declare namespace sap {
333
331
  /**
334
332
  * Gets current value of property {@link #getColorTheme colorTheme}.
335
333
  *
336
- * Sets the editors color theme Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
334
+ * Sets the editor color theme. Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
337
335
  * chaos, chrome, clouds, clouds_midnight, cobalt, crimson_editor, dawn, dreamweaver, eclipse, github, gob,
338
336
  * gruvbox, idle_fingers, iplastic, katzenmilch, kr_theme, kuroir, merbivore, merbivore_soft, mono_industrial,
339
337
  * monokai, pastel_on_dark, solarized_dark, solarized_light, sqlserver, terminal, textmate, tomorrow, tomorrow_night,
@@ -349,7 +347,7 @@ declare namespace sap {
349
347
  /**
350
348
  * Gets current value of property {@link #getEditable editable}.
351
349
  *
352
- * Sets whether the code in the editor can be changed by the user
350
+ * Sets whether the code in the editor can be changed by the user.
353
351
  *
354
352
  * Default value is `true`.
355
353
  */
@@ -363,10 +361,16 @@ declare namespace sap {
363
361
  * Default value is `"100%"`.
364
362
  */
365
363
  getHeight(): sap.ui.core.CSSSize;
364
+ /**
365
+ * Returns the DOMNode ID to be used for the "labelFor" attribute of the label.
366
+ *
367
+ * By default, this is the ID of the control itself.
368
+ */
369
+ getIdForLabel(): string;
366
370
  /**
367
371
  * Gets current value of property {@link #getLineNumbers lineNumbers}.
368
372
  *
369
- * Sets whether line numbers should be shown
373
+ * Sets whether line numbers should be shown.
370
374
  *
371
375
  * Default value is `true`.
372
376
  */
@@ -388,7 +392,7 @@ declare namespace sap {
388
392
  /**
389
393
  * Gets current value of property {@link #getSyntaxHints syntaxHints}.
390
394
  *
391
- * Sets whether to show syntax hints the editor. This flag is only available if line numbers are shown.
395
+ * Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
392
396
  *
393
397
  * Default value is `true`.
394
398
  */
@@ -396,7 +400,7 @@ declare namespace sap {
396
400
  /**
397
401
  * Gets current value of property {@link #getType type}.
398
402
  *
399
- * The type of the code in the editor used for syntax highlighting Possible types are: abap, abc, actionscript,
403
+ * The type of the code in the editor used for syntax highlighting. Possible types are: abap, abc, actionscript,
400
404
  * ada, apache_conf, applescript, asciidoc, assembly_x86, autohotkey, batchfile, bro, c9search, c_cpp, cirru,
401
405
  * clojure, cobol, coffee, coldfusion, csharp, css, curly, d, dart, diff, django, dockerfile, dot, drools,
402
406
  * eiffel, ejs, elixir, elm, erlang, forth, fortran, ftl, gcode, gherkin, gitignore, glsl, gobstones, golang,
@@ -408,7 +412,7 @@ declare namespace sap {
408
412
  * rst, ruby, rust, sass, scad, scala, scheme, scss, sh, sjs, smarty, snippets, soy_template, space, sql,
409
413
  * sqlserver, stylus, svg, swift, swig, tcl, tex, text, textile, toml, tsx, twig, typescript, vala, vbscript,
410
414
  * velocity, verilog, vhdl, wollok, xml, xquery, yaml, terraform, slim, redshift, red, puppet, php_laravel_blade,
411
- * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document,
415
+ * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
412
416
  *
413
417
  * Default value is `"javascript"`.
414
418
  */
@@ -416,7 +420,7 @@ declare namespace sap {
416
420
  /**
417
421
  * Gets current value of property {@link #getValue value}.
418
422
  *
419
- * The value displayed in the code editor
423
+ * The value displayed in the code editor.
420
424
  *
421
425
  * Default value is `empty string`.
422
426
  */
@@ -424,7 +428,7 @@ declare namespace sap {
424
428
  /**
425
429
  * Gets current value of property {@link #getValueSelection valueSelection}.
426
430
  *
427
- * Sets whether the code is automatically selected if a value is set
431
+ * Sets whether the code is automatically selected if a value is set.
428
432
  *
429
433
  * Default value is `false`.
430
434
  */
@@ -432,7 +436,7 @@ declare namespace sap {
432
436
  /**
433
437
  * Gets current value of property {@link #getWidth width}.
434
438
  *
435
- * The width of the code editor
439
+ * The width of the code editor.
436
440
  *
437
441
  * Default value is `"100%"`.
438
442
  */
@@ -455,7 +459,7 @@ declare namespace sap {
455
459
  /**
456
460
  * Sets a new value for property {@link #getEditable editable}.
457
461
  *
458
- * Sets whether the code in the editor can be changed by the user
462
+ * Sets whether the code in the editor can be changed by the user.
459
463
  *
460
464
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
461
465
  *
@@ -486,7 +490,7 @@ declare namespace sap {
486
490
  /**
487
491
  * Sets a new value for property {@link #getLineNumbers lineNumbers}.
488
492
  *
489
- * Sets whether line numbers should be shown
493
+ * Sets whether line numbers should be shown.
490
494
  *
491
495
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
492
496
  *
@@ -522,7 +526,7 @@ declare namespace sap {
522
526
  /**
523
527
  * Sets a new value for property {@link #getSyntaxHints syntaxHints}.
524
528
  *
525
- * Sets whether to show syntax hints the editor. This flag is only available if line numbers are shown.
529
+ * Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
526
530
  *
527
531
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
528
532
  *
@@ -537,7 +541,7 @@ declare namespace sap {
537
541
  /**
538
542
  * Sets a new value for property {@link #getType type}.
539
543
  *
540
- * The type of the code in the editor used for syntax highlighting Possible types are: abap, abc, actionscript,
544
+ * The type of the code in the editor used for syntax highlighting. Possible types are: abap, abc, actionscript,
541
545
  * ada, apache_conf, applescript, asciidoc, assembly_x86, autohotkey, batchfile, bro, c9search, c_cpp, cirru,
542
546
  * clojure, cobol, coffee, coldfusion, csharp, css, curly, d, dart, diff, django, dockerfile, dot, drools,
543
547
  * eiffel, ejs, elixir, elm, erlang, forth, fortran, ftl, gcode, gherkin, gitignore, glsl, gobstones, golang,
@@ -549,7 +553,7 @@ declare namespace sap {
549
553
  * rst, ruby, rust, sass, scad, scala, scheme, scss, sh, sjs, smarty, snippets, soy_template, space, sql,
550
554
  * sqlserver, stylus, svg, swift, swig, tcl, tex, text, textile, toml, tsx, twig, typescript, vala, vbscript,
551
555
  * velocity, verilog, vhdl, wollok, xml, xquery, yaml, terraform, slim, redshift, red, puppet, php_laravel_blade,
552
- * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document,
556
+ * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
553
557
  *
554
558
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
555
559
  *
@@ -564,7 +568,7 @@ declare namespace sap {
564
568
  /**
565
569
  * Sets a new value for property {@link #getValue value}.
566
570
  *
567
- * The value displayed in the code editor
571
+ * The value displayed in the code editor.
568
572
  *
569
573
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
570
574
  *
@@ -579,7 +583,7 @@ declare namespace sap {
579
583
  /**
580
584
  * Sets a new value for property {@link #getValueSelection valueSelection}.
581
585
  *
582
- * Sets whether the code is automatically selected if a value is set
586
+ * Sets whether the code is automatically selected if a value is set.
583
587
  *
584
588
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
585
589
  *
@@ -594,7 +598,7 @@ declare namespace sap {
594
598
  /**
595
599
  * Sets a new value for property {@link #getWidth width}.
596
600
  *
597
- * The width of the code editor
601
+ * The width of the code editor.
598
602
  *
599
603
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
600
604
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {