Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TabPanel

A widget which combines a TabBar and a StackedPanel. The namespace for the TabPanel class statics.

Notes

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

Implements

  • IDisposable
  • IMessageHandler

Index

Modules

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static TabPlacement

TabPlacement: "left" | "right" | "top" | "bottom"

A type alias for tab placement in a tab bar.

Constructors

constructor

Properties

Private _currentChanged

_currentChanged: Signal<this, ICurrentChangedArgs> = new Signal<this, TabPanel.ICurrentChangedArgs>(this)

Private _tabPlacement

_tabPlacement: TabPlacement

node

node: HTMLElement

Get the DOM node owned by the widget.

stackedPanel

stackedPanel: StackedPanel

The stacked panel used by the tab panel.

Notes

Modifying the panel directly can lead to undefined behavior.

tabBar

tabBar: TabBar<Widget>

The tab bar used by the tab panel.

Notes

Modifying the tab bar directly can lead to undefined behavior.

Accessors

currentChanged

  • 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, ICurrentChangedArgs>

currentIndex

  • get currentIndex(): number
  • set currentIndex(value: number): void

  • Get the index of the currently selected tab.

    Notes

    This will be -1 if no tab is selected.

    Returns number

  • Set the index of the currently selected tab.

    Notes

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

    Parameters

    • value: number

    Returns void

currentWidget

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

  • Get the currently selected widget.

    Notes

    This will be null if there is no selected tab.

    Returns Widget | null

  • Set the currently selected widget.

    Notes

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

    Parameters

    Returns void

dataset

  • get dataset(): DOMStringMap

disposed

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

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

id

  • get id(): string
  • set id(value: string): void

  • Get the id of the widget's DOM node.

    Returns string

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

isDisposed

  • get isDisposed(): boolean

isHidden

  • get isHidden(): boolean

isVisible

  • 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

layout

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

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

    Returns Layout | null

  • 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

parent

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

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

    Returns Widget | null

  • 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

tabPlacement

  • Get the tab placement for the tab panel.

    Notes

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

    Returns TabPlacement

  • Set the tab placement for the tab panel.

    Notes

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

    Parameters

    Returns void

tabsMovable

  • get tabsMovable(): boolean
  • set tabsMovable(value: boolean): void

  • Get the whether the tabs are movable by the user.

    Notes

    Tabs can always be moved programmatically.

    Returns boolean

  • Set the whether the tabs are movable by the user.

    Notes

    Tabs can always be moved programmatically.

    Parameters

    • value: boolean

    Returns void

title

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

widgets

  • get widgets(): ReadonlyArray<Widget>

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

    Returns ReadonlyArray<Widget>

Methods

Private _onCurrentChanged

Private _onTabActivateRequested

Private _onTabCloseRequested

Private _onTabMoved

Private _onWidgetRemoved

activate

  • activate(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): 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

addWidget

  • addWidget(widget: Widget): void

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

    Parameters

    • widget: Widget

      The widget to add to the tab panel.

      Notes

      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

children

  • children(): IIterator<Widget>

  • Create an iterator over the widget's children.

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

clearFlag

  • clearFlag(flag: Flag): void

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    Returns void

close

  • close(): void

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

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean

  • 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

  • dispose(): void

  • Dispose of the widget and its descendant widgets.

    Notes

    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

fit

  • fit(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

hasClass

  • hasClass(name: string): boolean

  • 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

  • hide(): void

  • 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

insertWidget

  • insertWidget(index: number, widget: Widget): 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.

      Notes

      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

Protected notifyLayout

  • notifyLayout(msg: Message): void

  • 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

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

  • A message handler invoked on an 'activate-request' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • onAfterHide(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • onAfterShow(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

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

    Notes

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

    Parameters

    Returns void

Protected onChildRemoved

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

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

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

Protected onFitRequest

  • onFitRequest(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onResize

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

    Notes

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

    Parameters

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

  • A message handler invoked on an 'update-request' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

processMessage

  • processMessage(msg: Message): void

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

removeClass

  • removeClass(name: string): 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

setFlag

  • setFlag(flag: Flag): void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    Returns void

setHidden

  • setHidden(hidden: boolean): 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

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

testFlag

  • testFlag(flag: Flag): boolean

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: boolean): boolean

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

update

  • update(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Generated using TypeDoc