@openui5/types 1.120.7 → 1.121.0

package/types/sap.ui.codeeditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.7
+// For Library Version: 1.121.0
 
 declare module "sap/ui/codeeditor/library" {}
 
@@ -14,11 +14,11 @@ declare module "sap/ui/codeeditor/CodeEditor" {
   import Event from "sap/ui/base/Event";
 
   /**
-   * @since 1.46
-   *
    * Allows to visualize source code of various types with syntax highlighting, line numbers in editable and
    * read only mode. Use this control in scenarios where the user should be able to inspect and edit source
    * code. The control currently uses the third-party code editor Ace.
+   *
+   * @since 1.46
    */
   export default class CodeEditor extends Control {
     /**
@@ -58,6 +58,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -78,15 +79,16 @@ declare module "sap/ui/codeeditor/CodeEditor" {
     /**
      * Returns a metadata object for class sap.ui.codeeditor.CodeEditor.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
     /**
-     * @since 1.52
-     *
      * Defines custom completer - object implementing a getCompletions method. The method has two parameters
      * - fnCallback method and context object. Context object provides details about oPos and sPrefix as provided
      * by the third-party code editor.
+     *
+     * @since 1.52
      */
     addCustomCompleter(
       /**
@@ -104,6 +106,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Fired when the value has changed and the focus leaves the code editor.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachChange(
@@ -129,6 +132,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Fired when the value has changed and the focus leaves the code editor.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachChange(
@@ -149,6 +153,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachLiveChange(
@@ -174,6 +179,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachLiveChange(
@@ -191,6 +197,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachChange(
@@ -208,6 +215,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachLiveChange(
@@ -221,10 +229,10 @@ declare module "sap/ui/codeeditor/CodeEditor" {
       oListener?: object
     ): this;
     /**
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
      * Fires event {@link #event:change change} to attached listeners.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     fireChange(
@@ -234,10 +242,10 @@ declare module "sap/ui/codeeditor/CodeEditor" {
       mParameters?: CodeEditor$ChangeEventParameters
     ): this;
     /**
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
      * Fires event {@link #event:liveChange liveChange} to attached listeners.
      *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     fireLiveChange(
@@ -247,11 +255,16 @@ declare module "sap/ui/codeeditor/CodeEditor" {
       mParameters?: CodeEditor$LiveChangeEventParameters
     ): this;
     /**
-     * Sets the focus to the code editor
+     * Returns the internal instance of the third-party Ace code editor.
      *
-     * @returns Returns `this` to allow method chaining
+     * **Note:** This control is based on third-party open-source software, and there might be incompatible
+     * changes introduced by the code owner in their future releases.
+     *
+     * @since 1.121
+     *
+     * @returns the internal third-party Ace code editor instance
      */
-    focus(): this;
+    getAceEditor(): object;
     /**
      * Gets current value of property {@link #getColorTheme colorTheme}.
      *
@@ -263,12 +276,14 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `"default"`.
      *
+     *
      * @returns Value of property `colorTheme`
      */
     getColorTheme(): string;
     /**
      * Returns the current value of the code editor
      *
+     *
      * @returns Returns the current value of the code editor
      */
     getCurrentValue(): string;
@@ -279,6 +294,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Value of property `editable`
      */
     getEditable(): boolean;
@@ -290,6 +306,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `"100%"`.
      *
+     *
      * @returns Value of property `height`
      */
     getHeight(): CSSSize;
@@ -298,6 +315,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * By default, this is the ID of the control itself.
      *
+     *
      * @returns ID to be used for the `labelFor`
      */
     getIdForLabel(): string;
@@ -308,12 +326,11 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Value of property `lineNumbers`
      */
     getLineNumbers(): boolean;
     /**
-     * @since 1.48.1
-     *
      * Gets current value of property {@link #getMaxLines maxLines}.
      *
      * Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
@@ -324,6 +341,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `0`.
      *
+     * @since 1.48.1
+     *
      * @returns Value of property `maxLines`
      */
     getMaxLines(): int;
@@ -334,6 +353,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Value of property `syntaxHints`
      */
     getSyntaxHints(): boolean;
@@ -356,6 +376,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `"javascript"`.
      *
+     *
      * @returns Value of property `type`
      */
     getType(): string;
@@ -366,6 +387,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `empty string`.
      *
+     *
      * @returns Value of property `value`
      */
     getValue(): string;
@@ -376,6 +398,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Value of property `valueSelection`
      */
     getValueSelection(): boolean;
@@ -386,21 +409,23 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `"100%"`.
      *
+     *
      * @returns Value of property `width`
      */
     getWidth(): CSSSize;
     /**
-     * @since 1.54.1
-     *
      * Pretty-prints the content of the editor.
      *
-     * **Note:** Works well only for PHP. For other programming languages, the content might not be formatted
-     * well. In such cases it is recommended to use your own formatting.
+     * **Note:** Works well for PHP. For other editor types (modes), the content might not be formatted well.
+     * In such cases it is recommended to use your own formatting.
+     *
+     * @since 1.54.1
      */
     prettyPrint(): void;
     /**
      * Sets the color theme of the code editor
      *
+     *
      * @returns Returns `this` to allow method chaining
      */
     setColorTheme(
@@ -418,6 +443,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setEditable(
@@ -436,6 +462,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `"100%"`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setHeight(
@@ -453,6 +480,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setLineNumbers(
@@ -462,8 +490,6 @@ declare module "sap/ui/codeeditor/CodeEditor" {
       bLineNumbers?: boolean
     ): this;
     /**
-     * @since 1.48.1
-     *
      * Sets a new value for property {@link #getMaxLines maxLines}.
      *
      * Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
@@ -476,6 +502,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `0`.
      *
+     * @since 1.48.1
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setMaxLines(
@@ -493,6 +521,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setSyntaxHints(
@@ -522,6 +551,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `"javascript"`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setType(
@@ -539,6 +569,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `empty string`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setValue(
@@ -556,6 +587,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setValueSelection(
@@ -573,6 +605,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Default value is `"100%"`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setWidth(
@@ -633,13 +666,13 @@ declare module "sap/ui/codeeditor/CodeEditor" {
     valueSelection?: boolean | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * @since 1.48.1
-     *
      * Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
      * number of lines specified, the content of the `CodeEditor` will become scrollable.
      *
      * **Note:** Keep in mind that the auto expand `CodeEditor` behavior requires the `height` property to be
      * set to `auto`.
+     *
+     * @since 1.48.1
      */
     maxLines?: int | PropertyBindingInfo | `{${string}}`;