import {ITextEditor} from '@susisu/mte-kernel'

public interface | source

ITextEditor

The ITextEditor represents an interface to a text editor.

Test:

ITextEditor

Method Summary

Public Methods
public	acceptsTableEdit(row: number): boolean Checks if the editor accepts a table at a row to be editted.
public	deleteLine(row: number): undefined Deletes a line at a specified row.
public	getCursorPosition(): Point Gets the current cursor position.
public	getLastRow(): number Gets the last row index of the text editor.
public	getLine(row: number): string Gets a line string at a row.
public	insertLine(row: number, line: string): undefined Inserts a line at a specified row.
public	replaceLines(startRow: number, endRow: number, lines: Array<string>): undefined Replace lines in a specified range.
public	setCursorPosition(pos: Point): undefined Sets the cursor position to a specified one.
public	setSelectionRange(range: Range): undefined Sets the selection range.
public	transact(func: Function): undefined Batches multiple operations as a single undo/redo step.

Public Methods

public acceptsTableEdit(row: number): boolean source

Checks if the editor accepts a table at a row to be editted. It should return false if, for example, the row is in a code block (not Markdown).

Params:

Name	Type	Attribute	Description
row	number		A row index in the text editor.

Return:

boolean

true if the table at the row can be editted.

Test:

ITextEditor #acceptsTableEdit()

public deleteLine(row: number): undefined source

Deletes a line at a specified row.

Params:

Name	Type	Attribute	Description
row	number		Row index, starts from `0`.

Return:

undefined

Test:

ITextEditor #deleteLine()

public getCursorPosition(): Point source

Gets the current cursor position.

Return:

Point

A point object that represents the cursor position.

Test:

ITextEditor #getCursorPosition()

public getLastRow(): number source

Gets the last row index of the text editor.

Return:

number

The last row index.

Test:

ITextEditor #getLastRow()

public getLine(row: number): string source

Gets a line string at a row.

Params:

Name	Type	Attribute	Description
row	number		Row index, starts from `0`.

Return:

string

The line at the specified row. The line must not contain an EOL like "\n" or "\r".

Test:

ITextEditor #getLine()

public insertLine(row: number, line: string): undefined source

Inserts a line at a specified row.

Params:

Name	Type	Attribute	Description
row	number		Row index, starts from `0`.
line	string		A string to be inserted. This must not contain an EOL like `"\n"` or `"\r"`.

Return:

undefined

Test:

ITextEditor #insertLine()

public replaceLines(startRow: number, endRow: number, lines: Array<string>): undefined source

Replace lines in a specified range.

Params:

Name	Type	Attribute	Description
startRow	number		Start row index, starts from `0`.
endRow	number		End row index. Lines from `startRow` to `endRow - 1` is replaced.
lines	Array<string>		An array of string. Each strings must not contain an EOL like `"\n"` or `"\r"`.