Class CustomEditor

Page object for custom editors

Hierarchy (view full)

IPageDecorator<typeof EditorLocators>
Editor<typeof EditorLocators>
- CustomEditor

Index

Constructors

Properties

elem$ elem$$ inputArea$ inputArea$$ title$ title$$ view

Accessors

elem locators parent

Methods

getTab getTitle isDirty openContextMenu poll save saveAs wait

Constructors

constructor

new CustomEditor(locators, element?, view?): CustomEditor
Parameters
- locators: VSCodeLocatorMap
- Optional element: string | ChainablePromiseElement<Element>
- view: EditorView | EditorGroup = ...
Returns CustomEditor
Inherited from Editor.constructor
- Defined in pageobjects/editor/Editor.ts:30

Properties

elem$

elem$: ChainablePromiseElement<Element>

elem$$

elem$$: ChainablePromiseArray<Element[]>

inputArea$

inputArea$: ChainablePromiseElement<Element>

inputArea$$

inputArea$$: ChainablePromiseArray<Element[]>

title$

title$: ChainablePromiseElement<Element>

title$$

title$$: ChainablePromiseArray<Element[]>

view

view: EditorView | EditorGroup = ...

Accessors

elem

get elem(): ChainablePromiseElement<Element>
Base element of given page object

Returns ChainablePromiseElement<Element>
- Defined in pageobjects/utils.ts:133

locators

get locators(): PageLocators
Get the locator map of given page object

Returns PageLocators
- Defined in pageobjects/utils.ts:106

parent

get parent(): ChainablePromiseElement<Element>
Parent element of given page object

Returns ChainablePromiseElement<Element>
- Defined in pageobjects/utils.ts:151

Methods

getTab

getTab(): Promise<EditorTab>
Get the corresponding editor tab

Returns Promise<EditorTab>
Inherited from Editor.getTab
- Defined in pageobjects/editor/Editor.ts:50

getTitle

getTitle(): Promise<string>
Get title/name of the open editor

Returns Promise<string>
Inherited from Editor.getTitle
- Defined in pageobjects/editor/Editor.ts:42

isDirty

isDirty(): Promise<boolean>
Check if the editor has unsaved changes

Returns Promise<boolean>
Promise resolving to true if there are unsaved changes, false otherwise
- Defined in pageobjects/editor/CustomEditor.ts:25

openContextMenu

openContextMenu(): Promise<ContextMenu>
Open context menu on the element

Returns Promise<ContextMenu>
Inherited from Editor.openContextMenu
- Defined in pageobjects/utils.ts:196

poll

poll(timeout?, interval?): Promise<CustomEditor>
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<CustomEditor>
thenable self reference
Inherited from Editor.poll
- Defined in pageobjects/utils.ts:183

save

save(): Promise<void>
Save the editor

Returns Promise<void>
- Defined in pageobjects/editor/CustomEditor.ts:34

saveAs

saveAs(): Promise<InputBox>
Open the Save as prompt

Returns Promise<InputBox>
InputBox serving as a simple file dialog
- Defined in pageobjects/editor/CustomEditor.ts:46

wait

wait(timeout?): Promise<CustomEditor>
Wait for the element to become visible
Parameters
- timeout: number = 5000
  custom timeout for the wait
Returns Promise<CustomEditor>
thenable self reference
Inherited from Editor.wait
- Defined in pageobjects/utils.ts:172

Generated using TypeDoc