Interface TreeExpansionService

The tree expandable service.

interface TreeExpansionService {
    onExpansionChanged: Event<Readonly<ExpandableTreeNode>>;
    collapseAll(node: Readonly<CompositeTreeNode>): Promise<boolean>;
    collapseNode(node: Readonly<ExpandableTreeNode>): Promise<boolean>;
    dispose(): void;
    expandNode(
        node: Readonly<ExpandableTreeNode>,
    ): Promise<undefined | Readonly<ExpandableTreeNode>>;
    toggleNodeExpansion(node: Readonly<ExpandableTreeNode>): Promise<void>;
}

Hierarchy (View Summary)

Disposable
- TreeExpansionService
  - TreeModel

Implemented by

TreeExpansionServiceImpl

Index

Properties

onExpansionChanged

Methods

collapseAll collapseNode dispose expandNode toggleNodeExpansion

Properties

`Readonly`onExpansionChanged

onExpansionChanged: Event<Readonly<ExpandableTreeNode>>

Emit when the node is expanded or collapsed.

Methods

collapseAll

collapseAll(node: Readonly<CompositeTreeNode>): Promise<boolean>
If the given node is valid then collapse it recursively.

Return true if a node has been collapsed; otherwise false.
Parameters
- node: Readonly<CompositeTreeNode>
Returns Promise<boolean>
- Defined in packages/core/src/browser/tree/tree-expansion.ts:49

collapseNode

collapseNode(node: Readonly<ExpandableTreeNode>): Promise<boolean>
If the given node is valid and expanded then collapse it.

Return true if a node has been collapsed; otherwise false.
Parameters
- node: Readonly<ExpandableTreeNode>
Returns Promise<boolean>
- Defined in packages/core/src/browser/tree/tree-expansion.ts:43

dispose

dispose(): void
Dispose this object.

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

expandNode

expandNode(
node: Readonly<ExpandableTreeNode>,
): Promise<undefined | Readonly<ExpandableTreeNode>>
Expand a node for the given node id if it is valid and collapsed. Expanding a node refreshes all its children.

Return a valid expanded refreshed node or undefined if such does not exist.
Parameters
- node: Readonly<ExpandableTreeNode>
Returns Promise<undefined | Readonly<ExpandableTreeNode>>
- Defined in packages/core/src/browser/tree/tree-expansion.ts:37

toggleNodeExpansion

toggleNodeExpansion(node: Readonly<ExpandableTreeNode>): Promise<void>
If the given node is invalid then does nothing. If the given node is collapsed then expand it; otherwise collapse it.
Parameters
- node: Readonly<ExpandableTreeNode>
Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree-expansion.ts:54