GitDiffTreeModel | Theia TypeDoc

Hierarchy

ScmTreeModel
- GitDiffTreeModel

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new GitDiffTreeModel(): GitDiffTreeModel

Overrides ScmTreeModel.constructor
- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:39
Returns GitDiffTreeModel

Properties

Protected _groups

_groups: ScmResourceGroup[] = []

Protected _viewMode

_viewMode: "tree" | "list"

Protected compareNodes

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

Type declaration

- (a: ScmFileChangeFolderNode | ScmFileChangeNode, b: ScmFileChangeFolderNode | ScmFileChangeNode): number
- Parameters
  - a: ScmFileChangeFolderNode | ScmFileChangeNode
  - b: ScmFileChangeFolderNode | ScmFileChangeNode
  Returns number

Protected Readonly contextKeys

contextKeys: ScmContextKeyService

Protected diffOptions

diffOptions: Diff

Protected Readonly expansionService

expansionService: TreeExpansionService

Protected Readonly git

git: Git

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 resourceOpener

resourceOpener: GitResourceOpener

Protected Readonly scmService

scmService: ScmService

Protected Readonly selectionService

selectionService: TreeSelectionService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnContentChange

toDisposeOnContentChange: DisposableCollection = ...

Protected Readonly tree

tree: Tree

Protected Readonly treeSearch

treeSearch: TreeSearch

Accessors

groups

get groups(): ScmResourceGroup[]

- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:97
Returns ScmResourceGroup[]

languageId

get languageId(): undefined | string

- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:58
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

rootUri

get rootUri(): undefined | string

- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:87
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"): any

- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:62
Returns "tree" | "list"
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:61
Parameters
- id: "tree" | "list"
Returns any

Methods

addSelection

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

Inherited from ScmTreeModel.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)[]

Inherited from ScmTreeModel.buildFileChangeTree
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:67
Parameters
- sortedResources: { pathParts: string[]; resource: ScmResource }[]
- start: number
- end: number
- level: number
- parent: ScmFileChangeGroupNode | ScmFileChangeFolderNode
Returns (ScmFileChangeFolderNode | ScmFileChangeNode)[]

canNavigateBackward

canNavigateBackward(): boolean

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

canNavigateForward

canNavigateForward(): boolean

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

canTabToWidget

canTabToWidget(): boolean

Overrides ScmTreeModel.canTabToWidget
- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:93
Returns boolean

collapseAll

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

Inherited from ScmTreeModel.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 ScmTreeModel.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

Inherited from ScmTreeModel.collectResources
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:84
Parameters
- resources: ScmResource[]
- node: TreeNode
- group: ScmResourceGroup
Returns void

Protected createBackwardIterator

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

Inherited from ScmTreeModel.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 ScmTreeModel.createIterator
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:158
Parameters
- node: undefined | TreeNode
Returns undefined | TreeIterator

Protected createTree

createTree(): ScmFileChangeRootNode

Inherited from ScmTreeModel.createTree
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:65
Returns ScmFileChangeRootNode

dispose

dispose(): void

Inherited from ScmTreeModel.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

Inherited from ScmTreeModel.doCompareNodes
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:72
Parameters
- a: ScmFileChangeFolderNode | ScmFileChangeNode
- b: ScmFileChangeFolderNode | ScmFileChangeNode
Returns number

Protected doGetNextNode

doGetNextNode(iterator: TreeIterator): undefined | SelectableTreeNode

Inherited from ScmTreeModel.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 ScmTreeModel.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 ScmTreeModel.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

Inherited from ScmTreeModel.execInNodeContext
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:85
Parameters
- node: TreeNode
- callback: () => void
  - - (): void
    - Returns void
Returns void

expandNode

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

Inherited from ScmTreeModel.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

Inherited from ScmTreeModel.findGroup
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:86
Parameters
- groupId: string
Returns undefined | ScmResourceGroup

Protected fireChanged

fireChanged(): void

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

getNextSelectableNode

getNextSelectableNode(node?: TreeNode): undefined | SelectableTreeNode

Inherited from ScmTreeModel.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 ScmTreeModel.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 ScmTreeModel.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

Inherited from ScmTreeModel.getResourceFromNode
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:80
Parameters
- node: ScmFileChangeNode
Returns undefined | ScmResource

getResourceGroupFromNode

getResourceGroupFromNode(node: ScmFileChangeGroupNode): undefined | ScmResourceGroup

Inherited from ScmTreeModel.getResourceGroupFromNode
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:81
Parameters
- node: ScmFileChangeGroupNode
Returns undefined | ScmResourceGroup

getResourcesFromFolderNode

getResourcesFromFolderNode(node: ScmFileChangeFolderNode): ScmResource[]

Inherited from ScmTreeModel.getResourcesFromFolderNode
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:82
Parameters
- node: ScmFileChangeFolderNode
Returns ScmResource[]

Protected getRoot

getRoot(node: ScmFileChangeGroupNode | ScmFileChangeFolderNode): ScmFileChangeRootNode

Inherited from ScmTreeModel.getRoot
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:77
Parameters
- node: ScmFileChangeGroupNode | ScmFileChangeFolderNode
Returns ScmFileChangeRootNode

getSelectionArgs

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

Inherited from ScmTreeModel.getSelectionArgs
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:83
Parameters
- selectedNodes: readonly SelectableTreeNode[]
Returns ScmResource[]

Protected handleExpansion

handleExpansion(node: Readonly<ExpandableTreeNode>): void

Inherited from ScmTreeModel.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 ScmTreeModel.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 ScmTreeModel.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 ScmTreeModel.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 ScmTreeModel.navigateBackward
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:166
Returns Promise<void>

navigateForward

navigateForward(): Promise<void>

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

open

open(change: ScmFileChange): Promise<void>

- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:101
Parameters
- change: ScmFileChange
Returns Promise<void>

openNode

openNode(raw?: TreeNode): void

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

Protected refreshRepository

refreshRepository(provider: GitScmProvider): Promise<void>

- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:63
Parameters
- provider: GitScmProvider
Returns Promise<void>

restoreState

restoreState(oldState: Options): void

Overrides ScmTreeModel.restoreState
- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:118
Parameters
- oldState: Options
Returns void

Protected revealNode

revealNode(node: TreeNode): Promise<void>

Inherited from ScmTreeModel.revealNode
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:79
Parameters
- node: TreeNode
Returns Promise<void>

Protected selectIfAncestorOfSelected

selectIfAncestorOfSelected(node: Readonly<ExpandableTreeNode>): void

Inherited from ScmTreeModel.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 ScmTreeModel.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 ScmTreeModel.selectNode
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:169
Parameters
- node: Readonly<SelectableTreeNode>
Returns void

selectParent

selectParent(): void

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

selectPrevNode

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

Inherited from ScmTreeModel.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 ScmTreeModel.selectRange
- Defined in packages/core/lib/browser/tree/tree-model.d.ts:171
Parameters
- node: Readonly<SelectableTreeNode>
Returns void

setContent

setContent(options: Options): Promise<void>

- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:46
Parameters
- options: Options
Returns Promise<void>

storeState

storeState(): Options

Overrides ScmTreeModel.storeState
- Defined in packages/git/src/browser/diff/git-diff-tree-model.tsx:106
Returns Options

Protected toFileChangeFolderNode

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

Inherited from ScmTreeModel.toFileChangeFolderNode
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:73
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

Inherited from ScmTreeModel.toFileChangeNode
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:78
Parameters
- resource: ScmResource
- parent: CompositeTreeNode
Returns ScmFileChangeNode

Protected toGroupNode

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

Inherited from ScmTreeModel.toGroupNode
- Defined in packages/scm/lib/browser/scm-tree-model.d.ts:66
Parameters
- group: ScmResourceGroup
- parent: CompositeTreeNode
Returns ScmFileChangeGroupNode

toggleNode

toggleNode(node: Readonly<SelectableTreeNode>): void

Inherited from ScmTreeModel.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 ScmTreeModel.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 ScmTreeModel.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 GitDiffTreeModel

Properties

Protected _groups

Protected _viewMode

Protected compareNodes

Type declaration

Parameters

a: ScmFileChangeFolderNode | ScmFileChangeNode

b: ScmFileChangeFolderNode | ScmFileChangeNode

Returns number

Protected Readonly contextKeys

Protected diffOptions

Protected Readonly expansionService

Protected Readonly git

Protected Readonly logger

Protected Readonly navigationService

Protected Readonly onChangedEmitter

Protected Readonly onOpenNodeEmitter

Protected Readonly props

Protected provider

Protected Readonly resourceOpener

Protected Readonly scmService

Protected Readonly selectionService

Protected Readonly toDispose

Protected Readonly toDisposeOnContentChange

Protected Readonly tree

Protected Readonly treeSearch

Accessors

groups

Returns ScmResourceGroup[]

languageId

Returns undefined | string

onChanged

Returns Event<void>

onDidChangeBusy

Returns Event<TreeNode>

onExpansionChanged

Returns Event<Readonly<ExpandableTreeNode>>

onNodeRefreshed

Returns Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

onOpenNode

Returns Event<TreeNode>

onSelectionChanged

Returns Event<readonly Readonly<SelectableTreeNode>[]>

root

Returns undefined | TreeNode

Parameters

root: undefined | TreeNode

Returns any

rootUri

Returns undefined | string

selectedNodes

Returns readonly Readonly<SelectableTreeNode>[]

viewMode

Returns "tree" | "list"

Parameters

id: "tree" | "list"

Returns any

Methods

addSelection

Parameters

selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection

Returns void

Protected buildFileChangeTree

Parameters

sortedResources: { pathParts: string[]; resource: ScmResource }[]

start: number

end: number

level: number

parent: ScmFileChangeGroupNode | ScmFileChangeFolderNode

Returns (ScmFileChangeFolderNode | ScmFileChangeNode)[]

canNavigateBackward