@openui5/types 1.115.0 → 1.116.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,26 +1,26 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.116.0
2
2
 
3
3
  declare module "sap/ui/codeeditor/library" {}
4
4
 
5
5
  declare module "sap/ui/codeeditor/CodeEditor" {
6
6
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
7
7
 
8
- import Event from "sap/ui/base/Event";
9
-
10
8
  import { CSSSize } from "sap/ui/core/library";
11
9
 
12
10
  import ElementMetadata from "sap/ui/core/ElementMetadata";
13
11
 
14
12
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
15
13
 
14
+ import Event from "sap/ui/base/Event";
15
+
16
16
  /**
17
- * @SINCE 1.46
17
+ * @since 1.46
18
18
  *
19
19
  * Allows to visualize source code of various types with syntax highlighting, line numbers in editable and
20
20
  * read only mode. Use this control in scenarios where the user should be able to inspect and edit source
21
21
  * code. The control currently uses the third-party code editor Ace.
22
22
  */
23
- class CodeEditor extends Control {
23
+ export default class CodeEditor extends Control {
24
24
  /**
25
25
  * Constructor for a new CodeEditor.
26
26
  *
@@ -82,7 +82,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
82
82
  */
83
83
  static getMetadata(): ElementMetadata;
84
84
  /**
85
- * @SINCE 1.52
85
+ * @since 1.52
86
86
  *
87
87
  * Defines custom completer - object implementing a getCompletions method. The method has two parameters
88
88
  * - fnCallback method and context object. Context object provides details about oPos and sPrefix as provided
@@ -115,7 +115,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
115
115
  /**
116
116
  * The function to be called when the event occurs
117
117
  */
118
- fnFunction: (p1: Event<$CodeEditorChangeEventParameters>) => void,
118
+ fnFunction: (p1: CodeEditor$ChangeEvent) => void,
119
119
  /**
120
120
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
121
121
  */
@@ -135,7 +135,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
135
135
  /**
136
136
  * The function to be called when the event occurs
137
137
  */
138
- fnFunction: (p1: Event<$CodeEditorChangeEventParameters>) => void,
138
+ fnFunction: (p1: CodeEditor$ChangeEvent) => void,
139
139
  /**
140
140
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
141
141
  */
@@ -160,7 +160,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
160
160
  /**
161
161
  * The function to be called when the event occurs
162
162
  */
163
- fnFunction: (p1: Event<$CodeEditorLiveChangeEventParameters>) => void,
163
+ fnFunction: (p1: CodeEditor$LiveChangeEvent) => void,
164
164
  /**
165
165
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
166
166
  */
@@ -180,7 +180,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
180
180
  /**
181
181
  * The function to be called when the event occurs
182
182
  */
183
- fnFunction: (p1: Event<$CodeEditorLiveChangeEventParameters>) => void,
183
+ fnFunction: (p1: CodeEditor$LiveChangeEvent) => void,
184
184
  /**
185
185
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
186
186
  */
@@ -197,7 +197,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
197
197
  /**
198
198
  * The function to be called, when the event occurs
199
199
  */
200
- fnFunction: (p1: Event<$CodeEditorChangeEventParameters>) => void,
200
+ fnFunction: (p1: CodeEditor$ChangeEvent) => void,
201
201
  /**
202
202
  * Context object on which the given function had to be called
203
203
  */
@@ -214,14 +214,14 @@ declare module "sap/ui/codeeditor/CodeEditor" {
214
214
  /**
215
215
  * The function to be called, when the event occurs
216
216
  */
217
- fnFunction: (p1: Event<$CodeEditorLiveChangeEventParameters>) => void,
217
+ fnFunction: (p1: CodeEditor$LiveChangeEvent) => void,
218
218
  /**
219
219
  * Context object on which the given function had to be called
220
220
  */
221
221
  oListener?: object
222
222
  ): this;
223
223
  /**
224
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
224
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
225
225
  *
226
226
  * Fires event {@link #event:change change} to attached listeners.
227
227
  *
@@ -231,10 +231,10 @@ declare module "sap/ui/codeeditor/CodeEditor" {
231
231
  /**
232
232
  * Parameters to pass along with the event
233
233
  */
234
- mParameters?: $CodeEditorChangeEventParameters
234
+ mParameters?: CodeEditor$ChangeEventParameters
235
235
  ): this;
236
236
  /**
237
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
237
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
238
238
  *
239
239
  * Fires event {@link #event:liveChange liveChange} to attached listeners.
240
240
  *
@@ -244,7 +244,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
244
244
  /**
245
245
  * Parameters to pass along with the event
246
246
  */
247
- mParameters?: $CodeEditorLiveChangeEventParameters
247
+ mParameters?: CodeEditor$LiveChangeEventParameters
248
248
  ): this;
249
249
  /**
250
250
  * Sets the focus to the code editor
@@ -312,7 +312,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
312
312
  */
313
313
  getLineNumbers(): boolean;
314
314
  /**
315
- * @SINCE 1.48.1
315
+ * @since 1.48.1
316
316
  *
317
317
  * Gets current value of property {@link #getMaxLines maxLines}.
318
318
  *
@@ -390,7 +390,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
390
390
  */
391
391
  getWidth(): CSSSize;
392
392
  /**
393
- * @SINCE 1.54.1
393
+ * @since 1.54.1
394
394
  *
395
395
  * Pretty-prints the content of the editor
396
396
  */
@@ -459,7 +459,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
459
459
  bLineNumbers?: boolean
460
460
  ): this;
461
461
  /**
462
- * @SINCE 1.48.1
462
+ * @since 1.48.1
463
463
  *
464
464
  * Sets a new value for property {@link #getMaxLines maxLines}.
465
465
  *
@@ -579,7 +579,6 @@ declare module "sap/ui/codeeditor/CodeEditor" {
579
579
  sWidth?: CSSSize
580
580
  ): this;
581
581
  }
582
- export default CodeEditor;
583
582
 
584
583
  export interface $CodeEditorSettings extends $ControlSettings {
585
584
  /**
@@ -631,7 +630,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
631
630
  valueSelection?: boolean | PropertyBindingInfo | `{${string}}`;
632
631
 
633
632
  /**
634
- * @SINCE 1.48.1
633
+ * @since 1.48.1
635
634
  *
636
635
  * Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
637
636
  * number of lines specified, the content of the `CodeEditor` will become scrollable.
@@ -658,15 +657,15 @@ declare module "sap/ui/codeeditor/CodeEditor" {
658
657
  /**
659
658
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
660
659
  */
661
- liveChange?: (oEvent: Event<$CodeEditorLiveChangeEventParameters>) => void;
660
+ liveChange?: (oEvent: CodeEditor$LiveChangeEvent) => void;
662
661
 
663
662
  /**
664
663
  * Fired when the value has changed and the focus leaves the code editor.
665
664
  */
666
- change?: (oEvent: Event<$CodeEditorChangeEventParameters>) => void;
665
+ change?: (oEvent: CodeEditor$ChangeEvent) => void;
667
666
  }
668
667
 
669
- export interface $CodeEditorChangeEventParameters {
668
+ export interface CodeEditor$ChangeEventParameters {
670
669
  /**
671
670
  * The current value of the code editor.
672
671
  */
@@ -678,7 +677,9 @@ declare module "sap/ui/codeeditor/CodeEditor" {
678
677
  oldValue?: string;
679
678
  }
680
679
 
681
- export interface $CodeEditorLiveChangeEventParameters {
680
+ export type CodeEditor$ChangeEvent = Event<CodeEditor$ChangeEventParameters>;
681
+
682
+ export interface CodeEditor$LiveChangeEventParameters {
682
683
  /**
683
684
  * The current value of the code editor.
684
685
  */
@@ -689,6 +690,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
689
690
  */
690
691
  editorEvent?: object;
691
692
  }
693
+
694
+ export type CodeEditor$LiveChangeEvent = Event<CodeEditor$LiveChangeEventParameters>;
692
695
  }
693
696
 
694
697
  declare namespace sap {