Theia API Documentation v1.65.0
    Preparing search index...

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

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Accessors

    Methods

    activate addClass addClipboardListener addEventListener addKeyListener addUpdateListener applyFontStyles children clearFlag close contains createContainerAttributes createNodeAttributes createNodeClassNames createNodeStyle decorateCaption decorateIcon decorateNodeStyle deflateForStorage disableScrollBarFocus dispose doFocus doHandleExpansionToggleDblClickEvent doRenderNodeRow doToggle doUpdateDecorations doUpdateRows fit getCaptionAttributes getCaptionChildEventHandlers getCaptionChildren getContainerTreeNode getDecorationData getDecorations getDefaultNodeStyle getDepthForNode getDepthPadding getIconClass getLinkClassName getNodeToFocus getPaddingLeft getPreviewNode getScrollContainer getScrollToRow getSeparatorContent getVirtualizedScrollState handleAuxClickEvent handleClickEvent handleContextMenuEvent handleDblClickEvent handleDown handleEnter handleEscape handleExpansionToggleDblClickEvent handleGlobalSelectionOnDisposal handleGlobalSelectionOnFocusIn handleGlobalSelectionOnFocusServiceFocusChange handleGlobalSelectionOnModelSelectionChange handleLeft handleMiddleClickEvent handleRight handleSpace handleUp handleViewWelcomeContentChange handleVisiblityChanged handleWelcomeContextChange hasClass hasCtrlCmdMask hasShiftMask hasTrailingSuffixes hide inflateFromStorage init isEnabledClick isExpandable isScrolledToBottom needsActiveIndentGuideline needsExpansionTogglePadding notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest openLinkOrCommand parseLinkedText processMessage registerGlobalSelectionHandlers removeClass render renderButtonNode renderCaption renderCaptionAffixes renderCheckbox renderExpansionToggle renderIcon renderIndent renderLinkNode renderNode renderNodeRow renderTailDecorations renderTailDecorationsForNode renderTextNode renderTree renderViewWelcome restoreState rowIsSelected scrollToSelected setFlag setHidden shouldDisplayNode shouldRenderIndent shouldShowWelcomeView shouldUpdateGlobalSelection show storeState tapNode testFlag toContextMenuArgs toggle toggleChecked toggleClass toggleCompression toNodeDescription toNodeIcon toNodeName toNodeRow toReactNode update updateGlobalSelection updateScrollToRow updateViewWelcomeNodes

    Constructors

    Properties

    commands: CommandRegistry
    compressionService: TreeCompressionService
    compressionToggle: CompressionToggle
    contextMenuRenderer: ContextMenuRenderer
    contextService: ContextKeyService
    corePreferences: CorePreferences
    decorations: Map<string, WidgetDecoration.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

    • undefined
    • { scrollLeft: number; scrollTop: number }
      • scrollLeft: number

        The scroll left value.

      • scrollTop: number

        The scroll top value.

    node: HTMLElement

    Get the DOM node owned by the widget.

    nodeRoot: Root
    onDidChangeVisibility: Event<boolean> = ...
    onDidChangeVisibilityEmitter: Emitter<boolean> = ...
    onDidDispose: Event<void> = ...
    onDidDisposeEmitter: Emitter<void> = ...
    onScroll: Event<TreeScrollEvent> = ...
    onScrollEmitter: Emitter<TreeScrollEvent> = ...
    onScrollUp: Event<void> = ...
    onScrollUpEmitter: Emitter<void> = ...
    onScrollYReachEnd: Event<void> = ...
    onScrollYReachEndEmitter: Emitter<void> = ...
    openerService: OpenerService
    preferenceService: PreferenceService
    props: TreeProps
    rows: Map<string, CompressedNodeRow> = ...
    scheduleUpdateScrollToRow: any = ...
    scrollArea: Element = ...
    scrollBar?: PerfectScrollbar
    ScrollingRowRenderer: FC<{ rows: NodeRow[] }> = ...
    scrollOptions?: Options
    scrollToRow: undefined | number

    Row index to ensure visibility.

    • Used to forcefully scroll if necessary.
    searchBox: SearchBox
    searchBoxFactory: SearchBoxFactory
    searchHighlights: Map<string, WidgetDecoration.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 | TreeWidget.View
    viewWelcomeNodes: ReactNode[] = []
    windowService: WindowService

    Accessors

    • get dataset(): DOMStringMap

      The dataset for the widget's DOM node.

      Returns DOMStringMap

    • get disposed(): ISignal<this, void>

      A signal emitted when the widget is disposed.

      Returns ISignal<this, void>

    • get hiddenMode(): HiddenMode

      Get the method for hiding the widget.

      Returns HiddenMode

    • set hiddenMode(value: HiddenMode): void

      Set the method for hiding the widget.

      Parameters

      Returns void

    • get id(): string

      Get the id of the widget's DOM node.

      Returns string

    • set id(value: string): void

      Set the id of the widget's DOM node.

      Parameters

      • value: string

      Returns void

    • get isAttached(): boolean

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

      Returns boolean

    • get isDisposed(): boolean

      Test whether the widget has been disposed.

      Returns boolean

    • get isHidden(): boolean

      Test whether the widget is explicitly hidden.

      Returns boolean

    • get isVisible(): boolean

      Test whether the widget is visible.

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

      Returns boolean

    • get layout(): null | Layout

      Get the layout for the widget.

      Returns null | Layout

    • set layout(value: null | Layout): void

      Set the layout for the widget.

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

      The layout is disposed automatically when the widget is disposed.

      Parameters

      Returns void

    • get parent(): null | Widget

      Get the parent of the widget.

      Returns null | Widget

    • set parent(value: null | Widget): void

      Set the parent of the widget.

      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.

      Parameters

      Returns void

    • get title(): Title<Widget>

      The title object for the widget.

      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.

      Returns Title<Widget>

    Methods

    • Post an 'activate-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Add a class name to the widget's DOM node.

      Parameters

      • name: string

        The class name to add to the node.

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

        The class name must not contain whitespace.

      Returns void

    • Create an iterator over the widget's children.

      Returns IterableIterator<Widget>

      A new iterator over the children of the widget.

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

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

    • Send a 'close-request' message to the widget.

      This is a simple convenience method for sending the message.

      Returns void

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

    • Post a 'fit-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

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

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

    • Hide the widget and make it hidden to its parent widget.

      This causes the isHidden property to be true.

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

      Returns void

    • Invoke the message processing routine of the widget's layout.

      Parameters

      • msg: Message

        The message to dispatch to the layout.

        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

    • A message handler invoked on an 'after-hide' message.

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

      Parameters

      Returns void

    • A message handler invoked on an 'after-show' message.

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

      Parameters

      Returns void

    • A message handler invoked on a 'before-hide' message.

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

      Parameters

      Returns void

    • A message handler invoked on a 'before-show' message.

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

    • A message handler invoked on a 'fit-request' message.

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

      Parameters

      Returns void

    • Process a message sent to the widget.

      Parameters

      • msg: Message

        The message sent to the widget.

        Subclasses may reimplement this method as needed.

      Returns void

    • Remove a class name from the widget's DOM node.

      Parameters

      • name: string

        The class name to remove from the node.

        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

    • Show or hide the widget according to a boolean value.

      Parameters

      • hidden: boolean

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

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

      Returns void

    • Show the widget and make it visible to its parent widget.

      This causes the isHidden property to be false.

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

      Returns void

    • Test whether the given widget flag is set.

      This will not typically be called directly by user code.

      Parameters

      Returns boolean

    • Toggle a class name on the widget's DOM node.

      Parameters

      • name: string

        The class name to toggle on the node.

      • Optionalforce: boolean

        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.

      The class name must not contain whitespace.

    • Post an 'update-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void