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

    Class TabPanel

    A widget which combines a TabBar and a StackedPanel.

    This is a simple panel which handles the common case of a tab bar placed next to a content area. The selected tab controls the widget which is shown in the content area.

    For use cases which require more control than is provided by this panel, the TabBar widget may be used independently.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    node stackedPanel tabBar

    Accessors

    addButtonEnabled addRequested currentChanged currentIndex currentWidget dataset disposed hiddenMode id isAttached isDisposed isHidden isVisible layout parent tabPlacement tabsMovable title widgets

    Methods

    activate addClass addWidget children clearFlag close contains dispose fit hasClass hide insertWidget notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest processMessage removeClass setFlag setHidden show testFlag toggleClass update

    Constructors

    Properties

    node: HTMLElement

    Get the DOM node owned by the widget.

    stackedPanel: StackedPanel

    The stacked panel used by the tab panel.

    Modifying the panel directly can lead to undefined behavior.

    tabBar: TabBar<Widget>

    The tab bar used by the tab panel.

    Modifying the tab bar directly can lead to undefined behavior.

    Accessors

    • get addButtonEnabled(): boolean

      Get the whether the add button is enabled.

      Returns boolean

    • set addButtonEnabled(value: boolean): void

      Set the whether the add button is enabled.

      Parameters

      • value: boolean

      Returns void

    • get addRequested(): ISignal<this, TabBar<Widget>>

      A signal emitted when the add button on a tab bar is clicked.

      Returns ISignal<this, TabBar<Widget>>

    • get currentChanged(): ISignal<this, TabPanel.ICurrentChangedArgs>

      A signal emitted when the current tab is changed.

      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, TabPanel.ICurrentChangedArgs>

    • get currentIndex(): number

      Get the index of the currently selected tab.

      This will be -1 if no tab is selected.

      Returns number

    • set currentIndex(value: number): void

      Set the index of the currently selected tab.

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

      Parameters

      • value: number

      Returns void

    • get currentWidget(): null | Widget

      Get the currently selected widget.

      This will be null if there is no selected tab.

      Returns null | Widget

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

      Set the currently selected widget.

      If the widget is not in the panel, it will be set to null.

      Parameters

      Returns void

    • 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 tabPlacement(): TabPlacement

      Get the tab placement for the tab panel.

      This controls the position of the tab bar relative to the content.

      Returns TabPlacement

    • set tabPlacement(value: TabPlacement): void

      Set the tab placement for the tab panel.

      This controls the position of the tab bar relative to the content.

      Parameters

      Returns void

    • get tabsMovable(): boolean

      Get the whether the tabs are movable by the user.

      Tabs can always be moved programmatically.

      Returns boolean

    • set tabsMovable(value: boolean): void

      Set the whether the tabs are movable by the user.

      Tabs can always be moved programmatically.

      Parameters

      • value: boolean

      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>

    • get widgets(): readonly Widget[]

      A read-only array of the widgets in the panel.

      Returns readonly 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

    • Add a widget to the end of the tab panel.

      Parameters

      • widget: Widget

        The widget to add to the tab panel.

        If the widget is already contained in the panel, it will be moved.

        The widget's title is used to populate the tab.

      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.

    • Clear the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

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

    • Dispose of the widget and its descendant widgets.

      It is unsafe to use the widget after it has been disposed.

      All calls made to this method after the first are a no-op.

      Returns void

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

      This is a simple convenience method for posting the message.

      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.

      This causes the isHidden property to be true.

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

      Returns void

    • Insert a widget into the tab panel at a specified index.

      Parameters

      • index: number

        The index at which to insert the widget.

      • widget: Widget

        The widget to insert into to the tab panel.

        If the widget is already contained in the panel, it will be moved.

        The widget's title is used to populate the tab.

      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 'activate-request' message.

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

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

      Parameters

      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-attach' message.

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

      Parameters

      Returns void

    • A message handler invoked on a 'before-detach' 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 'close-request' message.

      The default implementation unparents or detaches the widget.

      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

    • A message handler invoked on a 'resize' message.

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

      Parameters

      Returns void

    • A message handler invoked on an 'update-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

    • Set the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      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

    Settings

    Member Visibility

    On This Page

    Notes
    Constructors
    Properties
    Accessors
    Methods