Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Properties

ScrollingRowRenderer: FC<{ rows: NodeRow[] }> = ...
contextMenuRenderer: ContextMenuRenderer
corePreferences: CorePreferences
decorations: Map<string, WidgetDecoration.Data[]> = ...
decoratorService: TreeDecoratorService
focusService: TreeFocusService
labelProvider: LabelProvider
lastScrollState: undefined | { scrollLeft: number; scrollTop: number }

Store the last scroll state.

model: TreeModel
nodeRoot: Root
onDidChangeVisibility: Event<boolean> = ...
onDidChangeVisibilityEmitter: Emitter<boolean> = ...
onDidDispose: Event<void> = ...
onDidDisposeEmitter: Emitter<void> = ...
onScrollUp: Event<void> = ...
onScrollUpEmitter: Emitter<void> = ...
onScrollYReachEnd: Event<void> = ...
onScrollYReachEndEmitter: Emitter<void> = ...
props: TreeProps
rows: Map<string, NodeRow> = ...
scheduleUpdateScrollToRow: any = ...
scrollArea: Element = ...
scrollBar?: PerfectScrollbar
scrollOptions?: Options
scrollToRow: undefined | number

Row index to ensure visibility.

  • Used to forcefully scroll if necessary.
searchBox: SearchBox
searchBoxFactory: SearchBoxFactory
searchHighlights: Map<string, CaptionHighlight>
selectionService: SelectionService
shouldScrollToRow: boolean = true
toDispose: DisposableCollection = ...
toDisposeOnDetach: DisposableCollection = ...
treeSearch: TreeSearch
updateDecorations: any = ...

Update tree decorations.

  • Updating decorations are debounced in order to limit the number of expensive updates.
updateRows: any = ...
view: undefined | TreeWidget.View

Methods

  • addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes, action: ((event: KeyboardEvent) => boolean | void | Object), ...additionalEventTypes: K[]): void
  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void
  • applyFontStyles(original: CSSProperties, fontData: undefined | FontData): CSSProperties
  • clearFlag(flag: Flag): void
  • createContainerAttributes(): HTMLAttributes<HTMLElement>
  • createNodeAttributes(node: TreeNode, props: NodeProps): Attributes & HTMLAttributes<HTMLElement>
  • decorateCaption(node: TreeNode, attrs: HTMLAttributes<HTMLElement>): Attributes & HTMLAttributes<HTMLElement>
  • decorateIcon(node: TreeNode, icon: ReactNode): ReactNode
  • decorateNodeStyle(node: TreeNode, style: undefined | CSSProperties): undefined | CSSProperties
  • deflateForStorage(node: TreeNode): object
  • disableScrollBarFocus(scrollContainer: HTMLElement): void
  • dispose(): void
  • doFocus(): void
  • doHandleExpansionToggleDblClickEvent(event: MouseEvent<HTMLElement, MouseEvent>): void
  • doRenderNodeRow(__namedParameters: NodeRow): ReactNode
  • doToggle(event: MouseEvent<HTMLElement, MouseEvent>): void
  • doUpdateDecorations(): Promise<void>
  • doUpdateRows(): void
  • getCaptionAttributes(node: TreeNode, props: NodeProps): Attributes & HTMLAttributes<HTMLElement>
  • getContainerTreeNode(): undefined | TreeNode
  • getDepthPadding(depth: number): number
  • 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.

    • additionalClasses: string[] = []

      additional CSS classes.

    Returns string

    the icon class name.

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

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

    Parameters

    • node: undefined | TreeNode

      the tree node if available.

    • event: MouseEvent<HTMLElement, MouseEvent>

      the right-click mouse event.

    Returns void

  • handleDblClickEvent(node: undefined | TreeNode, event: MouseEvent<HTMLElement, MouseEvent>): void
  • handleDown(event: KeyboardEvent): void
  • handleEnter(event: KeyboardEvent): void
  • handleEscape(event: KeyboardEvent): void
  • handleExpansionToggleDblClickEvent(event: MouseEvent<HTMLElement, MouseEvent>): void
  • handleLeft(event: KeyboardEvent): Promise<void>
  • handleRight(event: KeyboardEvent): Promise<void>
  • handleSpace(event: KeyboardEvent): void
  • handleUp(event: KeyboardEvent): void
  • hasTrailingSuffixes(node: TreeNode): boolean
  • init(): void
  • needsActiveIndentGuideline(node: TreeNode): boolean
  • needsExpansionTogglePadding(node: TreeNode): boolean
  • onActivateRequest(msg: Message): void
  • onAfterAttach(msg: Message): void
  • onAfterDetach(msg: Message): void
  • onBeforeAttach(msg: Message): void
  • onBeforeDetach(msg: Message): void
  • onCloseRequest(msg: Message): void
  • onResize(msg: ResizeMessage): void
  • onUpdateRequest(msg: Message): void
  • render(): ReactNode
  • renderCaptionAffixes(node: TreeNode, props: NodeProps, affixKey: "captionPrefixes" | "captionSuffixes"): ReactNode
  • renderNodeRow(row: NodeRow): ReactNode
  • restoreState(oldState: object): void
  • scrollToSelected(): void
  • setFlag(flag: Flag): void
  • shouldDisplayNode(node: TreeNode): boolean
  • storeState(): object
  • toNodeDescription(node: TreeNode): string
  • toggle(event: MouseEvent<HTMLElement, MouseEvent>): void
  • updateGlobalSelection(): void
  • updateScrollToRow(): void