A widget which provides a flexible docking area for widgets.

Hierarchy (view full)

Constructors

Properties

_addButtonEnabled: boolean = false
_addRequested: Signal<DockPanel, TabBar<Widget>> = ...
_document: Document | ShadowRoot
_drag: null | Drag = null
_edges: IEdges
_layoutModified: Signal<DockPanel, void> = ...
_mode: Mode
_pressData: null | IPressData = null
_tabsConstrained: boolean = false
_tabsMovable: boolean = true

Get the DOM node owned by the widget.

overlay: IOverlay

The overlay used by the dock panel.

Accessors

  • get addButtonEnabled(): boolean
  • Whether the add buttons for each tab bar are enabled.

    Returns boolean

  • set addButtonEnabled(value): void
  • Set whether the add buttons for each tab bar are enabled.

    Parameters

    • value: boolean

    Returns void

  • get id(): string
  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): 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.

    Notes

    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): void
  • 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

  • get layoutModified(): ISignal<this, void>
  • A signal emitted when the layout configuration is modified.

    Notes

    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.

    Returns ISignal<this, void>

  • get mode(): Mode
  • Get the mode for the dock panel.

    Returns Mode

  • set mode(value): void
  • Set the mode for the dock panel.

    Notes

    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.

    Parameters

    Returns void

  • get parent(): null | Widget
  • Get the parent of the widget.

    Returns null | Widget

  • set parent(value): void
  • 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

  • get tabsConstrained(): boolean
  • Whether the tabs are constrained to their source dock panel

    Returns boolean

  • set tabsConstrained(value): void
  • Constrain/Allow tabs to be dragged outside of this dock panel

    Parameters

    • value: boolean

    Returns void

  • get title(): Title<Widget>
  • 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>

Methods

  • Show the overlay indicator at the given client position.

    Returns the drop zone at the specified client position.

    Notes

    If the position is not over a valid zone, the overlay is hidden.

    Parameters

    • clientX: number
    • clientY: number

    Returns DropZone

  • Activate a specified widget in the dock panel.

    Parameters

    • widget: Widget

      The widget of interest.

      Notes

      This will select and activate the given widget.

    Returns 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

  • Add a widget to the dock panel.

    Parameters

    • widget: Widget

      The widget to add to the dock panel.

    • options: DockLayout.IAddOptions = {}

      The additional options for adding the widget.

      Notes

      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.

    Returns void

  • Create an iterator over the widget's children.

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

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

  • Handle the DOM events for the dock panel.

    Parameters

    • event: Event

      The DOM event sent to the panel.

      Notes

      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.

    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.

    Notes

    This causes the isHidden property to be true.

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

    Returns 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

  • 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

  • Restore the layout to a previously saved configuration.

    Parameters

    • config: DockLayout.ILayoutConfig

      The layout configuration to restore.

      Notes

      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.

    Returns void

  • Select a specific widget in the dock panel.

    Parameters

    • widget: Widget

      The widget of interest.

      Notes

      This will make the widget the current widget in its tab area.

    Returns void

  • Create an iterator over the selected widgets in the panel.

    Returns IterableIterator<Widget>

    A new iterator over the selected user widgets.

    Notes

    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.

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

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

  • Create an iterator over the user widgets in the panel.

    Returns IterableIterator<Widget>

    A new iterator over the user widgets in the panel.

    Notes

    This iterator does not include the generated tab bars.