Class CustomTreeItem

View item in a custom-made content section (e.g. an extension tree view)

Hierarchy (view full)

IPageDecorator<ViewItemLocators>
TreeItem
- CustomTreeItem

Index

Constructors

constructor

new CustomTreeItem(locators, element, viewPart): CustomTreeItem
Parameters
- locators: VSCodeLocatorMap
- element: ChainablePromiseElement<Element>
- viewPart: TreeSection
Returns CustomTreeItem
Inherited from IPageDecorator<ViewItemLocators>.constructor
- Defined in pageobjects/sidebar/tree/custom/CustomTreeItem.ts:24

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[]>

actionLabel$

actionLabel$: ChainablePromiseElement<Element>

actionLabel$$

actionLabel$$: ChainablePromiseArray<Element[]>

actionTitle$

actionTitle$: ChainablePromiseElement<Element>

actionTitle$$

actionTitle$$: ChainablePromiseArray<Element[]>

actions$

actions$: ChainablePromiseElement<Element>

actions$$

actions$$: ChainablePromiseArray<Element[]>

author$

author$: ChainablePromiseElement<Element>

author$$

author$$: ChainablePromiseArray<Element[]>

button$

button$: ChainablePromiseElement<Element>

button$$

button$$: ChainablePromiseArray<Element[]>

buttonLabel$

buttonLabel$: ChainablePromiseElement<Element>

buttonLabel$$

buttonLabel$$: ChainablePromiseArray<Element[]>

ctor$

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

Type declaration

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

ctor$$

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

Type declaration

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

description$

description$: ChainablePromiseElement<Element>

description$$

description$$: ChainablePromiseArray<Element[]>

elem$

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

Type declaration

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

elem$$

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

Type declaration

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

expandedAttr$

expandedAttr$: ChainablePromiseElement<Element>

expandedAttr$$

expandedAttr$$: ChainablePromiseArray<Element[]>

expandedValue$

expandedValue$: ChainablePromiseElement<Element>

expandedValue$$

expandedValue$$: ChainablePromiseArray<Element[]>

header$

header$: ChainablePromiseElement<Element>

header$$

header$$: ChainablePromiseArray<Element[]>

headerExpanded$

headerExpanded$: ChainablePromiseElement<Element>

headerExpanded$$

headerExpanded$$: ChainablePromiseArray<Element[]>

index$

index$: ChainablePromiseElement<Element>

index$$

index$$: ChainablePromiseArray<Element[]>

install$

install$: ChainablePromiseElement<Element>

install$$

install$$: ChainablePromiseArray<Element[]>

itemTitle$

itemTitle$: ChainablePromiseElement<Element>

itemTitle$$

itemTitle$$: ChainablePromiseArray<Element[]>

level$

level$: ChainablePromiseElement<Element>

level$$

level$$: ChainablePromiseArray<Element[]>

manage$

manage$: ChainablePromiseElement<Element>

manage$$

manage$$: ChainablePromiseArray<Element[]>

title$

title$: ChainablePromiseElement<Element>

title$$

title$$: ChainablePromiseArray<Element[]>

titleText$

titleText$: ChainablePromiseElement<Element>

titleText$$

titleText$$: ChainablePromiseArray<Element[]>

tooltip$

tooltip$: ChainablePromiseElement<Element>

tooltip$$

tooltip$$: ChainablePromiseArray<Element[]>

tooltipAttribute$

tooltipAttribute$: ChainablePromiseElement<Element>

tooltipAttribute$$

tooltipAttribute$$: ChainablePromiseArray<Element[]>

twistie$

twistie$: ChainablePromiseElement<Element>

twistie$$

twistie$$: ChainablePromiseArray<Element[]>

version$

version$: ChainablePromiseElement<Element>

version$$

version$$: ChainablePromiseArray<Element[]>

viewPart

viewPart: TreeSection

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 item if expanded

Returns Promise<void>
Inherited from TreeItem.collapse
- Defined in pageobjects/sidebar/ViewItem.ts:120

expand

expand(): Promise<void>
Expands the current item, if it can be expanded and is collapsed.

Returns Promise<void>
Inherited from TreeItem.expand
- Defined in pageobjects/sidebar/ViewItem.ts:97

findChildItem

findChildItem(name): Promise<undefined | TreeItem>
Find a child item with the given name
Parameters
- name: string
Returns Promise<undefined | TreeItem>
Promise resolving to TreeItem object if the child item exists, undefined otherwise
Inherited from TreeItem.findChildItem
- Defined in pageobjects/sidebar/ViewItem.ts:107

getActionButton

getActionButton(label): Promise<undefined | ViewItemAction>
Find action button for view item by label
Parameters
- label: string
  label of the button to search by
Returns Promise<undefined | ViewItemAction>
ViewItemAction object if such button exists, undefined otherwise
Inherited from TreeItem.getActionButton
- Defined in pageobjects/sidebar/ViewItem.ts:161

getActionButtons

getActionButtons(): Promise<ViewItemAction[]>
Find all action buttons bound to the view item

Returns Promise<ViewItemAction[]>
array of ViewItemAction objects, empty array if item has no actions associated
Inherited from TreeItem.getActionButtons
- Defined in pageobjects/sidebar/ViewItem.ts:132

getChildren

getChildren(): Promise<TreeItem[]>
Find children of an item, will try to expand the item in the process

Returns Promise<TreeItem[]>
Promise resolving to array of TreeItem objects, empty array if item has no children
Inherited from TreeItem.getChildren
- Defined in pageobjects/sidebar/tree/custom/CustomTreeItem.ts:49

getDescription

getDescription(): Promise<string>
Retrieves the description of this TreeItem.

Returns Promise<string>
A promise resolving to the tooltip or undefined if the TreeItem has no description.
Inherited from TreeItem.getDescription
- Defined in pageobjects/sidebar/tree/custom/CustomTreeItem.ts:40

getLabel

getLabel(): Promise<string>
Retrieves the label of this view item

Returns Promise<string>
Inherited from TreeItem.getLabel
- Defined in pageobjects/sidebar/tree/custom/CustomTreeItem.ts:32

getTooltip

getTooltip(): Promise<string>
Retrieves the tooltip of this TreeItem.

Returns Promise<string>
A promise resolving to the tooltip or undefined if the TreeItem has no tooltip.
Inherited from TreeItem.getTooltip
- Defined in pageobjects/sidebar/tree/custom/CustomTreeItem.ts:36

hasChildren

hasChildren(): Promise<boolean>
Finds if the item has children by actually counting the child items Note that this will expand the item if it was collapsed

Returns Promise<boolean>
Promise resolving to true/false
Inherited from TreeItem.hasChildren
- Defined in pageobjects/sidebar/ViewItem.ts:71

isExpandable

isExpandable(): Promise<boolean>
Finds if the item is expandable/collapsible

Returns Promise<boolean>
Promise resolving to true/false
Inherited from TreeItem.isExpandable
- Defined in pageobjects/sidebar/tree/custom/CustomTreeItem.ts:60

isExpanded

isExpanded(): Promise<boolean>
Finds whether the item is expanded. Always returns false if item has no children.

Returns Promise<boolean>
Promise resolving to true/false
Inherited from TreeItem.isExpanded
- Defined in pageobjects/sidebar/tree/custom/CustomTreeItem.ts:44

openContextMenu

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

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

poll

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

select

select(): Promise<void>
Select the item in the view. Note that selecting the item will toggle its expand state when applicable.

Returns Promise<void>
Promise resolving when the item has been clicked
Inherited from TreeItem.select
- Defined in pageobjects/sidebar/ViewItem.ts:37

wait

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

Class CustomTreeItem

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

locators: VSCodeLocatorMap

element: ChainablePromiseElement<Element>

viewPart: TreeSection

Returns CustomTreeItem

Properties

actionConstructor$

Type declaration

Parameters

Rest ...args: []

Returns ChainablePromiseElement<Element>

actionConstructor$$

Type declaration

Parameters

Rest ...args: []

Returns ChainablePromiseArray<Element[]>

actionLabel$

actionLabel$$

actionTitle$

actionTitle$$

actions$

actions$$

author$

author$$

button$

button$$

buttonLabel$

buttonLabel$$

ctor$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseElement<Element>

ctor$$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseArray<Element[]>

description$

description$$

elem$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseElement<Element>

elem$$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseArray<Element[]>

expandedAttr$

expandedAttr$$

expandedValue$

expandedValue$$

header$

header$$

headerExpanded$

headerExpanded$$

index$

index$$

install$

install$$

itemTitle$

itemTitle$$

level$

level$$

manage$

manage$$

title$

title$$

titleText$

`Rest` ...args: []

`Rest` ...args: []

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

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

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

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