Class EditorView

View handling the open editors

Hierarchy (view full)

Properties

actionContainer$ actionContainer$$ actionItem$ actionItem$$ closeTab$ closeTab$$ diffEditor$ diffEditor$$ editorGroup$ editorGroup$$ elem$ elem$$ settingsEditor$ settingsEditor$$ tab$ tab$$ tabLabel$ tabLabel$$ tabSeparator$ tabSeparator$$ tabTitle$ tabTitle$$ webView$ webView$$

Accessors

elem locators parent

Methods

closeAllEditors closeEditor getAction getActions getActiveTab getEditorGroup getEditorGroups getOpenEditorTitles getOpenTabs getTabByTitle openEditor poll wait

Properties

actionContainer$

actionContainer$: ChainablePromiseElement<Element>

actionContainer$$

actionContainer$$: ChainablePromiseArray<Element[]>

actionItem$

actionItem$: ChainablePromiseElement<Element>

actionItem$$

actionItem$$: ChainablePromiseArray<Element[]>

closeTab$

closeTab$: ChainablePromiseElement<Element>

closeTab$$

closeTab$$: ChainablePromiseArray<Element[]>

diffEditor$

diffEditor$: ChainablePromiseElement<Element>

diffEditor$$

diffEditor$$: ChainablePromiseArray<Element[]>

editorGroup$

editorGroup$: ChainablePromiseElement<Element>

editorGroup$$

editorGroup$$: ChainablePromiseArray<Element[]>

elem$

elem$: ChainablePromiseElement<Element>

elem$$

elem$$: 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[]>

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

closeAllEditors

  • closeAllEditors(groupIndex?): Promise<void>

  • Close all open editor tabs

    Parameters

    • Optional groupIndex: number

      optional index to specify an editor group

    Returns Promise<void>

    Promise resolving once all tabs have had their close button pressed

closeEditor

  • closeEditor(title, groupIndex?): Promise<void>

  • Close an editor tab with the given title

    Parameters

    • title: string

      title of the tab

    • groupIndex: number = 0

      zero based index for the editor group (0 for the left most group)

    Returns Promise<void>

    Promise resolving when the tab's close button is pressed

getAction

  • getAction(title, groupIndex?): Promise<undefined | Element>

  • Get editor action of a select editor group, search by title

    Parameters

    • title: string
    • groupIndex: number = 0

      zero based index of the editor group (leftmost group has index 0), default 0

    Returns Promise<undefined | Element>

    promise resolving to WebElement object if found, undefined otherwise

getActions

  • getActions(groupIndex?): Promise<ElementArray>

  • Get editor actions of a select editor group

    Parameters

    • groupIndex: number = 0

      zero based index of the editor group (leftmost group has index 0), default 0

    Returns Promise<ElementArray>

    promise resolving to list of WebElement objects

getActiveTab

getEditorGroup

  • getEditorGroup(index): Promise<EditorGroup>

  • Retrieve an editor group with a given index (counting from left to right)

    Parameters

    • index: number

      zero based index of the editor group (leftmost group has index 0)

    Returns Promise<EditorGroup>

    promise resolving to an EditorGroup object

getEditorGroups

getOpenEditorTitles

  • getOpenEditorTitles(groupIndex?): Promise<string[]>

  • Retrieve all open editor tab titles in an array

    Parameters

    • Optional groupIndex: number

      optional index to specify an editor group, if left empty will search all groups

    Returns Promise<string[]>

    Promise resolving to array of editor titles

getOpenTabs

  • getOpenTabs(groupIndex?): Promise<EditorTab[]>

  • Retrieve all open editor tabs

    Parameters

    • Optional groupIndex: number

      index of group to search for tabs, if left undefined, all groups are searched

    Returns Promise<EditorTab[]>

    promise resolving to EditorTab list

getTabByTitle

  • getTabByTitle(title, groupIndex?): Promise<EditorTab>

  • Retrieve an editor tab from a given group by title

    Parameters

    • title: string

      title of the tab

    • groupIndex: number = 0

      zero based index of the editor group, default 0 (leftmost one)

    Returns Promise<EditorTab>

    promise resolving to EditorTab object

openEditor

poll

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

  • 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<EditorView>

    thenable self reference

wait

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc