FileTreeModel | Theia TypeDoc

Hierarchy

TreeModelImpl
- FileTreeModel
  - FileDialogModel

Implements

LocationService

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FileTreeModel(): FileTreeModel

Inherited from TreeModelImpl.constructor

Returns FileTreeModel

Properties

Protected Readonly environments

environments: EnvVariablesServer

Protected Readonly expansionService

expansionService: TreeExpansionService

Protected Readonly fileService

fileService: FileService

Protected Readonly labelProvider

labelProvider: LabelProvider

Protected Readonly logger

logger: ILogger

Protected Readonly messageService

messageService: MessageService

Protected Readonly navigationService

navigationService: TreeNavigationService

Protected Readonly onChangedEmitter

onChangedEmitter: Emitter<void>

Protected Readonly onOpenNodeEmitter

onOpenNodeEmitter: Emitter<TreeNode>

Protected Readonly selectionService

selectionService: TreeSelectionService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly tree

tree: Tree

Protected Readonly treeSearch

treeSearch: TreeSearch

Accessors

location

get location(): undefined | default
set location(uri: undefined | default): void

Implementation of LocationService.location
- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:50
Returns undefined | default
Implementation of LocationService.location
- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:58
Parameters
- uri: undefined | default
Returns void

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

selectedFileStatNodes

get selectedFileStatNodes(): Readonly<FileStatNode>[]

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:83
Returns Readonly<FileStatNode>[]

selectedNodes

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

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

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>

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>

copy

copy(source: default, target: Readonly<FileStatNode>): Promise<default>

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:153
Parameters
- source: default
- target: Readonly<FileStatNode>
Returns Promise<default>

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

drives

drives(): Promise<default[]>

Implementation of LocationService.drives
- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:73
Returns Promise<default[]>

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

Protected getAffectedNodes

getAffectedNodes(uris: default[]): Map<string, CompositeTreeNode>

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:141
Parameters
- uris: default[]
Returns Map<string, CompositeTreeNode>

Protected getAffectedUris

getAffectedUris(changes: FileChangesEvent): default[]

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:125
Parameters
- changes: FileChangesEvent
Returns default[]

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

getNodesByUri

getNodesByUri(uri: default): IterableIterator<TreeNode>

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:87
Parameters
- uri: default
Returns IterableIterator<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

Protected init

init(): void

Overrides TreeModelImpl.init
- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:44
Returns void

Protected isFileContentChanged

isFileContentChanged(change: FileChange): boolean

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:129
Parameters
- change: FileChange
Returns boolean

Protected isRootAffected

isRootAffected(changes: FileChangesEvent): boolean

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:117
Parameters
- changes: FileChangesEvent
Returns boolean

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>

move

move(source: TreeNode, target: TreeNode): Promise<undefined | default>

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:171
Move the given source file or directory to the given target directory.

Parameters
- source: TreeNode
- target: TreeNode
Returns Promise<undefined | default>

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>

Protected onDidMove

onDidMove(event: FileOperationEvent): void

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:97
to workaround https://github.com/Axosoft/nsfw/issues/42

Parameters
- event: FileOperationEvent
Returns void

Protected onFilesChanged

onFilesChanged(changes: FileChangesEvent): void

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:111
Parameters
- changes: FileChangesEvent
Returns void

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>

Protected refreshAffectedNodes

refreshAffectedNodes(uris: default[]): boolean

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:133
Parameters
- uris: default[]
Returns boolean

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

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

Protected shouldReplace

shouldReplace(fileName: string): Promise<boolean>

- Defined in packages/filesystem/src/browser/file-tree/file-tree-model.ts:197
Parameters
- fileName: string
Returns Promise<boolean>

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>

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

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FileTreeModel

Properties

Protected Readonly environments

Protected Readonly expansionService

Protected Readonly fileService

Protected Readonly labelProvider

Protected Readonly logger

Protected Readonly messageService

Protected Readonly navigationService

Protected Readonly onChangedEmitter

Protected Readonly onOpenNodeEmitter

Protected Readonly selectionService

Protected Readonly toDispose

Protected Readonly tree

Protected Readonly treeSearch

Accessors

location

Returns undefined | default

Parameters

uri: undefined | default

Returns void

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

selectedFileStatNodes

Returns Readonly<FileStatNode>[]

selectedNodes

Returns readonly Readonly<SelectableTreeNode>[]

Methods

addSelection

Parameters

selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection

Returns void

canNavigateBackward

Returns boolean

canNavigateForward

Returns boolean

collapseAll

Parameters

Optional raw: Readonly<CompositeTreeNode>

Returns Promise<boolean>

collapseNode

Parameters

Optional raw: Readonly<ExpandableTreeNode>

Returns Promise<boolean>

copy

Parameters

source: default

target: Readonly<FileStatNode>

Returns Promise<default>

Protected createBackwardIterator

Parameters

node: undefined | TreeNode

Returns undefined | TreeIterator

Protected createIterator

Parameters

node: undefined | TreeNode