Class SourceTree

A default implementation of the tree.

Hierarchy (view full)

TreeImpl
- SourceTree

Constructors

constructor

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

Properties

`Protected` _root

_root: undefined | TreeNode

`Protected` nodes

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

Type declaration

[id: string]: Mutable<TreeNode> | undefined

`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>
Inherited from TreeImpl.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>
Inherited from TreeImpl.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
Inherited from TreeImpl.root
- Defined in packages/core/src/browser/tree/tree.ts:278
set root(root): 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
Inherited from TreeImpl.root
- Defined in packages/core/src/browser/tree/tree.ts:283

Methods

`Protected` addNode

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

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from TreeImpl.dispose
- Defined in packages/core/src/browser/tree/tree.ts:273

`Protected` doMarkAsBusy

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

`Protected` doResetBusy

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

`Protected` doSetBusy

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

`Protected` fireChanged

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

`Protected` fireNodeRefreshed

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

getNode

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

`Protected` getRootNode

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

markAsBusy

markAsBusy(raw, ms, token): 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>
Inherited from TreeImpl.markAsBusy
- Defined in packages/core/src/browser/tree/tree.ts:386

markAsChecked

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

refresh

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

Return a valid refreshed composite root or undefined if such does not exist.
Parameters
- Optional raw: CompositeTreeNode
- Optional cancellationToken: CancellationToken
Returns Promise<undefined | CompositeTreeNode>
Inherited from TreeImpl.refresh
- Defined in packages/core/src/browser/tree/tree.ts:319

`Protected` removeNode

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

resolveChildren

resolveChildren(parent): Promise<TreeNode[]>
Parameters
- parent: TreeElementNodeParent
Returns Promise<TreeNode[]>
Overrides TreeImpl.resolveChildren
- Defined in packages/core/src/browser/source-tree/source-tree.ts:27

`Protected` resolveElements

resolveElements(parent): MaybePromise<IterableIterator<TreeElement>>
Parameters
- parent: TreeElementNodeParent
Returns MaybePromise<IterableIterator<TreeElement>>
- Defined in packages/core/src/browser/source-tree/source-tree.ts:39

`Protected` setChildren

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

`Protected` toNode

toNode(element, index, parent): TreeElementNode
Parameters
- element: TreeElement
- index: number
- parent: TreeElementNodeParent
Returns TreeElementNode
- Defined in packages/core/src/browser/source-tree/source-tree.ts:46

validateNode

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

Class SourceTree

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SourceTree

Properties

Protected _root

Protected nodes

Type declaration

[id: string]: Mutable<TreeNode> | undefined

Protected Readonly onChangedEmitter

Readonly onDidChangeBusy

Protected Readonly onDidChangeBusyEmitter

Readonly onDidUpdate

Protected Readonly onDidUpdateEmitter

Protected Readonly onNodeRefreshedEmitter

Protected Readonly toDispose

Protected toDisposeOnSetRoot

Accessors

onChanged

Returns Event<void>

onNodeRefreshed

Returns Event<CompositeTreeNode & WaitUntilEvent>

root

Returns undefined | TreeNode

Parameters

Returns void

Methods

Protected addNode

Parameters

Returns void

dispose

Returns void

Protected doMarkAsBusy

Parameters

Returns Promise<void>

Protected doResetBusy

Parameters

Returns void

Protected doSetBusy

Parameters

Returns void

Protected fireChanged

Returns void

Protected fireNodeRefreshed

Parameters

Returns Promise<void>

getNode

Parameters

Returns undefined | TreeNode

Protected getRootNode

Parameters

Returns TreeNode

markAsBusy

Parameters

Returns Promise<void>

markAsChecked

Parameters

Returns void

refresh

Parameters

Returns Promise<undefined | CompositeTreeNode>

Protected removeNode

Parameters

Returns void

resolveChildren

Parameters

Returns Promise<TreeNode[]>

Protected resolveElements

Parameters

Returns MaybePromise<IterableIterator<TreeElement>>

Protected setChildren

Parameters

Returns Promise<undefined | CompositeTreeNode>

Protected toNode

`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` resolveElements

`Protected` setChildren

`Protected` toNode