Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutlineViewTreeModel

Hierarchy

  • TreeModelImpl
    • OutlineViewTreeModel

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Readonly expansionService

expansionService: TreeExpansionService

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>

  • Returns Event<void>

onDidChangeBusy

  • get onDidChangeBusy(): Event<TreeNode>

  • Returns Event<TreeNode>

onExpansionChanged

  • get onExpansionChanged(): Event<Readonly<ExpandableTreeNode>>

  • Returns Event<Readonly<ExpandableTreeNode>>

onNodeRefreshed

  • get onNodeRefreshed(): Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

  • Returns Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

onOpenNode

  • get onOpenNode(): Event<TreeNode>

  • Returns Event<TreeNode>

onSelectionChanged

  • get onSelectionChanged(): Event<readonly Readonly<SelectableTreeNode>[]>

  • Returns Event<readonly Readonly<SelectableTreeNode>[]>

root

  • get root(): undefined | TreeNode
  • set root(root: undefined | TreeNode): any

  • Returns undefined | TreeNode

  • Parameters

    • root: undefined | TreeNode

    Returns any

selectedNodes

  • get selectedNodes(): readonly Readonly<SelectableTreeNode>[]

  • Returns readonly Readonly<SelectableTreeNode>[]

Methods

addSelection

  • addSelection(selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection): void

  • Parameters

    • selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection

    Returns void

canNavigateBackward

  • canNavigateBackward(): boolean

  • Returns boolean

canNavigateForward

  • canNavigateForward(): boolean

  • Returns boolean

collapseAll

  • collapseAll(raw?: Readonly<CompositeTreeNode>): Promise<boolean>

collapseNode

  • collapseNode(raw?: Readonly<ExpandableTreeNode>): Promise<boolean>

  • Parameters

    • Optional raw: Readonly<ExpandableTreeNode>

    Returns Promise<boolean>

Protected createBackwardIterator

  • createBackwardIterator(node: undefined | TreeNode): undefined | TreeIterator

  • Parameters

    • node: undefined | TreeNode

    Returns undefined | TreeIterator

Protected createIterator

  • createIterator(node: undefined | TreeNode): undefined | TreeIterator

  • Parameters

    • node: undefined | TreeNode

    Returns undefined | TreeIterator

dispose

  • dispose(): void

  • Returns void

Protected doGetNextNode

  • doGetNextNode(iterator: TreeIterator): undefined | SelectableTreeNode

  • Parameters

    • iterator: TreeIterator

    Returns undefined | SelectableTreeNode

Protected doNavigate

  • doNavigate(node: TreeNode): Promise<void>

  • Parameters

    • node: TreeNode

    Returns Promise<void>

Protected doOpenNode

  • doOpenNode(node: TreeNode): void

  • Parameters

    • node: TreeNode

    Returns void

expandNode

  • expandNode(raw?: Readonly<ExpandableTreeNode>): Promise<undefined | ExpandableTreeNode>

  • Parameters

    • Optional raw: Readonly<ExpandableTreeNode>

    Returns Promise<undefined | ExpandableTreeNode>

Protected fireChanged

  • fireChanged(): void

  • Returns void

getNextSelectableNode

  • getNextSelectableNode(node?: TreeNode): undefined | SelectableTreeNode

  • Parameters

    • Optional node: TreeNode

    Returns undefined | SelectableTreeNode

getNode

  • getNode(id: undefined | string): undefined | TreeNode

  • Parameters

    • id: undefined | string

    Returns undefined | TreeNode

getPrevSelectableNode

  • getPrevSelectableNode(node?: TreeNode): undefined | SelectableTreeNode

  • Parameters

    • Optional node: TreeNode

    Returns undefined | SelectableTreeNode

Protected handleExpansion

  • handleExpansion(node: Readonly<ExpandableTreeNode>): void

  • Handle the expansion of the tree node.

    • The method is a no-op in order to preserve focus on the editor after attempting to perform a collapse-all.

    Parameters

    • node: Readonly<ExpandableTreeNode>

      the expandable tree node.

    Returns void

Protected init

  • init(): void

  • Returns void

Protected isVisibleSelectableNode

  • isVisibleSelectableNode(node: TreeNode): node is SelectableTreeNode

  • Parameters

    • node: TreeNode

    Returns node is SelectableTreeNode

markAsBusy

  • markAsBusy(node: Readonly<TreeNode>, ms: number, token: CancellationToken): Promise<void>

  • Parameters

    • node: Readonly<TreeNode>
    • ms: number
    • token: CancellationToken

    Returns Promise<void>

navigateBackward

  • navigateBackward(): Promise<void>

  • Returns Promise<void>

navigateForward

  • navigateForward(): Promise<void>

  • Returns Promise<void>

navigateTo

  • navigateTo(nodeOrId: undefined | string | TreeNode): Promise<undefined | TreeNode>

  • Parameters

    • nodeOrId: undefined | string | TreeNode

    Returns Promise<undefined | TreeNode>

openNode

  • openNode(raw?: TreeNode): void

  • The default behavior of openNode calls doOpenNode which by default toggles the expansion of the node. Overriding to prevent expansion, but allow for the onOpenNode event to still fire on a double-click event.

    Parameters

    • Optional raw: TreeNode

    Returns void

refresh

  • refresh(parent?: Readonly<CompositeTreeNode>): Promise<undefined | CompositeTreeNode>

  • Parameters

    • Optional parent: Readonly<CompositeTreeNode>

    Returns Promise<undefined | CompositeTreeNode>

restoreState

  • restoreState(state: State): void

  • Parameters

    • state: State

    Returns void

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

selectNextNode

  • selectNextNode(type?: DEFAULT | TOGGLE | RANGE): void

  • Parameters

    • Optional type: DEFAULT | TOGGLE | RANGE

    Returns void

selectNode

  • selectNode(node: Readonly<SelectableTreeNode>): void

  • Parameters

    • node: Readonly<SelectableTreeNode>

    Returns void

selectParent

  • selectParent(): void

  • Returns void

selectPrevNode

  • selectPrevNode(type?: DEFAULT | TOGGLE | RANGE): void

  • Parameters

    • Optional type: DEFAULT | TOGGLE | RANGE

    Returns void

selectRange

  • selectRange(node: Readonly<SelectableTreeNode>): void

  • Parameters

    • node: Readonly<SelectableTreeNode>

    Returns void

storeState

  • storeState(): State

  • Returns State

toggleNode

  • toggleNode(node: Readonly<SelectableTreeNode>): void

  • Parameters

    • node: Readonly<SelectableTreeNode>

    Returns void

toggleNodeExpansion

  • toggleNodeExpansion(raw?: Readonly<ExpandableTreeNode>): Promise<void>

  • Parameters

    • Optional raw: Readonly<ExpandableTreeNode>

    Returns Promise<void>

validateNode

  • validateNode(node: undefined | TreeNode): undefined | TreeNode

  • Parameters

    • node: undefined | TreeNode

    Returns undefined | TreeNode