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

    The tree - an abstract data type.

    interface Tree {
        onChanged: Event<void>;
        onDidChangeBusy: Event<TreeNode>;
        onDidUpdate: Event<TreeNode[]>;
        onNodeRefreshed: Event<Readonly<CompositeTreeNode> & WaitUntilEvent>;
        root: TreeNode | undefined;
        dispose(): void;
        getNode(id: string | undefined): TreeNode | undefined;
        markAsBusy(
            node: Readonly<TreeNode>,
            ms: number,
            token: CancellationToken,
        ): Promise<void>;
        markAsChecked(node: TreeNode, checked: boolean): void;
        refresh(): Promise<Readonly<CompositeTreeNode> | undefined>;
        refresh(
            parent: Readonly<CompositeTreeNode>,
        ): Promise<Readonly<CompositeTreeNode> | undefined>;
        removeNode(node: TreeNode | undefined): void;
        validateNode(node: TreeNode | undefined): TreeNode | undefined;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    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

    onNodeRefreshed: Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

    Emit when the children of the given node are refreshed.

    root: TreeNode | undefined

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