Theia API Documentation v1.66.0
    Preparing search index...

    Class DockPanel

    A widget which provides a flexible docking area for widgets.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    node overlay

    Accessors

    addButtonEnabled addRequested dataset disposed hiddenMode id isAttached isDisposed isEmpty isHidden isVisible layout layoutModified mode parent renderer spacing tabsConstrained tabsMovable title

    Methods

    activate activateWidget addClass addWidget children clearFlag close contains dispose fit handleEvent handles hasClass hide notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest processMessage removeClass restoreLayout saveLayout selectedWidgets selectWidget setFlag setHidden show tabBars testFlag toggleClass update widgets

    Constructors

    Properties

    node: HTMLElement

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

      Set whether the add buttons for each tab bar are enabled.

      Parameters

      • value: boolean

      Returns void

    • get addRequested(): ISignal<this, TabBar<Widget>>

      A signal emitted when the add button on a tab bar is clicked.

      Returns ISignal<this, TabBar<Widget>>

    • get dataset(): DOMStringMap

      The dataset for the widget's DOM node.

      Returns DOMStringMap

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

      A signal emitted when the widget is disposed.

      Returns ISignal<this, void>

    • get hiddenMode(): HiddenMode

      The method for hiding widgets.

      Returns HiddenMode

    • set hiddenMode(v: HiddenMode): void

      Set the method for hiding widgets.

      Parameters

      Returns void

    • get id(): string

      Get the id of the widget's DOM node.

      Returns string

    • set id(value: string): 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 isEmpty(): boolean

      Whether the dock panel is empty.

      Returns boolean

    • get isHidden(): boolean

      Test whether the widget is explicitly hidden.

      Returns boolean

    • get isVisible(): boolean

      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.

      Returns boolean

    • get layout(): null | Layout

      Get the layout for the widget.

      Returns null | Layout

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

      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.

      Parameters

      Returns void

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

      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.

      Returns ISignal<this, void>

    • get mode(): Mode

      Get the mode for the dock panel.

      Returns Mode

    • set mode(value: Mode): void

      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.

      Parameters

      Returns void

    • get parent(): null | Widget

      Get the parent of the widget.

      Returns null | Widget

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

      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.

      Parameters

      Returns void

    • get spacing(): number

      Get the spacing between the widgets.

      Returns number

    • set spacing(value: number): void

      Set the spacing between the widgets.

      Parameters

      • value: number

      Returns void

    • get tabsConstrained(): boolean

      Whether the tabs are constrained to their source dock panel

      Returns boolean

    • set tabsConstrained(value: boolean): void

      Constrain/Allow tabs to be dragged outside of this dock panel

      Parameters

      • value: boolean

      Returns void

    • get tabsMovable(): boolean

      Whether the tabs can be dragged / moved at runtime.

      Returns boolean

    • set tabsMovable(value: boolean): void

      Enable / Disable draggable / movable tabs.

      Parameters

      • value: boolean

      Returns void

    • get title(): Title<Widget>

      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.

      Returns Title<Widget>

    Methods

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

      This is a simple convenience method for posting the message.

      Returns void

    • Activate a specified widget in the dock panel.

      Parameters

      • widget: Widget

        The widget of interest.

        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.

        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.

      • Optionaloptions: DockLayout.IAddOptions

        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.

      Returns void

    • Create an iterator over the widget's children.

      Returns IterableIterator<Widget>

      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.

    • Clear the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

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

      This is a simple convenience method for sending the message.

      Returns void

    • 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 of the resources held by the panel.

      Returns void

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

      This is a simple convenience method for posting the message.

      Returns void

    • Handle the DOM events for the dock panel.

      Parameters

      • event: Event

        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.

      Returns void

    • Create an iterator over the handles in the panel.

      Returns IterableIterator<HTMLDivElement>

      A new iterator over the handles in the panel.

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

      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.

        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

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

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

      Parameters

      Returns void

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

      Parameters

      Returns void

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

      The default implementation unparents or detaches the widget.

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

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

      Parameters

      Returns void

    • Process a message sent to the widget.

      Parameters

      • msg: Message

        The message sent to the widget.

      Returns void

    • Remove a class name from the widget's DOM node.

      Parameters

      • name: string

        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.

      Returns void

    • Restore the layout to a previously saved configuration.

      Parameters

      • config: DockLayout.ILayoutConfig

        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.

      Returns void

    • Save the current layout configuration of the dock panel.

      Returns DockLayout.ILayoutConfig

      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.

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

      Returns IterableIterator<Widget>

      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.

    • Select a specific widget in the dock panel.

      Parameters

      • widget: Widget

        The widget of interest.

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

      Returns void

    • Set the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Show or hide the widget according to a boolean value.

      Parameters

      • hidden: boolean

        true to hide the widget, or false to show it.

        This is a convenience method for hide() and show().

      Returns void

    • Show the widget and make it visible to its parent widget.

      This causes the isHidden property to be false.

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

      Returns void

    • Create an iterator over the tab bars in the panel.

      Returns IterableIterator<TabBar<Widget>>

      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.

      Parameters

      Returns boolean

    • Toggle a class name on the widget's DOM node.

      Parameters

      • name: string

        The class name to toggle on the node.

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

      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.

      Returns void

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

      Returns IterableIterator<Widget>

      A new iterator over the user widgets in the panel.

      This iterator does not include the generated tab bars.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods