Class TextEditor

Page object representing the active text editor

Hierarchy (view full)

Constructors

constructor

Properties

action$ action$$ actionContainer$ actionContainer$$ actionItem$ actionItem$$ actions$ actions$$ activeTab$ activeTab$$ breakPoint$ breakPoint$$ checkboxChecked$ checkboxChecked$$ checkboxSetting$ checkboxSetting$$ closeTab$ closeTab$$ comboOption$ comboOption$$ comboSetting$ comboSetting$$ dataUri$ dataUri$$ debugHint$ debugHint$$ diffEditor$ diffEditor$$ editorContainer$ editorContainer$$ editorGroup$ editorGroup$$ elem$ elem$$ findWidget$ findWidget$$ formatDoc$ formatDoc$$ header$ header$$ inputArea$ inputArea$$ itemCount$ itemCount$$ itemRow$ itemRow$$ lineNumber$ lineNumber$$ lineOverlay$ lineOverlay$$ linkButton$ linkButton$$ marginArea$ marginArea$$ modifiedEditor$ modifiedEditor$$ originalEditor$ originalEditor$$ selection$ selection$$ settingConstructor$ settingConstructor$$ settingDesctiption$ settingDesctiption$$ settingsEditor$ settingsEditor$$ tab$ tab$$ tabLabel$ tabLabel$$ tabSeparator$ tabSeparator$$ tabTitle$ tabTitle$$ tabs$ tabs$$ textSetting$ textSetting$$ title$ title$$ view webView$ webView$$

Accessors

elem locators parent

Methods

clearText formatDocument getCodeLens getCodeLenses getCoordinates getFilePath getFileUri getLineOfText getNumberOfLines getSelectedText getSelection getTab getText getTextAtLine getTitle isDirty moveCursor openContextMenu openFindWidget poll save saveAs selectText setText setTextAtLine toggleBreakpoint toggleContentAssist typeText typeTextAt wait

Constructors

constructor

Properties

action$

action$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>

    • Parameters

      • Rest ...args: [label: string]

      Returns ChainablePromiseElement<Element>

action$$

action$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>

    • Parameters

      • Rest ...args: [label: string]

      Returns ChainablePromiseArray<Element[]>

actionContainer$

actionContainer$: ChainablePromiseElement<Element>

actionContainer$$

actionContainer$$: ChainablePromiseArray<Element[]>

actionItem$

actionItem$: ChainablePromiseElement<Element>

actionItem$$

actionItem$$: ChainablePromiseArray<Element[]>

actions$

actions$: ChainablePromiseElement<Element>

actions$$

actions$$: ChainablePromiseArray<Element[]>

activeTab$

activeTab$: ChainablePromiseElement<Element>

activeTab$$

activeTab$$: ChainablePromiseArray<Element[]>

breakPoint$

breakPoint$: ChainablePromiseElement<Element>

breakPoint$$

breakPoint$$: ChainablePromiseArray<Element[]>

checkboxChecked$

checkboxChecked$: ChainablePromiseElement<Element>

checkboxChecked$$

checkboxChecked$$: ChainablePromiseArray<Element[]>

checkboxSetting$

checkboxSetting$: ChainablePromiseElement<Element>

checkboxSetting$$

checkboxSetting$$: ChainablePromiseArray<Element[]>

closeTab$

closeTab$: ChainablePromiseElement<Element>

closeTab$$

closeTab$$: ChainablePromiseArray<Element[]>

comboOption$

comboOption$: ChainablePromiseElement<Element>

comboOption$$

comboOption$$: ChainablePromiseArray<Element[]>

comboSetting$

comboSetting$: ChainablePromiseElement<Element>

comboSetting$$

comboSetting$$: ChainablePromiseArray<Element[]>

dataUri$

dataUri$: ChainablePromiseElement<Element>

dataUri$$

dataUri$$: ChainablePromiseArray<Element[]>

debugHint$

debugHint$: ChainablePromiseElement<Element>

debugHint$$

debugHint$$: ChainablePromiseArray<Element[]>

diffEditor$

diffEditor$: ChainablePromiseElement<Element>

diffEditor$$

diffEditor$$: ChainablePromiseArray<Element[]>

editorContainer$

editorContainer$: ChainablePromiseElement<Element>

editorContainer$$

editorContainer$$: ChainablePromiseArray<Element[]>

editorGroup$

editorGroup$: ChainablePromiseElement<Element>

editorGroup$$

editorGroup$$: ChainablePromiseArray<Element[]>

elem$

elem$: ChainablePromiseElement<Element>

elem$$

elem$$: ChainablePromiseArray<Element[]>

findWidget$

findWidget$: ChainablePromiseElement<Element>

findWidget$$

findWidget$$: ChainablePromiseArray<Element[]>

formatDoc$

formatDoc$: ChainablePromiseElement<Element>

formatDoc$$

formatDoc$$: ChainablePromiseArray<Element[]>

header$

header$: ChainablePromiseElement<Element>

header$$

header$$: ChainablePromiseArray<Element[]>

inputArea$

inputArea$: ChainablePromiseElement<Element>

inputArea$$

inputArea$$: ChainablePromiseArray<Element[]>

itemCount$

itemCount$: ChainablePromiseElement<Element>

itemCount$$

itemCount$$: ChainablePromiseArray<Element[]>

itemRow$

itemRow$: ChainablePromiseElement<Element>

itemRow$$

itemRow$$: ChainablePromiseArray<Element[]>

lineNumber$

lineNumber$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>

    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseElement<Element>

lineNumber$$

lineNumber$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>

    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseArray<Element[]>

lineOverlay$

lineOverlay$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>

    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseElement<Element>

lineOverlay$$

lineOverlay$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>

    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseArray<Element[]>

linkButton$

linkButton$: ChainablePromiseElement<Element>

linkButton$$

linkButton$$: ChainablePromiseArray<Element[]>

marginArea$

marginArea$: ChainablePromiseElement<Element>

marginArea$$

marginArea$$: ChainablePromiseArray<Element[]>

modifiedEditor$

modifiedEditor$: ChainablePromiseElement<Element>

modifiedEditor$$

modifiedEditor$$: ChainablePromiseArray<Element[]>

originalEditor$

originalEditor$: ChainablePromiseElement<Element>

originalEditor$$

originalEditor$$: ChainablePromiseArray<Element[]>

selection$

selection$: ChainablePromiseElement<Element>

selection$$

selection$$: ChainablePromiseArray<Element[]>

settingConstructor$

settingConstructor$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>

    • Parameters

      • Rest ...args: [title: string, category: string]

      Returns ChainablePromiseElement<Element>

settingConstructor$$

settingConstructor$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>

    • Parameters

      • Rest ...args: [title: string, category: string]

      Returns ChainablePromiseArray<Element[]>

settingDesctiption$

settingDesctiption$: ChainablePromiseElement<Element>

settingDesctiption$$

settingDesctiption$$: ChainablePromiseArray<Element[]>

settingsEditor$

settingsEditor$: ChainablePromiseElement<Element>

settingsEditor$$

settingsEditor$$: ChainablePromiseArray<Element[]>

tab$

tab$: ChainablePromiseElement<Element>

tab$$

tab$$: ChainablePromiseArray<Element[]>

tabLabel$

tabLabel$: ChainablePromiseElement<Element>

tabLabel$$

tabLabel$$: ChainablePromiseArray<Element[]>

tabSeparator$

tabSeparator$: ChainablePromiseElement<Element>

tabSeparator$$

tabSeparator$$: ChainablePromiseArray<Element[]>

tabTitle$

tabTitle$: ChainablePromiseElement<Element>

tabTitle$$

tabTitle$$: ChainablePromiseArray<Element[]>

tabs$

tabs$: ChainablePromiseElement<Element>

tabs$$

tabs$$: ChainablePromiseArray<Element[]>

textSetting$

textSetting$: ChainablePromiseElement<Element>

textSetting$$

textSetting$$: ChainablePromiseArray<Element[]>

title$

title$: ChainablePromiseElement<Element>

title$$

title$$: ChainablePromiseArray<Element[]>

view

view: EditorView | EditorGroup = ...

webView$

webView$: ChainablePromiseElement<Element>

webView$$

webView$$: ChainablePromiseArray<Element[]>

Accessors

elem

  • get elem(): ChainablePromiseElement<Element>

  • Base element of given page object

    Returns ChainablePromiseElement<Element>

locators

parent

  • get parent(): ChainablePromiseElement<Element>

  • Parent element of given page object

    Returns ChainablePromiseElement<Element>

Methods

clearText

formatDocument

  • formatDocument(): Promise<void>

  • Use the built-in 'Format Document' option to format the text

    Returns Promise<void>

    Promise resolving when the Format Document command is invoked

getCodeLens

  • getCodeLens(indexOrTitle): Promise<undefined | CodeLens>

  • Get a code lens based on title, or zero based index

    Parameters

    • indexOrTitle: string | number

      zero based index (counting from the top of the editor), or partial title of the code lens

    Returns Promise<undefined | CodeLens>

    CodeLens object if such a code lens exists, undefined otherwise

getCodeLenses

getCoordinates

  • getCoordinates(): Promise<[number, number]>

  • Get the cursor's coordinates as an array of two numbers: [line, column]

    Caution line & column coordinates do not start at 0 but at 1!

    Returns Promise<[number, number]>

getFilePath

  • getFilePath(): Promise<string>

  • Retrieve the path to the file opened in the active editor

    Returns Promise<string>

    Promise resolving to editor's underlying file path

getFileUri

  • getFileUri(): Promise<string>

  • Retrieve the Uri of the file opened in the active editor

    Returns Promise<string>

    Promise resolving to editor's underlying Uri

getLineOfText

  • getLineOfText(text, occurrence?): Promise<number>

  • Get line number that contains the given text. Not suitable for multi line inputs.

    Parameters

    • text: string

      text to search for

    • occurrence: number = 1

      select which occurrence of the search text to look for in case there are multiple in the document, defaults to 1 (the first instance)

    Returns Promise<number>

    Number of the line that contains the start of the given text. -1 if no such text is found. If occurrence number is specified, searches until it finds as many instances of the given text. Returns the line number that holds the last occurrence found this way.

getNumberOfLines

getSelectedText

getSelection

  • getSelection(): Promise<undefined | Selection>

  • Get the selection block as a page object

    Returns Promise<undefined | Selection>

    Selection page object

getTab

getText

getTextAtLine

  • getTextAtLine(line): Promise<string>

  • Get text from a given line

    Parameters

    • line: number

      number of the line to retrieve

    Returns Promise<string>

    Promise resolving to text at the given line number

getTitle

isDirty

  • isDirty(): Promise<boolean>

  • Find whether the active editor has unsaved changes

    Returns Promise<boolean>

    Promise resolving to true/false

moveCursor

  • moveCursor(line, column): Promise<void>

  • Move the cursor to the given coordinates

    Parameters

    • line: number

      line number to move to

    • column: number

      column number to move to

    Returns Promise<void>

    Promise resolving when the cursor has reached the given coordinates

openContextMenu

openFindWidget

poll

  • poll(timeout?, interval?): Promise<TextEditor>

  • Poll for the element to become visible

    Parameters

    • timeout: number = 10000

      custom timeout for the wait

    • interval: number = 2000

      custom interval to control polling

    Returns Promise<TextEditor>

    thenable self reference

save

saveAs

selectText

  • selectText(text, occurrence?): Promise<void>

  • Find and select a given text. Not usable for multi line selection.

    Parameters

    • text: string

      text to select

    • occurrence: number = 1

      specify which onccurrence of text to select if multiple are present in the document

    Returns Promise<void>

setText

  • setText(text, formatText?): Promise<void>

  • Replace the contents of the editor with a given text

    Parameters

    • text: string

      text to type into the editor

    • formatText: boolean = false

      format the new text, default false

    Returns Promise<void>

    Promise resolving once the new text is copied over

setTextAtLine

  • setTextAtLine(line, text): Promise<void>

  • Replace the contents of a line with a given text

    Parameters

    • line: number

      number of the line to edit

    • text: string

      text to set at the line

    Returns Promise<void>

    Promise resolving when the text is typed in

toggleBreakpoint

  • toggleBreakpoint(line): Promise<boolean>

  • Toggle breakpoint on a given line

    Parameters

    • line: number

      target line number

    Returns Promise<boolean>

    promise resolving to true when a breakpoint was added, false when removed or

toggleContentAssist

  • toggleContentAssist(open): Promise<undefined | ContentAssist>

  • Open/Close the content assistant at the current position in the editor by sending the default keyboard shortcut signal

    Parameters

    • open: boolean

      true to open, false to close

    Returns Promise<undefined | ContentAssist>

    Promise resolving to ContentAssist object when opening, void otherwise

typeText

  • typeText(text): Promise<void>

  • Type given text at the current coordinates

    Parameters

    • text: string

      text to type

    Returns Promise<void>

    promise resolving when the text is typed in

typeTextAt

  • typeTextAt(line, column, text): Promise<void>

  • Add the given text to the given coordinates

    Parameters

    • line: number

      number of the line to type into

    • column: number

      number of the column to start typing at

    • text: string

      text to add

    Returns Promise<void>

    Promise resolving when the text is typed in

wait

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc