Class FileNavigatorTree

A default implementation of the tree.

Hierarchy (View Summary)

FileTree
- FileNavigatorTree

Constructors

constructor

new FileNavigatorTree(): FileNavigatorTree
Returns FileNavigatorTree
Inherited from FileTree.constructor
- Defined in packages/core/lib/browser/tree/tree.d.ts:158

Properties

`Protected`_root

_root: undefined | TreeNode

`Protected` `Readonly`compressionToggle

compressionToggle: CompressionToggle

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`filter

filter: FileNavigatorFilter

`Protected` `Readonly`messagingService

messagingService: MessageService

`Protected` `Readonly`navigatorPreferences

navigatorPreferences: FileNavigatorPreferences

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

Accessors

onChanged

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

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

onNodeRefreshed

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

Returns Event<CompositeTreeNode & WaitUntilEvent>
Inherited from FileTree.onNodeRefreshed
- Defined in packages/core/lib/browser/tree/tree.d.ts:165

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 FileTree.root
- Defined in packages/core/lib/browser/tree/tree.d.ts:160
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 FileTree.root
- Defined in packages/core/lib/browser/tree/tree.d.ts:162

Methods

`Protected`addNode

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

createId

createId(root: WorkspaceRootNode, uri: URI): string
Parameters
- root: WorkspaceRootNode
- uri: URI
Returns string
- Defined in packages/navigator/src/browser/navigator-tree.ts:64

createWorkspaceRoot

createWorkspaceRoot(
rootFolder: FileStat,
workspaceNode: WorkspaceNode,
): Promise<WorkspaceRootNode>
Parameters
- rootFolder: FileStat
- workspaceNode: WorkspaceNode
Returns Promise<WorkspaceRootNode>
- Defined in packages/navigator/src/browser/navigator-tree.ts:69

dispose

dispose(): void
Dispose this object.

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

`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 FileTree.doMarkAsBusy
- Defined in packages/core/lib/browser/tree/tree.d.ts:177

`Protected`doResetBusy

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

`Protected`doSetBusy

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

`Protected`fireChanged

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

`Protected`fireNodeRefreshed

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

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 FileTree.getNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:167

`Protected`getRootNode

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

`Protected`init

init(): void
Returns void
- Defined in packages/navigator/src/browser/navigator-tree.ts:35

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 FileTree.markAsBusy
- Defined in packages/core/lib/browser/tree/tree.d.ts:175

markAsChecked

markAsChecked(node: Mutable<TreeNode>, checked: boolean): void
Parameters
- node: Mutable<TreeNode>
- checked: boolean
Returns void
Inherited from FileTree.markAsChecked
- Defined in packages/core/lib/browser/tree/tree.d.ts:176

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 FileTree.refresh
- Defined in packages/core/lib/browser/tree/tree.d.ts:169

`Protected`removeNode

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

resolveChildren

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

`Protected`resolveFileStat

resolveFileStat(node: FileStatNode): Promise<undefined | FileStat>
Parameters
- node: FileStatNode
Returns Promise<undefined | FileStat>
Inherited from FileTree.resolveFileStat
- Defined in packages/filesystem/lib/browser/file-tree/file-tree.d.ts:13

`Protected`setChildren

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

`Protected`toggleCompression

toggleCompression(): void
Returns void
- Defined in packages/navigator/src/browser/navigator-tree.ts:45

`Protected`toNode

toNode(fileStat: FileStat, parent: CompositeTreeNode): FileStatNode | DirNode
Parameters
- fileStat: FileStat
- parent: CompositeTreeNode
Returns FileStatNode | DirNode
Inherited from FileTree.toNode
- Defined in packages/filesystem/lib/browser/file-tree/file-tree.d.ts:15

`Protected`toNodeId

toNodeId(uri: URI, parent: CompositeTreeNode): string
Parameters
- uri: URI
- parent: CompositeTreeNode
Returns string
Overrides FileTree.toNodeId
- Defined in packages/navigator/src/browser/navigator-tree.ts:57

`Protected`toNodes

toNodes(fileStat: FileStat, parent: CompositeTreeNode): Promise<TreeNode[]>
Parameters
- fileStat: FileStat
- parent: CompositeTreeNode
Returns Promise<TreeNode[]>
Inherited from FileTree.toNodes
- Defined in packages/filesystem/lib/browser/file-tree/file-tree.d.ts:14

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 FileTree.validateNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:168

Class FileNavigatorTree

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FileNavigatorTree

Properties

Protected_root

Protected ReadonlycompressionToggle

Protected ReadonlyfileService

Protected Readonlyfilter

Protected ReadonlymessagingService

Protected ReadonlynavigatorPreferences

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

createId

Parameters

Returns string

createWorkspaceRoot

Parameters

Returns Promise<WorkspaceRootNode>

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

Protectedinit

Returns void

markAsBusy

Parameters

Returns Promise<void>

markAsChecked

Parameters

Returns void

refresh

Parameters

Returns Promise<undefined | CompositeTreeNode>

ProtectedremoveNode

Parameters

`Protected`_root

`Protected` `Readonly`compressionToggle

`Protected` `Readonly`fileService

`Protected` `Readonly`filter

`Protected` `Readonly`messagingService

`Protected` `Readonly`navigatorPreferences

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

`Protected`removeNode

`Protected`resolveFileStat

`Protected`setChildren

`Protected`toggleCompression

`Protected`toNode

`Protected`toNodeId

`Protected`toNodes