Interface TreeSelectionService

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

interface TreeSelectionService {
    onSelectionChanged: Event<readonly Readonly<SelectableTreeNode>[]>;
    selectedNodes: readonly Readonly<SelectableTreeNode>[];
    addSelection(
        selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection,
    ): void;
    clearSelection(): void;
    dispose(): void;
    restoreState(state: object): void;
    storeState(): object;
}

Hierarchy (View Summary)

Disposable
SelectionProvider<ReadonlyArray<Readonly<SelectableTreeNode>>>
- TreeSelectionService
  - TreeModel

Implemented by

TreeSelectionServiceImpl

Index

Properties

onSelectionChanged selectedNodes

Methods

addSelection clearSelection dispose restoreState storeState

Properties

`Readonly`onSelectionChanged

onSelectionChanged: Event<readonly Readonly<SelectableTreeNode>[]>

Emitted when the selection has changed in the tree.

`Readonly`selectedNodes

selectedNodes: readonly Readonly<SelectableTreeNode>[]

The tree selection, representing the selected nodes from the tree. If nothing is selected, the result will be empty.

Methods

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

clearSelection

clearSelection(): void
Clears all selected nodes

Returns void
- Defined in packages/core/src/browser/tree/tree-selection.ts:47

dispose

dispose(): void
Dispose this object.

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

restoreState

restoreState(state: object): void
Restore selection state.
Parameters
- state: object
Returns void
- Defined in packages/core/src/browser/tree/tree-selection.ts:57

storeState

storeState(): object
Store selection state.

Returns object
- Defined in packages/core/src/browser/tree/tree-selection.ts:52