Class CustomTreeSection

Custom tree view, e.g. contributed by an extension

Hierarchy (view full)

IPageDecorator<AllViewSectionLocators>
TreeSection
- CustomTreeSection

Constructors

constructor

new CustomTreeSection(locators, panel, content): CustomTreeSection
Parameters
- locators: VSCodeLocatorMap
- panel: ChainablePromiseElement<Element>
- content: ViewContent
Returns CustomTreeSection
Inherited from IPageDecorator<AllViewSectionLocators>.constructor
- Defined in pageobjects/sidebar/ViewSection.ts:33

Properties

actionConstructor$

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

Type declaration

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

actionConstructor$$

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

Type declaration

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

actions$

actions$: ChainablePromiseElement<Element>

actions$$

actions$$: ChainablePromiseArray<Element[]>

button$

button$: ChainablePromiseElement<Element>

button$$

button$$: ChainablePromiseArray<Element[]>

buttonLabel$

buttonLabel$: ChainablePromiseElement<Element>

buttonLabel$$

buttonLabel$$: ChainablePromiseArray<Element[]>

content

content: ViewContent

header$

header$: ChainablePromiseElement<Element>

header$$

header$$: ChainablePromiseArray<Element[]>

headerExpanded$

headerExpanded$: ChainablePromiseElement<Element>

headerExpanded$$

headerExpanded$$: ChainablePromiseArray<Element[]>

index$

index$: ChainablePromiseElement<Element>

index$$

index$$: ChainablePromiseArray<Element[]>

itemLabel$

itemLabel$: ChainablePromiseElement<Element>

itemLabel$$

itemLabel$$: ChainablePromiseArray<Element[]>

itemRow$

itemRow$: ChainablePromiseElement<Element>

itemRow$$

itemRow$$: ChainablePromiseArray<Element[]>

items$

items$: ChainablePromiseElement<Element>

items$$

items$$: ChainablePromiseArray<Element[]>

lastRow$

lastRow$: ChainablePromiseElement<Element>

lastRow$$

lastRow$$: ChainablePromiseArray<Element[]>

level$

level$: ChainablePromiseElement<Element>

level$$

level$$: ChainablePromiseArray<Element[]>

rowContainer$

rowContainer$: ChainablePromiseElement<Element>

rowContainer$$

rowContainer$$: ChainablePromiseArray<Element[]>

rowWithLabel$

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

Type declaration

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

rowWithLabel$$

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

Type declaration

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

searchBox$

searchBox$: ChainablePromiseElement<Element>

searchBox$$

searchBox$$: ChainablePromiseArray<Element[]>

textContainer$

textContainer$: ChainablePromiseElement<Element>

textContainer$$

textContainer$$: ChainablePromiseArray<Element[]>

textField$

textField$: ChainablePromiseElement<Element>

textField$$

textField$$: ChainablePromiseArray<Element[]>

title$

title$: ChainablePromiseElement<Element>

title$$

title$$: ChainablePromiseArray<Element[]>

titleText$

titleText$: ChainablePromiseElement<Element>

titleText$$

titleText$$: ChainablePromiseArray<Element[]>

welcomeContent$

welcomeContent$: ChainablePromiseElement<Element>

welcomeContent$$

welcomeContent$$: 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

collapse

collapse(): Promise<void>
Collapse the section if expanded

Returns Promise<void>
Promise resolving when the section is collapsed
- Defined in pageobjects/sidebar/ViewSection.ts:70

expand

expand(): Promise<void>
Expand the section if collapsed

Returns Promise<void>
Promise resolving when the section is expanded
- Defined in pageobjects/sidebar/ViewSection.ts:53

findItem

findItem(label, maxLevel?): Promise<undefined | TreeItem>
Parameters
- label: string
- maxLevel: number = 0
Returns Promise<undefined | TreeItem>
- Defined in pageobjects/sidebar/tree/custom/CustomTreeSection.ts:37

findWelcomeContent

findWelcomeContent(): Promise<undefined | WelcomeContentSection>
Finds Welcome Content present in this ViewSection and returns it. If none is found, then undefined is returned

Returns Promise<undefined | WelcomeContentSection>
- Defined in pageobjects/sidebar/ViewSection.ts:97

getAction

getAction(label): Promise<undefined | ViewPanelAction>
Retrieve an action button on the sections's header by its label
Parameters
- label: string
  label/title of the button
Returns Promise<undefined | ViewPanelAction>
ViewPanelAction object if found, undefined otherwise
- Defined in pageobjects/sidebar/ViewSection.ts:176

getActions

getActions(): Promise<ViewPanelAction[]>
Retrieve the action buttons on the section's header

Returns Promise<ViewPanelAction[]>
Promise resolving to array of ViewPanelAction objects
- Defined in pageobjects/sidebar/ViewSection.ts:148

getTitle

getTitle(): Promise<string>
Get the title of the section as string

Returns Promise<string>
Promise resolving to section title
- Defined in pageobjects/sidebar/ViewSection.ts:45

getVisibleItems

getVisibleItems(): Promise<TreeItem[]>
Returns Promise<TreeItem[]>
- Defined in pageobjects/sidebar/tree/custom/CustomTreeSection.ts:27

isExpanded

isExpanded(): Promise<boolean>
Finds whether the section is expanded

Returns Promise<boolean>
Promise resolving to true/false
- Defined in pageobjects/sidebar/ViewSection.ts:87

moreActions

moreActions(): Promise<undefined | ContextMenu>
Click on the More Actions... item if it exists

Returns Promise<undefined | ContextMenu>
ContextMenu page object if the action succeeds, undefined otherwise
- Defined in pageobjects/sidebar/ViewSection.ts:191

openItem

openItem(...path): Promise<TreeItem[]>
Parameters
- Rest ...path: string[]
Returns Promise<TreeItem[]>
- Defined in pageobjects/sidebar/tree/TreeSection.ts:8

poll

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

wait

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

Class CustomTreeSection

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

locators: VSCodeLocatorMap

panel: ChainablePromiseElement<Element>

content: ViewContent

Returns CustomTreeSection

Properties

actionConstructor$

Type declaration

Parameters

Rest ...args: []

Returns ChainablePromiseElement<Element>

actionConstructor$$

Type declaration

Parameters

Rest ...args: []

Returns ChainablePromiseArray<Element[]>

actions$

actions$$

button$

button$$

buttonLabel$

buttonLabel$$

content

header$

header$$

headerExpanded$

headerExpanded$$

index$

index$$

itemLabel$

itemLabel$$

itemRow$

itemRow$$

items$

items$$

lastRow$

lastRow$$

level$

level$$

rowContainer$

rowContainer$$

rowWithLabel$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseElement<Element>

rowWithLabel$$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseArray<Element[]>

searchBox$

searchBox$$

textContainer$

textContainer$$

textField$

textField$$

title$

title$$

titleText$

titleText$$

welcomeContent$

welcomeContent$$

Accessors

elem

Returns ChainablePromiseElement<Element>

locators

Returns PageLocators

parent

Returns ChainablePromiseElement<Element>

Methods

`Rest` ...args: []

`Rest` ...args: []

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

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

`Rest` ...path: string[]