Class TreeSelectionState

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

Hierarchy

TreeSelectionState

Index

Constructors

constructor

Properties

Accessors

focus

Methods

Constructors

constructor

new TreeSelectionState(tree: Tree, selectionStack?: readonly FocusableTreeSelection[]): TreeSelectionState

- Defined in packages/core/src/browser/tree/tree-selection-state.ts:55
Parameters
- tree: Tree
- selectionStack: readonly FocusableTreeSelection[] = []
Returns TreeSelectionState

Properties

Readonly selectionStack

selectionStack: readonly FocusableTreeSelection[] = []

Protected Readonly tree

tree: Tree

Accessors

focus

get focus(): undefined | SelectableTreeNode

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

Methods

Protected checkNoDefaultSelection

checkNoDefaultSelection<T>(selections: readonly T[]): readonly T[]

- Defined in packages/core/src/browser/tree/tree-selection-state.ts:233
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: TreeSelection
Parameters
- selections: readonly T[]
Returns readonly T[]

Protected handleDefault

handleDefault(state: TreeSelectionState, node: Readonly<SelectableTreeNode>): TreeSelectionState

- Defined in packages/core/src/browser/tree/tree-selection-state.ts:102
Parameters
- state: TreeSelectionState
- node: Readonly<SelectableTreeNode>
Returns TreeSelectionState

Protected handleRange

handleRange(state: TreeSelectionState, node: Readonly<SelectableTreeNode>): TreeSelectionState

- Defined in packages/core/src/browser/tree/tree-selection-state.ts:137
Parameters
- state: TreeSelectionState
- node: Readonly<SelectableTreeNode>
Returns TreeSelectionState

Protected handleToggle

handleToggle(state: TreeSelectionState, node: Readonly<SelectableTreeNode>): TreeSelectionState

- Defined in packages/core/src/browser/tree/tree-selection-state.ts:111
Parameters
- state: TreeSelectionState
- node: Readonly<SelectableTreeNode>
Returns TreeSelectionState

nextState

nextState(selection: FocusableTreeSelection): TreeSelectionState

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

selection

selection(): readonly SelectableTreeNode[]

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

Protected selectionRange

selectionRange(selection: FocusableTreeSelection): Readonly<SelectableTreeNode>[]

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

Protected toSelectableTreeNode

toSelectableTreeNode(node: undefined | TreeNode): undefined | SelectableTreeNode

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