Class TreeWidget

A contract for widgets that want to store and restore their inner state, between sessions.

Hierarchy (view full)

ReactWidget
- TreeWidget
  - SourceTreeWidget
  - TreeViewWelcomeWidget

Implements

StatefulWidget

Index

Constructors

constructor

Methods

addClipboardListener addEventListener addKeyListener addUpdateListener applyFontStyles clearFlag createContainerAttributes createNodeAttributes createNodeClassNames createNodeStyle decorateCaption decorateIcon decorateNodeStyle deflateForStorage disableScrollBarFocus dispose doFocus doHandleExpansionToggleDblClickEvent doRenderNodeRow doToggle doUpdateDecorations doUpdateRows getCaptionAttributes getCaptionChildren getContainerTreeNode getDecorationData getDecorations getDefaultNodeStyle getDepthForNode getDepthPadding getIconClass getNodeToFocus getPaddingLeft getPreviewNode getScrollContainer getScrollToRow handleAuxClickEvent handleClickEvent handleContextMenuEvent handleDblClickEvent handleDown handleEnter handleEscape handleExpansionToggleDblClickEvent handleLeft handleMiddleClickEvent handleRight handleSpace handleUp hasCtrlCmdMask hasShiftMask hasTrailingSuffixes inflateFromStorage init isExpandable needsActiveIndentGuideline needsExpansionTogglePadding onActivateRequest onAfterAttach onAfterDetach onBeforeAttach onBeforeDetach onCloseRequest onResize onUpdateRequest render renderCaption renderCaptionAffixes renderCheckbox renderExpansionToggle renderIcon renderIndent renderNode renderNodeRow renderTailDecorations renderTailDecorationsForNode renderTree restoreState rowIsSelected scrollToSelected setFlag shouldDisplayNode shouldRenderIndent storeState tapNode toContextMenuArgs toNodeDescription toNodeIcon toNodeName toNodeRow toReactNode toggle toggleChecked updateGlobalSelection updateScrollToRow

Constructors

constructor

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

Properties

`Protected` ScrollingRowRenderer

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

Type declaration

rows: NodeRow[]

`Protected` `Readonly` contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

`Protected` `Readonly` corePreferences

corePreferences: CorePreferences

`Protected` decorations

decorations: Map<string, core.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.

Type declaration

scrollLeft: number
The scroll left value.
scrollTop: number
The scroll top value.

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

`Protected` `Readonly` preferenceService

preferenceService: PreferenceService

`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` treeIndent

treeIndent: number = 8

`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 | core.View

Methods

`Protected` addClipboardListener

addClipboardListener<K>(element, type, listener): void
Type Parameters
- K extends "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void
Inherited from ReactWidget.addClipboardListener
- Defined in packages/core/src/browser/widgets/widget.ts:217

`Protected` addEventListener

addEventListener<K>(element, type, listener, useCapture?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void
Inherited from ReactWidget.addEventListener
- Defined in packages/core/src/browser/widgets/widget.ts:206

`Protected` addKeyListener

addKeyListener<K>(element, keysOrKeyCodes, action, ...additionalEventTypes): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- keysOrKeyCodes: KeysOrKeyCodes | core.Predicate
- action: ((event) => boolean | void | Object)
  - - (event): boolean | void | Object
    - Parameters
      event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void
Inherited from ReactWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:210

`Protected` addUpdateListener

addUpdateListener<K>(element, type, useCapture?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void
Inherited from ReactWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:199

`Protected` applyFontStyles

applyFontStyles(original, fontData): CSSProperties
Apply font styles to the tree.
Parameters
- original: CSSProperties
  the original css properties.
- fontData: undefined | FontData
  the optional fontData.
Returns CSSProperties
- Defined in packages/core/src/browser/tree/tree-widget.tsx:746

clearFlag

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

`Protected` createContainerAttributes

createContainerAttributes(): HTMLAttributes<HTMLElement>
Create the container attributes for the widget.

Returns HTMLAttributes<HTMLElement>
- Defined in packages/core/src/browser/tree/tree-widget.tsx:456

`Protected` createNodeAttributes

createNodeAttributes(node, props): Attributes & HTMLAttributes<HTMLElement>
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>
- Defined in packages/core/src/browser/tree/tree-widget.tsx:988

`Protected` createNodeClassNames

createNodeClassNames(node, props): string[]
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.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1008

`Protected` createNodeStyle

createNodeStyle(node, props): undefined | CSSProperties
Create the tree node style.
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
  the node properties.
Returns undefined | CSSProperties
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1058

`Protected` decorateCaption

decorateCaption(node, attrs): Attributes & HTMLAttributes<HTMLElement>
Decorate the tree caption.
Parameters
- node: TreeNode
  the tree node.
- attrs: HTMLAttributes<HTMLElement>
  the additional attributes.
Returns Attributes & HTMLAttributes<HTMLElement>
- Defined in packages/core/src/browser/tree/tree-widget.tsx:716

`Protected` decorateIcon

decorateIcon(node, icon): ReactNode
Decorate the tree node icon.
Parameters
- node: TreeNode
  the tree node.
- icon: ReactNode
  the icon.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:813

`Protected` decorateNodeStyle

decorateNodeStyle(node, style): 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.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1069

`Protected` deflateForStorage

deflateForStorage(node): object
Deflate the tree node for storage.
Parameters
- node: TreeNode
  the tree node.
Returns object
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1421

`Protected` disableScrollBarFocus

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

dispose

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

`Protected` doFocus

doFocus(): void
Actually focus the tree node.

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

`Protected` doHandleExpansionToggleDblClickEvent

doHandleExpansionToggleDblClickEvent(event): void
Actually handle the double-click mouse event on the expansion toggle.
Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
  the double-click mouse event.
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1377

`Protected` doRenderNodeRow

doRenderNodeRow(__namedParameters): ReactNode
Actually render the node row.
Parameters
- __namedParameters: NodeRow
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:533

`Protected` doToggle

doToggle(event): void
Actually toggle the tree node.
Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
  the mouse click event.
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:558

`Protected` doUpdateDecorations

doUpdateDecorations(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree-widget.tsx:398

`Protected` doUpdateRows

doUpdateRows(): void
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:328

`Protected` getCaptionAttributes

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

`Protected` getCaptionChildren

getCaptionChildren(node, props): ReactNode
Parameters
- node: TreeNode
- props: NodeProps
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:665

`Protected` getContainerTreeNode

getContainerTreeNode(): undefined | TreeNode
Get the container tree node.

Returns undefined | TreeNode
the tree node for the container if available.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:474

`Protected` getDecorationData

getDecorationData<K>(node, key): Required<Pick<core.Data, K>>[K][]
Get the tree decoration data for the given key.
Type Parameters
- K extends keyof core.Data
Parameters
- node: TreeNode
  the tree node.
- key: K
  the tree decoration data key.
Returns Required<Pick<core.Data, K>>[K][]
the tree decoration data at the given key.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1114

`Protected` getDecorations

getDecorations(node): core.Data[]
Get the tree node decorations.
Parameters
- node: TreeNode
  the tree node.
Returns core.Data[]
the list of tree decoration data.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1096

`Protected` getDefaultNodeStyle

getDefaultNodeStyle(node, props): 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.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1036

`Protected` getDepthForNode

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

`Protected` getDepthPadding

getDepthPadding(depth): number
Parameters
- depth: number
Returns number
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1521

`Protected` getIconClass

getIconClass(iconName, additionalClasses?): 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.
- additionalClasses: string[] = []
  additional CSS classes.
Returns string
the icon class name.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:896

`Protected` getNodeToFocus

getNodeToFocus(): undefined | SelectableTreeNode
Get the tree node to focus.

Returns undefined | SelectableTreeNode
the node to focus if available.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:425

`Protected` getPaddingLeft

getPaddingLeft(node, props): number
Parameters
- node: TreeNode
- props: NodeProps
Returns number
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1041

getPreviewNode

getPreviewNode(): undefined | Node
Returns undefined | Node
Inherited from ReactWidget.getPreviewNode
- Defined in packages/core/src/browser/widgets/widget.ts:221

`Protected` getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>
Get the scroll container.

Returns MaybePromise<HTMLElement>
Overrides ReactWidget.getScrollContainer
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1135

`Protected` getScrollToRow

getScrollToRow(): undefined | number
Get the scrollToRow.

Returns undefined | number
the scrollToRow if available.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:385

`Protected` handleAuxClickEvent

handleAuxClickEvent(node, event): void
Handle the middle-click mouse event.
Parameters
- node: undefined | TreeNode
  the tree node if available.
- event: MouseEvent<HTMLElement, MouseEvent>
  the middle-click mouse event.
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1319

`Protected` handleClickEvent

handleClickEvent(node, event): void
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
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1275

`Protected` handleContextMenuEvent

handleContextMenuEvent(node, event): 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
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1346

`Protected` handleDblClickEvent

handleDblClickEvent(node, event): 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
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1309

`Protected` handleDown

handleDown(event): void
Handle the down arrow keyboard event.
Parameters
- event: KeyboardEvent
  the down arrow keyboard event.
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1229

`Protected` handleEnter

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

`Protected` handleEscape

handleEscape(event): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1262

`Protected` `Readonly` handleExpansionToggleDblClickEvent

handleExpansionToggleDblClickEvent(event): void
Handle the double-click mouse event on the expansion toggle.
Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1372

`Protected` handleLeft

handleLeft(event): Promise<void>
Handle the left arrow keyboard event.
Parameters
- event: KeyboardEvent
  the left arrow keyboard event.
Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1190

`Protected` handleMiddleClickEvent

handleMiddleClickEvent(event): void
Handle the middle-click mouse event.
Parameters
- event: MouseEvent
  the middle-click mouse event.
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1333

`Protected` handleRight

handleRight(event): Promise<void>
Handle the right arrow keyboard event.
Parameters
- event: KeyboardEvent
  the right arrow keyboard event.
Returns Promise<void>
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1203

`Protected` handleSpace

handleSpace(event): void
Handle the space key keyboard event.
- If the element has a checkbox, it will be toggled.
- Otherwise, it should be similar to a single-click action.
Parameters
- event: KeyboardEvent
  the space key keyboard event.
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1253

`Protected` handleUp

handleUp(event): void
Handle the up arrow keyboard event.
Parameters
- event: KeyboardEvent
  the up arrow keyboard event.
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1216

`Protected` hasCtrlCmdMask

hasCtrlCmdMask(event): 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.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1399

`Protected` hasShiftMask

hasShiftMask(event): 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.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1409

`Protected` hasTrailingSuffixes

hasTrailingSuffixes(node): 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.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:737

`Protected` inflateFromStorage

inflateFromStorage(node, parent?): TreeNode
Inflate the tree node from storage.
Parameters
- node: any
  the tree node.
- Optional parent: TreeNode
  the optional tree node.
Returns TreeNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1451

`Protected` init

init(): void
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:206

`Protected` isExpandable

isExpandable(node): 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.
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1086

`Protected` needsActiveIndentGuideline

needsActiveIndentGuideline(node): boolean
Parameters
- node: TreeNode
Returns boolean
- Defined in packages/core/src/browser/tree/tree-widget.tsx:943

`Protected` needsExpansionTogglePadding

needsExpansionTogglePadding(node): boolean
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
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1049

`Protected` onActivateRequest

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

`Protected` onAfterAttach

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

`Protected` onAfterDetach

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

`Protected` onBeforeAttach

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

`Protected` onBeforeDetach

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

`Protected` onCloseRequest

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

`Protected` onResize

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

`Protected` onUpdateRequest

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

`Protected` render

render(): ReactNode
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
Overrides ReactWidget.render
- Defined in packages/core/src/browser/tree/tree-widget.tsx:449

`Protected` renderCaption

renderCaption(node, props): ReactNode
Render the tree node caption given the node properties.
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
  the node properties.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:640

`Protected` renderCaptionAffixes

renderCaptionAffixes(node, props, affixKey): 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
- Defined in packages/core/src/browser/tree/tree-widget.tsx:784

`Protected` renderCheckbox

renderCheckbox(node, props): ReactNode
Render the node expansion toggle.
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
  the node properties.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:606

`Protected` renderExpansionToggle

renderExpansionToggle(node, props): ReactNode
Render the node expansion toggle.
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
  the node properties.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:578

`Protected` renderIcon

renderIcon(node, props): ReactNode
Render the tree node given the node properties.
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
  the node properties.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:545

`Protected` renderIndent

renderIndent(node, props): ReactNode
Render indent for the file tree based on the depth
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:906

`Protected` renderNode

renderNode(node, props): ReactNode
Render the node given the tree node and node properties.
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
  the node properties.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:966

`Protected` `Readonly` renderNodeRow

renderNodeRow(row): ReactNode
Render the node row.
Parameters
- row: NodeRow
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:529

`Protected` renderTailDecorations

renderTailDecorations(node, props): ReactNode
Render the tree node tail decorations.
Parameters
- node: TreeNode
  the tree node.
- props: NodeProps
  the node properties.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:850

`Protected` renderTailDecorationsForNode

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

`Protected` renderTree

renderTree(model): ReactNode
Render the tree widget.
Parameters
- model: TreeModel
  the tree model.
Returns ReactNode
- Defined in packages/core/src/browser/tree/tree-widget.tsx:488

restoreState

restoreState(oldState): void
Restore the state.
Parameters
- oldState: object
  the old state object.
Returns void
Implementation of StatefulWidget.restoreState
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1490

`Protected` rowIsSelected

rowIsSelected(node, props): boolean
Parameters
- node: TreeNode
- props: NodeProps
Returns boolean
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1025

`Protected` scrollToSelected

scrollToSelected(): void
Scroll to the selected tree node.

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

setFlag

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

`Protected` shouldDisplayNode

shouldDisplayNode(node): boolean
Parameters
- node: TreeNode
Returns boolean
- Defined in packages/core/src/browser/tree/tree-widget.tsx:360

`Protected` shouldRenderIndent

shouldRenderIndent(node): boolean
Determines whether an indentation div should be rendered for the specified tree node. If there are multiple tree nodes inside of a single rendered row, this method should only return true for the first node.
Parameters
- node: TreeNode
Returns boolean
- Defined in packages/core/src/browser/tree/tree-widget.tsx:939

storeState

storeState(): object
Store the tree state.

Returns object
Implementation of StatefulWidget.storeState
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1469

`Protected` tapNode

tapNode(node?): void
The effective handler of an unmodified single-click event.
Parameters
- Optional node: TreeNode
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1295

`Protected` toContextMenuArgs

toContextMenuArgs(node): undefined | any[]
Convert the tree node to context menu arguments.
Parameters
- node: SelectableTreeNode
  the selectable tree node.
Returns undefined | any[]
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1389

`Protected` toNodeDescription

toNodeDescription(node): string
Parameters
- node: TreeNode
Returns string
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1518

`Protected` toNodeIcon

toNodeIcon(node): string
Parameters
- node: TreeNode
Returns string
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1510

`Protected` toNodeName

toNodeName(node): string
Parameters
- node: TreeNode
Returns string
- Defined in packages/core/src/browser/tree/tree-widget.tsx:1514

`Protected` toNodeRow

toNodeRow(node, index, depth): NodeRow
Parameters
- node: TreeNode
- index: number
- depth: number
Returns NodeRow
- Defined in packages/core/src/browser/tree/tree-widget.tsx:356

`Protected` toReactNode

toReactNode(caption, highlight): ReactNode[]
Update the node given the caption and highlight.
Parameters
- caption: string
  the caption.
- highlight: CaptionHighlight
  the tree decoration caption highlight.
Returns ReactNode[]
- Defined in packages/core/src/browser/tree/tree-widget.tsx:686

`Protected` `Readonly` toggle

toggle(event): void
Toggle the node.
Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:553

`Protected` toggleChecked

toggleChecked(event): void
Parameters
- event: MouseEvent<HTMLElement, MouseEvent>
Returns void
- Defined in packages/core/src/browser/tree/tree-widget.tsx:622

`Protected` updateGlobalSelection

updateGlobalSelection(): void
Update the global selection for the tree.

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

`Protected` updateScrollToRow

updateScrollToRow(): void
Update the scrollToRow.

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

Class TreeWidget

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TreeWidget

Properties

Protected ScrollingRowRenderer

Type declaration

rows: NodeRow[]

Protected Readonly contextMenuRenderer

Protected Readonly corePreferences

Protected decorations

Protected Readonly decoratorService

Protected Readonly focusService

Protected Readonly labelProvider

Protected lastScrollState

Type declaration

scrollLeft: number

scrollTop: number

Readonly model

Protected nodeRoot

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected Readonly preferenceService

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 treeIndent

Protected Readonly treeSearch

Protected Readonly updateDecorations

Protected updateRows

Protected view

Methods

Protected addClipboardListener

Type Parameters

Parameters

Returns void

Protected addEventListener

Type Parameters

Parameters

Returns void

Protected addKeyListener

Type Parameters

Parameters

Parameters

Returns boolean | void | Object

Returns void

Protected addUpdateListener

Type Parameters

Parameters

Returns void

Protected applyFontStyles

Parameters

Returns CSSProperties

clearFlag

Parameters

Returns void

`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

`Protected` `Readonly` preferenceService

`Readonly` props

`Protected` rows

`Protected` scheduleUpdateScrollToRow

`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` treeIndent

`Protected` `Readonly` treeSearch

`Protected` `Readonly` updateDecorations

`Protected` updateRows

`Protected` view

`Protected` addClipboardListener

`Protected` addEventListener

`Protected` addKeyListener

`Protected` addUpdateListener

`Protected` applyFontStyles

`Protected` createContainerAttributes

`Protected` createNodeAttributes

`Protected` createNodeClassNames

`Protected` createNodeStyle

`Protected` decorateCaption

`Protected` decorateIcon

`Protected` decorateNodeStyle

`Protected` deflateForStorage

`Protected` disableScrollBarFocus

`Protected` doFocus

`Protected` doHandleExpansionToggleDblClickEvent

`Protected` doRenderNodeRow

`Protected` doToggle

`Protected` doUpdateDecorations

`Protected` doUpdateRows

`Protected` getCaptionAttributes

`Protected` getCaptionChildren

`Protected` getContainerTreeNode

`Protected` getDecorationData

`Protected` getDecorations

`Protected` getDefaultNodeStyle

`Protected` getDepthForNode

`Protected` getDepthPadding

`Protected` getIconClass