Class TreeModelImpl

The tree - an abstract data type.

Hierarchy (View Summary)

TreeModelImpl

Implements

TreeModel
SelectionProvider<ReadonlyArray<Readonly<SelectableTreeNode>>>

Index

Constructors

constructor

new TreeModelImpl(): TreeModelImpl
Returns TreeModelImpl

Properties

`Protected` `Readonly`expansionService

expansionService: TreeExpansionService

`Protected` `Readonly`focusService

focusService: TreeFocusService

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`navigationService

navigationService: TreeNavigationService

`Protected` `Readonly`onChangedEmitter

onChangedEmitter: Emitter<void> = ...

`Protected` `Readonly`onOpenNodeEmitter

onOpenNodeEmitter: Emitter<TreeNode> = ...

`Protected` `Readonly`selectionService

selectionService: TreeSelectionService

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`tree

tree: Tree

`Protected` `Readonly`treeSearch

treeSearch: TreeSearch

Accessors

onChanged

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

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

onDidChangeBusy

get onDidChangeBusy(): Event<TreeNode>
Emits when the busy state of the given node is changed.

Returns Event<TreeNode>
Implementation of TreeModel.onDidChangeBusy
- Defined in packages/core/src/browser/tree/tree-model.ts:541

onDidUpdate

get onDidUpdate(): Event<TreeNode[]>
An update to the tree node occurred, but the tree structure remains unchanged

Returns Event<TreeNode[]>
Implementation of TreeModel.onDidUpdate
- Defined in packages/core/src/browser/tree/tree-model.ts:549

onExpansionChanged

get onExpansionChanged(): Event<Readonly<ExpandableTreeNode>>
Emit when the node is expanded or collapsed.

Returns Event<Readonly<ExpandableTreeNode>>
Implementation of TreeModel.onExpansionChanged
- Defined in packages/core/src/browser/tree/tree-model.ts:270

onNodeRefreshed

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

Returns Event<Readonly<CompositeTreeNode> & WaitUntilEvent>
Implementation of TreeModel.onNodeRefreshed
- Defined in packages/core/src/browser/tree/tree-model.ts:237

onOpenNode

get onOpenNode(): Event<TreeNode>
Event when a node should be opened.

Returns Event<TreeNode>
Implementation of TreeModel.onOpenNode
- Defined in packages/core/src/browser/tree/tree-model.ts:229

onSelectionChanged

get onSelectionChanged(): Event<readonly Readonly<SelectableTreeNode>[]>
tslint:disable-next-line:typedef

Returns Event<readonly Readonly<SelectableTreeNode>[]>
Implementation of SelectionProvider.onSelectionChanged
- Defined in packages/core/src/browser/tree/tree-model.ts:266

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 TreeModel.root
- Defined in packages/core/src/browser/tree/tree-model.ts:217
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 TreeModel.root
- Defined in packages/core/src/browser/tree/tree-model.ts:221

selectedNodes

get selectedNodes(): readonly Readonly<SelectableTreeNode>[]
tslint:disable-next-line:typedef

Returns readonly Readonly<SelectableTreeNode>[]
Implementation of TreeModel.selectedNodes
- Defined in packages/core/src/browser/tree/tree-model.ts:261

Methods

addSelection

addSelection(
selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection,
): void
Registers the given selection into the tree selection service. If the selection state changes after adding the selectionOrTreeNode argument, a selection changed event will be fired. If the argument is a tree node, a it will be treated as a tree selection with the default selection type.
Parameters
- selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection
Returns void
Implementation of TreeModel.addSelection
- Defined in packages/core/src/browser/tree/tree-model.ts:509

canNavigateBackward

canNavigateBackward(): boolean
Tests whether it is possible to navigate backward.

Returns boolean
Implementation of TreeModel.canNavigateBackward
- Defined in packages/core/src/browser/tree/tree-model.ts:481

canNavigateForward

canNavigateForward(): boolean
Tests whether it is possible to navigate forward.

Returns boolean
Implementation of TreeModel.canNavigateForward
- Defined in packages/core/src/browser/tree/tree-model.ts:477

clearSelection

clearSelection(): void
Clears all selected nodes

Returns void
Implementation of TreeModel.clearSelection
- Defined in packages/core/src/browser/tree/tree-model.ts:513

collapseAll

collapseAll(raw?: Readonly<CompositeTreeNode>): Promise<boolean>
Collapses recursively. If the node argument is undefined, then collapses the currently selected tree node. If multiple tree nodes are selected, collapses the most recently selected tree node.
Parameters
- Optionalraw: Readonly<CompositeTreeNode>
Returns Promise<boolean>
Implementation of TreeModel.collapseAll
- Defined in packages/core/src/browser/tree/tree-model.ts:298

collapseNode

collapseNode(raw?: Readonly<ExpandableTreeNode>): Promise<boolean>
Collapses the given node. If the node argument is undefined, then collapses the currently selected tree node. If multiple tree nodes are selected, collapses the most recently selected tree node.
Parameters
- Optionalraw: Readonly<ExpandableTreeNode>
Returns Promise<boolean>
Implementation of TreeModel.collapseNode
- Defined in packages/core/src/browser/tree/tree-model.ts:289

`Protected`createBackwardIterator

createBackwardIterator(node: undefined | TreeNode): undefined | TreeIterator
Parameters
- node: undefined | TreeNode
Returns undefined | TreeIterator
- Defined in packages/core/src/browser/tree/tree-model.ts:404

`Protected`createBackwardTreeIterator

createBackwardTreeIterator(node: undefined | TreeNode): undefined | TreeIterator
Parameters
- node: undefined | TreeNode
Returns undefined | TreeIterator
- Defined in packages/core/src/browser/tree/tree-model.ts:393

`Protected`createForwardIteratorForNode

createForwardIteratorForNode(node: TreeNode): TreeIterator
Parameters
- node: TreeNode
Returns TreeIterator
- Defined in packages/core/src/browser/tree/tree-model.ts:437

`Protected`createIterator

createIterator(node: undefined | TreeNode): undefined | TreeIterator
Parameters
- node: undefined | TreeNode
Returns undefined | TreeIterator
- Defined in packages/core/src/browser/tree/tree-model.ts:426

`Protected`createTreeIterator

createTreeIterator(node: undefined | TreeNode): undefined | TreeIterator
Parameters
- node: undefined | TreeNode
Returns undefined | TreeIterator
- Defined in packages/core/src/browser/tree/tree-model.ts:415

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of TreeModel.dispose
- Defined in packages/core/src/browser/tree/tree-model.ts:198

`Protected`doGetNextNode

doGetNextNode<T extends TreeNode>(
iterator: TreeIterator,
criterion: (node: TreeNode) => node is T,
): undefined | T
Type Parameters
- T extends TreeNode
Parameters
- iterator: TreeIterator
- criterion: (node: TreeNode) => node is T
Returns undefined | T
- Defined in packages/core/src/browser/tree/tree-model.ts:376

`Protected`doGetNode

doGetNode(iterator: TreeIterator): undefined | TreeNode
Parameters
- iterator: TreeIterator
Returns undefined | TreeNode
- Defined in packages/core/src/browser/tree/tree-model.ts:370

`Protected`doNavigate

doNavigate(node: TreeNode): Promise<void>
Parameters
- node: TreeNode
Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree-model.ts:499

`Protected`doOpenNode

doOpenNode(node: TreeNode): void
Parameters
- node: TreeNode
Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:449

expandNode

expandNode(
raw?: Readonly<ExpandableTreeNode>,
): Promise<undefined | ExpandableTreeNode>
Expands the given node. If the node argument is undefined, then expands the currently selected tree node. If multiple tree nodes are selected, expands the most recently selected tree node.
Parameters
- Optionalraw: Readonly<ExpandableTreeNode>
Returns Promise<undefined | ExpandableTreeNode>
Implementation of TreeModel.expandNode
- Defined in packages/core/src/browser/tree/tree-model.ts:274

`Protected`fireChanged

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

`Protected`getExpansionCandidates

getExpansionCandidates(
raw?: Readonly<TreeNode>,
): IterableIterator<undefined | TreeNode>
Parameters
- Optionalraw: Readonly<TreeNode>
Returns IterableIterator<undefined | TreeNode>
- Defined in packages/core/src/browser/tree/tree-model.ts:283

getFocusedNode

getFocusedNode(): undefined | SelectableTreeNode
Returns the node currently in focus in this tree, or undefined if no node is focused.

Returns undefined | SelectableTreeNode
Implementation of TreeModel.getFocusedNode
- Defined in packages/core/src/browser/tree/tree-model.ts:245

getNextNode

getNextNode(node?: undefined | TreeNode): undefined | TreeNode
Returns the next tree node, regardless of its selection or visibility state.
Parameters
- node: undefined | TreeNode = ...
Returns undefined | TreeNode
Implementation of TreeModel.getNextNode
- Defined in packages/core/src/browser/tree/tree-model.ts:354

getNextSelectableNode

getNextSelectableNode(
node?: undefined | TreeNode,
): undefined | SelectableTreeNode
Returns the next selectable tree node.
Parameters
- node: undefined | TreeNode = ...
Returns undefined | SelectableTreeNode
Implementation of TreeModel.getNextSelectableNode
- Defined in packages/core/src/browser/tree/tree-model.ts:359

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 TreeModel.getNode
- Defined in packages/core/src/browser/tree/tree-model.ts:241

getPrevNode

getPrevNode(node?: undefined | TreeNode): undefined | TreeNode
Returns the previous tree node, regardless of its selection or visibility state.
Parameters
- node: undefined | TreeNode = ...
Returns undefined | TreeNode
Implementation of TreeModel.getPrevNode
- Defined in packages/core/src/browser/tree/tree-model.ts:329

getPrevSelectableNode

getPrevSelectableNode(
node?: undefined | TreeNode,
): undefined | SelectableTreeNode
Returns the previous selectable tree node.
Parameters
- node: undefined | TreeNode = ...
Returns undefined | SelectableTreeNode
Implementation of TreeModel.getPrevSelectableNode
- Defined in packages/core/src/browser/tree/tree-model.ts:334

`Protected`handleExpansion

handleExpansion(node: Readonly<ExpandableTreeNode>): void
Parameters
- node: Readonly<ExpandableTreeNode>
Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:202

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:181

`Protected`isVisibleSelectableNode

isVisibleSelectableNode(node: TreeNode): node is SelectableTreeNode
Parameters
- node: TreeNode
Returns node is SelectableTreeNode
- Defined in packages/core/src/browser/tree/tree-model.ts:389

markAsBusy

markAsBusy(
    node: Readonly<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
- node: Readonly<TreeNode>
- ms: number
- token: CancellationToken
Returns Promise<void>
Implementation of TreeModel.markAsBusy
- Defined in packages/core/src/browser/tree/tree-model.ts:545

markAsChecked

markAsChecked(node: TreeNode, checked: boolean): void
Parameters
- node: TreeNode
- checked: boolean
Returns void
Implementation of TreeModel.markAsChecked
- Defined in packages/core/src/browser/tree/tree-model.ts:553

navigateBackward

navigateBackward(): Promise<void>
Navigates backward.

Returns Promise<void>
Implementation of TreeModel.navigateBackward
- Defined in packages/core/src/browser/tree/tree-model.ts:492

navigateForward

navigateForward(): Promise<void>
Navigates forward.

Returns Promise<void>
Implementation of TreeModel.navigateForward
- Defined in packages/core/src/browser/tree/tree-model.ts:485

navigateTo

navigateTo(
nodeOrId: undefined | string | TreeNode,
): Promise<undefined | TreeNode>
Navigates to the given node if it is defined. This method accepts both the tree node and its ID as an argument. Navigation sets a node as a root node and expand it. Resolves to the node if the navigation was successful. Otherwise, resolves to undefined.
Parameters
- nodeOrId: undefined | string | TreeNode
Returns Promise<undefined | TreeNode>
Implementation of TreeModel.navigateTo
- Defined in packages/core/src/browser/tree/tree-model.ts:465

openNode

openNode(raw?: TreeNode): void
Opens the given node or the currently selected on if the argument is undefined. If multiple nodes are selected, open the most recently selected node.
Parameters
- Optionalraw: TreeNode
Returns void
Implementation of TreeModel.openNode
- Defined in packages/core/src/browser/tree/tree-model.ts:441

refresh

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

Return a valid refreshed composite root or undefined if such does not exist.
Parameters
- Optionalparent: Readonly<CompositeTreeNode>
Returns Promise<undefined | CompositeTreeNode>
Implementation of TreeModel.refresh
- Defined in packages/core/src/browser/tree/tree-model.ts:253

restoreState

restoreState(state: TreeModelImpl.State): void
Restore selection state.
Parameters
- state: TreeModelImpl.State
Returns void
Implementation of TreeModel.restoreState
- Defined in packages/core/src/browser/tree/tree-model.ts:535

`Protected`selectIfAncestorOfSelected

selectIfAncestorOfSelected(node: Readonly<ExpandableTreeNode>): void
Select the given node if it is the ancestor of a selected node.
Parameters
- node: Readonly<ExpandableTreeNode>
Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:209

selectNext

selectNext(): void
Selects the next tree node, regardless of its selection or visibility state.

Returns void
Implementation of TreeModel.selectNext
- Defined in packages/core/src/browser/tree/tree-model.ts:342

selectNextNode

selectNextNode(type?: SelectionType): void
Selects the next node relatively to the currently selected one. This method takes the expansion state of the tree into consideration.
Parameters
- type: SelectionType = TreeSelection.SelectionType.DEFAULT
Returns void
Implementation of TreeModel.selectNextNode
- Defined in packages/core/src/browser/tree/tree-model.ts:347

selectNode

selectNode(node: Readonly<SelectableTreeNode>): void
Selects the given tree node. Has no effect when the node does not exist in the tree. Discards any previous selection state.
Parameters
- node: Readonly<SelectableTreeNode>
Returns void
Implementation of TreeModel.selectNode
- Defined in packages/core/src/browser/tree/tree-model.ts:517

`Protected`selectNodeIfSelectable

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

selectParent

selectParent(): void
Selects the parent node relatively to the selected taking into account node expansion.

Returns void
Implementation of TreeModel.selectParent
- Defined in packages/core/src/browser/tree/tree-model.ts:455

selectPrev

selectPrev(): void
Selects the previous tree node, regardless of its selection or visibility state.

Returns void
Implementation of TreeModel.selectPrev
- Defined in packages/core/src/browser/tree/tree-model.ts:317

selectPrevNode

selectPrevNode(type?: SelectionType): void
Selects the previous node relatively to the currently selected one. This method takes the expansion state of the tree into consideration.
Parameters
- type: SelectionType = TreeSelection.SelectionType.DEFAULT
Returns void
Implementation of TreeModel.selectPrevNode
- Defined in packages/core/src/browser/tree/tree-model.ts:322

selectRange

selectRange(node: Readonly<SelectableTreeNode>): void
Selects a range of tree nodes. The target of the selection range is the argument, the from tree node is the previous selected node. If no node was selected previously, invoking this method does nothing.
Parameters
- node: Readonly<SelectableTreeNode>
Returns void
Implementation of TreeModel.selectRange
- Defined in packages/core/src/browser/tree/tree-model.ts:525

storeState

storeState(): TreeModelImpl.State
Store selection state.

Returns TreeModelImpl.State
Implementation of TreeModel.storeState
- Defined in packages/core/src/browser/tree/tree-model.ts:529

toggleNode

toggleNode(node: Readonly<SelectableTreeNode>): void
Selects the given node if it was not yet selected, or unselects it if it was. Keeps the previous selection state and updates it with the current toggle selection.
Parameters
- node: Readonly<SelectableTreeNode>
Returns void
Implementation of TreeModel.toggleNode
- Defined in packages/core/src/browser/tree/tree-model.ts:521

toggleNodeExpansion

toggleNodeExpansion(raw?: Readonly<ExpandableTreeNode>): Promise<void>
Toggles the expansion state of the given node. If not give, then it toggles the expansion state of the currently selected node. If multiple nodes are selected, then the most recently selected tree node's expansion state will be toggled.
Parameters
- Optionalraw: Readonly<ExpandableTreeNode>
Returns Promise<void>
Implementation of TreeModel.toggleNodeExpansion
- Defined in packages/core/src/browser/tree/tree-model.ts:309

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 TreeModel.validateNode
- Defined in packages/core/src/browser/tree/tree-model.ts:249

Class TreeModelImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TreeModelImpl

Properties

Protected ReadonlyexpansionService

Protected ReadonlyfocusService

Protected Readonlylogger

Protected ReadonlynavigationService

Protected ReadonlyonChangedEmitter

Protected ReadonlyonOpenNodeEmitter

Protected ReadonlyselectionService

Protected ReadonlytoDispose

Protected Readonlytree

Protected ReadonlytreeSearch

Accessors

onChanged

Returns Event<void>

onDidChangeBusy

Returns Event<TreeNode>

onDidUpdate

Returns Event<TreeNode[]>

onExpansionChanged

Returns Event<Readonly<ExpandableTreeNode>>

onNodeRefreshed

Returns Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

onOpenNode

Returns Event<TreeNode>

onSelectionChanged

Returns Event<readonly Readonly<SelectableTreeNode>[]>

root

Returns undefined | TreeNode

Parameters

Returns void

selectedNodes

Returns readonly Readonly<SelectableTreeNode>[]

Methods

addSelection

Parameters

Returns void

canNavigateBackward

Returns boolean

canNavigateForward

Returns boolean

clearSelection

Returns void

collapseAll

Parameters

Returns Promise<boolean>

collapseNode

Parameters

Returns Promise<boolean>

ProtectedcreateBackwardIterator

Parameters

Returns undefined | TreeIterator

ProtectedcreateBackwardTreeIterator

Parameters

Returns undefined | TreeIterator

ProtectedcreateForwardIteratorForNode

Parameters

Returns TreeIterator

ProtectedcreateIterator

Parameters

Returns undefined | TreeIterator

ProtectedcreateTreeIterator

Parameters

Returns undefined | TreeIterator

dispose

Returns void

ProtecteddoGetNextNode

Type Parameters

Parameters

Returns undefined | T

`Protected` `Readonly`expansionService

`Protected` `Readonly`focusService

`Protected` `Readonly`logger

`Protected` `Readonly`navigationService

`Protected` `Readonly`onChangedEmitter

`Protected` `Readonly`onOpenNodeEmitter

`Protected` `Readonly`selectionService

`Protected` `Readonly`toDispose

`Protected` `Readonly`tree

`Protected` `Readonly`treeSearch

`Protected`createBackwardIterator

`Protected`createBackwardTreeIterator

`Protected`createForwardIteratorForNode

`Protected`createIterator

`Protected`createTreeIterator

`Protected`doGetNextNode

`Protected`doGetNode

`Protected`doNavigate

`Protected`doOpenNode

`Protected`fireChanged

`Protected`getExpansionCandidates

`Protected`handleExpansion

`Protected`init

`Protected`isVisibleSelectableNode

`Protected`selectIfAncestorOfSelected