Class TreeSelectionServiceImpl

SelectionProvider is implemented by services to notify listeners about selection changes.

Implements

TreeSelectionService

Index

Constructors

constructor

new TreeSelectionServiceImpl(): TreeSelectionServiceImpl
Returns TreeSelectionServiceImpl

Properties

`Protected` `Readonly`focusService

focusService: TreeFocusService

`Protected` `Readonly`onSelectionChangedEmitter

onSelectionChangedEmitter: Emitter<readonly Readonly<SelectableTreeNode>[]> = ...

`Protected`state

state: TreeSelectionState

`Protected` `Readonly`tree

tree: Tree

Accessors

onSelectionChanged

get onSelectionChanged(): Event<readonly Readonly<SelectableTreeNode>[]>
Emitted when the selection has changed in the tree.

Returns Event<readonly Readonly<SelectableTreeNode>[]>
Implementation of TreeSelectionService.onSelectionChanged
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:47

selectedNodes

get selectedNodes(): readonly Readonly<SelectableTreeNode>[]
The tree selection, representing the selected nodes from the tree. If nothing is selected, the result will be empty.

Returns readonly Readonly<SelectableTreeNode>[]
Implementation of TreeSelectionService.selectedNodes
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:43

Methods

`Protected`addFocus

addFocus(node: undefined | SelectableTreeNode): void
Parameters
- node: undefined | SelectableTreeNode
Returns void
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:114

addSelection

addSelection(
selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection,
): void
Registers the given selection into the tree selection service. If the selection state changes after adding the selectionOrTreeNode argument, a selection changed event will be fired. If the argument is a tree node, a it will be treated as a tree selection with the default selection type.
Parameters
- selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection
Returns void
Implementation of TreeSelectionService.addSelection
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:55

clearSelection

clearSelection(): void
Clears all selected nodes

Returns void
Implementation of TreeSelectionService.clearSelection
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:80

`Protected`difference

difference<T>(left: readonly T[], right: readonly T[]): readonly T[]
Returns an array of the difference of two arrays. The returned array contains all elements that are contained by left and not contained by right. right may also contain elements not present in left: these are simply ignored.
Type Parameters
- T
Parameters
- left: readonly T[]
- right: readonly T[]
Returns readonly T[]
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:125

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of TreeSelectionService.dispose
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:39

`Protected`fireSelectionChanged

fireSelectionChanged(): void
Returns void
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:51

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:35

`Protected`removeFocus

removeFocus(...nodes: (readonly SelectableTreeNode[])[]): void
Parameters
- ...nodes: (readonly SelectableTreeNode[])[]
Returns void
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:110

restoreState

restoreState(state: TreeSelectionServiceImpl.State): void
Restore selection state.
Parameters
- state: TreeSelectionServiceImpl.State
Returns void
Implementation of TreeSelectionService.restoreState
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:147

`Protected`select

select(nodes: readonly SelectableTreeNode[]): void
Parameters
- nodes: readonly SelectableTreeNode[]
Returns void
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:106

storeState

storeState(): TreeSelectionServiceImpl.State
Store selection state.

Returns TreeSelectionServiceImpl.State
Implementation of TreeSelectionService.storeState
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:137

`Protected`transiteTo

transiteTo(newState: TreeSelectionState, setFocus?: boolean): void
Parameters
- newState: TreeSelectionState
- setFocus: boolean = true
Returns void
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:84

`Protected`unselect

unselect(nodes: readonly SelectableTreeNode[]): void
Parameters
- nodes: readonly SelectableTreeNode[]
Returns void
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:102

`Protected`validateNode

validateNode(node: Readonly<TreeNode>): undefined | Readonly<TreeNode>
Returns a reference to the argument if the node exists in the tree. Otherwise, undefined.
Parameters
- node: Readonly<TreeNode>
Returns undefined | Readonly<TreeNode>
- Defined in packages/core/src/browser/tree/tree-selection-impl.ts:132

Class TreeSelectionServiceImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TreeSelectionServiceImpl

Properties

Protected ReadonlyfocusService

Protected ReadonlyonSelectionChangedEmitter

Protectedstate

Protected Readonlytree

Accessors

onSelectionChanged

Returns Event<readonly Readonly<SelectableTreeNode>[]>

selectedNodes

Returns readonly Readonly<SelectableTreeNode>[]

Methods

ProtectedaddFocus

Parameters

Returns void

addSelection

Parameters

Returns void

clearSelection

Returns void

Protecteddifference

Type Parameters

Parameters

Returns readonly T[]

dispose

Returns void

ProtectedfireSelectionChanged

Returns void

Protectedinit

Returns void

ProtectedremoveFocus

Parameters

Returns void

restoreState

Parameters

Returns void

Protectedselect

Parameters

Returns void

storeState

Returns TreeSelectionServiceImpl.State

ProtectedtransiteTo

Parameters

Returns void

Protectedunselect

Parameters

Returns void

ProtectedvalidateNode

Parameters

Returns undefined | Readonly<TreeNode>

Settings

On This Page

`Protected` `Readonly`focusService

`Protected` `Readonly`onSelectionChangedEmitter

`Protected`state

`Protected` `Readonly`tree

`Protected`addFocus

`Protected`difference

`Protected`fireSelectionChanged

`Protected`init

`Protected`removeFocus

`Protected`select

`Protected`transiteTo

`Protected`unselect

`Protected`validateNode