PreferenceTreeModel | Theia TypeDoc

Hierarchy

TreeModelImpl
- PreferenceTreeModel

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new PreferenceTreeModel(): PreferenceTreeModel

Inherited from TreeModelImpl.constructor

Returns PreferenceTreeModel

Properties

Protected _currentRows

_currentRows: Map<string, PreferenceTreeNodeRow> = ...

Protected _currentScope

_currentScope: number = ...

Protected _isFiltered

_isFiltered: boolean = false

Protected _totalVisibleLeaves

_totalVisibleLeaves: number = 0

Protected Readonly expansionService

expansionService: TreeExpansionService

Protected Readonly filterInput

filterInput: PreferencesSearchbarWidget

Protected lastSearchedFuzzy

lastSearchedFuzzy: string = ''

Protected lastSearchedLiteral

lastSearchedLiteral: string = ''

Protected Readonly logger

logger: ILogger

Protected Readonly navigationService

navigationService: TreeNavigationService

Protected Readonly onChangedEmitter

onChangedEmitter: Emitter<void>

Readonly onFilterChanged

onFilterChanged: Event<PreferenceFilterChangeEvent> = ...

Protected Readonly onOpenNodeEmitter

onOpenNodeEmitter: Emitter<TreeNode>

Protected Readonly onTreeFilterChangedEmitter

onTreeFilterChangedEmitter: Emitter<PreferenceFilterChangeEvent> = ...

Protected Readonly preferenceService

preferenceService: PreferenceService

Protected Readonly schemaProvider

schemaProvider: PreferenceSchemaProvider

Protected Readonly scopeTracker

scopeTracker: PreferencesScopeTabBar

Protected Readonly selectionService

selectionService: TreeSelectionService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly tree

tree: Tree

Protected Readonly treeGenerator

treeGenerator: PreferenceTreeGenerator

Protected Readonly treeSearch

treeSearch: TreeSearch

Accessors

currentRows

get currentRows(): Readonly<Map<string, PreferenceTreeNodeRow>>

- Defined in packages/preferences/src/browser/preference-tree-model.ts:75
Returns Readonly<Map<string, PreferenceTreeNodeRow>>

currentScope

get currentScope(): SelectedScopeDetails

- Defined in packages/preferences/src/browser/preference-tree-model.ts:91
Returns SelectedScopeDetails

isFiltered

get isFiltered(): boolean

- Defined in packages/preferences/src/browser/preference-tree-model.ts:83
Returns boolean

onChanged

get onChanged(): Event<void>

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:137
Returns Event<void>

onDidChangeBusy

get onDidChangeBusy(): Event<TreeNode>

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:174
Returns Event<TreeNode>

onExpansionChanged

get onExpansionChanged(): Event<Readonly<ExpandableTreeNode>>

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:146
Returns Event<Readonly<ExpandableTreeNode>>

onNodeRefreshed

get onNodeRefreshed(): Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:140
Returns Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

onOpenNode

get onOpenNode(): Event<TreeNode>

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:138
Returns Event<TreeNode>

onSchemaChanged

get onSchemaChanged(): Event<CompositeTreeNode>

- Defined in packages/preferences/src/browser/preference-tree-model.ts:95
Returns Event<CompositeTreeNode>

onSelectionChanged

get onSelectionChanged(): Event<readonly Readonly<SelectableTreeNode>[]>

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:145
Returns Event<readonly Readonly<SelectableTreeNode>[]>

propertyList

get propertyList(): {}

- Defined in packages/preferences/src/browser/preference-tree-model.ts:87
Returns {}
- [key: string]: PreferenceDataProperty

root

get root(): undefined | TreeNode
set root(root: undefined | TreeNode): any

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:135
Returns undefined | TreeNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:136
Parameters
- root: undefined | TreeNode
Returns any

selectedNodes

get selectedNodes(): readonly Readonly<SelectableTreeNode>[]

- Defined in packages/core/lib/browser/tree/tree-model.d.ts:144
Returns readonly Readonly<SelectableTreeNode>[]

totalVisibleLeaves

get totalVisibleLeaves(): number

- Defined in packages/preferences/src/browser/preference-tree-model.ts:79
Returns number

Methods

addSelection

addSelection(selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection): void

Inherited from TreeModelImpl.addSelection
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:168
Parameters
- selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection
Returns void

canNavigateBackward

canNavigateBackward(): boolean

Inherited from TreeModelImpl.canNavigateBackward
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:164
Returns boolean

canNavigateForward

canNavigateForward(): boolean

Inherited from TreeModelImpl.canNavigateForward
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:163
Returns boolean

collapseAll

collapseAll(raw?: Readonly<CompositeTreeNode>): Promise<boolean>

Inherited from TreeModelImpl.collapseAll
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:149
Parameters
- Optional raw: Readonly<CompositeTreeNode>
Returns Promise<boolean>

collapseAllExcept

collapseAllExcept(openNode: undefined | TreeNode): void

- Defined in packages/preferences/src/browser/preference-tree-model.ts:207
Parameters
- openNode: undefined | TreeNode
Returns void

collapseNode

collapseNode(raw?: Readonly<ExpandableTreeNode>): Promise<boolean>

Inherited from TreeModelImpl.collapseNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:148
Parameters
- Optional raw: Readonly<ExpandableTreeNode>
Returns Promise<boolean>

Protected createBackwardIterator

createBackwardIterator(node: undefined | TreeNode): undefined | TreeIterator

Inherited from TreeModelImpl.createBackwardIterator
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:157
Parameters
- node: undefined | TreeNode
Returns undefined | TreeIterator

Protected createIterator

createIterator(node: undefined | TreeNode): undefined | TreeIterator

Inherited from TreeModelImpl.createIterator
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:158
Parameters
- node: undefined | TreeNode
Returns undefined | TreeIterator

dispose

dispose(): void

Inherited from TreeModelImpl.dispose
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:129
Returns void

Protected doGetNextNode

doGetNextNode(iterator: TreeIterator): undefined | SelectableTreeNode

Inherited from TreeModelImpl.doGetNextNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:155
Parameters
- iterator: TreeIterator
Returns undefined | SelectableTreeNode

Protected doNavigate

doNavigate(node: TreeNode): Promise<void>

Inherited from TreeModelImpl.doNavigate
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:167
Parameters
- node: TreeNode
Returns Promise<void>

Protected doOpenNode

doOpenNode(node: TreeNode): void

Inherited from TreeModelImpl.doOpenNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:160
Parameters
- node: TreeNode
Returns void

Protected expandAll

expandAll(): void

- Defined in packages/preferences/src/browser/preference-tree-model.ts:220
Returns void

expandNode

expandNode(raw?: Readonly<ExpandableTreeNode>): Promise<undefined | ExpandableTreeNode>

Inherited from TreeModelImpl.expandNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:147
Parameters
- Optional raw: Readonly<ExpandableTreeNode>
Returns Promise<undefined | ExpandableTreeNode>

Protected fireChanged

fireChanged(): void

Inherited from TreeModelImpl.fireChanged
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:139
Returns void

getNextSelectableNode

getNextSelectableNode(node?: TreeNode): undefined | SelectableTreeNode

Inherited from TreeModelImpl.getNextSelectableNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:154
Parameters
- Optional node: TreeNode
Returns undefined | SelectableTreeNode

getNode

getNode(id: undefined | string): undefined | TreeNode

Inherited from TreeModelImpl.getNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:141
Parameters
- id: undefined | string
Returns undefined | TreeNode

getPrevSelectableNode

getPrevSelectableNode(node?: TreeNode): undefined | SelectableTreeNode

Inherited from TreeModelImpl.getPrevSelectableNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:152
Parameters
- Optional node: TreeNode
Returns undefined | SelectableTreeNode

Protected handleExpansion

handleExpansion(node: Readonly<ExpandableTreeNode>): void

Inherited from TreeModelImpl.handleExpansion
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:130
Parameters
- node: Readonly<ExpandableTreeNode>
Returns void

Private handleNewSchema

handleNewSchema(newRoot: CompositeTreeNode): void

- Defined in packages/preferences/src/browser/preference-tree-model.ts:128
Parameters
- newRoot: CompositeTreeNode
Returns void

Protected init

init(): Promise<void>

Overrides TreeModelImpl.init
- Defined in packages/preferences/src/browser/preference-tree-model.ts:100
Returns Promise<void>

Protected isVisibleSelectableNode

isVisibleSelectableNode(node: TreeNode): node is SelectableTreeNode

Overrides TreeModelImpl.isVisibleSelectableNode
- Defined in packages/preferences/src/browser/preference-tree-model.ts:187
Parameters
- node: TreeNode
Returns node is SelectableTreeNode

markAsBusy

markAsBusy(node: Readonly<TreeNode>, ms: number, token: CancellationToken): Promise<void>

Inherited from TreeModelImpl.markAsBusy
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:175
Parameters
- node: Readonly<TreeNode>
- ms: number
- token: CancellationToken
Returns Promise<void>

navigateBackward

navigateBackward(): Promise<void>

Inherited from TreeModelImpl.navigateBackward
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:166
Returns Promise<void>

navigateForward

navigateForward(): Promise<void>

Inherited from TreeModelImpl.navigateForward
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:165
Returns Promise<void>

navigateTo

navigateTo(nodeOrId: undefined | string | TreeNode): Promise<undefined | TreeNode>

Inherited from TreeModelImpl.navigateTo
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:162
Parameters
- nodeOrId: undefined | string | TreeNode
Returns Promise<undefined | TreeNode>

openNode

openNode(raw?: TreeNode): void

Inherited from TreeModelImpl.openNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:159
Parameters
- Optional raw: TreeNode
Returns void

Protected passesCurrentFilters

passesCurrentFilters(node: LeafNode, prefID: string): boolean

- Defined in packages/preferences/src/browser/preference-tree-model.ts:169
Parameters
- node: LeafNode
- prefID: string
Returns boolean

refresh

refresh(parent?: Readonly<CompositeTreeNode>): Promise<undefined | CompositeTreeNode>

Inherited from TreeModelImpl.refresh
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:143
Parameters
- Optional parent: Readonly<CompositeTreeNode>
Returns Promise<undefined | CompositeTreeNode>

restoreState

restoreState(state: State): void

Inherited from TreeModelImpl.restoreState
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:173
Parameters
- state: State
Returns void

Protected selectIfAncestorOfSelected

selectIfAncestorOfSelected(node: Readonly<ExpandableTreeNode>): void

Inherited from TreeModelImpl.selectIfAncestorOfSelected
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:134
Select the given node if it is the ancestor of a selected node.

Parameters
- node: Readonly<ExpandableTreeNode>
Returns void

selectIfNotSelected

selectIfNotSelected(node: SelectableTreeNode): boolean

- Defined in packages/preferences/src/browser/preference-tree-model.ts:233
Parameters
- node: SelectableTreeNode
Returns boolean

true if selection changed, false otherwise

selectNextNode

selectNextNode(type?: DEFAULT | TOGGLE | RANGE): void

Inherited from TreeModelImpl.selectNextNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:153
Parameters
- Optional type: DEFAULT | TOGGLE | RANGE
Returns void

selectNode

selectNode(node: Readonly<SelectableTreeNode>): void

Inherited from TreeModelImpl.selectNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:169
Parameters
- node: Readonly<SelectableTreeNode>
Returns void

selectParent

selectParent(): void

Inherited from TreeModelImpl.selectParent
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:161
Returns void

selectPrevNode

selectPrevNode(type?: DEFAULT | TOGGLE | RANGE): void

Inherited from TreeModelImpl.selectPrevNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:151
Parameters
- Optional type: DEFAULT | TOGGLE | RANGE
Returns void

selectRange

selectRange(node: Readonly<SelectableTreeNode>): void

Inherited from TreeModelImpl.selectRange
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:171
Parameters
- node: Readonly<SelectableTreeNode>
Returns void

storeState

storeState(): State

Inherited from TreeModelImpl.storeState
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:172
Returns State

toggleNode

toggleNode(node: Readonly<SelectableTreeNode>): void

Inherited from TreeModelImpl.toggleNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:170
Parameters
- node: Readonly<SelectableTreeNode>
Returns void

toggleNodeExpansion

toggleNodeExpansion(raw?: Readonly<ExpandableTreeNode>): Promise<void>

Inherited from TreeModelImpl.toggleNodeExpansion
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:150
Parameters
- Optional raw: Readonly<ExpandableTreeNode>
Returns Promise<void>

Protected updateFilteredRows

updateFilteredRows(source: PreferenceFilterChangeSource): void

- Defined in packages/preferences/src/browser/preference-tree-model.ts:164
Parameters
- source: PreferenceFilterChangeSource
Returns void

Protected updateRows

updateRows(): void

- Defined in packages/preferences/src/browser/preference-tree-model.ts:136
Returns void

Protected updateVisibleChildren

updateVisibleChildren(node: TreeNode): void

- Defined in packages/preferences/src/browser/preference-tree-model.ts:191
Parameters
- node: TreeNode
Returns void

validateNode

validateNode(node: undefined | TreeNode): undefined | TreeNode

Inherited from TreeModelImpl.validateNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:142
Parameters
- node: undefined | TreeNode
Returns undefined | TreeNode

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PreferenceTreeModel

Properties

Protected _currentRows

Protected _currentScope

Protected _isFiltered

Protected _totalVisibleLeaves

Protected Readonly expansionService

Protected Readonly filterInput

Protected lastSearchedFuzzy

Protected lastSearchedLiteral

Protected Readonly logger

Protected Readonly navigationService

Protected Readonly onChangedEmitter

Readonly onFilterChanged

Protected Readonly onOpenNodeEmitter

Protected Readonly onTreeFilterChangedEmitter

Protected Readonly preferenceService

Protected Readonly schemaProvider

Protected Readonly scopeTracker

Protected Readonly selectionService

Protected Readonly toDispose

Protected Readonly tree

Protected Readonly treeGenerator

Protected Readonly treeSearch

Accessors

currentRows

Returns Readonly<Map<string, PreferenceTreeNodeRow>>

currentScope

Returns SelectedScopeDetails

isFiltered

Returns boolean

onChanged

Returns Event<void>

onDidChangeBusy

Returns Event<TreeNode>

onExpansionChanged

Returns Event<Readonly<ExpandableTreeNode>>

onNodeRefreshed

Returns Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

onOpenNode

Returns Event<TreeNode>

onSchemaChanged

Returns Event<CompositeTreeNode>

onSelectionChanged

Returns Event<readonly Readonly<SelectableTreeNode>[]>

propertyList

Returns {}

[key: string]: PreferenceDataProperty

root

Returns undefined | TreeNode

Parameters

root: undefined | TreeNode

Returns any

selectedNodes

Returns readonly Readonly<SelectableTreeNode>[]

totalVisibleLeaves

Returns number

Methods

addSelection

Parameters

selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection

Returns void

canNavigateBackward

Returns boolean

canNavigateForward

Returns boolean

collapseAll

Parameters

Optional raw: Readonly<CompositeTreeNode>

Returns Promise<boolean>

collapseAllExcept

Parameters