Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TabBarRenderer

A tab bar renderer that offers a context menu. In addition, this renderer is able to set an explicit position and size on the icon and label of each tab in a side bar. This is necessary because the elements of side bar tabs are rotated using the CSS transform property, disrupting the browser's ability to arrange those elements automatically.

Hierarchy

  • Renderer
    • TabBarRenderer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Optional _tabBar

_tabBar?: TabBar<Widget>

Protected Optional Readonly commandService

commandService?: CommandService

Optional contextMenuPath

contextMenuPath?: MenuPath

The menu path used to render the context menu.

Protected Optional Readonly contextMenuRenderer

contextMenuRenderer?: ContextMenuRenderer

Protected Optional Readonly corePreferences

corePreferences?: CorePreferences

Protected Readonly decorations

decorations: Map<Title<Widget>, WidgetDecoration.Data[]> = ...

Protected Optional Readonly decoratorService

decoratorService?: TabBarDecoratorService

Protected Optional Readonly hoverService

hoverService?: HoverService

Protected Optional Readonly iconThemeService

iconThemeService?: IconThemeService

Protected Optional Readonly selectionService

selectionService?: SelectionService

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeOnTabBar

toDisposeOnTabBar: DisposableCollection = ...

Accessors

tabBar

  • get tabBar(): undefined | TabBar<Widget>
  • set tabBar(tabBar: undefined | TabBar<Widget>): void

Methods

createTabId

  • createTabId(title: Title<Widget>, isPartOfHiddenTabBar?: boolean): string

  • Generate ID for an entry in the tab bar

    Parameters

    • title: Title<Widget>

      Title of the widget controlled by this tab bar

    • isPartOfHiddenTabBar: boolean = false

      Tells us if this entry is part of the hidden horizontal tab bar. If yes, add a suffix to differentiate it's ID from the entry in the visible tab bar

    Returns string

    DOM element ID

createTabStyle

dispose

  • dispose(): void

findDuplicateLabels

  • findDuplicateLabels(titles: Title<Widget>[]): Map<string, string>

  • Find duplicate labels from the currently opened tabs in the tab bar. Return the appropriate partial paths that can distinguish the identical labels.

    E.g., a/p/index.ts => a/..., b/p/index.ts => b/...

    To prevent excessively long path displayed, show at maximum three levels from the end by default.

    Parameters

    • titles: Title<Widget>[]

      Array of titles in the current tab bar.

    Returns Map<string, string>

    A map from each tab's original path to its displayed partial path.

Protected getDecorationData

Protected getDecorations

Private getIconClass

  • getIconClass(iconName: string | string[], additionalClasses?: string[]): string

Protected handleCloseClickEvent

  • handleCloseClickEvent(event: MouseEvent): void

Protected handleContextMenuEvent

  • handleContextMenuEvent(event: MouseEvent): void

Protected handleDblClickEvent

  • handleDblClickEvent(event: MouseEvent): void

Protected handleMouseEnterEvent

  • handleMouseEnterEvent(event: MouseEvent): void

renderBadge

Protected renderEnhancedPreview

  • renderEnhancedPreview(title: Title<Widget>): HTMLDivElement

renderIcon

  • If size information is available for the icon, set it as inline style. Tab padding is also considered in the top position.

    Parameters

    • data: SideBarRenderData

      Data used to render the tab icon.

    • Optional isInSidePanel: boolean

      An optional check which determines if the tab is in the side-panel.

    Returns VirtualElement

renderLabel

  • If size information is available for the label, set it as inline style. Tab padding and icon size are also considered in the top position.

    Parameters

    • data: SideBarRenderData

      Data used to render the tab.

    • Optional isInSidePanel: boolean

      An optional check which determines if the tab is in the side-panel.

    Returns VirtualElement

    The virtual element of the rendered label.

renderLock

renderTab

  • renderTab(data: SideBarRenderData, isInSidePanel?: boolean, isPartOfHiddenTabBar?: boolean): VirtualElement

  • Render tabs with the default DOM structure, but additionally register a context menu listener.

    Parameters

    • data: SideBarRenderData

      Data used to render the tab.

    • Optional isInSidePanel: boolean

      An optional check which determines if the tab is in the side-panel.

    • Optional isPartOfHiddenTabBar: boolean

      An optional check which determines if the tab is in the hidden horizontal tab bar.

    Returns VirtualElement

    The virtual element of the rendered tab.

Protected resetDecorations

  • resetDecorations(title?: Title<Widget>): void