Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileNavigatorWidget

Hierarchy

  • FileTreeWidget
    • FileNavigatorWidget

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new FileNavigatorWidget(props: TreeProps, model: FileNavigatorModel, contextMenuRenderer: ContextMenuRenderer, commandService: CommandService, selectionService: SelectionService, workspaceService: WorkspaceService, shell: ApplicationShell): FileNavigatorWidget

Properties

Protected canOpenWorkspaceFileAndFolder

canOpenWorkspaceFileAndFolder: boolean = ...

Protected Readonly commandService

commandService: CommandService

Protected Readonly commands

commands: CommandRegistry

Protected Readonly contextKeyService

contextKeyService: NavigatorContextKeyService

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

Protected Readonly contextService

contextService: ContextKeyService

Protected Readonly corePreferences

corePreferences: PreferenceProxy<CoreConfiguration>

Protected decorations

decorations: Map<string, Data[]>

Protected Readonly decoratorService

decoratorService: TreeDecoratorService

Protected defaultItem

defaultItem: undefined | IItem

Protected Readonly handleExpansionToggleDblClickEvent

handleExpansionToggleDblClickEvent: (event: MouseEvent<HTMLElement, MouseEvent>) => void

Handle the double-click mouse event on the expansion toggle.

Type declaration

    • (event: MouseEvent<HTMLElement, MouseEvent>): void

    • Parameters

      • event: MouseEvent<HTMLElement, MouseEvent>

      Returns void

Protected Readonly handleScroll

handleScroll: (info: ScrollParams) => void

Handle the scroll event.

Type declaration

    • (info: ScrollParams): void

    • Parameters

      • info: ScrollParams

      Returns void

Protected Readonly iconThemeService

iconThemeService: IconThemeService

Protected items

items: IItem[]

Protected Readonly labelProvider

labelProvider: LabelProvider

Protected lastScrollState

lastScrollState: undefined | { scrollLeft: number; scrollTop: number }

Store the last scroll state.

Readonly model

model: FileNavigatorModel

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Protected Readonly onRender

onRender: DisposableCollection

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected openLinkOrCommand

openLinkOrCommand: (event: MouseEvent<Element, MouseEvent>, href: string) => void

Type declaration

    • (event: MouseEvent<Element, MouseEvent>, href: string): void

    • Parameters

      • event: MouseEvent<Element, MouseEvent>
      • href: string

      Returns void

Protected Readonly openerService

openerService: OpenerService

Readonly props

props: TreeProps

Protected Readonly renderNodeRow

renderNodeRow: (row: NodeRow) => ReactNode

Render the node row.

Type declaration

    • (row: NodeRow): ReactNode

    • Parameters

      • row: NodeRow

      Returns ReactNode

Protected rows

rows: Map<string, NodeRow>

scrollArea

scrollArea: Element

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected scrollToRow

scrollToRow: undefined | number

Row index to ensure visibility.

  • Used to forcefully scroll if necessary.

Protected searchBox

searchBox: SearchBox

Protected Readonly searchBoxFactory

searchBoxFactory: SearchBoxFactory

Protected searchHighlights

searchHighlights: Map<string, CaptionHighlight>

Protected Readonly selectionService

selectionService: SelectionService

Protected Readonly shell

shell: ApplicationShell

Protected shouldScrollToRow

shouldScrollToRow: boolean

Protected Readonly toCancelNodeExpansion

toCancelNodeExpansion: DisposableCollection

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly toggle

toggle: (event: MouseEvent<HTMLElement, MouseEvent>) => void

Toggle the node.

Type declaration

    • (event: MouseEvent<HTMLElement, MouseEvent>): void

    • Parameters

      • event: MouseEvent<HTMLElement, MouseEvent>

      Returns void

Protected Readonly treeSearch

treeSearch: TreeSearch

Protected Readonly updateDecorations

updateDecorations: any

Update tree decorations.

  • Updating decorations are debounced in order to limit the number of expensive updates.

Protected updateRows

updateRows: any

Protected Readonly uploadService

uploadService: FileUploadService

Protected view

view: undefined | View

Protected viewWelcomeNodes

viewWelcomeNodes: ReactNode[]

Protected Readonly windowService

windowService: WindowService

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

Protected hidesExplorerArrows

  • get hidesExplorerArrows(): boolean

  • Returns boolean

visibleItems

  • get visibleItems(): ViewWelcome[]

  • Returns ViewWelcome[]

Methods

Protected addClipboardListener

  • addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

  • Type parameters

    • K: "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>

    Returns void

Protected addEventListener

  • addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>
    • Optional useCapture: boolean

    Returns void

Protected Readonly addFolder

  • addFolder(): void

Protected addKeyListener

  • addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[], action: (event: KeyboardEvent) => boolean | void | Object, ...additionalEventTypes: K[]): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
    • action: (event: KeyboardEvent) => boolean | void | Object
        • (event: KeyboardEvent): boolean | void | Object

        • Parameters

          • event: KeyboardEvent

          Returns boolean | void | Object

    • Rest ...additionalEventTypes: K[]

    Returns void

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • Optional useCapture: boolean

    Returns void

Protected applyFontStyles

  • applyFontStyles(original: CSSProperties, fontData: undefined | FontData): CSSProperties

  • Apply font styles to the tree.

    Parameters

    • original: CSSProperties

      the original css properties.

    • fontData: undefined | FontData

      the optional fontData.

    Returns CSSProperties

clearFlag

  • clearFlag(flag: Flag): void

  • Parameters

    • flag: Flag

    Returns void

Protected createContainerAttributes

  • createContainerAttributes(): HTMLAttributes<HTMLElement>

  • Returns HTMLAttributes<HTMLElement>

Protected createNodeAttributes

  • createNodeAttributes(node: TreeNode, props: NodeProps): Attributes & HTMLAttributes<HTMLElement>

  • Parameters

    • node: TreeNode
    • props: NodeProps

    Returns Attributes & HTMLAttributes<HTMLElement>

Protected createNodeClassNames

  • createNodeClassNames(node: TreeNode, props: NodeProps): string[]

  • Parameters

    • node: TreeNode
    • props: NodeProps

    Returns string[]

Protected createNodeStyle

  • createNodeStyle(node: TreeNode, props: NodeProps): undefined | CSSProperties

  • Create the tree node style.

    Parameters

    • node: TreeNode

      the tree node.

    • props: NodeProps

      the node properties.

    Returns undefined | CSSProperties

Protected decorateCaption

  • decorateCaption(node: TreeNode, attrs: HTMLAttributes<HTMLElement>): Attributes & HTMLAttributes<HTMLElement>

  • Decorate the tree caption.

    Parameters

    • node: TreeNode

      the tree node.

    • attrs: HTMLAttributes<HTMLElement>

      the additional attributes.

    Returns Attributes & HTMLAttributes<HTMLElement>

Protected decorateIcon

  • decorateIcon(node: TreeNode, icon: ReactNode): ReactNode

  • Decorate the tree node icon.

    Parameters

    • node: TreeNode

      the tree node.

    • icon: ReactNode

      the icon.

    Returns ReactNode

Protected decorateNodeStyle

  • decorateNodeStyle(node: TreeNode, style: undefined | CSSProperties): undefined | CSSProperties

  • Decorate the node style.

    Parameters

    • node: TreeNode

      the tree node.

    • style: undefined | CSSProperties

      the optional CSS properties.

    Returns undefined | CSSProperties

    the CSS styles if available.

Protected deflateForStorage

  • deflateForStorage(node: TreeNode): object

  • Parameters

    • node: TreeNode

    Returns object

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

  • Parameters

    • scrollContainer: HTMLElement

    Returns void

dispose

  • dispose(): void

  • Returns void

Protected doAddFolder

  • doAddFolder(): void

Protected doFocus

  • doFocus(): void

  • Actually focus the tree node.

    Returns void

Protected doHandleExpansionToggleDblClickEvent

  • doHandleExpansionToggleDblClickEvent(event: MouseEvent<HTMLElement, MouseEvent>): void

  • Actually handle the double-click mouse event on the expansion toggle.

    Parameters

    • event: MouseEvent<HTMLElement, MouseEvent>

      the double-click mouse event.

    Returns void

Protected doOpenFolder

  • doOpenFolder(): void

Protected doOpenWorkspace

  • doOpenWorkspace(): void

Protected doRenderNodeRow

  • doRenderNodeRow(__namedParameters: NodeRow): ReactNode

  • Actually render the node row.

    Parameters

    • __namedParameters: NodeRow

    Returns ReactNode

Protected doToggle

  • doToggle(event: MouseEvent<HTMLElement, MouseEvent>): void

  • Actually toggle the tree node.

    Parameters

    • event: MouseEvent<HTMLElement, MouseEvent>

      the mouse click event.

    Returns void

Protected doUpdateDecorations

  • doUpdateDecorations(): Promise<void>

  • Returns Promise<void>

Protected doUpdateRows

  • doUpdateRows(): void

Protected enableDndOnMainPanel

  • enableDndOnMainPanel(): void

Protected forceUpdate

  • forceUpdate(__namedParameters?: ForceUpdateOptions): void

Protected getContainerTreeNode

  • getContainerTreeNode(): undefined | TreeNode

Protected getDecorationData

  • getDecorationData<K>(node: TreeNode, key: K): Data[K][]

  • Get the tree decoration data for the given key.

    Type parameters

    • K: "captionPrefixes" | "captionSuffixes" | "priority" | "fontData" | "backgroundColor" | "tailDecorations" | "tooltip" | "iconColor" | "iconOverlay" | "highlight" | "badge"

    Parameters

    • node: TreeNode

      the tree node.

    • key: K

      the tree decoration data key.

    Returns Data[K][]

    the tree decoration data at the given key.

Protected getDecorations

  • getDecorations(node: TreeNode): Data[]

  • Get the tree node decorations.

    Parameters

    • node: TreeNode

      the tree node.

    Returns Data[]

    the list of tree decoration data.

Protected getDefaultNodeStyle

  • getDefaultNodeStyle(node: TreeNode, props: NodeProps): undefined | CSSProperties

  • Get the default node style.

    Parameters

    • node: TreeNode

      the tree node.

    • props: NodeProps

      the node properties.

    Returns undefined | CSSProperties

    the CSS properties if available.

Protected getDropTargetDirNode

  • getDropTargetDirNode(node: undefined | TreeNode): undefined | DirNode

  • Parameters

    • node: undefined | TreeNode

    Returns undefined | DirNode

Protected getIconClass

  • getIconClass(iconName: string | string[], additionalClasses?: string[]): string

  • Determine the classes to use for an icon

    • Assumes a Font Awesome name when passed a single string, otherwise uses the passed string array

    Parameters

    • iconName: string | string[]

      the icon name or list of icon names.

    • Optional additionalClasses: string[]

      additional CSS classes.

    Returns string

    the icon class name.

Protected getLinkClassName

  • getLinkClassName(href: string): string

  • Parameters

    • href: string

    Returns string

Protected getNodeToFocus

  • getNodeToFocus(): undefined | SelectableTreeNode

  • Get the tree node to focus.

    Returns undefined | SelectableTreeNode

    the node to focus if available.

Protected getNodeTooltip

  • getNodeTooltip(node: TreeNode): undefined | string

  • Parameters

    • node: TreeNode

    Returns undefined | string

Protected getPaddingLeft

  • getPaddingLeft(node: TreeNode, props: NodeProps): number

  • Parameters

    • node: TreeNode
    • props: NodeProps

    Returns number

Protected getScrollContainer

  • getScrollContainer(): MaybePromise<HTMLElement>

  • Get the scroll container.

    Returns MaybePromise<HTMLElement>

Protected getScrollToRow

  • getScrollToRow(): undefined | number

  • Get the scrollToRow.

    Returns undefined | number

    the scrollToRow if available.

Protected getSelectedTreeNodesFromData

  • getSelectedTreeNodesFromData(data: DataTransfer): TreeNode[]

  • Parameters

    • data: DataTransfer

    Returns TreeNode[]

Protected getTreeNodeFromData

  • getTreeNodeFromData(data: DataTransfer): undefined | TreeNode

  • Parameters

    • data: DataTransfer

    Returns undefined | TreeNode

Protected handleClickEvent

  • handleClickEvent(node: undefined | TreeNode, event: MouseEvent<HTMLElement, MouseEvent>): void

Protected handleContextMenuEvent

  • handleContextMenuEvent(node: undefined | TreeNode, event: MouseEvent<HTMLElement, MouseEvent>): void

  • Handle the context menu click event.

    • The context menu click event is triggered by the right-click.

    Parameters

    • node: undefined | TreeNode

      the tree node if available.

    • event: MouseEvent<HTMLElement, MouseEvent>

      the right-click mouse event.

    Returns void

Protected handleCopy

  • handleCopy(event: ClipboardEvent): void

Protected handleDblClickEvent

  • handleDblClickEvent(node: undefined | TreeNode, event: MouseEvent<HTMLElement, MouseEvent>): void

  • Handle the double-click mouse event.

    Parameters

    • node: undefined | TreeNode

      the tree node if available.

    • event: MouseEvent<HTMLElement, MouseEvent>

      the double-click mouse event.

    Returns void

Protected handleDown

  • handleDown(event: KeyboardEvent): void

  • Handle the down arrow keyboard event.

    Parameters

    • event: KeyboardEvent

      the down arrow keyboard event.

    Returns void

Protected handleDragEnterEvent

  • handleDragEnterEvent(node: undefined | TreeNode, event: DragEvent<Element>): void

  • Parameters

    • node: undefined | TreeNode
    • event: DragEvent<Element>

    Returns void

Protected handleDragLeaveEvent

  • handleDragLeaveEvent(node: undefined | TreeNode, event: DragEvent<Element>): void

  • Parameters

    • node: undefined | TreeNode
    • event: DragEvent<Element>

    Returns void

Protected handleDragOverEvent

  • handleDragOverEvent(node: undefined | TreeNode, event: DragEvent<Element>): void

  • Parameters

    • node: undefined | TreeNode
    • event: DragEvent<Element>

    Returns void

Protected handleDragStartEvent

  • handleDragStartEvent(node: TreeNode, event: DragEvent<Element>): void

  • Parameters

    • node: TreeNode
    • event: DragEvent<Element>

    Returns void

Protected handleDropEvent

  • handleDropEvent(node: undefined | TreeNode, event: DragEvent<Element>): Promise<void>

  • Parameters

    • node: undefined | TreeNode
    • event: DragEvent<Element>

    Returns Promise<void>

Protected handleEnter

  • handleEnter(event: KeyboardEvent): void

  • Handle the enter key keyboard event.

    • enter opens the tree node.

    Parameters

    • event: KeyboardEvent

      the enter key keyboard event.

    Returns void

Protected handleLeft

  • handleLeft(event: KeyboardEvent): Promise<void>

  • Handle the left arrow keyboard event.

    Parameters

    • event: KeyboardEvent

      the left arrow keyboard event.

    Returns Promise<void>

Protected handlePaste

  • handlePaste(event: ClipboardEvent): void

Protected handleRight

  • handleRight(event: KeyboardEvent): Promise<void>

  • Handle the right arrow keyboard event.

    Parameters

    • event: KeyboardEvent

      the right arrow keyboard event.

    Returns Promise<void>

Protected handleUp

  • handleUp(event: KeyboardEvent): void

  • Handle the up arrow keyboard event.

    Parameters

    • event: KeyboardEvent

      the up arrow keyboard event.

    Returns void

handleViewWelcomeContentChange

  • handleViewWelcomeContentChange(viewWelcomes: ViewWelcome[]): void

  • Parameters

    • viewWelcomes: ViewWelcome[]

    Returns void

handleWelcomeContextChange

  • handleWelcomeContextChange(): void

  • Returns void

Protected hasCtrlCmdMask

  • hasCtrlCmdMask(event: ModifierAwareEvent): boolean

  • Determine if the tree modifier aware event has a ctrlcmd mask.

    Parameters

    • event: ModifierAwareEvent

      the tree modifier aware event.

    Returns boolean

    true if the tree modifier aware event contains the ctrlcmd mask.

Protected hasShiftMask

  • hasShiftMask(event: ModifierAwareEvent): boolean

  • Determine if the tree modifier aware event has a shift mask.

    Parameters

    • event: ModifierAwareEvent

      the tree modifier aware event.

    Returns boolean

    true if the tree modifier aware event contains the shift mask.

Protected hasTrailingSuffixes

  • hasTrailingSuffixes(node: TreeNode): boolean

  • Determine if the tree node contains trailing suffixes.

    Parameters

    • node: TreeNode

      the tree node.

    Returns boolean

    true if the tree node contains trailing suffices.

Protected inflateFromStorage

  • inflateFromStorage(node: any, parent?: TreeNode): TreeNode

  • Parameters

    • node: any
    • Optional parent: TreeNode

    Returns TreeNode

Protected init

  • init(): void

Protected isEmptyMultiRootWorkspace

  • isEmptyMultiRootWorkspace(model: TreeModel): boolean

Protected isEnabledClick

  • isEnabledClick(href: string): boolean

  • Parameters

    • href: string

    Returns boolean

Protected isExpandable

  • isExpandable(node: TreeNode): node is ExpandableTreeNode

  • Determine if the tree node is expandable.

    Parameters

    • node: TreeNode

      the tree node.

    Returns node is ExpandableTreeNode

    true if the tree node is expandable.

Protected Readonly keyUpHandler

  • keyUpHandler(e: KeyboardEvent<Element>): void

Protected needsActiveIndentGuideline

  • needsActiveIndentGuideline(node: TreeNode): boolean

  • Parameters

    • node: TreeNode

    Returns boolean

Protected needsExpansionTogglePadding

  • needsExpansionTogglePadding(node: TreeNode): boolean

  • Parameters

    • node: TreeNode

    Returns boolean

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • onAfterHide(msg: Message): void

Protected onAfterShow

  • onAfterShow(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onResize

  • onResize(msg: ResizeMessage): void

  • Parameters

    • msg: ResizeMessage

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected Readonly openFolder

  • openFolder(): void

Protected Readonly openWorkspace

  • openWorkspace(): void

Protected parseLinkedText

  • parseLinkedText(text: string): LinkedTextItem[]

  • Parameters

    • text: string

    Returns LinkedTextItem[]

Protected render

  • render(): ReactNode

  • Returns ReactNode

Protected renderButtonNode

  • renderButtonNode(node: ILink, lineKey: string): ReactNode

  • Parameters

    • node: ILink
    • lineKey: string

    Returns ReactNode

Protected renderCaption

  • renderCaption(node: TreeNode, props: NodeProps): ReactNode

  • Render the tree node caption given the node properties.

    Parameters

    • node: TreeNode

      the tree node.

    • props: NodeProps

      the node properties.

    Returns ReactNode

Protected renderCaptionAffixes

  • renderCaptionAffixes(node: TreeNode, props: NodeProps, affixKey: "captionPrefixes" | "captionSuffixes"): ReactNode

  • Render caption affixes for the given tree node.

    Parameters

    • node: TreeNode

      the tree node.

    • props: NodeProps

      the node properties.

    • affixKey: "captionPrefixes" | "captionSuffixes"

      the affix key.

    Returns ReactNode

Protected renderCommandLinkNode

  • renderCommandLinkNode(node: ILink, linkKey: string): ReactNode

  • Parameters

    • node: ILink
    • linkKey: string

    Returns ReactNode

Protected renderEmptyMultiRootWorkspace

  • renderEmptyMultiRootWorkspace(): ReactNode

Protected renderExpansionToggle

  • renderExpansionToggle(node: TreeNode, props: NodeProps): ReactNode

  • Parameters

    • node: TreeNode
    • props: NodeProps

    Returns ReactNode

Protected renderIcon

  • renderIcon(node: TreeNode, props: NodeProps): ReactNode

  • Parameters

    • node: TreeNode
    • props: NodeProps

    Returns ReactNode

Protected renderIndent

  • renderIndent(node: TreeNode, props: NodeProps): ReactNode

  • Render indent for the file tree based on the depth

    Parameters

    • node: TreeNode

      the tree node.

    • props: NodeProps

    Returns ReactNode

Protected renderNode

  • renderNode(node: TreeNode, props: NodeProps): ReactNode

  • Render the node given the tree node and node properties.

    Parameters

    • node: TreeNode

      the tree node.

    • props: NodeProps

      the node properties.

    Returns ReactNode

Protected renderTailDecorations

  • renderTailDecorations(node: TreeNode, props: NodeProps): ReactNode

Protected renderTailDecorationsForDirectoryNode

  • renderTailDecorationsForDirectoryNode(node: TreeNode, props: NodeProps, tailDecorations: (TailDecoration | TailDecorationIcon | TailDecorationIconClass)[]): ReactNode

Protected renderTailDecorationsForNode

  • renderTailDecorationsForNode(node: TreeNode, props: NodeProps, tailDecorations: (TailDecoration | TailDecorationIcon | TailDecorationIconClass)[]): ReactNode

  • Parameters

    • node: TreeNode
    • props: NodeProps
    • tailDecorations: (TailDecoration | TailDecorationIcon | TailDecorationIconClass)[]

    Returns ReactNode

Protected renderTextNode

  • renderTextNode(node: string, textKey: string): ReactNode

  • Parameters

    • node: string
    • textKey: string

    Returns ReactNode

Protected renderTree

  • renderTree(model: TreeModel): ReactNode

Protected renderViewWelcome

  • renderViewWelcome(): ReactNode

  • Returns ReactNode

restoreState

  • restoreState(oldState: object): void

  • Restore the state.

    Parameters

    • oldState: object

      the old state object.

    Returns void

Protected scrollToSelected

  • scrollToSelected(): void

  • Scroll to the selected tree node.

    Returns void

setFlag

  • setFlag(flag: Flag): void

  • Parameters

    • flag: Flag

    Returns void

Protected setSelectedTreeNodesAsData

  • setSelectedTreeNodesAsData(data: DataTransfer, sourceNode: TreeNode, relatedNodes: TreeNode[]): void

  • Parameters

    • data: DataTransfer
    • sourceNode: TreeNode
    • relatedNodes: TreeNode[]

    Returns void

Protected setTreeNodeAsData

  • setTreeNodeAsData(data: DataTransfer, node: TreeNode): void

  • Parameters

    • data: DataTransfer
    • node: TreeNode

    Returns void

Protected shouldDisplayNode

  • shouldDisplayNode(node: TreeNode): boolean

  • Parameters

    • node: TreeNode

    Returns boolean

Protected shouldShowWelcomeView

  • shouldShowWelcomeView(): boolean

storeState

  • storeState(): object

  • Store the tree state.

    Returns object

Protected toContextMenuArgs

  • toContextMenuArgs(node: SelectableTreeNode): undefined | any[]

  • Convert the tree node to context menu arguments.

    Parameters

    • node: SelectableTreeNode

      the selectable tree node.

    Returns undefined | any[]

Protected toNodeDescription

  • toNodeDescription(node: TreeNode): string

  • Parameters

    • node: TreeNode

    Returns string

Protected toNodeIcon

  • toNodeIcon(node: TreeNode): string

  • Parameters

    • node: TreeNode

    Returns string

Protected toNodeName

  • toNodeName(node: TreeNode): string

  • Parameters

    • node: TreeNode

    Returns string

Protected toReactNode

  • toReactNode(caption: string, highlight: CaptionHighlight): ReactNode[]

  • Update the node given the caption and highlight.

    Parameters

    • caption: string

      the caption.

    • highlight: CaptionHighlight

      the tree decoration caption highlight.

    Returns ReactNode[]

Protected updateGlobalSelection

  • updateGlobalSelection(): void

  • Update the global selection for the tree.

    Returns void

Protected updateScrollToRow

  • updateScrollToRow(updateOptions?: ForceUpdateOptions): void

  • Update the scrollToRow.

    Parameters

    • Optional updateOptions: ForceUpdateOptions

      the tree widget force update options.

    Returns void

Protected updateSelectionContextKeys

  • updateSelectionContextKeys(): void

Protected updateViewWelcomeNodes

  • updateViewWelcomeNodes(): void

  • Returns void