Class TreeExpansionServiceImpl

The tree expandable service.

Hierarchy (View Summary)

TreeExpansionServiceImpl
- CompressedExpansionService

Implements

TreeExpansionService

Index

Constructors

Properties

onExpansionChangedEmitter tree

Accessors

onExpansionChanged

Methods

collapseAll collapseNode dispose doCollapseAll doCollapseNode doExpandNode expandNode fireExpansionChanged init toggleNodeExpansion

Constructors

constructor

new TreeExpansionServiceImpl(): TreeExpansionServiceImpl
Returns TreeExpansionServiceImpl

Properties

`Protected` `Readonly`onExpansionChangedEmitter

onExpansionChangedEmitter: Emitter<ExpandableTreeNode> = ...

`Protected` `Readonly`tree

tree: Tree

Accessors

onExpansionChanged

get onExpansionChanged(): Event<ExpandableTreeNode>
Emit when the node is expanded or collapsed.

Returns Event<ExpandableTreeNode>
Implementation of TreeExpansionService.onExpansionChanged
- Defined in packages/core/src/browser/tree/tree-expansion.ts:102

Methods

collapseAll

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

Return true if a node has been collapsed; otherwise false.
Parameters
- raw: CompositeTreeNode
Returns Promise<boolean>
Implementation of TreeExpansionService.collapseAll
- Defined in packages/core/src/browser/tree/tree-expansion.ts:133

collapseNode

collapseNode(raw: 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
- raw: ExpandableTreeNode
Returns Promise<boolean>
Implementation of TreeExpansionService.collapseNode
- Defined in packages/core/src/browser/tree/tree-expansion.ts:128

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of TreeExpansionService.dispose
- Defined in packages/core/src/browser/tree/tree-expansion.ts:98

`Protected`doCollapseAll

doCollapseAll(node: undefined | TreeNode): boolean
Parameters
- node: undefined | TreeNode
Returns boolean
- Defined in packages/core/src/browser/tree/tree-expansion.ts:138

`Protected`doCollapseNode

doCollapseNode(node: undefined | TreeNode): boolean
Parameters
- node: undefined | TreeNode
Returns boolean
- Defined in packages/core/src/browser/tree/tree-expansion.ts:148

`Protected`doExpandNode

doExpandNode(node: ExpandableTreeNode): Promise<undefined | ExpandableTreeNode>
Parameters
- node: ExpandableTreeNode
Returns Promise<undefined | ExpandableTreeNode>
- Defined in packages/core/src/browser/tree/tree-expansion.ts:118

expandNode

expandNode(raw: ExpandableTreeNode): Promise<undefined | 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
- raw: ExpandableTreeNode
Returns Promise<undefined | ExpandableTreeNode>
Implementation of TreeExpansionService.expandNode
- Defined in packages/core/src/browser/tree/tree-expansion.ts:110

`Protected`fireExpansionChanged

fireExpansionChanged(node: ExpandableTreeNode): void
Parameters
- node: ExpandableTreeNode
Returns void
- Defined in packages/core/src/browser/tree/tree-expansion.ts:106

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/browser/tree/tree-expansion.ts:88

toggleNodeExpansion

toggleNodeExpansion(node: 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: ExpandableTreeNode
Returns Promise<void>
Implementation of TreeExpansionService.toggleNodeExpansion
- Defined in packages/core/src/browser/tree/tree-expansion.ts:157