Class PluginTree

A default implementation of the tree.

Hierarchy (View Summary)

TreeImpl
- PluginTree

Constructors

constructor

new PluginTree(): PluginTree
Returns PluginTree
Inherited from TreeImpl.constructor
- Defined in packages/core/lib/browser/tree/tree.d.ts:180

Properties

`Protected`_root

_root: undefined | TreeNode

`Protected` `Readonly`logger

logger: ILogger

`Protected`nodes

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

`Protected` `Readonly`notification

notification: MessageService

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

onDidChangeWelcomeState: Event<void> = ...

`Protected` `Readonly`onDidChangeWelcomeStateEmitter

onDidChangeWelcomeStateEmitter: Emitter<void> = ...

`Readonly`onDidUpdate

onDidUpdate: Event<TreeNode[]>

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

`Protected` `Readonly`onDidUpdateEmitter

onDidUpdateEmitter: Emitter<TreeNode[]>

Accessors

hasTreeItemResolve

get hasTreeItemResolve(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:206

isEmpty

get isEmpty(): boolean
Returns boolean
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:214

onChanged

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

Returns Event<void>
Inherited from TreeImpl.onChanged
- Defined in packages/core/lib/browser/tree/tree.d.ts:185

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/lib/browser/tree/tree.d.ts:187

proxy

get proxy(): undefined | TreeViewsExt
Returns undefined | TreeViewsExt
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:202
set proxy(proxy: undefined | TreeViewsExt): void
Parameters
- proxy: undefined | TreeViewsExt
Returns void
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:194

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/lib/browser/tree/tree.d.ts:182
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
Inherited from TreeImpl.root
- Defined in packages/core/lib/browser/tree/tree.d.ts:184

viewInfo

set viewInfo(viewInfo: View): void
Parameters
- viewInfo: View
Returns void
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:210

Methods

`Protected`addNode

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

`Protected`createResolvableTreeNode

createResolvableTreeNode(
item: TreeViewItem,
parent: CompositeTreeNode,
): TreeNode
Creates a resolvable tree node. If a node already exists, reset it because the underlying TreeViewItem might have been disposed in the backend.
Parameters
- item: TreeViewItem
- parent: CompositeTreeNode
Returns TreeNode
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:307

`Protected`createTreeNode

createTreeNode(item: TreeViewItem, parent: CompositeTreeNode): TreeNode
Parameters
- item: TreeViewItem
- parent: CompositeTreeNode
Returns TreeNode
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:246

`Protected`createTreeNodeUpdate

createTreeNodeUpdate(item: TreeViewItem): Partial<TreeViewNode>
Parameters
- item: TreeViewItem
Returns Partial<TreeViewNode>
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:347

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from TreeImpl.dispose
- Defined in packages/core/lib/browser/tree/tree.d.ts:181

`Protected`doMarkAsBusy

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

`Protected`doResetBusy

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

`Protected`doSetBusy

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

`Protected`fetchChildren

fetchChildren(
proxy: TreeViewsExt,
parent: CompositeTreeNode,
): Promise<TreeViewItem[]>
Parameters
- proxy: TreeViewsExt
- parent: CompositeTreeNode
Returns Promise<TreeViewItem[]>
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:227

`Protected`fireChanged

fireChanged(): void
Returns void
Inherited from TreeImpl.fireChanged
- Defined in packages/core/lib/browser/tree/tree.d.ts:186

`Protected`fireNodeRefreshed

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

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
Inherited from TreeImpl.getNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:189

`Protected`getRootNode

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

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>
Inherited from TreeImpl.markAsBusy
- Defined in packages/core/lib/browser/tree/tree.d.ts:197

markAsChecked

markAsChecked(node: Mutable<TreeNode>, checked: boolean): void
Parameters
- node: Mutable<TreeNode>
- checked: boolean
Returns void
Overrides TreeImpl.markAsChecked
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:275

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>
Inherited from TreeImpl.refresh
- Defined in packages/core/lib/browser/tree/tree.d.ts:191

removeNode

removeNode(node: undefined | TreeNode): void
Remove the given node and all of its descendants from the tree's internal id-to-node index. Safe to call on already-detached subtrees.

Callers that mutate the tree structure directly via CompositeTreeNode.removeChild should invoke this (or pass the tree to removeChild) to keep getNode and validateNode from returning orphaned nodes.
Parameters
- node: undefined | TreeNode
Returns void
Inherited from TreeImpl.removeNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:194

`Protected`resolveChildren

resolveChildren(parent: CompositeTreeNode): Promise<TreeNode[]>
Parameters
- parent: CompositeTreeNode
Returns Promise<TreeNode[]>
Overrides TreeImpl.resolveChildren
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:218

`Protected`setChildren

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

`Protected`toDecorationData

toDecorationData(item: TreeViewItem): WidgetDecoration.Data
Parameters
- item: TreeViewItem
Returns WidgetDecoration.Data
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:367

`Protected`toIconClass

toIconClass(item: TreeViewItem): undefined | string
Parameters
- item: TreeViewItem
Returns undefined | string
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:378

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
Inherited from TreeImpl.validateNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:190

Class PluginTree

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PluginTree

Properties

Protected_root

Protected Readonlylogger

Protectednodes

Protected Readonlynotification

Protected ReadonlyonChangedEmitter

ReadonlyonDidChangeBusy

Protected ReadonlyonDidChangeBusyEmitter

ReadonlyonDidChangeWelcomeState

Protected ReadonlyonDidChangeWelcomeStateEmitter

ReadonlyonDidUpdate

Protected ReadonlyonDidUpdateEmitter

Protected ReadonlyonNodeRefreshedEmitter

Protected Readonlyoptions

Protected ReadonlysharedStyle

Protected ReadonlytoDispose

ProtectedtoDisposeOnSetRoot

Accessors

hasTreeItemResolve

Returns Promise<boolean>

isEmpty

Returns boolean

onChanged

Returns Event<void>

onNodeRefreshed

Returns Event<CompositeTreeNode & WaitUntilEvent>

proxy

Returns undefined | TreeViewsExt

Parameters

Returns void

root

Returns undefined | TreeNode

Parameters

Returns void

viewInfo

Parameters

Returns void

Methods

ProtectedaddNode

Parameters

Returns void

ProtectedcreateResolvableTreeNode

Parameters

Returns TreeNode

ProtectedcreateTreeNode

Parameters

Returns TreeNode

ProtectedcreateTreeNodeUpdate

Parameters

Returns Partial<TreeViewNode>

dispose

Returns void

ProtecteddoMarkAsBusy

Parameters

Returns Promise<void>

ProtecteddoResetBusy

Parameters

Returns void

ProtecteddoSetBusy

Parameters

Returns void

ProtectedfetchChildren

Parameters

Returns Promise<TreeViewItem[]>

ProtectedfireChanged

Returns void

ProtectedfireNodeRefreshed

Parameters

Returns Promise<void>

getNode

`Protected`_root

`Protected` `Readonly`logger

`Protected`nodes

`Protected` `Readonly`notification

`Protected` `Readonly`onChangedEmitter

`Readonly`onDidChangeBusy

`Protected` `Readonly`onDidChangeBusyEmitter

`Readonly`onDidChangeWelcomeState

`Protected` `Readonly`onDidChangeWelcomeStateEmitter

`Readonly`onDidUpdate

`Protected` `Readonly`onDidUpdateEmitter

`Protected` `Readonly`onNodeRefreshedEmitter

`Protected` `Readonly`options

`Protected` `Readonly`sharedStyle

`Protected` `Readonly`toDispose

`Protected`toDisposeOnSetRoot

`Protected`addNode

`Protected`createResolvableTreeNode

`Protected`createTreeNode

`Protected`createTreeNodeUpdate

`Protected`doMarkAsBusy

`Protected`doResetBusy

`Protected`doSetBusy

`Protected`fetchChildren

`Protected`fireChanged

`Protected`fireNodeRefreshed

`Protected`getRootNode

`Protected`resolveChildren

`Protected`setChildren

`Protected`toDecorationData

`Protected`toIconClass