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:185
Parameters
- props: TreeProps
- model: TreeModel
- contextMenuRenderer: ContextMenuRenderer
Returns TreeWidget

Properties

Protected ScrollingRowRenderer

ScrollingRowRenderer: FC<{ rows: NodeRow[] }> = ...

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

Protected Readonly corePreferences

corePreferences: CorePreferences

Protected decorations

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

Protected Readonly decoratorService

decoratorService: TreeDecoratorService

Protected Readonly focusService

focusService: TreeFocusService

Protected Readonly labelProvider

labelProvider: LabelProvider

Protected lastScrollState

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

Store the last scroll state.

Readonly model

model: TreeModel

Protected nodeRoot

nodeRoot: Root

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

Readonly onDidDispose

onDidDispose: Event<void> = ...

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

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

Protected scheduleUpdateScrollToRow

scheduleUpdateScrollToRow: any = ...

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 | TreeWidget.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:215
Type Parameters
- K extends "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:204
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

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

Inherited from ReactWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:208
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes
- 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:197
Type Parameters
- K extends keyof HTMLElementEventMap
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:689
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:226
Parameters
- flag: Flag
Returns void

Protected createContainerAttributes

createContainerAttributes(): HTMLAttributes<HTMLElement>

- Defined in packages/core/src/browser/tree/tree-widget.tsx:433
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:919
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:938
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:988
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:659
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:756
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:999
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:1322
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:179
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

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

Protected doFocus

doFocus(): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:388
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:1278
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:510
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:535
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:375
Returns Promise<void>

Protected doUpdateRows

doUpdateRows(): void

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

Protected getCaptionAttributes

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:589
Parameters
- node: TreeNode
- props: NodeProps
Returns Attributes & HTMLAttributes<HTMLElement>

Protected getCaptionChildren

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

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

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): Required<Pick<WidgetDecoration.Data, K>>[K][]

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

Type Parameters
- K extends keyof WidgetDecoration.Data
Parameters
- node: TreeNode
  
  the tree node.
- key: K
  
  the tree decoration data key.
Returns Required<Pick<WidgetDecoration.Data, K>>[K][]
the tree decoration data at the given key.

Protected getDecorations

getDecorations(node: TreeNode): WidgetDecoration.Data[]

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

Parameters
- node: TreeNode
  
  the tree node.
Returns WidgetDecoration.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:966
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 getDepthForNode

getDepthForNode(node: TreeNode, depths: Map<undefined | CompositeTreeNode, number>): number

- Defined in packages/core/src/browser/tree/tree-widget.tsx:328
Parameters
- node: TreeNode
- depths: Map<undefined | CompositeTreeNode, number>
Returns number

Protected getDepthPadding

getDepthPadding(depth: number): number

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1422
Parameters
- depth: number
Returns number

Protected getIconClass

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:839
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:402
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:971
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:1065
Get the scroll container.

Returns MaybePromise<HTMLElement>

Protected getScrollToRow

getScrollToRow(): undefined | number

- Defined in packages/core/src/browser/tree/tree-widget.tsx:362
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:1202
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:1247
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:1236
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:1159
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:1173
Handle the enter key keyboard event.
- enter opens the tree node.
Parameters
- event: KeyboardEvent
  
  the enter key keyboard event.
Returns void

Protected handleEscape

handleEscape(event: KeyboardEvent): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1189
Parameters
- event: KeyboardEvent
Returns void

Protected Readonly handleExpansionToggleDblClickEvent

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1273
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:1120
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:1133
Handle the right arrow keyboard event.

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

Protected handleSpace

handleSpace(event: KeyboardEvent): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1182
Handle the space key keyboard event.
- By default should be similar to a single-click action.
Parameters
- event: KeyboardEvent
  
  the space key keyboard event.
Returns void

Protected handleUp

handleUp(event: KeyboardEvent): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1146
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:1300
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:1310
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:680
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:1352
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:200
Returns void

Protected isExpandable

isExpandable(node: TreeNode): node is ExpandableTreeNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1016
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:875
Parameters
- node: TreeNode
Returns boolean

Protected needsExpansionTogglePadding

needsExpansionTogglePadding(node: TreeNode): boolean

- Defined in packages/core/src/browser/tree/tree-widget.tsx:979
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:380
Parameters
- msg: Message
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

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

Protected onAfterDetach

onAfterDetach(msg: Message): void

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

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

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

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

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

Protected onCloseRequest

onCloseRequest(msg: Message): void

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

Protected onResize

onResize(msg: ResizeMessage): void

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

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

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

Protected render

render(): ReactNode

Overrides ReactWidget.render
- Defined in packages/core/src/browser/tree/tree-widget.tsx:426
Render the React widget in the DOM.
- If the widget has been previously rendered, any subsequent calls will perform an update and only change the DOM if absolutely necessary.
Returns ReactNode

Protected renderCaption

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:583
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:727
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:555
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:522
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:849
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:898
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:506
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:793
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: Partial<TailDecoration & TailDecorationIcon & TailDecorationIconClass>[]): ReactNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:801
Parameters
- node: TreeNode
- props: NodeProps
- tailDecorations: Partial<TailDecoration & TailDecorationIcon & TailDecorationIconClass>[]
Returns ReactNode

Protected renderTree

renderTree(model: TreeModel): ReactNode

- Defined in packages/core/src/browser/tree/tree-widget.tsx:465
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:1391
Restore the state.

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

Protected rowIsSelected

rowIsSelected(node: TreeNode, props: NodeProps): boolean

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

Protected scrollToSelected

scrollToSelected(): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:488
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:219
Parameters
- flag: Flag
Returns void

Protected shouldDisplayNode

shouldDisplayNode(node: TreeNode): boolean

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

storeState

storeState(): object

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

Returns object

Protected tapNode

tapNode(node?: TreeNode): void

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1222
The effective handler of an unmodified single-click event.

Parameters
- Optional node: TreeNode
Returns void

Protected toContextMenuArgs

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:1290
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:1419
Parameters
- node: TreeNode
Returns string

Protected toNodeIcon

toNodeIcon(node: TreeNode): string

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

Protected toNodeName

toNodeName(node: TreeNode): string

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

Protected toNodeRow

toNodeRow(node: TreeNode, index: number, depth: number): NodeRow

- Defined in packages/core/src/browser/tree/tree-widget.tsx:333
Parameters
- node: TreeNode
- index: number
- depth: number
Returns NodeRow

Protected toReactNode

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

- Defined in packages/core/src/browser/tree/tree-widget.tsx:629
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:530
Toggle the node.

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

Protected updateGlobalSelection

updateGlobalSelection(): void

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

Returns void

Protected updateScrollToRow

updateScrollToRow(): void

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

Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: TreeProps

model: TreeModel

contextMenuRenderer: ContextMenuRenderer

Returns TreeWidget

Properties

Protected ScrollingRowRenderer

Protected Readonly contextMenuRenderer

Protected Readonly corePreferences

Protected decorations

Protected Readonly decoratorService

Protected Readonly focusService

Protected Readonly labelProvider

Protected lastScrollState

Readonly model

Protected nodeRoot

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Readonly props

Protected rows

Protected scheduleUpdateScrollToRow

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 extends "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes

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

Parameters

event: KeyboardEvent

Returns boolean | void | Object

Rest ...additionalEventTypes: K[]

Returns void