Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileNavigatorModel

Hierarchy

  • FileTreeModel
    • FileNavigatorModel

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Readonly applicationState

applicationState: FrontendApplicationStateService

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 openerService

openerService: OpenerService

Protected Readonly pendingBusyProgress

pendingBusyProgress: Map<string, Deferred<void>> = ...

Protected Readonly progressService

progressService: ProgressService

Protected Readonly selectionService

selectionService: TreeSelectionService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly tree

tree: FileNavigatorTree

Protected Readonly treeSearch

treeSearch: TreeSearch

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

location

  • get location(): undefined | default
  • set location(uri: undefined | default): any

  • Returns undefined | default

  • Parameters

    • uri: undefined | default

    Returns any

onChanged

  • get onChanged(): Event<void>

  • Returns Event<void>

onDidChangeBusy

  • get onDidChangeBusy(): Event<TreeNode>

  • Returns Event<TreeNode>

onExpansionChanged

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

  • Returns Event<Readonly<ExpandableTreeNode>>

onNodeRefreshed

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

  • Returns Event<Readonly<CompositeTreeNode> & WaitUntilEvent>

onOpenNode

  • get onOpenNode(): Event<TreeNode>

  • Returns Event<TreeNode>

onSelectionChanged

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

  • Returns Event<readonly Readonly<SelectableTreeNode>[]>

root

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

  • Returns undefined | TreeNode

  • Parameters

    • root: undefined | TreeNode

    Returns any

selectedFileStatNodes

  • get selectedFileStatNodes(): Readonly<FileStatNode>[]

  • Returns Readonly<FileStatNode>[]

selectedNodes

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

  • Returns readonly Readonly<SelectableTreeNode>[]

Methods

addSelection

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

  • Parameters

    • selectionOrTreeNode: Readonly<SelectableTreeNode> | TreeSelection

    Returns void

canNavigateBackward

  • canNavigateBackward(): boolean

  • Returns boolean

canNavigateForward

  • canNavigateForward(): boolean

  • Returns boolean

collapseAll

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

  • Parameters

    • Optional raw: Readonly<CompositeTreeNode>

    Returns Promise<boolean>

collapseNode

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

  • Parameters

    • Optional raw: Readonly<ExpandableTreeNode>

    Returns Promise<boolean>

copy

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

  • Parameters

    • source: default
    • target: Readonly<FileStatNode>

    Returns Promise<default>

Protected createBackwardIterator

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

  • Parameters

    • node: undefined | TreeNode

    Returns undefined | TreeIterator

Protected createIterator

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

  • Parameters

    • node: undefined | TreeNode

    Returns undefined | TreeIterator

Protected createMultipleRootNode

Protected createRoot

  • createRoot(): Promise<undefined | TreeNode>

dispose

  • dispose(): void

  • Returns void

Protected doGetNextNode

  • doGetNextNode(iterator: TreeIterator): undefined | SelectableTreeNode

  • Parameters

    • iterator: TreeIterator

    Returns undefined | SelectableTreeNode

Protected doNavigate

  • doNavigate(node: TreeNode): Promise<void>

  • Parameters

    • node: TreeNode

    Returns Promise<void>

Protected doOpenNode

  • doOpenNode(node: TreeNode): void

drives

  • drives(): Promise<default[]>

  • Returns Promise<default[]>

expandNode

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

  • Parameters

    • Optional raw: Readonly<ExpandableTreeNode>

    Returns Promise<undefined | ExpandableTreeNode>

Protected fireChanged

  • fireChanged(): void

  • Returns void

Protected getAffectedNodes

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

  • Parameters

    • uris: default[]

    Returns Map<string, CompositeTreeNode>

Protected getAffectedUris

  • getAffectedUris(changes: FileChangesEvent): default[]

  • Parameters

    • changes: FileChangesEvent

    Returns default[]

getNextSelectableNode

  • getNextSelectableNode(node?: TreeNode): undefined | SelectableTreeNode

  • Parameters

    • Optional node: TreeNode

    Returns undefined | SelectableTreeNode

getNode

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

  • Parameters

    • id: undefined | string

    Returns undefined | TreeNode

Protected getNodeClosestToRootByUri

  • getNodeClosestToRootByUri(uri: default): undefined | TreeNode

getNodesByUri

  • getNodesByUri(uri: default): IterableIterator<TreeNode>

getPrevSelectableNode

  • getPrevSelectableNode(node?: TreeNode): undefined | SelectableTreeNode

  • Parameters

    • Optional node: TreeNode

    Returns undefined | SelectableTreeNode

Protected handleExpansion

  • handleExpansion(node: Readonly<ExpandableTreeNode>): void

  • Parameters

    • node: Readonly<ExpandableTreeNode>

    Returns void

Protected init

  • init(): void

Protected initializeRoot

  • initializeRoot(): Promise<void>

Protected isFileContentChanged

  • isFileContentChanged(change: FileChange): boolean

  • Parameters

    • change: FileChange

    Returns boolean

Protected isRootAffected

  • isRootAffected(changes: FileChangesEvent): boolean

  • Parameters

    • changes: FileChangesEvent

    Returns boolean

Protected isVisibleSelectableNode

  • isVisibleSelectableNode(node: TreeNode): node is SelectableTreeNode

  • Parameters

    • node: TreeNode

    Returns node is SelectableTreeNode

markAsBusy

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

  • Parameters

    • node: Readonly<TreeNode>
    • ms: number
    • token: CancellationToken

    Returns Promise<void>

move

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

navigateBackward

  • navigateBackward(): Promise<void>

  • Returns Promise<void>

navigateForward

  • navigateForward(): Promise<void>

  • Returns Promise<void>

navigateTo

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

  • Parameters

    • nodeOrId: undefined | string | TreeNode

    Returns Promise<undefined | TreeNode>

Protected onDidMove

  • onDidMove(event: FileOperationEvent): void

  • to workaround https://github.com/Axosoft/nsfw/issues/42

    Parameters

    • event: FileOperationEvent

    Returns void

Protected onFilesChanged

  • onFilesChanged(changes: FileChangesEvent): void

  • Parameters

    • changes: FileChangesEvent

    Returns void

openNode

  • openNode(raw?: TreeNode): void

  • Parameters

    • Optional raw: TreeNode

    Returns void

previewNode

  • previewNode(node: TreeNode): void

refresh

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

  • Parameters

    • Optional parent: Readonly<CompositeTreeNode>

    Returns Promise<undefined | CompositeTreeNode>

Protected refreshAffectedNodes

  • refreshAffectedNodes(uris: default[]): boolean

  • Parameters

    • uris: default[]

    Returns boolean

Protected reportBusyProgress

  • reportBusyProgress(): void

restoreState

  • restoreState(state: State): void

  • Parameters

    • state: State

    Returns void

revealFile

  • revealFile(uri: default): Promise<undefined | TreeNode>

  • Reveals node in the navigator by given file uri.

    Parameters

    • uri: default

      uri to file which should be revealed in the navigator

    Returns Promise<undefined | TreeNode>

    file tree node if the file with given uri was revealed, undefined otherwise

Protected selectIfAncestorOfSelected

  • selectIfAncestorOfSelected(node: Readonly<ExpandableTreeNode>): void

  • 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

  • Parameters

    • Optional type: DEFAULT | TOGGLE | RANGE

    Returns void

selectNode

  • selectNode(node: Readonly<SelectableTreeNode>): void

  • Parameters

    • node: Readonly<SelectableTreeNode>

    Returns void

selectParent

  • selectParent(): void

  • Returns void

selectPrevNode

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

  • Parameters

    • Optional type: DEFAULT | TOGGLE | RANGE

    Returns void

selectRange

  • selectRange(node: Readonly<SelectableTreeNode>): void

  • Parameters

    • node: Readonly<SelectableTreeNode>

    Returns void

Protected shouldReplace

  • shouldReplace(fileName: string): Promise<boolean>

  • Parameters

    • fileName: string

    Returns Promise<boolean>

storeState

  • storeState(): State

  • Returns State

toggleNode

  • toggleNode(node: Readonly<SelectableTreeNode>): void

  • Parameters

    • node: Readonly<SelectableTreeNode>

    Returns void

toggleNodeExpansion

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

  • Parameters

    • Optional raw: Readonly<ExpandableTreeNode>

    Returns Promise<void>

Protected updateRoot

  • updateRoot(): Promise<void>

validateNode

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

  • Parameters

    • node: undefined | TreeNode

    Returns undefined | TreeNode