Class TreeSelectionState

Class for representing and managing the selection state and the focus of a tree.

Index

Constructors

Properties

selectionStack tree

Accessors

Methods

checkNoDefaultSelection handleDefault handleRange handleToggle nextState selection selectionRange toSelectableTreeNode

Constructors

constructor

new TreeSelectionState(tree, selectionStack?): TreeSelectionState
Parameters
- tree: Tree
- selectionStack: readonly FocusableTreeSelection[] = []
Returns TreeSelectionState
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:57

Properties

`Readonly` selectionStack

selectionStack: readonly FocusableTreeSelection[] = []

`Protected` `Readonly` tree

tree: Tree

Accessors

focus

get focus(): undefined | SelectableTreeNode
Returns undefined | SelectableTreeNode
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:96

node

get node(): undefined | SelectableTreeNode
Returns undefined | SelectableTreeNode
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:102

Methods

`Protected` checkNoDefaultSelection

checkNoDefaultSelection<T>(selections): readonly T[]
Checks whether the argument contains any DEFAULT tree selection type. If yes, throws an error, otherwise returns with a reference the argument.
Type Parameters
- T extends TreeSelection
Parameters
- selections: readonly T[]
Returns readonly T[]
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:238

`Protected` handleDefault

handleDefault(state, node): TreeSelectionState
Parameters
- state: TreeSelectionState
- node: Readonly<SelectableTreeNode>
Returns TreeSelectionState
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:107

`Protected` handleRange

handleRange(state, node): TreeSelectionState
Parameters
- state: TreeSelectionState
- node: Readonly<SelectableTreeNode>
Returns TreeSelectionState
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:142

`Protected` handleToggle

handleToggle(state, node): TreeSelectionState
Parameters
- state: TreeSelectionState
- node: Readonly<SelectableTreeNode>
Returns TreeSelectionState
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:116

nextState

nextState(selection): TreeSelectionState
Parameters
- selection: FocusableTreeSelection
Returns TreeSelectionState
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:62

selection

selection(): readonly SelectableTreeNode[]
Returns readonly SelectableTreeNode[]
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:75

`Protected` selectionRange

selectionRange(selection): Readonly<SelectableTreeNode>[]
Returns with an array of items representing the selection range. The from node is the focus the to node is the selected node itself on the tree selection. Both the from node and the to node are inclusive.
Parameters
- selection: FocusableTreeSelection
Returns Readonly<SelectableTreeNode>[]
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:171

`Protected` toSelectableTreeNode

toSelectableTreeNode(node): undefined | SelectableTreeNode
Parameters
- node: undefined | TreeNode
Returns undefined | SelectableTreeNode
- Defined in packages/core/src/browser/tree/tree-selection-state.ts:219