Class TabBar<T>

A widget which displays titles as a single row or column of tabs.

Notes

If CSS transforms are used to rotate nodes for vertically oriented text, then tab dragging will not work correctly. The tabsMovable property should be set to false when rotating nodes from CSS.

Type Parameters

  • T

Hierarchy (view full)

Constructors

Properties

_addButtonEnabled: boolean = false
_addRequested: Signal<TabBar<T>, void> = ...
_currentChanged: Signal<TabBar<T>, TabBar.ICurrentChangedArgs<T>> = ...
_currentIndex: number = -1
_document: Document | ShadowRoot
_dragData: null | IDragData = null
_name: string
_orientation: TabBar.Orientation
_previousTitle: null | Title<T> = null
_tabActivateRequested: Signal<TabBar<T>, ITabActivateRequestedArgs<T>> = ...
_tabCloseRequested: Signal<TabBar<T>, ITabCloseRequestedArgs<T>> = ...
_tabDetachRequested: Signal<TabBar<T>, ITabDetachRequestedArgs<T>> = ...
_tabMoved: Signal<TabBar<T>, ITabMovedArgs<T>> = ...
_titles: Title<T>[] = []
_titlesEditable: boolean = false
allowDeselect: boolean

Whether a tab can be deselected by the user.

Notes

Tabs can be always be deselected programmatically.

insertBehavior: InsertBehavior

The selection behavior when inserting a tab.

Get the DOM node owned by the widget.

removeBehavior: RemoveBehavior

The selection behavior when removing a tab.

renderer: TabBar.IRenderer<T>

The renderer used by the tab bar.

tabsMovable: boolean

Whether the tabs are movable by the user.

Notes

Tabs can always be moved programmatically.

Accessors

  • get addButtonEnabled(): boolean
  • Whether the add button is enabled.

    Returns boolean

  • set addButtonEnabled(value): void
  • Set whether the add button is enabled.

    Parameters

    • value: boolean

    Returns void

  • get currentChanged(): ISignal<this, TabBar.ICurrentChangedArgs<T>>
  • A signal emitted when the current tab is changed.

    Notes

    This signal is emitted when the currently selected tab is changed either through user or programmatic interaction.

    Notably, this signal is not emitted when the index of the current tab changes due to tabs being inserted, removed, or moved. It is only emitted when the actual current tab node is changed.

    Returns ISignal<this, TabBar.ICurrentChangedArgs<T>>

  • get currentIndex(): number
  • Get the index of the currently selected tab.

    Notes

    This will be -1 if no tab is selected.

    Returns number

  • set currentIndex(value): void
  • Set the index of the currently selected tab.

    Notes

    If the value is out of range, the index will be set to -1.

    Parameters

    • value: number

    Returns void

  • get id(): string
  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): 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.

    Notes

    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): void
  • 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.

    Parameters

    Returns void

  • get parent(): null | Widget
  • Get the parent of the widget.

    Returns null | Widget

  • set parent(value): void
  • 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.

    Parameters

    Returns void

  • get tabDetachRequested(): ISignal<this, ITabDetachRequestedArgs<T>>
  • A signal emitted when a tab is dragged beyond the detach threshold.

    Notes

    This signal is emitted when the user drags a tab with the mouse, and mouse is dragged beyond the detach threshold.

    The consumer of the signal should call releaseMouse and remove the tab in order to complete the detach.

    This signal is only emitted once per drag cycle.

    Returns ISignal<this, ITabDetachRequestedArgs<T>>

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

    Returns Title<Widget>

  • get titlesEditable(): boolean
  • Whether the titles can be user-edited.

    Returns boolean

  • set titlesEditable(value): void
  • Set whether titles can be user edited.

    Parameters

    • value: boolean

    Returns void

Methods

  • Adjust the current index for a tab insert operation.

    This method accounts for the tab bar's insertion behavior when adjusting the current index and emitting the changed signal.

    Parameters

    Returns void

  • Adjust the current index for a tab move operation.

    This method will not cause the actual current tab to change. It silently adjusts the index to account for the given move.

    Parameters

    • i: number
    • j: number

    Returns void

  • Adjust the current index for a tab remove operation.

    This method accounts for the tab bar's remove behavior when adjusting the current index and emitting the changed signal.

    Parameters

    Returns void

  • Get the index of the tab which handles tabindex="0". If the add button handles tabindex="0", -1 is returned. If none of the previous handles tabindex="0", null is returned.

    Returns null | number

  • Release the mouse and restore the non-dragged tab positions.

    Returns 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

  • Add a tab to the end of the tab bar.

    Parameters

    • value: Title<T> | Title.IOptions<T>

      The title which holds the data for the tab, or an options object to convert to a title.

    Returns Title<T>

    The title object added to the tab bar.

    Notes

    If the title is already added to the tab bar, it will be moved.

  • Create an iterator over the widget's children.

    Returns IterableIterator<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.

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

  • Handle the DOM events for the tab bar.

    Parameters

    • event: Event

      The DOM event sent to the tab bar.

      Notes

      This method implements the DOM EventListener interface and is called in response to events on the tab bar's DOM node.

      This should not be called directly by user code.

    Returns void

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

    Notes

    This causes the isHidden property to be true.

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

    Returns void

  • Insert a tab into the tab bar at the specified index.

    Parameters

    • index: number

      The index at which to insert the tab.

    • value: Title<T> | Title.IOptions<T>

      The title which holds the data for the tab, or an options object to convert to a title.

    Returns Title<T>

    The title object added to the tab bar.

    Notes

    The index will be clamped to the bounds of the tabs.

    If the title is already added to the tab bar, it will be moved.

  • 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

  • Release the mouse and restore the non-dragged tab positions.

    Notes

    This will cause the tab bar to stop handling mouse events and to restore the tabs to their non-dragged positions.

    Returns 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

  • Remove a tab from the tab bar.

    Parameters

    • title: Title<T>

      The title for the tab to remove.

      Notes

      This is a no-op if the title is not in the tab bar.

    Returns void

  • Remove the tab at a given index from the tab bar.

    Parameters

    • index: number

      The index of the tab to remove.

      Notes

      This is a no-op if the index is out of range.

    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.

      Notes

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

    Returns 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

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

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: 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.

    Notes

    The class name must not contain whitespace.