Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TreeWidget

Hierarchy

Implements

Index

Classes

Interfaces

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

Protected Readonly corePreferences

corePreferences: CorePreferences

Readonly dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

Protected decorations

decorations: Map<string, TreeDecoration.Data[]> = new Map()

Protected Readonly decoratorService

decoratorService: TreeDecoratorService

Readonly disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

id

id: string

Set the id of the widget's DOM node.

Readonly isAttached

isAttached: boolean

Test whether the widget's node is attached to the DOM.

Readonly isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

Readonly isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

Readonly isVisible

isVisible: boolean

Test whether the widget is visible.

Notes

A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

Protected Readonly labelProvider

labelProvider: LabelProvider

Protected lastScrollState

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

Store the last scroll state.

layout

layout: Layout | null

Set the layout for the widget.

Notes

The layout is single-use only. It cannot be changed after the first assignment.

The layout is disposed automatically when the widget is disposed.

Readonly model

model: TreeModel

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = this.onDidChangeVisibilityEmitter.event

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = new Emitter<boolean>()

Readonly onDidDispose

onDidDispose: Event<void> = this.onDidDisposeEmitter.event

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = new Emitter<void>()

Protected Readonly onRender

onRender: DisposableCollection = new DisposableCollection()

Readonly onScrollUp

onScrollUp: Event<void> = this.onScrollUpEmitter.event

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = new Emitter<void>()

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = this.onScrollYReachEndEmitter.event

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = new Emitter<void>()

parent

parent: Widget | null

Set the parent of the widget.

Notes

Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

The widget will be automatically removed from its old parent.

This is a no-op if there is no effective parent change.

Readonly props

props: TreeProps

Protected rows

rows: Map<string, NodeRow> = new Map<string, TreeWidget.NodeRow>()

scrollArea

scrollArea: Element = this.node

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: PerfectScrollbar.Options

Protected scrollToRow

scrollToRow: number | undefined

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, TreeDecoration.CaptionHighlight>

Protected Readonly selectionService

selectionService: SelectionService

Protected shouldScrollToRow

shouldScrollToRow: boolean = true

Readonly title

title: Title<Widget>

The title object for the widget.

Notes

The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

Since not all widgets will use the title, it is created on demand.

The owner property of the title is set to this widget.

Protected Readonly toDispose

toDispose: DisposableCollection = new DisposableCollection(this.onDidDisposeEmitter,Disposable.create(() => this.onDidDisposeEmitter.fire()),this.onScrollYReachEndEmitter,this.onScrollUpEmitter,this.onDidChangeVisibilityEmitter)

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = new DisposableCollection()

Protected Readonly treeSearch

treeSearch: TreeSearch

Protected Readonly updateDecorations

updateDecorations: any = debounce(() => this.doUpdateDecorations(), 150)

Update tree decorations.

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

Protected updateRows

updateRows: any = debounce(() => this.doUpdateRows(), 10)

Protected view

view: View | undefined

Methods

activate

  • activate(): void
  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): void
  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

Protected addClipboardListener

Protected addEventListener

Protected addKeyListener

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

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: undefined | false | true): void

Protected applyFontStyles

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

children

  • children(): IIterator<Widget>
  • Create an iterator over the widget's children.

    Returns IIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • clearFlag(flag: Flag): void

close

  • close(): void
  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean
  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

Protected createContainerAttributes

  • createContainerAttributes(): HTMLAttributes<HTMLElement>

Protected createNodeAttributes

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

Protected createNodeClassNames

Protected createNodeStyle

Protected decorateCaption

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

Protected decorateIcon

  • decorateIcon(node: TreeNode, icon: React.ReactNode | null): React.ReactNode

Protected decorateNodeStyle

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

Protected deflateForStorage

  • deflateForStorage(node: TreeNode): object

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

dispose

  • dispose(): void

Protected doFocus

  • doFocus(): void

Protected doRenderNodeRow

  • doRenderNodeRow(__namedParameters: { depth: number; index: number; node: TreeNode }): React.ReactNode

Protected doToggle

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

Protected doUpdateDecorations

  • doUpdateDecorations(): Promise<void>

Protected doUpdateRows

  • doUpdateRows(): void

fit

  • fit(): void
  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Protected forceUpdate

  • forceUpdate(__namedParameters?: { resize: boolean }): void

Protected getContainerTreeNode

  • getContainerTreeNode(): TreeNode | undefined

Protected getDecorationData

  • getDecorationData<K>(node: TreeNode, key: K): TreeDecoration.Data[K][]
  • Get the tree decoration data for the given key.

    Type parameters

    • K: keyof TreeDecoration.Data

    Parameters

    • node: TreeNode

      the tree node.

    • key: K

      the tree decoration data key.

    Returns TreeDecoration.Data[K][]

    the tree decoration data at the given key.

Protected getDecorations

  • getDecorations(node: TreeNode): TreeDecoration.Data[]

Protected getDefaultNodeStyle

Private getIconClass

  • getIconClass(iconName: string | string[], additionalClasses?: string[]): string
  • Determine the classes to use for an icon

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

    Parameters

    • iconName: string | string[]

      the icon name or list of icon names.

    • Default value additionalClasses: string[] = []

      additional CSS classes.

    Returns string

    the icon class name.

Protected getNodeToFocus

Protected getPaddingLeft

Protected getScrollContainer

Protected getScrollToRow

  • getScrollToRow(): number | undefined

Protected handleClickEvent

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

Protected handleContextMenuEvent

  • handleContextMenuEvent(node: TreeNode | undefined, event: MouseEvent<HTMLElement>): void
  • Handle the context menu click event.

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

    Parameters

    • node: TreeNode | undefined

      the tree node if available.

    • event: MouseEvent<HTMLElement>

      the right-click mouse event.

    Returns void

Protected handleDblClickEvent

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

Protected handleDown

  • handleDown(event: KeyboardEvent): void

Protected handleEnter

  • handleEnter(event: KeyboardEvent): void

Protected handleLeft

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

Protected handleRight

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

Protected Readonly handleScroll

  • handleScroll(info: ScrollParams): void

Protected handleUp

  • handleUp(event: KeyboardEvent): void

hasClass

  • hasClass(name: string): boolean
  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

Protected hasCtrlCmdMask

Protected hasShiftMask

Protected hasTrailingSuffixes

  • hasTrailingSuffixes(node: TreeNode): boolean

hide

  • hide(): void
  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

Protected inflateFromStorage

Protected init

  • init(): void

Protected isExpandable

  • isExpandable(node: TreeNode): node is ExpandableTreeNode

Protected needsActiveIndentGuideline

  • needsActiveIndentGuideline(node: TreeNode): boolean

Protected needsExpansionTogglePadding

  • needsExpansionTogglePadding(node: TreeNode): boolean

Protected notifyLayout

  • notifyLayout(msg: Message): void
  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onAfterHide

  • onAfterHide(msg: Message): void
  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • onAfterShow(msg: Message): void
  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void
  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void
  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    Returns void

Protected onChildRemoved

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onFitRequest

  • onFitRequest(msg: Message): void
  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onResize

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

processMessage

  • processMessage(msg: Message): void
  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

removeClass

  • removeClass(name: string): void
  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

Protected render

  • render(): React.ReactNode

Protected renderCaption

Protected renderCaptionAffixes

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

Protected renderExpansionToggle

Protected renderIcon

Protected renderIndent

Protected renderNode

Protected Readonly renderNodeRow

  • renderNodeRow(row: NodeRow): undefined | null | string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement<any, any> | null) | {}> | ReactNodeArray | ReactPortal

Protected renderTailDecorations

Protected renderTree

  • renderTree(model: TreeModel): React.ReactNode

restoreState

  • restoreState(oldState: object): void

Protected scrollToSelected

  • scrollToSelected(): void

setFlag

  • setFlag(flag: Flag): void

setHidden

  • setHidden(hidden: boolean): void
  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

Protected shouldDisplayNode

  • shouldDisplayNode(node: TreeNode): boolean

show

  • show(): void
  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

storeState

  • storeState(): object

testFlag

  • testFlag(flag: Flag): boolean
  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    Returns boolean

Protected toContextMenuArgs

Protected toNodeDescription

  • toNodeDescription(node: TreeNode): string

Protected toNodeIcon

Protected toNodeName

Protected toReactNode

  • toReactNode(caption: string, highlight: TreeDecoration.CaptionHighlight): React.ReactNode[]
  • Update the node given the caption and highlight.

    Parameters

    • caption: string

      the caption.

    • highlight: TreeDecoration.CaptionHighlight

      the tree decoration caption highlight.

    Returns React.ReactNode[]

Protected Readonly toggle

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

toggleClass

  • toggleClass(name: string, force?: undefined | false | true): boolean
  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: undefined | false | true

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • update(): void
  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Protected updateGlobalSelection

  • updateGlobalSelection(): void

Protected updateScrollToRow