Class TreeItemAbstract

TreeItem abstract class

Hierarchy (view full)

Properties

actionConstructor$ actionConstructor$$ actionLabel$ actionLabel$$ actionTitle$ actionTitle$$ actions$ actions$$ author$ author$$ button$ button$$ buttonLabel$ buttonLabel$$ ctor$ ctor$$ description$ description$$ elem$ elem$$ expandedAttr$ expandedAttr$$ expandedValue$ expandedValue$$ header$ header$$ headerExpanded$ headerExpanded$$ index$ index$$ install$ install$$ itemTitle$ itemTitle$$ level$ level$$ manage$ manage$$ title$ title$$ titleText$ titleText$$ tooltip$ tooltip$$ tooltipAttribute$ tooltipAttribute$$ twistie$ twistie$$ version$ version$$ welcomeContent$ welcomeContent$$

Accessors

elem locators parent

Methods

collapse expand findChildItem getActionButton getActionButtons getChildren getDescription getLabel getTooltip hasChildren isExpandable isExpanded openContextMenu poll select wait

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

welcomeContent$

welcomeContent$: ChainablePromiseElement<Element>

welcomeContent$$

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

collapse

expand

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

getActionButton

getActionButtons

Abstract 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

Abstract getDescription

  • getDescription(): Promise<undefined | string>

  • Retrieves the description of this TreeItem.

    Returns Promise<undefined | string>

    A promise resolving to the tooltip or undefined if the TreeItem has no description.

Abstract getLabel

Abstract getTooltip

  • getTooltip(): Promise<undefined | string>

  • Retrieves the tooltip of this TreeItem.

    Returns Promise<undefined | string>

    A promise resolving to the tooltip or undefined if the TreeItem has no tooltip.

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

Abstract isExpandable

  • isExpandable(): Promise<boolean>

  • Finds if the item is expandable/collapsible

    Returns Promise<boolean>

    Promise resolving to true/false

Abstract 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

openContextMenu

poll

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

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

    thenable self reference

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

wait

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc