Class ScmTreeModel

Hierarchy

TreeModelImpl
- ScmTreeModel
  - ScmGroupsTreeModel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ScmTreeModel(): ScmTreeModel

Inherited from TreeModelImpl.constructor

Returns ScmTreeModel

Properties

Private _languageId

_languageId: undefined | string

Protected _viewMode

_viewMode: "tree" | "list" = 'list'

Protected Readonly contextKeys

contextKeys: ScmContextKeyService

Protected Readonly expansionService

expansionService: TreeExpansionService

Protected Readonly logger

logger: ILogger

Protected Readonly navigationService

navigationService: TreeNavigationService

Protected Readonly onChangedEmitter

onChangedEmitter: Emitter<void>

Protected Readonly onOpenNodeEmitter

onOpenNodeEmitter: Emitter<TreeNode>

Protected Readonly props

props: ScmTreeModelProps

Protected provider

provider: undefined | ScmProvider

Protected Readonly selectionService

selectionService: TreeSelectionService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly tree

tree: Tree

Protected Readonly treeSearch

treeSearch: TreeSearch

Accessors

Abstract groups

get groups(): ScmResourceGroup[]

- Defined in packages/scm/src/browser/scm-tree-model.ts:117
Returns ScmResourceGroup[]

languageId

get languageId(): undefined | string

- Defined in packages/scm/src/browser/scm-tree-model.ts:91
Returns undefined | string

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>

onSelectionChanged

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

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

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

Abstract rootUri

get rootUri(): undefined | string

- Defined in packages/scm/src/browser/scm-tree-model.ts:116
Returns undefined | string

selectedNodes

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

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

viewMode

get viewMode(): "tree" | "list"
set viewMode(id: "tree" | "list"): void

- Defined in packages/scm/src/browser/scm-tree-model.ts:112
Returns "tree" | "list"
- Defined in packages/scm/src/browser/scm-tree-model.ts:98
Parameters
- id: "tree" | "list"
Returns void

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

Protected buildFileChangeTree

buildFileChangeTree(sortedResources: { pathParts: string[]; resource: ScmResource }[], start: number, end: number, level: number, parent: ScmFileChangeGroupNode | ScmFileChangeFolderNode): (ScmFileChangeFolderNode | ScmFileChangeNode)[]

- Defined in packages/scm/src/browser/scm-tree-model.ts:170
Parameters
- sortedResources: { pathParts: string[]; resource: ScmResource }[]
- start: number
- end: number
- level: number
- parent: ScmFileChangeGroupNode | ScmFileChangeFolderNode
Returns (ScmFileChangeFolderNode | ScmFileChangeNode)[]

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

Abstract canTabToWidget

canTabToWidget(): boolean

- Defined in packages/scm/src/browser/scm-tree-model.ts:95
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>

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 collectResources

collectResources(resources: ScmResource[], node: TreeNode, group: ScmResourceGroup): void

- Defined in packages/scm/src/browser/scm-tree-model.ts:345
Parameters
- resources: ScmResource[]
- node: TreeNode
- group: ScmResourceGroup
Returns void

Protected compareNodes

compareNodes(a: ScmFileChangeFolderNode | ScmFileChangeNode, b: ScmFileChangeFolderNode | ScmFileChangeNode): number

- Defined in packages/scm/src/browser/scm-tree-model.ts:219
Parameters
- a: ScmFileChangeFolderNode | ScmFileChangeNode
- b: ScmFileChangeFolderNode | ScmFileChangeNode
Returns number

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

Protected createTree

createTree(): ScmFileChangeRootNode

- Defined in packages/scm/src/browser/scm-tree-model.ts:119
Returns ScmFileChangeRootNode

dispose

dispose(): void

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

Protected doCompareNodes

doCompareNodes(a: ScmFileChangeFolderNode | ScmFileChangeNode, b: ScmFileChangeFolderNode | ScmFileChangeNode): number

- Defined in packages/scm/src/browser/scm-tree-model.ts:220
Parameters
- a: ScmFileChangeFolderNode | ScmFileChangeNode
- b: ScmFileChangeFolderNode | ScmFileChangeNode
Returns number

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

execInNodeContext

execInNodeContext(node: TreeNode, callback: () => void): void

- Defined in packages/scm/src/browser/scm-tree-model.ts:356
Parameters
- node: TreeNode
- callback: () => void
  - - (): void
    - Returns void
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>

findGroup

findGroup(groupId: string): undefined | ScmResourceGroup

- Defined in packages/scm/src/browser/scm-tree-model.ts:387
Parameters
- groupId: string
Returns undefined | ScmResourceGroup

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

getResourceFromNode

getResourceFromNode(node: ScmFileChangeNode): undefined | ScmResource

- Defined in packages/scm/src/browser/scm-tree-model.ts:300
Parameters
- node: ScmFileChangeNode
Returns undefined | ScmResource

getResourceGroupFromNode

getResourceGroupFromNode(node: ScmFileChangeGroupNode): undefined | ScmResourceGroup

- Defined in packages/scm/src/browser/scm-tree-model.ts:308
Parameters
- node: ScmFileChangeGroupNode
Returns undefined | ScmResourceGroup

getResourcesFromFolderNode

getResourcesFromFolderNode(node: ScmFileChangeFolderNode): ScmResource[]

- Defined in packages/scm/src/browser/scm-tree-model.ts:312
Parameters
- node: ScmFileChangeFolderNode
Returns ScmResource[]

Protected getRoot

getRoot(node: ScmFileChangeGroupNode | ScmFileChangeFolderNode): ScmFileChangeRootNode

- Defined in packages/scm/src/browser/scm-tree-model.ts:264
Parameters
- node: ScmFileChangeGroupNode | ScmFileChangeFolderNode
Returns ScmFileChangeRootNode

getSelectionArgs

getSelectionArgs(selectedNodes: readonly SelectableTreeNode[]): ScmResource[]

- Defined in packages/scm/src/browser/scm-tree-model.ts:321
Parameters
- selectedNodes: readonly SelectableTreeNode[]
Returns ScmResource[]

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

Protected init

init(): void

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

Protected isVisibleSelectableNode

isVisibleSelectableNode(node: TreeNode): node is SelectableTreeNode

Inherited from TreeModelImpl.isVisibleSelectableNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:156
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

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(oldState: any): void

Overrides TreeModelImpl.restoreState
- Defined in packages/scm/src/browser/scm-tree-model.ts:400
Parameters
- oldState: any
Returns void

Protected revealNode

revealNode(node: TreeNode): Promise<void>

- Defined in packages/scm/src/browser/scm-tree-model.ts:288
Parameters
- node: TreeNode
Returns Promise<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

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(): any

Overrides TreeModelImpl.storeState
- Defined in packages/scm/src/browser/scm-tree-model.ts:392
Returns any

Protected toFileChangeFolderNode

toFileChangeFolderNode(resources: { pathParts: string[]; resource: ScmResource }[], start: number, end: number, level: number, nodeRelativePath: string, parent: ScmFileChangeGroupNode | ScmFileChangeFolderNode): ScmFileChangeFolderNode

- Defined in packages/scm/src/browser/scm-tree-model.ts:232
Parameters
- resources: { pathParts: string[]; resource: ScmResource }[]
- start: number
- end: number
- level: number
- nodeRelativePath: string
- parent: ScmFileChangeGroupNode | ScmFileChangeFolderNode
Returns ScmFileChangeFolderNode

Protected toFileChangeNode

toFileChangeNode(resource: ScmResource, parent: CompositeTreeNode): ScmFileChangeNode

- Defined in packages/scm/src/browser/scm-tree-model.ts:272
Parameters
- resource: ScmResource
- parent: CompositeTreeNode
Returns ScmFileChangeNode

Protected toGroupNode

toGroupNode(group: ScmResourceGroup, parent: CompositeTreeNode): ScmFileChangeGroupNode

- Defined in packages/scm/src/browser/scm-tree-model.ts:136
Parameters
- group: ScmResourceGroup
- parent: CompositeTreeNode
Returns ScmFileChangeGroupNode

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>

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