Construct a new dock panel.
The options for initializing the panel.
Set whether the add buttons for each tab bar are enabled.
A signal emitted when the add button on a tab bar is clicked.
The dataset for the widget's DOM node.
A signal emitted when the widget is disposed.
Set the method for hiding widgets.
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.
Whether the dock panel is empty.
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.
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.
A signal emitted when the layout configuration is modified.
This signal is emitted whenever the current layout configuration may have changed.
This signal is emitted asynchronously in a collapsed fashion, so that multiple synchronous modifications results in only a single emit of the signal.
Set the mode for the dock panel.
Changing the mode is a destructive operation with respect to the panel's layout configuration. If layout state must be preserved, save the current layout config before changing the mode.
Get the DOM node owned by the widget.
The overlay used by the dock panel.
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.
The renderer used by the dock panel.
Set the spacing between the widgets.
Constrain/Allow tabs to be dragged outside of this dock panel
Enable / Disable draggable / movable tabs.
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.
Post an 'activate-request'
message to the widget.
This is a simple convenience method for posting the message.
Activate a specified widget in the dock panel.
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.
Add a widget to the dock panel.
The widget to add to the dock panel.
The additional options for adding the widget.
If the panel is in single document mode, the options are ignored and the widget is always added as tab in the hidden tab bar.
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.
Dispose of the resources held by the panel.
Post a 'fit-request'
message to the widget.
This is a simple convenience method for posting the message.
Handle the DOM events for the dock panel.
The DOM event sent to the panel.
This method implements the DOM EventListener
interface and is
called in response to events on the panel's DOM node. It should
not be called directly by user code.
Create an iterator over the handles in the panel.
A new iterator over the handles in the panel.
Test whether the widget's DOM node has the given class name.
The class name of interest.
true
if the node has the class, false
otherwise.
Invoke 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.
A message handler invoked on an 'activate-request'
message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-attach'
message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-detach'
message.
A message handler invoked on an 'after-hide'
message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-show'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-attach'
message.
A message handler invoked on a 'before-detach'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-hide'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-show'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-added'
message.
A message handler invoked on a 'child-removed'
message.
A message handler invoked on a 'close-request'
message.
The default implementation unparents or detaches the widget.
A message handler invoked on a 'fit-request'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'update-request'
message.
The default implementation of this handler is a no-op.
Process a message sent to the widget.
The message sent to the widget.
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.
Restore the layout to a previously saved configuration.
The layout configuration to restore.
Widgets which currently belong to the layout but which are not contained in the config will be unparented.
The dock panel automatically reverts to 'multiple-document'
mode when a layout config is restored.
Save the current layout configuration of the dock panel.
A new config object for the current layout state.
The return value can be provided to the restoreLayout
method
in order to restore the layout to its current configuration.
Select a specific widget in the dock panel.
Create an iterator over the selected widgets in the panel.
A new iterator over the selected user widgets.
This iterator yields the widgets corresponding to the current tab of each tab bar in the panel.
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()
.
Create an iterator over the tab bars in the panel.
A new iterator over the tab bars in the panel.
This iterator does not include the user widgets.
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.
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.
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.
Create an iterator over the user widgets in the panel.
A new iterator over the user widgets in the panel.
This iterator does not include the generated tab bars.
Generated using TypeDoc
a widget which provides a flexible docking area for widgets. Tweaked to use an inline svg as the close icon