Interface TreeExpansionService

The tree expandable service.

Hierarchy

Disposable
- TreeExpansionService

Index

Properties

onExpansionChanged

Methods

Properties

Readonly onExpansionChanged

onExpansionChanged: Event<Readonly<ExpandableTreeNode>>

Emit when the node is expanded or collapsed.

Methods

collapseAll

collapseAll(node: Readonly<CompositeTreeNode>): Promise<boolean>

- Defined in packages/core/src/browser/tree/tree-expansion.ts:49
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>

collapseNode

collapseNode(node: Readonly<ExpandableTreeNode>): Promise<boolean>

- Defined in packages/core/src/browser/tree/tree-expansion.ts:43
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>

dispose

dispose(): void

Inherited from Disposable.dispose
- Defined in packages/core/src/common/disposable.ts:24
Dispose this object.

Returns void

expandNode

expandNode(node: Readonly<ExpandableTreeNode>): Promise<undefined | Readonly<ExpandableTreeNode>>

- Defined in packages/core/src/browser/tree/tree-expansion.ts:37
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>>

toggleNodeExpansion

toggleNodeExpansion(node: Readonly<ExpandableTreeNode>): Promise<void>

- Defined in packages/core/src/browser/tree/tree-expansion.ts:54
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>