Class CompressedExpansionService

The tree expandable service.

Hierarchy (View Summary)

TreeExpansionServiceImpl
- CompressedExpansionService

Index

Constructors

constructor

new CompressedExpansionService(): CompressedExpansionService
Returns CompressedExpansionService
Inherited from TreeExpansionServiceImpl.constructor

Properties

`Protected` `Readonly`compressionService

compressionService: TreeCompressionService

`Protected` `Readonly`compressionToggle

compressionToggle: CompressionToggle

`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>
Inherited from TreeExpansionServiceImpl.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>
Inherited from TreeExpansionServiceImpl.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>
Overrides TreeExpansionServiceImpl.collapseNode
- Defined in packages/core/src/browser/tree/tree-compression/compressed-tree-expansion-service.ts:37

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from TreeExpansionServiceImpl.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
Inherited from TreeExpansionServiceImpl.doCollapseAll
- Defined in packages/core/src/browser/tree/tree-expansion.ts:138

`Protected`doCollapseNode

doCollapseNode(node: undefined | TreeNode): boolean
Parameters
- node: undefined | TreeNode
Returns boolean
Inherited from TreeExpansionServiceImpl.doCollapseNode
- 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>
Inherited from TreeExpansionServiceImpl.doExpandNode
- 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>
Overrides TreeExpansionServiceImpl.expandNode
- Defined in packages/core/src/browser/tree/tree-compression/compressed-tree-expansion-service.ts:26

`Protected`fireExpansionChanged

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

`Protected`init

init(): void
Returns void
Inherited from TreeExpansionServiceImpl.init
- 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>
Inherited from TreeExpansionServiceImpl.toggleNodeExpansion
- Defined in packages/core/src/browser/tree/tree-expansion.ts:157

Class CompressedExpansionService

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CompressedExpansionService

Properties

Protected ReadonlycompressionService

Protected ReadonlycompressionToggle

Protected ReadonlyonExpansionChangedEmitter

Protected Readonlytree

Accessors

onExpansionChanged

Returns Event<ExpandableTreeNode>

Methods

collapseAll

Parameters

Returns Promise<boolean>

collapseNode

Parameters

Returns Promise<boolean>

dispose

Returns void

ProtecteddoCollapseAll

Parameters

Returns boolean

ProtecteddoCollapseNode

Parameters

Returns boolean

ProtecteddoExpandNode

Parameters

Returns Promise<undefined | ExpandableTreeNode>

expandNode

Parameters

Returns Promise<undefined | ExpandableTreeNode>

ProtectedfireExpansionChanged

Parameters

Returns void

Protectedinit

Returns void

toggleNodeExpansion

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`compressionService

`Protected` `Readonly`compressionToggle

`Protected` `Readonly`onExpansionChangedEmitter

`Protected` `Readonly`tree

`Protected`doCollapseAll

`Protected`doCollapseNode

`Protected`doExpandNode

`Protected`fireExpansionChanged

`Protected`init