Class SearchInWorkspaceResultTreeWidget

Protected _replaceTerm

Protected _showReplaceButtons

Protected appliedDecorations

Protected changeEmitter

Protected Readonly colorRegistry

Protected Readonly defaultRootName

Protected Readonly editorManager

Protected Readonly expansionService

Protected Readonly fileResourceResolver

Protected Readonly fileService

Protected Readonly filesystemPreferences

Protected focusInputEmitter

Protected forceVisibleRootNode

Protected onExpansionChangedEmitter

Protected Readonly progressService

Protected resultTree

Protected Readonly searchInWorkspacePreferences

Protected Readonly searchOnEditorModificationDelay

Protected searchOptions

Protected Readonly searchService

Protected searchTerm

Protected Readonly shell

Protected Readonly toDisposeOnActiveEditorChanged

Protected Readonly workspaceService

Protected appendToResultTree

• appendToResultTree(result): void

• Append search results to the result tree.

  Parameters

  • result: SearchInWorkspaceResult

    Search result.

  Returns void

Protected buildReplaceAllConfirmationMessage

• buildReplaceAllConfirmationMessage(occurrences, fileCount, replaceValue): string

• Parameters

  • occurrences: number
  • fileCount: number
  • replaceValue: string

  Returns string

Protected collapseFileNode

• collapseFileNode(node, preferenceValue): void

• Collapse the search-in-workspace file node based on the preference value.

  Parameters

  • node: SearchInWorkspaceFileNode
  • preferenceValue: string

  Returns void

Protected confirmReplaceAll

• confirmReplaceAll(resultNumber, fileNumber, replacementText): Promise<undefined | boolean>

• Parameters

  • resultNumber: number
  • fileNumber: number
  • replacementText: string

  Returns Promise<undefined | boolean>

Protected convertPatternToGlob

• convertPatternToGlob(workspaceRootUri, pattern): string

• Convert a pattern to match all directories.

  Parameters

  • workspaceRootUri: undefined | URI

    the uri of the current workspace root.
  • pattern: string

    the pattern to be converted.

  Returns string

Protected createEditorDecorations

• createEditorDecorations(resultNode): EditorDecoration[]

• Parameters

  • resultNode: undefined | SearchInWorkspaceFileNode

  Returns EditorDecoration[]

Protected createFileNode

• createFileNode(rootUri, path, fileUri, parent): SearchInWorkspaceFileNode

• Parameters

  • rootUri: string
  • path: string
  • fileUri: string
  • parent: SearchInWorkspaceRootFolderNode

  Returns SearchInWorkspaceFileNode

Protected createReplacePreview

• createReplacePreview(node): Promise<URI>

• Parameters

  • node: SearchInWorkspaceFileNode

  Returns Promise<URI>

Protected createResultLineNode

• createResultLineNode(result, match, fileNode): SearchInWorkspaceResultLineNode

• Parameters

  • result: SearchInWorkspaceResult
  • match: SearchMatch
  • fileNode: SearchInWorkspaceFileNode

  Returns SearchInWorkspaceResultLineNode

Protected createRootFolderNode

• createRootFolderNode(rootUri): SearchInWorkspaceRootFolderNode

• Parameters

  • rootUri: string

  Returns SearchInWorkspaceRootFolderNode

Protected decorateEditor

• decorateEditor(node, editorWidget): void

• Parameters

  • node: undefined | SearchInWorkspaceFileNode
  • editorWidget: EditorWidget

  Returns void

Protected doGetWidget

• doGetWidget(node): Promise<EditorWidget>

• Get the editor widget by the node.

  Parameters

  • node: SearchInWorkspaceResultLineNode

    the node representing a match in the search results.

  Returns Promise<EditorWidget>

  The editor widget to which the text replace will be done.

Protected doOpen

• doOpen(node, asDiffWidget?, preview?): Promise<EditorWidget>

• Parameters

  • node: SearchInWorkspaceResultLineNode
  • asDiffWidget: boolean = false
  • preview: boolean = false

  Returns Promise<EditorWidget>

Protected doRemove

• doRemove(node, e): void

• Parameters

  • node: TreeNode
  • e: MouseEvent<HTMLElement, MouseEvent>

  Returns void

Protected doReplace

• doReplace(node, e): void

• Parameters

  • node: TreeNode
  • e: MouseEvent<HTMLElement, MouseEvent>

  Returns void

Protected filenameAndPath

• filenameAndPath(rootUriStr, uriStr): {
      name: string;
      path: string;
  }

• Parameters

  • rootUriStr: string
  • uriStr: string

  Returns {
      name: string;
      path: string;
  }

  • name: string

  • path: string

Protected findMatches

• findMatches(searchTerm, widget, searchOptions): SearchMatch[]

• Find matches for the given editor.

  Parameters

  • searchTerm: string

    the search term.
  • widget: EditorWidget

    the editor widget.
  • searchOptions: SearchInWorkspaceOptions

    the search options to apply.

  Returns SearchMatch[]

  the list of matches.

Protected getDepthPadding

• getDepthPadding(depth): number

• Parameters

  • depth: number

  Returns number

Protected getExcludeGlobs

• getExcludeGlobs(excludeOptions?): string[]

• Get the list of exclude globs.

  Parameters

  • Optional excludeOptions: string[]

    the exclude search option.

  Returns string[]

  the list of exclude globs.

Protected getFileCount

• getFileCount(node): number

• Parameters

  • node: TreeNode

  Returns number

Protected getFileNodesByUri

• getFileNodesByUri(uri): SearchInWorkspaceFileNode[]

• Parameters

  • uri: URI

  Returns SearchInWorkspaceFileNode[]

Protected getResultCount

• getResultCount(node): number

• Parameters

  • node: TreeNode

  Returns number

Protected getVisibleNodes

• getVisibleNodes(): IterableIterator<TreeNode>

• Returns IterableIterator<TreeNode>

Protected handleSearchCompleted

• handleSearchCompleted(cancelIndicator?): void

• Handle when searching completed.

  Parameters

  • Optional cancelIndicator: CancellationTokenSource

  Returns void

Protected handleUp

• handleUp(event): void

• Parameters

  • event: KeyboardEvent

  Returns void

Protected inPatternList

• inPatternList(uri, patterns): boolean

• Determine if the URI matches any of the patterns.

  Parameters

  • uri: URI

    the editor URI.
  • patterns: string[]

    the glob patterns to verify.

  Returns boolean

Protected init

• init(): void

• Returns void

Protected nodeIteratorToString

• nodeIteratorToString(nodes): string

• Parameters

  • nodes: Iterable<TreeNode>

  Returns string

Protected refreshModelChildren

• refreshModelChildren(): Promise<void>

• Returns Promise<void>

Protected Readonly remove

• remove(node, e): void

• Parameters

  • node: TreeNode
  • e: MouseEvent<HTMLElement, MouseEvent>

  Returns void

Protected renderCaption

• renderCaption(node, props): ReactNode

• Parameters

  • node: TreeNode
  • props: NodeProps

  Returns ReactNode

Protected renderFileNode

• renderFileNode(node): ReactNode

• Parameters

  • node: SearchInWorkspaceFileNode

  Returns ReactNode

Protected renderMatchLinePart

• renderMatchLinePart(node): ReactNode

• Parameters

  • node: SearchInWorkspaceResultLineNode

  Returns ReactNode

Protected renderRemoveButton

• renderRemoveButton(node): ReactNode

• Parameters

  • node: TreeNode

  Returns ReactNode

Protected renderReplaceButton

• renderReplaceButton(node): ReactNode

• Parameters

  • node: TreeNode

  Returns ReactNode

Protected renderResultLineNode

• renderResultLineNode(node): ReactNode

• Parameters

  • node: SearchInWorkspaceResultLineNode

  Returns ReactNode

Protected renderRootFolderNode

• renderRootFolderNode(node): ReactNode

• Parameters

  • node: SearchInWorkspaceRootFolderNode

  Returns ReactNode

Protected renderTailDecorations

• renderTailDecorations(node, props): ReactNode

• Parameters

  • node: TreeNode
  • props: NodeProps

  Returns ReactNode

Protected replaceResult

• replaceResult(node, replaceOne, replacementText): Promise<void>

• Replace text either in all search matches under a node or in all search matches, and save the changes.

  Parameters

  • node: TreeNode

    node in the tree widget in which the "replace all" is performed.
  • replaceOne: boolean

    whether the function is to replace all matches under a node. If it is false, replace all.
  • replacementText: string

    text to be used for all replacements in the current replacement cycle.

  Returns Promise<void>

Protected searchActiveEditor

• searchActiveEditor(activeEditor, searchTerm, searchOptions): void

• Search the active editor only and update the tree with those results.

  Parameters

  • activeEditor: EditorWidget
  • searchTerm: string
  • searchOptions: SearchInWorkspaceOptions

  Returns void

Protected searchInEditor

• searchInEditor(editorWidget, searchTerm, searchOptions): undefined | SearchInWorkspaceResult

• Perform a search in the target editor.

  Parameters

  • editorWidget: EditorWidget

    the editor widget.
  • searchTerm: string

    the search term.
  • searchOptions: SearchInWorkspaceOptions

    the search options to apply.

  Returns undefined | SearchInWorkspaceResult

  the search results from the given editor, undefined if the editor is either filtered or has no matches found.

Protected searchInOpenEditors

• searchInOpenEditors(searchTerm, searchOptions): {
      matches: SearchInWorkspaceResult[];
      numberOfResults: number;
  }

• Perform a search in all open editors.

  Parameters

  • searchTerm: string

    the search term.
  • searchOptions: SearchInWorkspaceOptions

    the search options to apply.

  Returns {
      matches: SearchInWorkspaceResult[];
      numberOfResults: number;
  }

  the tuple of result count, and the list of search results.

  • matches: SearchInWorkspaceResult[]

  • numberOfResults: number

Protected selectExpandOpenResultNode

• selectExpandOpenResultNode(node): void

• Parameters

  • node: SearchInWorkspaceResultLineNode

  Returns void

Protected selectFirstResult

• selectFirstResult(): void

• Returns void

Protected selectLastResult

• selectLastResult(): void

• Returns void

Protected shouldApplySearch

• shouldApplySearch(editorWidget, searchOptions): boolean

• Determine if the given editor satisfies the filtering criteria. An editor should be searched only if:

  • it is not excluded through the excludes list.
  • it is not explicitly present in a non-empty includes list.

  Parameters

  • editorWidget: EditorWidget
  • searchOptions: SearchInWorkspaceOptions

  Returns boolean

Protected sortResultTree

• sortResultTree(): void

• Sort the result tree by URIs.

  Returns void

Protected Readonly startSearchOnModification

• startSearchOnModification(activeEditor): DebouncedFunc<(() => void)>

• Parameters

  • activeEditor: EditorWidget

  Returns DebouncedFunc<(() => void)>

Protected updateCurrentEditorDecorations

• updateCurrentEditorDecorations(): void

• Returns void

Protected updateRightResults

• updateRightResults(node): void

• Parameters

  • node: SearchInWorkspaceResultLineNode

  Returns void