Private _addPrivate _addPrivate _documentPrivate _dragPrivate _edgesPrivate _layoutPrivate _modePrivate _pressPrivate _rendererPrivate _tabsPrivate _tabsReadonly nodeGet the DOM node owned by the widget.
Readonly overlayThe overlay used by the dock panel.
Whether the add buttons for each tab bar are enabled.
Set whether the add buttons for each tab bar are enabled.
The dataset for the widget's DOM node.
The method for hiding widgets.
Set the method for hiding widgets.
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.
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.
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.
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.
Get the mode for the dock panel.
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 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.
The renderer used by the dock panel.
Get the spacing between the widgets.
Set the spacing between the widgets.
Whether the tabs are constrained to their source dock panel
Constrain/Allow tabs to be dragged outside of this dock panel
Whether the tabs can be dragged / moved at runtime.
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.
Private _createPrivate _createPrivate _evtPrivate _evtPrivate _evtPrivate _evtPrivate _evtPrivate _evtPrivate _evtPrivate _evtPrivate _onHandle the currentChanged signal from a tab bar.
Private _onHandle the tabActivateRequested signal from a tab bar.
Private _onPrivate _onHandle the tabCloseRequested signal from a tab bar.
Private _onHandle the tabDetachRequested signal from a tab bar.
Private _onPrivate _releasePrivate _showShow the overlay indicator at the given client position.
Returns the drop zone at the specified client position.
If the position is not over a valid zone, the overlay is hidden.
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.
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.
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.
Protected notifyProtected onProtected onProtected onProtected onProtected onProtected onProtected onProtected onProtected onProtected onA message handler invoked on a 'child-added' message.
Protected onA message handler invoked on a 'child-removed' message.
Protected onProtected onProtected onA message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
Protected onRemove 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.
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().
Toggle a class name on the widget's DOM node.
true if the class is now present, false otherwise.
The class name must not contain whitespace.
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.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
Generated using TypeDoc
A widget which provides a flexible docking area for widgets.