Class TreeImpl

A default implementation of the tree.

Hierarchy (View Summary)

TreeImpl

Implements

Tree

Constructors

constructor

new TreeImpl(): TreeImpl
Returns TreeImpl
- Defined in packages/core/src/browser/tree/tree.ts:267

Properties

`Protected`_root

_root: undefined | TreeNode

`Protected`nodes

nodes: { [id: string]: undefined | Mutable<TreeNode> } = {}

`Protected` `Readonly`onChangedEmitter

onChangedEmitter: Emitter<void> = ...

`Readonly`onDidChangeBusy

onDidChangeBusy: Event<TreeNode> = ...

Emits when the busy state of the given node is changed.

`Protected` `Readonly`onDidChangeBusyEmitter

onDidChangeBusyEmitter: Emitter<TreeNode> = ...

`Readonly`onDidUpdate

onDidUpdate: Event<TreeNode[]> = ...

An update to the tree node occurred, but the tree structure remains unchanged

`Protected` `Readonly`onDidUpdateEmitter

onDidUpdateEmitter: Emitter<TreeNode[]> = ...

`Protected` `Readonly`onNodeRefreshedEmitter

onNodeRefreshedEmitter: Emitter<CompositeTreeNode & WaitUntilEvent> = ...

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected`toDisposeOnSetRoot

toDisposeOnSetRoot: DisposableCollection = ...

Accessors

onChanged

get onChanged(): Event<void>
Emit when the tree is changed.

Returns Event<void>
Implementation of Tree.onChanged
- Defined in packages/core/src/browser/tree/tree.ts:293

onNodeRefreshed

get onNodeRefreshed(): Event<CompositeTreeNode & WaitUntilEvent>
Emit when the children of the given node are refreshed.

Returns Event<CompositeTreeNode & WaitUntilEvent>
Implementation of Tree.onNodeRefreshed
- Defined in packages/core/src/browser/tree/tree.ts:301

root

get root(): undefined | TreeNode
A root node of this tree. Undefined if there is no root node. Setting a root node refreshes the tree.

Returns undefined | TreeNode
Implementation of Tree.root
- Defined in packages/core/src/browser/tree/tree.ts:278
set root(root: undefined | TreeNode): void
A root node of this tree. Undefined if there is no root node. Setting a root node refreshes the tree.
Parameters
- root: undefined | TreeNode
Returns void
Implementation of Tree.root
- Defined in packages/core/src/browser/tree/tree.ts:283

Methods

`Protected`addNode

addNode(node: undefined | TreeNode): void
Parameters
- node: undefined | TreeNode
Returns void
- Defined in packages/core/src/browser/tree/tree.ts:373

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Tree.dispose
- Defined in packages/core/src/browser/tree/tree.ts:273

`Protected`doMarkAsBusy

doMarkAsBusy(
    node: Mutable<TreeNode>,
    ms: number,
    token: CancellationToken,
): Promise<void>
Parameters
- node: Mutable<TreeNode>
- ms: number
- token: CancellationToken
Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree.ts:398

`Protected`doResetBusy

doResetBusy(node: Mutable<TreeNode>): void
Parameters
- node: Mutable<TreeNode>
Returns void
- Defined in packages/core/src/browser/tree/tree.ts:415

`Protected`doSetBusy

doSetBusy(node: Mutable<TreeNode>): void
Parameters
- node: Mutable<TreeNode>
Returns void
- Defined in packages/core/src/browser/tree/tree.ts:408

`Protected`fireChanged

fireChanged(): void
Returns void
- Defined in packages/core/src/browser/tree/tree.ts:297

`Protected`fireNodeRefreshed

fireNodeRefreshed(parent: CompositeTreeNode): Promise<void>
Parameters
- parent: CompositeTreeNode
Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree.ts:305

getNode

getNode(id: undefined | string): undefined | TreeNode
Return a node for the given identifier or undefined if such does not exist.
Parameters
- id: undefined | string
Returns undefined | TreeNode
Implementation of Tree.getNode
- Defined in packages/core/src/browser/tree/tree.ts:310

`Protected`getRootNode

getRootNode(node: TreeNode): TreeNode
Parameters
- node: TreeNode
Returns TreeNode
- Defined in packages/core/src/browser/tree/tree.ts:365

markAsBusy

markAsBusy(raw: TreeNode, ms: number, token: CancellationToken): Promise<void>
Marks the give node as busy after a specified number of milliseconds. A token source of the given token should be canceled to unmark.
Parameters
- raw: TreeNode
- ms: number
- token: CancellationToken
Returns Promise<void>
Implementation of Tree.markAsBusy
- Defined in packages/core/src/browser/tree/tree.ts:386

markAsChecked

markAsChecked(node: Mutable<TreeNode>, checked: boolean): void
Parameters
- node: Mutable<TreeNode>
- checked: boolean
Returns void
Implementation of Tree.markAsChecked
- Defined in packages/core/src/browser/tree/tree.ts:393

refresh

refresh(
raw?: CompositeTreeNode,
cancellationToken?: CancellationToken,
): Promise<undefined | CompositeTreeNode>
Refresh children of the root node.

Return a valid refreshed composite root or undefined if such does not exist.
Parameters
- Optionalraw: CompositeTreeNode
- OptionalcancellationToken: CancellationToken
Returns Promise<undefined | CompositeTreeNode>
Implementation of Tree.refresh
- Defined in packages/core/src/browser/tree/tree.ts:319

`Protected`removeNode

removeNode(node: undefined | TreeNode): void
Parameters
- node: undefined | TreeNode
Returns void
- Defined in packages/core/src/browser/tree/tree.ts:356

`Protected`resolveChildren

resolveChildren(parent: CompositeTreeNode): Promise<TreeNode[]>
Parameters
- parent: CompositeTreeNode
Returns Promise<TreeNode[]>
- Defined in packages/core/src/browser/tree/tree.ts:339

`Protected`setChildren

setChildren(
parent: CompositeTreeNode,
children: TreeNode[],
): Promise<undefined | CompositeTreeNode>
Parameters
- parent: CompositeTreeNode
- children: TreeNode[]
Returns Promise<undefined | CompositeTreeNode>
- Defined in packages/core/src/browser/tree/tree.ts:343

validateNode

validateNode(node: undefined | TreeNode): undefined | TreeNode
Return a valid node in this tree matching to the given; otherwise undefined.
Parameters
- node: undefined | TreeNode
Returns undefined | TreeNode
Implementation of Tree.validateNode
- Defined in packages/core/src/browser/tree/tree.ts:314

Class TreeImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TreeImpl

Properties

Protected_root

Protectednodes

Protected ReadonlyonChangedEmitter

ReadonlyonDidChangeBusy

Protected ReadonlyonDidChangeBusyEmitter

ReadonlyonDidUpdate

Protected ReadonlyonDidUpdateEmitter

Protected ReadonlyonNodeRefreshedEmitter

Protected ReadonlytoDispose

ProtectedtoDisposeOnSetRoot

Accessors

onChanged

Returns Event<void>

onNodeRefreshed

Returns Event<CompositeTreeNode & WaitUntilEvent>

root

Returns undefined | TreeNode

Parameters

Returns void

Methods

ProtectedaddNode

Parameters

Returns void

dispose

Returns void

ProtecteddoMarkAsBusy

Parameters

Returns Promise<void>

ProtecteddoResetBusy

Parameters

Returns void

ProtecteddoSetBusy

Parameters

Returns void

ProtectedfireChanged

Returns void

ProtectedfireNodeRefreshed

Parameters

Returns Promise<void>

getNode

Parameters

Returns undefined | TreeNode

ProtectedgetRootNode

Parameters

Returns TreeNode

markAsBusy

Parameters

Returns Promise<void>

markAsChecked

Parameters

Returns void

refresh

Parameters

Returns Promise<undefined | CompositeTreeNode>

ProtectedremoveNode

Parameters

Returns void

ProtectedresolveChildren

Parameters

Returns Promise<TreeNode[]>

ProtectedsetChildren

Parameters

Returns Promise<undefined | CompositeTreeNode>

validateNode

Parameters

Returns undefined | TreeNode

Settings

On This Page

`Protected`_root

`Protected`nodes

`Protected` `Readonly`onChangedEmitter

`Readonly`onDidChangeBusy

`Protected` `Readonly`onDidChangeBusyEmitter

`Readonly`onDidUpdate

`Protected` `Readonly`onDidUpdateEmitter

`Protected` `Readonly`onNodeRefreshedEmitter

`Protected` `Readonly`toDispose

`Protected`toDisposeOnSetRoot

`Protected`addNode

`Protected`doMarkAsBusy

`Protected`doResetBusy

`Protected`doSetBusy

`Protected`fireChanged

`Protected`fireNodeRefreshed

`Protected`getRootNode

`Protected`removeNode

`Protected`resolveChildren

`Protected`setChildren