TreeWidget | Theia TypeDoc

Hierarchy

ReactWidget
- TreeWidget
  - SourceTreeWidget
  - TreeViewWelcomeWidget

Implements

StatefulWidget

Index

Constructors

constructor

Methods

Constructors

constructor

new TreeWidget(props: TreeProps, model: TreeModel, contextMenuRenderer: ContextMenuRenderer): TreeWidget

Overrides ReactWidget.constructor
- Defined in packages/core/src/browser/tree/tree-widget.tsx:179
Parameters
- props: TreeProps
- model: TreeModel
- contextMenuRenderer: ContextMenuRenderer
Returns TreeWidget

Properties

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

Protected Readonly corePreferences

corePreferences: PreferenceProxy<CoreConfiguration>

Protected decorations

decorations: Map<string, Data[]> = ...

Protected Readonly decoratorService

decoratorService: TreeDecoratorService

Protected Readonly labelProvider

labelProvider: LabelProvider

Protected lastScrollState

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

Store the last scroll state.

Readonly model

model: TreeModel

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> = ...

Readonly props

props: TreeProps

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 shouldScrollToRow

shouldScrollToRow: boolean = true

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

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 view

view: undefined | View

Methods

Protected addClipboardListener

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

Inherited from ReactWidget.addClipboardListener
- Defined in packages/core/src/browser/widgets/widget.ts:209
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

Inherited from ReactWidget.addEventListener
- Defined in packages/core/src/browser/widgets/widget.ts:198
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 addKeyListener

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

Inherited from ReactWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:202
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

Inherited from ReactWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:191
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:683
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

Inherited from ReactWidget.clearFlag
- Defined in packages/core/src/browser/widgets/widget.ts:220
Parameters
- flag: Flag
Returns void

Protected createContainerAttributes

createContainerAttributes(): HTMLAttributes<HTMLElement>

- Defined in packages/core/src/browser/tree/tree-widget.tsx:436
Create the container attributes for the widget.

Returns HTMLAttributes<HTMLElement>

Protected createNodeAttributes

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:901
Create node attributes for the tree node given the node properties.

Parameters
- node: TreeNode
  
  the tree node.
- props: NodeProps
  
  the node properties.
Returns Attributes & HTMLAttributes<HTMLElement>

Protected createNodeClassNames

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:920
Create the node class names.

Parameters
- node: TreeNode
  
  the tree node.
- props: NodeProps
  
  the node properties.
Returns string[]

the list of tree node class names.

Protected createNodeStyle

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:966
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>

- Defined in packages/core/src/browser/tree/tree-widget.tsx:653
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:750
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:977
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1277
Deflate the tree node for storage.

Parameters
- node: TreeNode
  
  the tree node.
Returns object

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from ReactWidget.disableScrollBarFocus
- Defined in packages/core/src/browser/widgets/widget.ts:173
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Inherited from ReactWidget.dispose
- Defined in packages/core/src/browser/widgets/widget.ts:116
Returns void

Protected doFocus

doFocus(): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:390
Actually focus the tree node.

Returns void

Protected doHandleExpansionToggleDblClickEvent

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1232
Actually handle the double-click mouse event on the expansion toggle.

Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
  
  the double-click mouse event.
Returns void

Protected doRenderNodeRow

doRenderNodeRow(__namedParameters: NodeRow): ReactNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:514
Actually render the node row.

Parameters
- __namedParameters: NodeRow
Returns ReactNode

Protected doToggle

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:539
Actually toggle the tree node.

Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
  
  the mouse click event.
Returns void

Protected doUpdateDecorations

doUpdateDecorations(): Promise<void>

- Defined in packages/core/src/browser/tree/tree-widget.tsx:361
Returns Promise<void>

Protected doUpdateRows

doUpdateRows(): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:295
Returns void

Protected forceUpdate

forceUpdate(__namedParameters?: ForceUpdateOptions): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:370
Force deep resizing and rendering of rows. https://github.com/bvaughn/react-virtualized/blob/master/docs/List.md#recomputerowheights-index-number

Parameters
- __namedParameters: ForceUpdateOptions = ...
Returns void

Protected getContainerTreeNode

getContainerTreeNode(): undefined | TreeNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:451
Get the container tree node.

Returns undefined | TreeNode

the tree node for the container if available.

Protected getDecorationData

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1022
Get the tree decoration data for the given key.

Type parameters
- K: "backgroundColor" | "priority" | "fontData" | "captionPrefixes" | "captionSuffixes" | "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[]

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1004
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:944
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 getIconClass

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:821
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.
- additionalClasses: string[] = []
  
  additional CSS classes.
Returns string

the icon class name.

Protected getNodeToFocus

getNodeToFocus(): undefined | SelectableTreeNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:409
Get the tree node to focus.

Returns undefined | SelectableTreeNode

the node to focus if available.

Protected getPaddingLeft

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:949
Parameters
- node: TreeNode
- props: NodeProps
Returns number

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Overrides ReactWidget.getScrollContainer
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1043
Get the scroll container.

Returns MaybePromise<HTMLElement>

Protected getScrollToRow

getScrollToRow(): undefined | number

- Defined in packages/core/src/browser/tree/tree-widget.tsx:346
Get the scrollToRow.

Returns undefined | number

the scrollToRow if available.

Protected handleClickEvent

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1155
Handle the single-click mouse event.

Parameters
- node: undefined | TreeNode
  
  the tree node if available.
- event: MouseEvent<HTMLElement, MouseEvent>
  
  the mouse single-click event.
Returns void

Protected handleContextMenuEvent

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1199
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 handleDblClickEvent

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1188
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1133
Handle the down arrow keyboard event.

Parameters
- event: KeyboardEvent
  
  the down arrow keyboard event.
Returns void

Protected handleEnter

handleEnter(event: KeyboardEvent): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1146
Handle the enter key keyboard event.
- enter opens the tree node.
Parameters
- event: KeyboardEvent
  
  the enter key keyboard event.
Returns void

Protected Readonly handleExpansionToggleDblClickEvent

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1227
Handle the double-click mouse event on the expansion toggle.

Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
Returns void

Protected handleLeft

handleLeft(event: KeyboardEvent): Promise<void>

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1095
Handle the left arrow keyboard event.

Parameters
- event: KeyboardEvent
  
  the left arrow keyboard event.
Returns Promise<void>

Protected handleRight

handleRight(event: KeyboardEvent): Promise<void>

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1108
Handle the right arrow keyboard event.

Parameters
- event: KeyboardEvent
  
  the right arrow keyboard event.
Returns Promise<void>

Protected Readonly handleScroll

handleScroll(info: ScrollParams): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:503
Handle the scroll event.

Parameters
- info: ScrollParams
Returns void

Protected handleUp

handleUp(event: KeyboardEvent): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1121
Handle the up arrow keyboard event.

Parameters
- event: KeyboardEvent
  
  the up arrow keyboard event.
Returns void

Protected hasCtrlCmdMask

hasCtrlCmdMask(event: ModifierAwareEvent): boolean

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1254
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1265
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:674
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1307
Inflate the tree node from storage.

Parameters
- node: any
  
  the tree node.
- Optional parent: TreeNode
  
  the optional tree node.
Returns TreeNode

Protected init

init(): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:196
Returns void

Protected isExpandable

isExpandable(node: TreeNode): node is ExpandableTreeNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:994
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 needsActiveIndentGuideline

needsActiveIndentGuideline(node: TreeNode): boolean

- Defined in packages/core/src/browser/tree/tree-widget.tsx:857
Parameters
- node: TreeNode
Returns boolean

Protected needsExpansionTogglePadding

needsExpansionTogglePadding(node: TreeNode): boolean

- Defined in packages/core/src/browser/tree/tree-widget.tsx:957
If the node is a composite, a toggle will be rendered. Otherwise we need to add the width and the left, right padding => 18px

Parameters
- node: TreeNode
Returns boolean

Protected onActivateRequest

onActivateRequest(msg: Message): void

Overrides ReactWidget.onActivateRequest
- Defined in packages/core/src/browser/tree/tree-widget.tsx:382
Parameters
- msg: Message
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

Overrides ReactWidget.onAfterAttach
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1056
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from ReactWidget.onAfterDetach
- Defined in packages/core/src/browser/widgets/widget.ts:136
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from ReactWidget.onBeforeAttach
- Defined in packages/core/src/browser/widgets/widget.ts:129
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from ReactWidget.onBeforeDetach
- Defined in packages/core/src/browser/widgets/widget.ts:143
Parameters
- msg: Message
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from ReactWidget.onCloseRequest
- Defined in packages/core/src/browser/widgets/widget.ts:124
Parameters
- msg: Message
Returns void

Protected onResize

onResize(msg: ResizeMessage): void

Overrides ReactWidget.onResize
- Defined in packages/core/src/browser/tree/tree-widget.tsx:424
Parameters
- msg: ResizeMessage
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Overrides ReactWidget.onUpdateRequest
- Defined in packages/core/src/browser/tree/tree-widget.tsx:417
Parameters
- msg: Message
Returns void

Protected render

render(): ReactNode

Overrides ReactWidget.render
- Defined in packages/core/src/browser/tree/tree-widget.tsx:429
Returns ReactNode

Protected renderCaption

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:587
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:721
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 renderExpansionToggle

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:559
Render the node expansion toggle.

Parameters
- node: TreeNode
  
  the tree node.
- props: NodeProps
  
  the node properties.
Returns ReactNode

Protected renderIcon

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:526
Render the tree node given the node properties.

Parameters
- node: TreeNode
  
  the tree node.
- props: NodeProps
  
  the node properties.
Returns ReactNode

Protected renderIndent

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:831
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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:880
Render the node given the tree node and node properties.

Parameters
- node: TreeNode
  
  the tree node.
- props: NodeProps
  
  the node properties.
Returns ReactNode

Protected Readonly renderNodeRow

renderNodeRow(row: NodeRow): ReactNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:510
Render the node row.

Parameters
- row: NodeRow
Returns ReactNode

Protected renderTailDecorations

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:787
Render the tree node tail decorations.

Parameters
- node: TreeNode
  
  the tree node.
- props: NodeProps
  
  the node properties.
Returns ReactNode

Protected renderTailDecorationsForNode

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:795
Parameters
- node: TreeNode
- props: NodeProps
- tailDecorations: (TailDecoration | TailDecorationIcon | TailDecorationIconClass)[]
Returns ReactNode

Protected renderTree

renderTree(model: TreeModel): ReactNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:460
Render the tree widget.

Parameters
- model: TreeModel
  
  the tree model.
Returns ReactNode

restoreState

restoreState(oldState: object): void

Implementation of StatefulWidget.restoreState
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1345
Restore the state.

Parameters
- oldState: object
  
  the old state object.
Returns void

Protected scrollToSelected

scrollToSelected(): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:485
Scroll to the selected tree node.

Returns void

setFlag

setFlag(flag: Flag): void

Inherited from ReactWidget.setFlag
- Defined in packages/core/src/browser/widgets/widget.ts:213
Parameters
- flag: Flag
Returns void

Protected shouldDisplayNode

shouldDisplayNode(node: TreeNode): boolean

- Defined in packages/core/src/browser/tree/tree-widget.tsx:323
Parameters
- node: TreeNode
Returns boolean

storeState

storeState(): object

Implementation of StatefulWidget.storeState
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1325
Store the tree state.

Returns object

Protected toContextMenuArgs

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1244
Convert the tree node to context menu arguments.

Parameters
- node: SelectableTreeNode
  
  the selectable tree node.
Returns undefined | any[]

Protected toNodeDescription

toNodeDescription(node: TreeNode): string

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1367
Parameters
- node: TreeNode
Returns string

Protected toNodeIcon

toNodeIcon(node: TreeNode): string

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1359
Parameters
- node: TreeNode
Returns string

Protected toNodeName

toNodeName(node: TreeNode): string

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1363
Parameters
- node: TreeNode
Returns string

Protected toReactNode

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:623
Update the node given the caption and highlight.

Parameters
- caption: string
  
  the caption.
- highlight: CaptionHighlight
  
  the tree decoration caption highlight.
Returns ReactNode[]

Protected Readonly toggle

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:534
Toggle the node.

Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
Returns void

Protected updateGlobalSelection

updateGlobalSelection(): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:289
Update the global selection for the tree.

Returns void

Protected updateScrollToRow

updateScrollToRow(updateOptions?: ForceUpdateOptions): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:336
Update the scrollToRow.

Parameters
- Optional updateOptions: ForceUpdateOptions
  
  the tree widget force update options.
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: TreeProps

model: TreeModel

contextMenuRenderer: ContextMenuRenderer

Returns TreeWidget

Properties

Protected Readonly contextMenuRenderer

Protected Readonly corePreferences

Protected decorations

Protected Readonly decoratorService

Protected Readonly labelProvider

Protected lastScrollState

Readonly model

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Protected Readonly onRender

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Readonly props

Protected rows

scrollArea

Protected Optional scrollBar

Protected Optional scrollOptions

Protected scrollToRow

Protected searchBox

Protected Readonly searchBoxFactory

Protected searchHighlights

Protected Readonly selectionService

Protected shouldScrollToRow

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Protected Readonly treeSearch

Protected Readonly updateDecorations

Protected updateRows

Protected view

Methods

Protected addClipboardListener

Type parameters

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

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type parameters

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener

Type parameters

Parameters

element: HTMLElement

keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]

action: (event: KeyboardEvent) => boolean | void | Object

Parameters

event: KeyboardEvent

Returns boolean | void | Object

Rest ...additionalEventTypes: K[]

Returns void

Protected addUpdateListener

Type parameters

Parameters

element: HTMLElement

type: K