Module AceAjax

Index

Variables

Interfaces

Variables

Anchor: Anchor

Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated.

public detach(): any

When called, the 'change' event listener is removed.

Returns

any

public getDocument(): Document

Returns the current document.

Returns

Document

public getPosition(): Position

Returns an object identifying the row and column position of the current anchor.

Returns

Position

public on(event: string, fn: (e: any) => any): any

Parameters

  • event: string
  • fn: (e: any) => any

Returns

any

public onChange(e: any): any

Fires whenever the anchor position changes. Both of these objects have a row and column property corresponding to the position. Events that can trigger this function include [[Anchor.setPosition setPosition()]].

Parameters

  • e: any

    An object containing information about the anchor position. It has two properties:

    • old: An object describing the old Anchor position
    • value: An object describing the new Anchor position

Returns

any

public setPosition(row: number, column: number, noClip: boolean): any

Sets the anchor position to the specified row and column. If noClip is true, the position is not clipped.

Parameters

  • row: number

    The row index to move the anchor to

  • column: number

    The column index to move the anchor to

  • noClip: boolean

    Identifies if you want the position to be clipped

Returns

any

BackgroundTokenizer: BackgroundTokenizer

Tokenizes the current [[Document Document]] in the background, and caches the tokenized rows for future use. If a certain row is changed, everything below that row is re-tokenized.

public states: Array<any>

public fireUpdateEvent(firstRow: number, lastRow: number): any

Emits the 'update' event. firstRow and lastRow are used to define the boundaries of the region to be updated.

Parameters

  • firstRow: number

    The starting row region

  • lastRow: number

    The final row region

Returns

any

public getState(row: number): string

[Returns the state of tokenization at the end of a row.]{: #BackgroundTokenizer.getState}

Parameters

  • row: number

    The row to get state at

Returns

string

public getTokens(row: number): TokenInfo[]

Gives list of tokens of the row. (tokens are cached)

Parameters

  • row: number

    The row to get tokens at

Returns

TokenInfo[]

public setDocument(doc: Document): any

Sets a new document to associate with this object.

Parameters

  • doc: Document

    The new document to associate with

Returns

any

public setTokenizer(tokenizer: Tokenizer): any

Sets a new tokenizer for this object.

Parameters

  • tokenizer: Tokenizer

    The new tokenizer to use

Returns

any

public start(startRow: number): any

Starts tokenizing at the row indicated.

Parameters

  • startRow: number

    The row to start at

Returns

any

public stop(): any

Stops tokenizing.

Returns

any

Document: Document

Contains the text of the document. Document can be attached to several [[EditSession EditSession]]s. At its core, Documents are just an array of strings, with each row in the document matching up to the array index.

public applyDeltas(deltas: Delta[]): any

Applies all the changes previously accumulated. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.

Parameters

Returns

any

public createAnchor(row: number, column: number): any

Creates a new Anchor to define a floating point in the document.

Parameters

  • row: number

    The row number to use

  • column: number

    The column number to use

Returns

any

public getAllLines(): Array<string>

Returns all lines in the document as string array. Warning: The caller should not modify this array!

Returns

Array<string>

public getLength(): number

Returns the number of rows in the document.

Returns

number

public getLine(row: number): string

Returns a verbatim copy of the given line as it is in the document

Parameters

  • row: number

    The row index to retrieve

Returns

string

public getLines(firstRow: number, lastRow: number): Array<string>

Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.

Parameters

  • firstRow: number

    The first row index to retrieve

  • lastRow: number

    The final row index to retrieve

Returns

Array<string>

public getNewLineCharacter(): string

Returns the newline character that's being used, depending on the value of newLineMode.

Returns

string

public getNewLineMode(): string

[Returns the type of newlines being used; either windows, unix, or auto]{: #Document.getNewLineMode}

Returns

string

public getTextRange(range: Range): string

[Given a range within the document, this function returns all the text within that range as a single string.]{: #Document.getTextRange.desc}

Parameters

  • range: Range

    The range to work with

Returns

string

public getValue(): string

Returns all the lines in the document as a single string, split by the new line character.

Returns

string

public indexToPosition(index: number, startRow: number): Position

Converts an index position in a document to a {row, column} object. Index refers to the "absolute position" of a character in the document. For example:

var x = 0; // 10 characters, plus one for newline
var y = -1;

Here, y is an index 15: 11 characters for the first row, and 5 characters until y in the second.

Parameters

  • index: number

    An index to convert

  • startRow: number

Returns

Position

public insert(position: Position, text: string): any

Inserts a block of text and the indicated position.

Parameters

  • position: Position

    The position to start inserting at

  • text: string

    A chunk of text to insert

Returns

any

public insertInLine(position: any, text: string): any

Inserts text into the position at the current row. This method also triggers the 'change' event.

Parameters

  • position: any

    The position to insert at

  • text: string

    A chunk of text

Returns

any

public insertLines(row: number, lines: Array<string>): any

Inserts the elements in lines into the document, starting at the row index given by row. This method also triggers the 'change' event.

Parameters

  • row: number

    The index of the row to insert at

  • lines: Array<string>

    An array of strings

Returns

any

public insertNewLine(position: Position): any

Inserts a new line into the document at the current row's position. This method also triggers the 'change' event.

Parameters

  • position: Position

    The position to insert at

Returns

any

public isNewLine(text: string): boolean

Returns true if text is a newline character (either \r\n, \r, or \n).

Parameters

  • text: string

    The text to check

Returns

boolean

public on(event: string, fn: (e: any) => any): any

Parameters

  • event: string
  • fn: (e: any) => any

Returns

any

public positionToIndex(pos: Position, startRow: number): number

Converts the {row, column} position in a document to the character's index. Index refers to the "absolute position" of a character in the document. For example:

var x = 0; // 10 characters, plus one for newline
var y = -1;

Here, y is an index 15: 11 characters for the first row, and 5 characters until y in the second.

Parameters

  • pos: Position

    The {row, column} to convert

  • startRow: number

Returns

number

public remove(range: Range): any

Removes the range from the document.

Parameters

  • range: Range

    A specified Range to remove

Returns

any

public removeInLine(row: number, startColumn: number, endColumn: number): any

Removes the specified columns from the row. This method also triggers the 'change' event.

Parameters

  • row: number

    The row to remove from

  • startColumn: number

    The column to start removing at

  • endColumn: number

    The column to stop removing at

Returns

any

public removeLines(firstRow: number, lastRow: number): Array<string>

Removes a range of full lines. This method also triggers the 'change' event.

Parameters

  • firstRow: number

    The first row to be removed

  • lastRow: number

    The last row to be removed

Returns

Array<string>

public removeNewLine(row: number): any

Removes the new line between row and the row immediately following it. This method also triggers the 'change' event.

Parameters

  • row: number

    The row to check

Returns

any

public replace(range: Range, text: string): any

Replaces a range in the document with the new text.

Parameters

  • range: Range

    A specified Range to replace

  • text: string

    The new text to use as a replacement

Returns

any

public revertDeltas(deltas: Delta[]): any

Reverts any changes previously applied. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.

Parameters

Returns

any

public setNewLineMode(newLineMode: string): any

[Sets the new line mode.]{: #Document.setNewLineMode.desc}

Parameters

  • newLineMode: string

    {: #Document.setNewLineMode.param}

Returns

any

public setValue(text: string): any

Replaces all the lines in the current Document with the value of text.

Parameters

  • text: string

    The text to use

Returns

any

EditSession: { new(text: string, mode?: AceAjax.TextMode): AceAjax.IEditSession; new(content: string, mode?: string): AceAjax.IEditSession; new(text: string[], mode?: string): AceAjax.IEditSession; }

constructor(): IEditSession

Sets up a new EditSession and associates it with the given Document and TextMode.

Returns

IEditSession

constructor(): IEditSession

Returns

IEditSession

constructor(): IEditSession

Returns

IEditSession

Editor: Editor

The main entry point into the Ace functionality. The Editor manages the EditSession (which manages Documents), as well as the VirtualRenderer, which draws everything to the screen. Event sessions dealing with the mouse and keyboard are bubbled up from Document to the Editor, which decides what to do with them.

public commands: CommandManager

public container: HTMLElement

public inMultiSelectMode: boolean

public keyBinding: KeyBinding

public renderer: VirtualRenderer

public selection: Selection

public session: IEditSession

public blockIndent(): any

Indents the current line.

Returns

any

public blockOutdent(arg?: string): any

Outdents the current line.

Parameters

  • arg?: string optional

Returns

any

public blur(): any

Blurs the current textInput.

Returns

any

public centerSelection(): any

Attempts to center the current selection on the screen.

Returns

any

public clearSelection(): any

{:Selection.clearSelection}

Returns

any

public copyLinesDown(): number

Copies all the selected lines down one row.

Returns

number

public copyLinesUp(): number

Copies all the selected lines up one row.

Returns

number

public destroy(): any

Cleans up the entire editor.

Returns

any

public execCommand(command: string, args?: any): any

Parameters

  • command: string
  • args?: any optional

Returns

any

public find(needle: string, options?: any, animate?: boolean): any

Attempts to find needle within the document. For more information on options, see [[Search Search]].

Parameters

  • needle: string

    The text to search for (optional)

  • options?: any optional

    An object defining various search properties

  • animate?: boolean optional

    If true animate scrolling

Returns

any

public findNext(options?: any, animate?: boolean): any

Performs another search for needle in the document. For more information on options, see [[Search Search]].

Parameters

  • options?: any optional

    search options

  • animate?: boolean optional

    If true animate scrolling

Returns

any

public findPrevious(options?: any, animate?: boolean): any

Performs a search for needle backwards. For more information on options, see [[Search Search]].

Parameters

  • options?: any optional

    search options

  • animate?: boolean optional

    If true animate scrolling

Returns

any

public focus(): any

Brings the current textInput into focus.

Returns

any

public getBehavioursEnabled(): boolean

Returns true if the behaviors are currently enabled. {:BehaviorsDef}

Returns

boolean

public getCopyText(): string

Returns the string of text currently highlighted.

Returns

string

public getCursorPosition(): Position

Gets the current position of the cursor.

Returns

Position

public getCursorPositionScreen(): number

Returns the screen position of the cursor.

Returns

number

public getDragDelay(): number

Returns the current mouse drag delay.

Returns

number

public getFirstVisibleRow(): number

{:VirtualRenderer.getFirstVisibleRow}

Returns

number

public getHighlightActiveLine(): any

Returns true if current lines are always highlighted.

Returns

any

public getHighlightSelectedWord(): boolean

Returns true if currently highlighted words are to be highlighted.

Returns

boolean

public getKeyboardHandler(): string

Returns the keyboard handler, such as "vim" or "windows".

Returns

string

public getLastSearchOptions(): any

{:Search.getOptions} For more information on options, see [[Search Search]].

Returns

any

public getLastVisibleRow(): number

{:VirtualRenderer.getLastVisibleRow}

Returns

number

public getNumberAt(): number

Works like EditSession.getTokenAt, except it returns a number.

Returns

number

public getOverwrite(): boolean

Returns true if overwrites are enabled; false otherwise.

Returns

boolean

public getPrintMarginColumn(): number

Returns the column number of where the print margin is.

Returns

number

public getReadOnly(): boolean

Returns true if the editor is set to read-only mode.

Returns

boolean

public getScrollSpeed(): number

Returns the value indicating how fast the mouse scroll speed is (in milliseconds).

Returns

number

public getSelection(): Selection

Returns the currently highlighted selection.

Returns

Selection

public getSelectionRange(): Range

{:Selection.getRange}

Returns

Range

public getSelectionStyle(): string

Returns the current selection style.

Returns

string

public getSession(): IEditSession

Returns the current session being used.

Returns

IEditSession

public getShowFoldWidgets(): any

Returns true if the fold widgets are shown.

Returns

any

public getShowInvisibles(): boolean

Returns true if invisible characters are being shown.

Returns

boolean

public getShowPrintMargin(): boolean

Returns true if the print margin is being shown.

Returns

boolean

public getTheme(): string

{:VirtualRenderer.getTheme}

Returns

string

public getValue(): string

Returns the current session's content.

Returns

string

public getWrapBehavioursEnabled(): any

Returns true if the wrapping behaviors are currently enabled.

Returns

any

public gotoLine(lineNumber: number, column?: number, animate?: boolean): any

Moves the cursor to the specified line number, and also into the indiciated column.

Parameters

  • lineNumber: number

    The line number to go to

  • column?: number optional

    A column number to go to

  • animate?: boolean optional

    If true animates scolling

Returns

any

public gotoPageDown(): any

Shifts the document to wherever "page down" is, as well as moving the cursor position.

Returns

any

public gotoPageUp(): any

Shifts the document to wherever "page up" is, as well as moving the cursor position.

Returns

any

public indent(): any

Inserts an indentation into the current cursor position or indents the selected lines.

Returns

any

public insert(text: string): any

Inserts text into wherever the cursor is pointing.

Parameters

  • text: string

    The new text to add

Returns

any

public isFocused(): any

Returns true if the current textInput is in focus.

Returns

any

public isRowFullyVisible(row: number): boolean

Indicates if the entire row is currently visible on the screen.

Parameters

  • row: number

    The row to check

Returns

boolean

public isRowVisible(row: number): boolean

Indicates if the row is currently visible on the screen.

Parameters

  • row: number

    The row to check

Returns

boolean

public jumpToMatching(): any

Moves the cursor's row and column to the next matching bracket.

Returns

any

public modifyNumber(amount: number): any

If the character before the cursor is a number, this functions changes its value by amount.

Parameters

  • amount: number

    The value to change the numeral by (can be negative to decrease value)

Returns

any

public moveCursorTo(row: number, column?: number, animate?: boolean): any

Moves the cursor to the specified row and column. Note that this does not de-select the current selection.

Parameters

  • row: number

    The new row number

  • column?: number optional

    The new column number

  • animate?: boolean optional

Returns

any

public moveCursorToPosition(position: Position): any

Moves the cursor to the position indicated by pos.row and pos.column.

Parameters

  • position: Position

    An object with two properties, row and column

Returns

any

public moveLinesDown(): number

Shifts all the selected lines down one row.

Returns

number

public moveLinesUp(): number

Shifts all the selected lines up one row.

Returns

number

public moveText(fromRange: Range, toPosition: any): Range

Moves a range of text from the given range to the given position. toPosition is an object that looks like this:

{ row: newRowLocation, column: newColumnLocation }

Parameters

  • fromRange: Range

    The range of text you want moved within the document

  • toPosition: any

    The location (row and column) where you want to move the text to

Returns

Range

public navigateDown(times?: number): any

Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection.

Parameters

  • times?: number optional

    The number of times to change navigation

Returns

any

public navigateFileEnd(): any

Moves the cursor to the end of the current file. Note that this does de-select the current selection.

Returns

any

public navigateFileStart(): any

Moves the cursor to the start of the current file. Note that this does de-select the current selection.

Returns

any

public navigateLeft(times?: number): any

Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection.

Parameters

  • times?: number optional

    The number of times to change navigation

Returns

any

public navigateLineEnd(): any

Moves the cursor to the end of the current line. Note that this does de-select the current selection.

Returns

any

public navigateLineStart(): any

Moves the cursor to the start of the current line. Note that this does de-select the current selection.

Returns

any

public navigateRight(times: number): any

Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection.

Parameters

  • times: number

    The number of times to change navigation

Returns

any

public navigateTo(row: number, column: number): any

Moves the cursor to the specified row and column. Note that this does de-select the current selection.

Parameters

  • row: number

    The new row number

  • column: number

    The new column number

Returns

any

public navigateUp(times?: number): any

Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection.

Parameters

  • times?: number optional

    The number of times to change navigation

Returns

any

public navigateWordLeft(): any

Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.

Returns

any

public navigateWordRight(): any

Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.

Returns

any

public onBlur(): any

Emitted once the editor has been blurred.

Returns

any

public onChangeMode(e?: any): any

Parameters

  • e?: any optional

Returns

any

public onCommandKey(e: any, hashId: any, keyCode: any): any

Parameters

  • e: any
  • hashId: any
  • keyCode: any

Returns

any

public onCopy(): any

Called whenever a text "copy" happens.

Returns

any

public onCursorChange(): any

Emitted when the selection changes.

Returns

any

public onCut(): any

Called whenever a text "cut" happens.

Returns

any

public onDocumentChange(e: any): any

Emitted whenever the document is changed.

Parameters

  • e: any

    Contains a single property, data, which has the delta of changes

Returns

any

public onFocus(): any

Emitted once the editor comes into focus.

Returns

any

public onPaste(text: string): any

Called whenever a text "paste" happens.

Parameters

  • text: string

    The pasted text

Returns

any

public onSelectionChange(e: any): any

Parameters

  • e: any

Returns

any

public onTextInput(text: string): any

Parameters

  • text: string

Returns

any

public redo(): any

{:UndoManager.redo}

Returns

any

public remove(dir: string): any

Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.

Parameters

  • dir: string

    The direction of the deletion to occur, either "left" or "right"

Returns

any

public removeLines(): any

Removes all the lines in the current selection

Returns

any

public removeToLineEnd(): any

Removes all the words to the right of the current selection, until the end of the line.

Returns

any

public removeToLineStart(): any

Removes all the words to the left of the current selection, until the start of the line.

Returns

any

public removeWordLeft(): any

Removes the word directly to the left of the current selection.

Returns

any

public removeWordRight(): any

Removes the word directly to the right of the current selection.

Returns

any

public replace(replacement: string, options?: any): any

Replaces the first occurance of options.needle with the value in replacement.

Parameters

  • replacement: string

    The text to replace with

  • options?: any optional

    The [[Search Search]] options to use

Returns

any

public replaceAll(replacement: string, options?: any): any

Replaces all occurances of options.needle with the value in replacement.

Parameters

  • replacement: string

    The text to replace with

  • options?: any optional

    The [[Search Search]] options to use

Returns

any

public resize(force?: boolean): any

{:VirtualRenderer.onResize}

Parameters

  • force?: boolean optional

    If true, recomputes the size, even if the height and width haven't changed

Returns

any

public scrollPageDown(): any

Scrolls the document to wherever "page down" is, without changing the cursor position.

Returns

any

public scrollPageUp(): any

Scrolls the document to wherever "page up" is, without changing the cursor position.

Returns

any

public scrollToLine(line: number, center: boolean, animate: boolean, callback: Function): any

Scrolls to a line. If center is true, it puts the line in middle of screen (or attempts to).

Parameters

  • line: number

    The line to scroll to

  • center: boolean

    If true

  • animate: boolean

    If true animates scrolling

  • callback: Function

    Function to be called when the animation has finished

Returns

any

public scrollToRow(): any

Moves the editor to the specified row.

Returns

any

public selectAll(): any

Selects all the text in editor.

Returns

any

public selectMoreLines(n: number): any

Parameters

  • n: number

Returns

any

public selectPageDown(): any

Selects the text from the current position of the document until where a "page down" finishes.

Returns

any

public selectPageUp(): any

Selects the text from the current position of the document until where a "page up" finishes.

Returns

any

public setBehavioursEnabled(enabled: boolean): any

Specifies whether to use behaviors or not. ["Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.]{: #BehaviorsDef}

Parameters

  • enabled: boolean

    Enables or disables behaviors

Returns

any

public setDragDelay(dragDelay: number): any

Sets the delay (in milliseconds) of the mouse drag.

Parameters

  • dragDelay: number

    A value indicating the new delay

Returns

any

public setFontSize(size: string): any

Set a new font size (in pixels) for the editor text.

Parameters

  • size: string

    A font size ( e.g. "12px")

Returns

any

public setHighlightActiveLine(shouldHighlight: boolean): any

Determines whether or not the current line should be highlighted.

Parameters

  • shouldHighlight: boolean

    Set to true to highlight the current line

Returns

any

public setHighlightSelectedWord(shouldHighlight: boolean): any

Determines if the currently selected word should be highlighted.

Parameters

  • shouldHighlight: boolean

    Set to true to highlight the currently selected word

Returns

any

public setKeyboardHandler(keyboardHandler: string): any

Sets a new key handler, such as "vim" or "windows".

Parameters

  • keyboardHandler: string

    The new key handler

Returns

any

public setOverwrite(overwrite: boolean): any

Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

Parameters

  • overwrite: boolean

    Defines wheter or not to set overwrites

Returns

any

public setPrintMarginColumn(showPrintMargin: number): any

Sets the column defining where the print margin should be.

Parameters

  • showPrintMargin: number

    Specifies the new print margin

Returns

any

public setReadOnly(readOnly: boolean): any

If readOnly is true, then the editor is set to read-only mode, and none of the content can change.

Parameters

  • readOnly: boolean

    Specifies whether the editor can be modified or not

Returns

any

public setScrollSpeed(speed: number): any

Sets how fast the mouse scrolling should do.

Parameters

  • speed: number

    A value indicating the new speed (in milliseconds)

Returns

any

public setSelectionStyle(style: string): any

Indicates how selections should occur. By default, selections are set to "line". There are no other styles at the moment, although this code change in the future. This function also emits the 'changeSelectionStyle' event.

Parameters

  • style: string

    The new selection style

Returns

any

public setSession(session: IEditSession): any

Sets a new editsession to use. This method also emits the 'changeSession' event.

Parameters

Returns

any

public setShowFoldWidgets(show: boolean): any

Indicates whether the fold widgets are shown or not.

Parameters

  • show: boolean

    Specifies whether the fold widgets are shown

Returns

any

public setShowInvisibles(showInvisibles: boolean): any

If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor.

Parameters

  • showInvisibles: boolean

    Specifies whether or not to show invisible characters

Returns

any

public setShowPrintMargin(showPrintMargin: boolean): any

If showPrintMargin is set to true, the print margin is shown in the editor.

Parameters

  • showPrintMargin: boolean

    Specifies whether or not to show the print margin

Returns

any

public setStyle(style: string): any

{:VirtualRenderer.setStyle}

Parameters

  • style: string

    A class name

Returns

any

public setTheme(theme: string): any

{:VirtualRenderer.setTheme}

Parameters

  • theme: string

    The path to a theme

Returns

any

public setValue(val: string, cursorPos?: number): string

Sets the current document to val.

Parameters

  • val: string

    The new value to set for the document

  • cursorPos?: number optional

    Where to set the new value. undefined or 0 is selectAll, -1 is at the document start, and 1 is at the end

Returns

string

public setWrapBehavioursEnabled(enabled: boolean): any

Specifies whether to use wrapping behaviors or not, i.e. automatically wrapping the selection with characters such as brackets when such a character is typed in.

Parameters

  • enabled: boolean

    Enables or disables wrapping behaviors

Returns

any

public splitLine(): any

Splits the line at the current selection (by inserting an '\n').

Returns

any

public toLowerCase(): any

Converts the current selection entirely into lowercase.

Returns

any

public toUpperCase(): any

Converts the current selection entirely into uppercase.

Returns

any

public toggleCommentLines(): any

Given the currently selected range, this function either comments all the lines, or uncomments all of them.

Returns

any

public toggleOverwrite(): any

Sets the value of overwrite to the opposite of whatever it currently is.

Returns

any

public transposeLetters(): any

Transposes current line.

Returns

any

public undo(): any

{:UndoManager.undo}

Returns

any

public unsetStyle(): any

{:VirtualRenderer.unsetStyle}

Returns

any

KeyBinding: KeyBinding

public addKeyboardHandler(kb: any, pos: any): any

Parameters

  • kb: any
  • pos: any

Returns

any

public getKeyboardHandler(): any

Returns

any

public onCommandKey(e: any, hashId: any, keyCode: any): any

Parameters

  • e: any
  • hashId: any
  • keyCode: any

Returns

any

public onTextInput(text: any): any

Parameters

  • text: any

Returns

any

public removeKeyboardHandler(kb: any): boolean

Parameters

  • kb: any

Returns

boolean

public setDefaultHandler(kb: any): any

Parameters

  • kb: any

Returns

any

public setKeyboardHandler(kb: any): any

Parameters

  • kb: any

Returns

any

PlaceHolder: PlaceHolder

public cancel(): any

PlaceHolder.cancel() TODO

Returns

any

public detach(): any

PlaceHolder.detach() TODO

Returns

any

public hideOtherMarkers(): any

PlaceHolder.hideOtherMarkers() Hides all over markers in the [[EditSession EditSession]] that are not the currently selected one.

Returns

any

public on(event: string, fn: (e: any) => any): any

Parameters

  • event: string
  • fn: (e: any) => any

Returns

any

public onCursorChange(): any

PlaceHolder@onCursorChange(e) Emitted when the cursor changes.

Returns

any

public onUpdate(): any

PlaceHolder@onUpdate(e) Emitted when the place holder updates.

Returns

any

public setup(): any

PlaceHolder.setup() TODO

Returns

any

public showOtherMarkers(): any

PlaceHolder.showOtherMarkers() TODO

Returns

any

Range: Range

This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.

public end: Position

public endColumn: number

public endRow: number

public start: Position

public startColumn: number

public startRow: number

public clipRows(firstRow: number, lastRow: number): Range

Returns the part of the current Range that occurs within the boundaries of firstRow and lastRow as a new Range object.

Parameters

  • firstRow: number

    The starting row

  • lastRow: number

    The ending row

Returns

Range

public clone(): Range

Returns a duplicate of the calling range.

Returns

Range

public collapseRows(): Range

Returns a range containing the starting and ending rows of the original range, but with a column value of 0.

Returns

Range

public compare(row: number, column: number): number

Checks the row and column points with the row and column points of the calling range.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

number

public compareEnd(row: number, column: number): number

Checks the row and column points with the row and column points of the calling range.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

number

public compareInside(row: number, column: number): number

Checks the row and column points with the row and column points of the calling range.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

number

public comparePoint(p: Range): number

Checks the row and column points of p with the row and column points of the calling range.

Parameters

  • p: Range

    A point to compare with

Returns

number

public compareRange(range: Range): number

Compares this range (A) with another range (B).

Parameters

  • range: Range

    A range to compare with

Returns

number

public compareStart(row: number, column: number): number

Checks the row and column points with the row and column points of the calling range.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

number

public contains(row: number, column: number): boolean

Returns true if the row and column provided are within the given range. This can better be expressed as returning true if:

this.start.row <= row <= this.end.row &&
this.start.column <= column <= this.end.column

Parameters

  • row: number

    A row to check for

  • column: number

    A column to check for

Returns

boolean

public containsRange(range: Range): boolean

Checks the start and end points of range and compares them to the calling range. Returns true if the range is contained within the caller's range.

Parameters

  • range: Range

    A range to compare with

Returns

boolean

public extend(row: number, column: number): Range

Changes the row and column points for the calling range for both the starting and ending points.

Parameters

  • row: number

    A new row to extend to

  • column: number

    A new column to extend to

Returns

Range

public fromPoints(start: Range, end: Range): Range

Creates and returns a new Range based on the row and column of the given parameters.

Parameters

  • start: Range

    A starting point to use

  • end: Range

    An ending point to use

Returns

Range

public inside(row: number, column: number): boolean

Returns true if the row and column are within the given range.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

boolean

public insideEnd(row: number, column: number): boolean

Returns true if the row and column are within the given range's ending points.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

boolean

public insideStart(row: number, column: number): boolean

Returns true if the row and column are within the given range's starting points.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

boolean

public intersects(range: Range): boolean

Returns true if passed in range intersects with the one calling this method.

Parameters

  • range: Range

    A range to compare with

Returns

boolean

public isEmpty(): boolean

Returns

boolean

public isEnd(row: number, column: number): boolean

Returns true if the caller's ending row point is the same as row, and if the caller's ending column is the same as column.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

boolean

public isEqual(range: Range): any

Returns true if and only if the starting row and column, and ending row and column, are equivalent to those given by range.

Parameters

  • range: Range

    A range to check against

Returns

any

public isMultiLine(): boolean

Returns true if the range spans across multiple lines.

Returns

boolean

public isStart(row: number, column: number): boolean

Returns true if the caller's starting row point is the same as row, and if the caller's starting column is the same as column.

Parameters

  • row: number

    A row point to compare with

  • column: number

    A column point to compare with

Returns

boolean

public setEnd(row: number, column: number): any

Sets the starting row and column for the range.

Parameters

  • row: number

    A row point to set

  • column: number

    A column point to set

Returns

any

public setStart(row: number, column: number): any

Sets the starting row and column for the range.

Parameters

  • row: number

    A row point to set

  • column: number

    A column point to set

Returns

any

public toScreenRange(session: IEditSession): Range

Given the current Range, this function converts those starting and ending points into screen positions, and then returns a new Range object.

Parameters

  • session: IEditSession

    The EditSession to retrieve coordinates from

Returns

Range

public toString(): any

Returns a string containing the range's row and column information, given like this:

[start.row/start.column] -> [end.row/end.column]

Returns

any

RangeList: new() => AceAjax.IRangeList

constructor(): IRangeList

Returns

IRangeList

RenderLoop: RenderLoop

ScrollBar: ScrollBar

A set of methods for setting and retrieving the editor's scrollbar.

public getWidth(): number

Returns the width of the scroll bar.

Returns

number

public onScroll(e: any): any

Emitted when the scroll bar, well, scrolls.

Parameters

  • e: any

    Contains one property, "data", which indicates the current scroll top position

Returns

any

public setHeight(height: number): any

Sets the height of the scroll bar, in pixels.

Parameters

  • height: number

    The new height

Returns

any

public setInnerHeight(height: number): any

Sets the inner height of the scroll bar, in pixels.

Parameters

  • height: number

    The new inner height

Returns

any

public setScrollTop(scrollTop: number): any

Sets the scroll top of the scroll bar.

Parameters

  • scrollTop: number

    The new scroll top

Returns

any

Search: Search

A class designed to handle all sorts of text searches within a [[Document Document]].

public find(session: IEditSession): Range

Searches for options.needle. If found, this method returns the [[Range Range]] where the text first occurs. If options.backwards is true, the search goes backwards in the session.

Parameters

Returns

Range

public findAll(session: IEditSession): Range[]

Searches for all occurances options.needle. If found, this method returns an array of [[Range Ranges]] where the text first occurs. If options.backwards is true, the search goes backwards in the session.

Parameters

Returns

Range[]

public getOptions(): any

[Returns an object containing all the search options.]{: #Search.getOptions}

Returns

any

public replace(input: string, replacement: string): string

Searches for options.needle in input, and, if found, replaces it with replacement.

Parameters

  • input: string

    The text to search in

  • replacement: string

    The replacing text

    • (String): If options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.
      If options.needle was not found, this function returns null.

Returns

string

public set(options: any): Search

Sets the search options via the options parameter.

Parameters

  • options: any

    An object containing all the new search properties

Returns

Search

public setOptions(An: any): any

Sets the search options via the options parameter.

Parameters

  • An: any

    object containing all the search propertie

Returns

any

Selection: Selection

Contains the cursor position and the text selection of an edit session. The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.

public addEventListener(ev: string, callback: Function): any

Parameters

  • ev: string
  • callback: Function

Returns

any

public addRange(range: Range): any

Parameters

Returns

any

public clearSelection(): any

[Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.]{: #Selection.clearSelection}

Returns

any

public fromOrientedRange(range: Range): any

Parameters

Returns

any

public getAllRanges(): Range[]

Returns

Range[]

public getCursor(): Position

Gets the current position of the cursor.

Returns

Position

public getRange(): Range

[Returns the Range for the selected text.]{: #Selection.getRange}

Returns

Range

public getSelectionAnchor(): any

Returns an object containing the row and column of the calling selection anchor.

Returns

any

public getSelectionLead(): any

Returns an object containing the row and column of the calling selection lead.

Returns

any

public getWordRange(): any

Moves the selection to highlight the entire word.

Returns

any

public isBackwards(): boolean

Returns true if the selection is going backwards in the document.

Returns

boolean

public isEmpty(): boolean

Returns true if the selection is empty.

Returns

boolean

public isMultiLine(): boolean

Returns true if the selection is a multi-line.

Returns

boolean

public moveCursorBy(rows: number, chars: number): any

Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

Parameters

  • rows: number

    The number of rows to move by

  • chars: number

    The number of characters to move by

Returns

any

public moveCursorDown(): any

Moves the cursor down one row.

Returns

any

public moveCursorFileEnd(): any

Moves the cursor to the end of the file.

Returns

any

public moveCursorFileStart(): any

Moves the cursor to the start of the file.

Returns

any

public moveCursorLeft(): any

Moves the cursor left one column.

Returns

any

public moveCursorLineEnd(): any

Moves the cursor to the end of the line.

Returns

any

public moveCursorLineStart(): any

Moves the cursor to the start of the line.

Returns

any

public moveCursorLongWordLeft(): any

Moves the cursor to the word on the left.

Returns

any

public moveCursorLongWordRight(): any

Moves the cursor to the word on the right.

Returns

any

public moveCursorRight(): any

Moves the cursor right one column.

Returns

any

public moveCursorTo(row: number, column: number, keepDesiredColumn?: boolean): any

Moves the cursor to the row and column provided. [If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.]{: #preventUpdateBoolDesc}

Parameters

  • row: number

    The row to move to

  • column: number

    The column to move to

  • keepDesiredColumn?: boolean optional

    {: #preventUpdateBool}

Returns

any

public moveCursorToPosition(position: any): any

Moves the selection to the position indicated by its row and column.

Parameters

  • position: any

    The position to move to

Returns

any

public moveCursorToScreen(row: number, column: number, keepDesiredColumn: boolean): any

Moves the cursor to the screen position indicated by row and column. {:preventUpdateBoolDesc}

Parameters

  • row: number

    The row to move to

  • column: number

    The column to move to

  • keepDesiredColumn: boolean

Returns

any

public moveCursorUp(): any

Moves the cursor up one row.

Returns

any

public moveCursorWordLeft(): any

Returns

any

public moveCursorWordRight(): any

Returns

any

public on(event: string, fn: (e: any) => any): any

Parameters

  • event: string
  • fn: (e: any) => any

Returns

any

public selectAWord(): any

Selects a word, including its right whitespace.

Returns

any

public selectAll(): any

Selects all the text in the document.

Returns

any

public selectDown(): any

Moves the selection down one row.

Returns

any

public selectFileEnd(): any

Moves the selection to the end of the file.

Returns

any

public selectFileStart(): any

Moves the selection to the start of the file.

Returns

any

public selectLeft(): any

Moves the selection left one column.

Returns

any

public selectLine(): any

Selects the entire line.

Returns

any

public selectLineEnd(): any

Moves the selection to the end of the current line.

Returns

any

public selectLineStart(): any

Moves the selection to the beginning of the current line.

Returns

any

public selectRight(): any

Moves the selection right one column.

Returns

any

public selectTo(row: number, column: number): any

Moves the selection cursor to the indicated row and column.

Parameters

  • row: number

    The row to select to

  • column: number

    The column to select to

Returns

any

public selectToPosition(pos: any): any

Moves the selection cursor to the row and column indicated by pos.

Parameters

  • pos: any

    An object containing the row and column

Returns

any

public selectUp(): any

Moves the selection up one row.

Returns

any

public selectWord(): any

Selects an entire word boundary.

Returns

any

public selectWordLeft(): any

Moves the selection to the first word on the left.

Returns

any

public selectWordRight(): any

Moves the selection to the first word on the right.

Returns

any

public setRange(range: Range, reverse: boolean): any

Sets the selection to the provided range.

Parameters

  • range: Range

    The range of text to select

  • reverse: boolean

    Indicates if the range should go backwards (true) or not

Returns

any

public setSelectionAnchor(row: number, column: number): any

Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

Parameters

  • row: number

    The new row

  • column: number

    The new column

Returns

any

public setSelectionRange(match: any): any

Parameters

  • match: any

Returns

any

public shiftSelection(columns: number): any

Shifts the selection up (or down, if [[Selection.isBackwards isBackwards()]] is true) the given number of columns.

Parameters

  • columns: number

    The number of columns to shift by

Returns

any

Split: Split

public blur(): any

Blurs the current editor.

Returns

any

public focus(): any

Focuses the current editor.

Returns

any

public forEach(callback: Function, scope: string): any

Executes callback on all of the available editors.

Parameters

  • callback: Function

    A callback function to execute

  • scope: string

    The default scope for the callback

Returns

any

public getCurrentEditor(): Editor

Returns the current editor.

Returns

Editor

public getEditor(idx: number): any

Returns the editor identified by the index idx.

Parameters

  • idx: number

    The index of the editor you want

Returns

any

public getOrientation(): number

Returns the orientation.

Returns

number

public getSplits(): number

Returns the number of splits.

Returns

number

public resize(): any

Resizes the editor.

Returns

any

public setFontSize(size: number): any

Sets the font size, in pixels, for all the available editors.

Parameters

  • size: number

    The new font size

Returns

any

public setKeyboardHandler(keybinding: string): any

Sets the keyboard handler for the editor.

Parameters

  • keybinding: string

Returns

any

public setOrientation(orientation: number): any

Sets the orientation.

Parameters

  • orientation: number

    The new orientation value

Returns

any

public setSession(session: IEditSession, idx: number): any

Sets a new [[EditSession EditSession]] for the indicated editor.

Parameters

  • session: IEditSession

    The new edit session

  • idx: number

    The editor's index you're interested in

Returns

any

public setTheme(theme: string): any

Sets a theme for each of the available editors.

Parameters

  • theme: string

    The name of the theme to set

Returns

any

TokenIterator: TokenIterator

This class provides an essay way to treat the document as a stream of tokens, and provides methods to iterate over these tokens.

public getCurrentToken(): TokenInfo

Returns the current tokenized string.

Returns

TokenInfo

public getCurrentTokenColumn(): number

Returns the current column.

Returns

number

public getCurrentTokenRow(): number

Returns the current row.

Returns

number

public stepBackward(): Array<string>

Tokenizes all the items from the current point to the row prior in the document.

Returns

Array<string>

public stepForward(): string

Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.

Returns

string

Tokenizer: Tokenizer

This class takes a set of highlighting rules, and creates a tokenizer out of them. For more information, see the wiki on extending highlighters.

public getLineTokens(): any

Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.

Returns

any

UndoManager: UndoManager

This object maintains the undo stack for an [[EditSession EditSession]].

public execute(options: any): any

Provides a means for implementing your own undo manager. options has one property, args, an [[Array Array]], with two elements:

  • args[0] is an array of deltas
  • args[1] is the document to associate with

Parameters

  • options: any

    Contains additional properties

Returns

any

public hasRedo(): boolean

Returns true if there are redo operations left to perform.

Returns

boolean

public hasUndo(): boolean

Returns true if there are undo operations left to perform.

Returns

boolean

public redo(dontSelect: boolean): any

[Perform a redo operation on the document, reimplementing the last change.]{: #UndoManager.redo}

Parameters

  • dontSelect: boolean

Returns

any

public reset(): any

Destroys the stack of undo and redo redo operations.

Returns

any

public undo(dontSelect?: boolean): Range

[Perform an undo operation on the document, reverting the last change.]{: #UndoManager.undo}

Parameters

  • dontSelect?: boolean optional

Returns

Range

VirtualRenderer: VirtualRenderer

The class that is responsible for drawing everything you see on the screen!

public characterWidth: number

public lineHeight: number

public scroller: any

public addGutterDecoration(): any

Deprecated; (moved to EditSession)

Returns

any

public adjustWrapLimit(): any

Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.

Returns

any

public destroy(): any

Destroys the text and cursor layers for this renderer.

Returns

any

public getAnimatedScroll(): boolean

Returns whether an animated scroll happens or not.

Returns

boolean

public getContainerElement(): HTMLElement

Returns the root element containing this renderer.

Returns

HTMLElement

public getFirstFullyVisibleRow(): number

Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

Returns

number

public getFirstVisibleRow(): number

[Returns the index of the first visible row.]{: #VirtualRenderer.getFirstVisibleRow}

Returns

number

public getHScrollBarAlwaysVisible(): boolean

Returns whether the horizontal scrollbar is set to be always visible.

Returns

boolean

public getLastFullyVisibleRow(): number

Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

Returns

number

public getLastVisibleRow(): number

[Returns the index of the last visible row.]{: #VirtualRenderer.getLastVisibleRow}

Returns

number

public getMouseEventTarget(): HTMLElement

Returns the element that the mouse events are attached to

Returns

HTMLElement

public getPrintMarginColumn(): boolean

Returns whether the print margin column is being shown or not.

Returns

boolean

public getScrollBottomRow(): number

Returns the last visible row, regardless of whether it's fully visible or not.

Returns

number

public getScrollLeft(): number

{:EditSession.getScrollLeft}

Returns

number

public getScrollTop(): number

{:EditSession.getScrollTop}

Returns

number

public getScrollTopRow(): number

Returns the first visible row, regardless of whether it's fully visible or not.

Returns

number

public getShowGutter(): boolean

Returns true if the gutter is being shown.

Returns

boolean

public getShowInvisibles(): boolean

Returns whether invisible characters are being shown or not.

Returns

boolean

public getShowPrintMargin(): boolean

Returns whether the print margin is being shown or not.

Returns

boolean

public getTextAreaContainer(): HTMLElement

Returns the element to which the hidden text area is added.

Returns

HTMLElement

public getTheme(): string

[Returns the path of the current theme.]{: #VirtualRenderer.getTheme}

Returns

string

public hideComposition(): any

Hides the current composition.

Returns

any

public hideCursor(): any

Hides the cursor icon.

Returns

any

public isScrollableBy(deltaX: number, deltaY: number): boolean

Returns true if you can still scroll by either parameter; in other words, you haven't reached the end of the file or line.

Parameters

  • deltaX: number

    The x value to scroll by

  • deltaY: number

    The y value to scroll by

Returns

boolean

public onResize(force: boolean, gutterWidth: number, width: number, height: number): any

[Triggers a resize of the editor.]{: #VirtualRenderer.onResize}

Parameters

  • force: boolean

    If true, recomputes the size, even if the height and width haven't changed

  • gutterWidth: number

    The width of the gutter in pixels

  • width: number

    The width of the editor in pixels

  • height: number

    The hiehgt of the editor, in pixels

Returns

any

public removeGutterDecoration(): any

Deprecated; (moved to EditSession)

Returns

any

public screenToTextCoordinates(left: number, top: number): any

Parameters

  • left: number
  • top: number

Returns

any

public scrollBy(deltaX: number, deltaY: number): any

Scrolls the editor across both x- and y-axes.

Parameters

  • deltaX: number

    The x value to scroll by

  • deltaY: number

    The y value to scroll by

Returns

any

public scrollCursorIntoView(): any

Scrolls the cursor into the first visibile area of the editor

Returns

any

public scrollToLine(line: number, center: boolean, animate: boolean, callback: Function): any

Gracefully scrolls the editor to the row indicated.

Parameters

  • line: number

    A line number

  • center: boolean

    If true, centers the editor the to indicated line

  • animate: boolean

    If true animates scrolling

  • callback: Function

    Function to be called after the animation has finished

Returns

any

public scrollToRow(row: number): any

Gracefully scrolls from the top of the editor to the row indicated.

Parameters

  • row: number

    A row id

Returns

any

public scrollToX(scrollLeft: number): number

Scrolls the editor across the x-axis to the pixel indicated.

Parameters

  • scrollLeft: number

    The position to scroll to

Returns

number

public scrollToY(scrollTop: number): number

Scrolls the editor to the y pixel indicated.

Parameters

  • scrollTop: number

    The position to scroll to

Returns

number

public setAnimatedScroll(shouldAnimate: boolean): any

Identifies whether you want to have an animated scroll or not.

Parameters

  • shouldAnimate: boolean

    Set to true to show animated scrolls

Returns

any

public setAnnotations(annotations: Array<any>): any

Sets annotations for the gutter.

Parameters

  • annotations: Array<any>

    An array containing annotations

Returns

any

public setCompositionText(text: string): any

Sets the inner text of the current composition to text.

Parameters

  • text: string

    A string of text to use

Returns

any

public setHScrollBarAlwaysVisible(alwaysVisible: boolean): any

Identifies whether you want to show the horizontal scrollbar or not.

Parameters

  • alwaysVisible: boolean

    Set to true to make the horizontal scroll bar visible

Returns

any

public setPadding(padding: number): any

Sets the padding for all the layers.

Parameters

  • padding: number

    A new padding value (in pixels)

Returns

any

public setPrintMarginColumn(showPrintMargin: boolean): any

Identifies whether you want to show the print margin column or not.

Parameters

  • showPrintMargin: boolean

    Set to true to show the print margin column

Returns

any

public setSession(session: IEditSession): any

Associates the renderer with an [[EditSession EditSession]].

Parameters

Returns

any

public setShowGutter(show: boolean): any

Identifies whether you want to show the gutter or not.

Parameters

  • show: boolean

    Set to true to show the gutter

Returns

any

public setShowInvisibles(showInvisibles: boolean): any

Identifies whether you want to show invisible characters or not.

Parameters

  • showInvisibles: boolean

    Set to true to show invisibles

Returns

any

public setShowPrintMargin(showPrintMargin: boolean): any

Identifies whether you want to show the print margin or not.

Parameters

  • showPrintMargin: boolean

    Set to true to show the print margin

Returns

any

public setStyle(style: string): any

[Adds a new class, style, to the editor.]{: #VirtualRenderer.setStyle}

Parameters

  • style: string

    A class name

Returns

any

public setTheme(theme: string): any

[Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.]{: #VirtualRenderer.setTheme}

Parameters

  • theme: string

    The path to a theme

Returns

any

public showComposition(position: number): any

undefined

Parameters

  • position: number

Returns

any

public showCursor(): any

Shows the cursor icon.

Returns

any

public textToScreenCoordinates(row: number, column: number): any

Returns an object containing the pageX and pageY coordinates of the document position.

Parameters

  • row: number

    The document row position

  • column: number

    The document column position

Returns

any

public unsetStyle(style: string): any

[Removes the class style from the editor.]{: #VirtualRenderer.unsetStyle}

Parameters

  • style: string

    A class name

Returns

any

public updateBackMarkers(): any

Schedules an update to all the back markers in the document.

Returns

any

public updateBreakpoints(): any

Redraw breakpoints.

Returns

any

public updateCursor(): any

Updates the cursor icon.

Returns

any

public updateFontSize(): any

Updates the font size.

Returns

any

public updateFrontMarkers(): any

Schedules an update to all the front markers in the document.

Returns

any

public updateFull(force: boolean): any

Triggers a full update of all the layers, for all the rows.

Parameters

  • force: boolean

    If true, forces the changes through

Returns

any

public updateLines(firstRow: number, lastRow: number): any

Triggers a partial update of the text, from the range given by the two parameters.

Parameters

  • firstRow: number

    The first row to update

  • lastRow: number

    The last row to update

Returns

any

public updateText(): any

Triggers a full update of the text, for all the rows.

Returns

any

public visualizeBlur(): any

Blurs the current container.

Returns

any

public visualizeFocus(): any

Focuses the current container.

Returns

any