Whether a tab can be deselected by the user.
Tabs can be always be deselected programmatically.
The selection behavior when inserting a tab.
Readonly
nodeGet the DOM node owned by the widget.
The selection behavior when removing a tab.
Readonly
rendererThe renderer used by the tab bar.
Static
translatorTranslator object
Whether the add button is enabled.
Set whether the add button is enabled.
The tab bar add button node.
This is the node which holds the add button.
Modifying this node directly can lead to undefined behavior.
The tab bar content node.
This is the node which holds the tab nodes.
Modifying this node directly can lead to undefined behavior.
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.
Set the index of the currently selected tab.
If the value is out of range, the index will be set to -1
.
The dataset for the widget's DOM node.
The document to use with the tab bar.
The default is the global document
instance.
Get the method for hiding the widget.
Set the method for hiding the widget.
Get the id of the widget's DOM node.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
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.
Get the layout for the widget.
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.
Get the name of the tab bar.
Set the name of the tab bar.
Get the orientation of the tab bar.
This controls whether the tabs are arranged in a row or column.
Set the orientation of the tab bar.
This controls whether the tabs are arranged in a row or column.
Get the parent of the widget.
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.
A signal emitted when a tab is clicked by the user.
If the clicked tab is not the current tab, the clicked tab will be
made current and the currentChanged
signal will be emitted first.
This signal is emitted even if the clicked tab is the current tab.
A signal emitted when a tab is dragged beyond the detach threshold.
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.
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.
A read-only array of the titles in the tab bar.
Whether the titles can be user-edited.
Set whether titles can be user edited.
Post an 'activate-request'
message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
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.
Create an iterator over the widget's children.
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.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
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.
Protected
notifyInvoke the message processing routine of the widget's layout.
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.
Protected
onA message handler invoked on an 'activate-request'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-attach'
message.
The default implementation of this handler is a no-op.
Protected
onProtected
onA message handler invoked on an 'after-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-show'
message.
The default implementation of this handler is a no-op.
Protected
onProtected
onA message handler invoked on a 'before-detach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-show'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-added'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-removed'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'close-request'
message.
The default implementation unparents or detaches the widget.
Protected
onA message handler invoked on a 'fit-request'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
Protected
onRelease the mouse and restore the non-dragged tab positions.
This will cause the tab bar to stop handling mouse events and to restore the tabs to their non-dragged positions.
Remove a class name from the widget's DOM node.
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.
Remove a tab from the tab bar.
Show or hide the widget according to a boolean value.
true
to hide the widget, or false
to show it.
This is a convenience method for hide()
and show()
.
Test whether the given widget flag is set.
This will not typically be called directly by user code.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optional
force: booleanWhether 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.
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.
a widget which displays titles as a single row or column of tabs. Tweaked to use an inline svg as the close icon