Interface TreeModel

The tree - an abstract data type.

interface TreeModel {
    onChanged: Event<void>;
    onDidChangeBusy: Event<TreeNode>;
    onDidUpdate: Event<TreeNode[]>;
    onExpansionChanged: Event<Readonly<ExpandableTreeNode>>;
    onNodeRefreshed: Event<Readonly<CompositeTreeNode> & WaitUntilEvent>;
    onOpenNode: Event<Readonly<TreeNode>>;
    onSelectionChanged: Event<readonly Readonly<SelectableTreeNode>[]>;
    root: undefined | TreeNode;
    selectedNodes: readonly Readonly<SelectableTreeNode>[];
    addSelection(selectionOrTreeNode): void;
    canNavigateBackward(): boolean;
    canNavigateForward(): boolean;
    clearSelection(): void;
    collapseAll(node?): Promise<boolean>;
    collapseNode(node?): Promise<boolean>;
    dispose(): void;
    expandNode(node?): Promise<undefined | Readonly<ExpandableTreeNode>>;
    getFocusedNode(): undefined | SelectableTreeNode;
    getNextNode(node?): undefined | TreeNode;
    getNextSelectableNode(node?): undefined | SelectableTreeNode;
    getNode(id): undefined | TreeNode;
    getPrevNode(node?): undefined | TreeNode;
    getPrevSelectableNode(node?): undefined | SelectableTreeNode;
    markAsBusy(node, ms, token): Promise<void>;
    markAsChecked(node, checked): void;
    navigateBackward(): Promise<void>;
    navigateForward(): Promise<void>;
    navigateTo(nodeOrId): Promise<undefined | TreeNode>;
    openNode(node?): void;
    refresh(): Promise<undefined | Readonly<CompositeTreeNode>>;
    refresh(parent): Promise<undefined | Readonly<CompositeTreeNode>>;
    restoreState(state): void;
    selectNext(): void;
    selectNextNode(type?): void;
    selectNode(node): void;
    selectParent(): void;
    selectPrev(): void;
    selectPrevNode(type?): void;
    selectRange(node): void;
    storeState(): object;
    toggleNode(node): void;
    toggleNodeExpansion(node?): Promise<void>;
    validateNode(node): undefined | TreeNode;
}

Hierarchy (view full)

Implemented by

TreeModelImpl

Properties

`Readonly` onChanged

onChanged: Event<void>

Emit when the tree is changed.

`Readonly` onDidChangeBusy

onDidChangeBusy: Event<TreeNode>

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

`Readonly` onDidUpdate

onDidUpdate: Event<TreeNode[]>

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

`Readonly` onExpansionChanged

onExpansionChanged: Event<Readonly<ExpandableTreeNode>>

Emit when the node is expanded or collapsed.

`Readonly` onNodeRefreshed

onNodeRefreshed: Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

Emit when the children of the given node are refreshed.

`Readonly` onOpenNode

onOpenNode: Event<Readonly<TreeNode>>

Event when a node should be opened.

`Readonly` onSelectionChanged

onSelectionChanged: Event<readonly Readonly<SelectableTreeNode>[]>

Emitted when the selection has changed in the tree.

root

root: undefined | TreeNode

A root node of this tree. Undefined if there is no root node. Setting a root node refreshes the tree.

`Readonly` selectedNodes

selectedNodes: readonly Readonly<SelectableTreeNode>[]

The tree selection, representing the selected nodes from the tree. If nothing is selected, the result will be empty.

Methods

addSelection

addSelection(selectionOrTreeNode): 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
Inherited from TreeSelectionService.addSelection
- Defined in packages/core/src/browser/tree/tree-selection.ts:42

canNavigateBackward

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

Returns boolean
- Defined in packages/core/src/browser/tree/tree-model.ts:91

canNavigateForward

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

Returns boolean
- Defined in packages/core/src/browser/tree/tree-model.ts:86

clearSelection

clearSelection(): void
Clears all selected nodes

Returns void
Inherited from TreeSelectionService.clearSelection
- Defined in packages/core/src/browser/tree/tree-selection.ts:47

collapseAll

collapseAll(node?): 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
- Optional node: Readonly<CompositeTreeNode>
Returns Promise<boolean>
Overrides TreeExpansionService.collapseAll
- Defined in packages/core/src/browser/tree/tree-model.ts:53

collapseNode

collapseNode(node?): 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
- Optional node: Readonly<ExpandableTreeNode>
Returns Promise<boolean>
Overrides TreeExpansionService.collapseNode
- Defined in packages/core/src/browser/tree/tree-model.ts:47

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from TreeExpansionService.dispose
- Defined in packages/core/src/common/disposable.ts:24

expandNode

expandNode(node?): Promise<undefined | Readonly<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
- Optional node: Readonly<ExpandableTreeNode>
Returns Promise<undefined | Readonly<ExpandableTreeNode>>
Overrides TreeExpansionService.expandNode
- Defined in packages/core/src/browser/tree/tree-model.ts:41

getFocusedNode

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

Returns undefined | SelectableTreeNode
- Defined in packages/core/src/browser/tree/tree-model.ts:162

getNextNode

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

getNextSelectableNode

getNextSelectableNode(node?): undefined | SelectableTreeNode
Returns the next selectable tree node.
Parameters
- Optional node: TreeNode
Returns undefined | SelectableTreeNode
- Defined in packages/core/src/browser/tree/tree-model.ts:140

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

getPrevNode

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

getPrevSelectableNode

getPrevSelectableNode(node?): undefined | SelectableTreeNode
Returns the previous selectable tree node.
Parameters
- Optional node: TreeNode
Returns undefined | SelectableTreeNode
- Defined in packages/core/src/browser/tree/tree-model.ts:120

markAsBusy

markAsBusy(node, 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
- node: Readonly<TreeNode>
- ms: number
- token: CancellationToken
Returns Promise<void>
Inherited from Tree.markAsBusy
- Defined in packages/core/src/browser/tree/tree.ts:73

markAsChecked

markAsChecked(node, checked): void
Parameters
- node: TreeNode
- checked: boolean
Returns void
Inherited from Tree.markAsChecked
- Defined in packages/core/src/browser/tree/tree.ts:80

navigateBackward

navigateBackward(): Promise<void>
Navigates backward.

Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree-model.ts:100

navigateForward

navigateForward(): Promise<void>
Navigates forward.

Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree-model.ts:96

navigateTo

navigateTo(nodeOrId): 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 | Readonly<TreeNode>
Returns Promise<undefined | TreeNode>
- Defined in packages/core/src/browser/tree/tree-model.ts:82

openNode

openNode(node?): 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
- Optional node: Readonly<TreeNode>
Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:65

refresh

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

Return a valid refreshed composite root or undefined if such does not exist.

Returns Promise<undefined | Readonly<CompositeTreeNode>>
Inherited from Tree.refresh
- Defined in packages/core/src/browser/tree/tree.ts:54
refresh(parent): Promise<undefined | Readonly<CompositeTreeNode>>
Refresh children of a node for the give node id if it is valid.

Return a valid refreshed composite node or undefined if such does not exist.
Parameters
- parent: Readonly<CompositeTreeNode>
Returns Promise<undefined | Readonly<CompositeTreeNode>>
Inherited from Tree.refresh
- Defined in packages/core/src/browser/tree/tree.ts:60

restoreState

restoreState(state): void
Restore selection state.
Parameters
- state: object
Returns void
Inherited from TreeSelectionService.restoreState
- Defined in packages/core/src/browser/tree/tree-selection.ts:57

selectNext

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

Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:125

selectNextNode

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

selectNode

selectNode(node): 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
- Defined in packages/core/src/browser/tree/tree-model.ts:145

selectParent

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

Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:75

selectPrev

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

Returns void
- Defined in packages/core/src/browser/tree/tree-model.ts:105

selectPrevNode

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

selectRange

selectRange(node): 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
- Defined in packages/core/src/browser/tree/tree-model.ts:157

storeState

storeState(): object
Store selection state.

Returns object
Inherited from TreeSelectionService.storeState
- Defined in packages/core/src/browser/tree/tree-selection.ts:52

toggleNode

toggleNode(node): 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
- Defined in packages/core/src/browser/tree/tree-model.ts:151

toggleNodeExpansion

toggleNodeExpansion(node?): 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
- Optional node: Readonly<ExpandableTreeNode>
Returns Promise<void>
Overrides TreeExpansionService.toggleNodeExpansion
- Defined in packages/core/src/browser/tree/tree-model.ts:59

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

Interface TreeModel

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

Readonly onChanged

Readonly onDidChangeBusy

Readonly onDidUpdate

Readonly onExpansionChanged

Readonly onNodeRefreshed

Readonly onOpenNode

Readonly onSelectionChanged

root

Readonly selectedNodes

Methods

addSelection

Parameters

Returns void

canNavigateBackward

Returns boolean

canNavigateForward

Returns boolean

clearSelection

Returns void

collapseAll

Parameters

Returns Promise<boolean>

collapseNode

Parameters

Returns Promise<boolean>

dispose

Returns void

expandNode

Parameters

Returns Promise<undefined | Readonly<ExpandableTreeNode>>

getFocusedNode

Returns undefined | SelectableTreeNode

getNextNode

Parameters

Returns undefined | TreeNode

getNextSelectableNode

Parameters

Returns undefined | SelectableTreeNode

getNode

Parameters

Returns undefined | TreeNode

getPrevNode

Parameters

Returns undefined | TreeNode

getPrevSelectableNode

Parameters

Returns undefined | SelectableTreeNode

markAsBusy

Parameters

Returns Promise<void>

markAsChecked

Parameters

Returns void

navigateBackward

Returns Promise<void>

navigateForward

Returns Promise<void>

navigateTo

Parameters

Returns Promise<undefined | TreeNode>

openNode

Parameters

Returns void

refresh

Returns Promise<undefined | Readonly<CompositeTreeNode>>

Parameters

Returns Promise<undefined | Readonly<CompositeTreeNode>>

restoreState

Parameters

Returns void

selectNext

Returns void

selectNextNode

`Readonly` onChanged

`Readonly` onDidChangeBusy

`Readonly` onDidUpdate

`Readonly` onExpansionChanged

`Readonly` onNodeRefreshed

`Readonly` onOpenNode

`Readonly` onSelectionChanged

`Readonly` selectedNodes