Theia API Documentation v1.65.0
    Preparing search index...

    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: Readonly<SelectableTreeNode> | TreeSelection,
        ): void;
        canNavigateBackward(): boolean;
        canNavigateForward(): boolean;
        clearSelection(): void;
        collapseAll(node?: Readonly<CompositeTreeNode>): Promise<boolean>;
        collapseNode(node?: Readonly<ExpandableTreeNode>): Promise<boolean>;
        dispose(): void;
        expandNode(
            node?: Readonly<ExpandableTreeNode>,
        ): Promise<undefined | Readonly<ExpandableTreeNode>>;
        getFocusedNode(): undefined | SelectableTreeNode;
        getNextNode(node?: TreeNode): undefined | TreeNode;
        getNextSelectableNode(node?: TreeNode): undefined | SelectableTreeNode;
        getNode(id: undefined | string): undefined | TreeNode;
        getPrevNode(node?: TreeNode): undefined | TreeNode;
        getPrevSelectableNode(node?: TreeNode): undefined | SelectableTreeNode;
        markAsBusy(
            node: Readonly<TreeNode>,
            ms: number,
            token: CancellationToken,
        ): Promise<void>;
        markAsChecked(node: TreeNode, checked: boolean): void;
        navigateBackward(): Promise<void>;
        navigateForward(): Promise<void>;
        navigateTo(
            nodeOrId: undefined | string | Readonly<TreeNode>,
        ): Promise<undefined | TreeNode>;
        openNode(node?: Readonly<TreeNode>): void;
        refresh(): Promise<undefined | Readonly<CompositeTreeNode>>;
        refresh(
            parent: Readonly<CompositeTreeNode>,
        ): Promise<undefined | Readonly<CompositeTreeNode>>;
        restoreState(state: object): void;
        selectNext(): void;
        selectNextNode(type?: SelectionType): void;
        selectNode(node: Readonly<SelectableTreeNode>): void;
        selectParent(): void;
        selectPrev(): void;
        selectPrevNode(type?: SelectionType): void;
        selectRange(node: Readonly<SelectableTreeNode>): void;
        storeState(): object;
        toggleNode(node: Readonly<SelectableTreeNode>): void;
        toggleNodeExpansion(node?: Readonly<ExpandableTreeNode>): Promise<void>;
        validateNode(node: undefined | TreeNode): undefined | TreeNode;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    onChanged onDidChangeBusy onDidUpdate onExpansionChanged onNodeRefreshed onOpenNode onSelectionChanged root selectedNodes

    Methods

    addSelection canNavigateBackward canNavigateForward clearSelection collapseAll collapseNode dispose expandNode getFocusedNode getNextNode getNextSelectableNode getNode getPrevNode getPrevSelectableNode markAsBusy markAsChecked navigateBackward navigateForward navigateTo openNode refresh restoreState selectNext selectNextNode selectNode selectParent selectPrev selectPrevNode selectRange storeState toggleNode toggleNodeExpansion validateNode

    Properties

    onChanged: Event<void>

    Emit when the tree is changed.

    onDidChangeBusy: Event<TreeNode>

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

    onDidUpdate: Event<TreeNode[]>

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

    onExpansionChanged: Event<Readonly<ExpandableTreeNode>>

    Emit when the node is expanded or collapsed.

    onNodeRefreshed: Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

    Emit when the children of the given node are refreshed.

    onOpenNode: Event<Readonly<TreeNode>>

    Event when a node should be opened.

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

    Emitted when the selection has changed in the tree.

    root: undefined | TreeNode

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

    selectedNodes: readonly Readonly<SelectableTreeNode>[]

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

    Methods

    • 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>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods