Class FindWidget

Text Editor's Find Widget

Hierarchy (view full)

IPageDecorator<typeof FindWidgetLocators>
BasePage<typeof FindWidgetLocators>
- FindWidget

Constructors

constructor

new FindWidget(locators, element, textEditor): FindWidget
Parameters
- locators: VSCodeLocatorMap
- element: ChainablePromiseElement<Element>
- textEditor: TextEditor
Returns FindWidget
Inherited from IPageDecorator<typeof FindWidgetLocators>.constructor
- Defined in pageobjects/editor/TextEditor.ts:565

Properties

button$

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

Type declaration

- (...args): ChainablePromiseElement<Element>
- Parameters
  - Rest ...args: [title: string]
  Returns ChainablePromiseElement<Element>

button$$

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

Type declaration

- (...args): ChainablePromiseArray<Element[]>
- Parameters
  - Rest ...args: [title: string]
  Returns ChainablePromiseArray<Element[]>

checkbox$

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

Type declaration

- (...args): ChainablePromiseElement<Element>
- Parameters
  - Rest ...args: [title: string]
  Returns ChainablePromiseElement<Element>

checkbox$$

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

Type declaration

- (...args): ChainablePromiseArray<Element[]>
- Parameters
  - Rest ...args: [title: string]
  Returns ChainablePromiseArray<Element[]>

content$

content$: ChainablePromiseElement<Element>

content$$

content$$: ChainablePromiseArray<Element[]>

findPart$

findPart$: ChainablePromiseElement<Element>

findPart$$

findPart$$: ChainablePromiseArray<Element[]>

input$

input$: ChainablePromiseElement<Element>

input$$

input$$: ChainablePromiseArray<Element[]>

matchCount$

matchCount$: ChainablePromiseElement<Element>

matchCount$$

matchCount$$: ChainablePromiseArray<Element[]>

replacePart$

replacePart$: ChainablePromiseElement<Element>

replacePart$$

replacePart$$: ChainablePromiseArray<Element[]>

textEditor

textEditor: TextEditor

toggleReplace$

toggleReplace$: ChainablePromiseElement<Element>

toggleReplace$$

toggleReplace$$: ChainablePromiseArray<Element[]>

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

close

close(): Promise<void>
Close the widget.

Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:663

getReplaceText

getReplaceText(): Promise<string>
Get text from Replace input box

Returns Promise<string>
value of replace input as string
- Defined in pageobjects/editor/TextEditor.ts:625

getResultCount

getResultCount(): Promise<[number, number]>
Get the number of results as an ordered pair of numbers

Returns Promise<[number, number]>
pair in form of [current result index, total number of results]
- Defined in pageobjects/editor/TextEditor.ts:671

getSearchText

getSearchText(): Promise<string>
Get text from Find input box

Returns Promise<string>
value of find input as string
- Defined in pageobjects/editor/TextEditor.ts:606

nextMatch

nextMatch(): Promise<void>
Click 'Next match'

Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:633

poll

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

previousMatch

previousMatch(): Promise<void>
Click 'Previous match'

Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:641

replace

replace(): Promise<void>
Click 'Replace'. Only works in replace mode.

Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:649

replaceAll

replaceAll(): Promise<void>
Click 'Replace All'. Only works in replace mode.

Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:656

setReplaceText

setReplaceText(text): Promise<void>
Set text in the replace box. Will toggle replace mode on if called in find mode.
Parameters
- text: string
  text to fill in
Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:615

setSearchText

setSearchText(text): Promise<void>
Set text in the search box
Parameters
- text: string
  text to fill in
Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:597

toggleMatchCase

toggleMatchCase(toggle): Promise<void>
Toggle the search to match case
Parameters
- toggle: boolean
  true to turn on, false to turn off
Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:686

toggleMatchWholeWord

toggleMatchWholeWord(toggle): Promise<void>
Toggle the search to match whole words
Parameters
- toggle: boolean
  true to turn on, false to turn off
Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:694

togglePreserveCase

togglePreserveCase(toggle): Promise<void>
Toggle the replace to preserve case
Parameters
- toggle: boolean
  true to turn on, false to turn off
Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:710

toggleReplace

toggleReplace(replace): Promise<void>
Toggle between find and replace mode
Parameters
- replace: boolean
  true for replace, false for find
Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:577

toggleUseRegularExpression

toggleUseRegularExpression(toggle): Promise<void>
Toggle the search to use regular expressions
Parameters
- toggle: boolean
  true to turn on, false to turn off
Returns Promise<void>
- Defined in pageobjects/editor/TextEditor.ts:702

wait

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

Class FindWidget

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

locators: VSCodeLocatorMap

element: ChainablePromiseElement<Element>

textEditor: TextEditor

Returns FindWidget

Properties

button$

Type declaration

Parameters

Rest ...args: [title: string]

Returns ChainablePromiseElement<Element>

button$$

Type declaration

Parameters

Rest ...args: [title: string]

Returns ChainablePromiseArray<Element[]>

checkbox$

Type declaration

Parameters

Rest ...args: [title: string]

Returns ChainablePromiseElement<Element>

checkbox$$

Type declaration

Parameters

Rest ...args: [title: string]

Returns ChainablePromiseArray<Element[]>

content$

content$$

findPart$

findPart$$

input$

input$$

matchCount$

matchCount$$

replacePart$

replacePart$$

textEditor

toggleReplace$

toggleReplace$$

Accessors

elem

Returns ChainablePromiseElement<Element>

locators

Returns PageLocators

parent

Returns ChainablePromiseElement<Element>

Methods

close

Returns Promise<void>

getReplaceText

Returns Promise<string>

getResultCount

Returns Promise<[number, number]>

getSearchText

Returns Promise<string>

nextMatch

Returns Promise<void>

poll

Parameters

timeout: number = 10000

interval: number = 2000

Returns Promise<FindWidget>

previousMatch

Returns Promise<void>

replace

Returns Promise<void>

replaceAll

Returns Promise<void>

setReplaceText

Parameters

text: string

`Rest` ...args: [title: string]

`Rest` ...args: [title: string]

`Rest` ...args: [title: string]

`Rest` ...args: [title: string]