Class TreeViewWelcomeWidget

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

Hierarchy (view full)

Constructors

Properties

Accessors

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 getLinkClassName getNodeToFocus getPaddingLeft getPreviewNode getScrollContainer getScrollToRow handleAuxClickEvent handleClickEvent handleContextMenuEvent handleDblClickEvent handleDown handleEnter handleEscape handleExpansionToggleDblClickEvent handleLeft handleMiddleClickEvent handleRight handleSpace handleUp handleViewWelcomeContentChange handleWelcomeContextChange hasCtrlCmdMask hasShiftMask hasTrailingSuffixes inflateFromStorage init isEnabledClick isExpandable needsActiveIndentGuideline needsExpansionTogglePadding onActivateRequest onAfterAttach onAfterDetach onBeforeAttach onBeforeDetach onCloseRequest onResize onUpdateRequest openLinkOrCommand parseLinkedText render renderButtonNode renderCaption renderCaptionAffixes renderCheckbox renderExpansionToggle renderIcon renderIndent renderLinkNode renderNode renderNodeRow renderTailDecorations renderTailDecorationsForNode renderTextNode renderTree renderViewWelcome restoreState rowIsSelected scrollToSelected setFlag shouldDisplayNode shouldRenderIndent shouldShowWelcomeView storeState tapNode toContextMenuArgs toNodeDescription toNodeIcon toNodeName toNodeRow toReactNode toggle toggleChecked updateGlobalSelection updateScrollToRow updateViewWelcomeNodes

Constructors

Properties

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

Type declaration

commands: CommandRegistry
contextMenuRenderer: ContextMenuRenderer
contextService: ContextKeyService
corePreferences: CorePreferences
decorations: Map<string, core.Data[]> = ...
decoratorService: TreeDecoratorService
defaultItem: undefined | IItem
focusService: TreeFocusService
items: IItem[] = []
labelParser: LabelParser
labelProvider: LabelProvider
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.

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> = ...
openerService: OpenerService
preferenceService: PreferenceService
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 = ...
toDisposeBeforeUpdateViewWelcomeNodes: DisposableCollection = ...
toDisposeOnDetach: DisposableCollection = ...
treeIndent: number = 8
treeSearch: TreeSearch
updateDecorations: any = ...

Update tree decorations.

  • Updating decorations are debounced in order to limit the number of expensive updates.
updateRows: any = ...
view: undefined | core.View
viewWelcomeNodes: ReactNode[] = []
windowService: WindowService

Accessors

Methods

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