Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DockPanel

A widget which provides a flexible docking area for widgets. The namespace for the DockPanel class statics.

Hierarchy

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static IAddOptions

IAddOptions: IAddOptions

A type alias for the add widget options.

Static ILayoutConfig

ILayoutConfig: ILayoutConfig

A type alias for a layout configuration object.

Static IRenderer

IRenderer: IRenderer

A type alias for a dock panel renderer;

Static InsertMode

InsertMode: InsertMode

A type alias for the supported insertion modes.

Static Mode

Mode: "single-document" | "multiple-document"

A type alias for the supported dock panel modes.

Constructors

constructor

  • new DockPanel(options?: IOptions): DockPanel

Properties

Private _addButtonEnabled

_addButtonEnabled: boolean = false

Private _addRequested

_addRequested: Signal<this, TabBar<Widget>> = new Signal<this, TabBar<Widget>>(this)

Private _document

_document: Document | ShadowRoot

Private _drag

_drag: Drag | null = null

Private _edges

_edges: IEdges

Private _layoutModified

_layoutModified: Signal<this, void> = new Signal<this, void>(this)

Private _mode

_mode: Mode

Private _pressData

_pressData: IPressData | null = null

Private _renderer

_renderer: IRenderer

Private _tabsConstrained

_tabsConstrained: boolean = false

Private _tabsMovable

_tabsMovable: boolean = true

node

node: HTMLElement

Get the DOM node owned by the widget.

overlay

overlay: IOverlay

The overlay used by the dock panel.

Static defaultRenderer

defaultRenderer: Renderer = new Renderer()

The default Renderer instance.

Accessors

addButtonEnabled

  • get addButtonEnabled(): boolean
  • set addButtonEnabled(value: boolean): void

addRequested

dataset

  • get dataset(): DOMStringMap

disposed

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

hiddenMode

id

  • get id(): string
  • set id(value: string): void

isAttached

  • get isAttached(): boolean

isDisposed

  • get isDisposed(): boolean

isEmpty

  • get isEmpty(): boolean

isHidden

  • get isHidden(): boolean

isVisible

  • 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

layout

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

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

    Returns Layout | null

  • 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

layoutModified

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

mode

  • get mode(): Mode
  • set mode(value: Mode): void

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

    Returns Mode

  • 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

parent

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

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

    Returns Widget | null

  • 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

renderer

spacing

  • get spacing(): number
  • set spacing(value: number): void

tabsConstrained

  • get tabsConstrained(): boolean
  • set tabsConstrained(value: boolean): void

tabsMovable

  • get tabsMovable(): boolean
  • set tabsMovable(value: boolean): void

title

  • 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

Private _createHandle

  • _createHandle(): HTMLDivElement

Private _createTabBar

Private _evtDragEnter

  • _evtDragEnter(event: IDragEvent): void

Private _evtDragLeave

  • _evtDragLeave(event: IDragEvent): void

Private _evtDragOver

  • _evtDragOver(event: IDragEvent): void

Private _evtDrop

  • _evtDrop(event: IDragEvent): void

Private _evtKeyDown

  • _evtKeyDown(event: KeyboardEvent): void

Private _evtMouseDown

  • _evtMouseDown(event: MouseEvent): void

Private _evtMouseMove

  • _evtMouseMove(event: MouseEvent): void

Private _evtMouseUp

  • _evtMouseUp(event: MouseEvent): void

Private _onCurrentChanged

Private _onTabActivateRequested

Private _onTabAddRequested

Private _onTabCloseRequested

Private _onTabDetachRequested

Private _onTabMoved

  • _onTabMoved(): void

Private _releaseMouse

  • _releaseMouse(): void

Private _showOverlay

  • _showOverlay(clientX: number, clientY: number): Private.DropZone

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

activate

  • activate(): void

activateWidget

  • activateWidget(widget: Widget): void

  • 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

addClass

  • addClass(name: string): 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

addWidget

  • Add a widget to the dock panel.

    Parameters

    • widget: Widget

      The widget to add to the dock panel.

    • Default value options: 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

children

  • children(): IIterator<Widget>

  • Create an iterator over the widget's children.

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

clearFlag

  • clearFlag(flag: Flag): void

close

  • close(): void

contains

  • contains(widget: Widget): boolean

  • 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

  • dispose(): void

fit

  • fit(): void

handleEvent

  • handleEvent(event: Event): void

  • 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

handles

  • handles(): IIterator<HTMLDivElement>

  • Create an iterator over the handles in the panel.

    Returns IIterator<HTMLDivElement>

    A new iterator over the handles in the panel.

hasClass

  • hasClass(name: string): boolean

  • 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

  • hide(): void

Protected notifyLayout

  • notifyLayout(msg: Message): 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

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onAfterHide

  • onAfterHide(msg: Message): void

Protected onAfterShow

  • onAfterShow(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void

Protected onChildAdded

Protected onChildRemoved

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onFitRequest

  • onFitRequest(msg: Message): void

Protected onResize

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

processMessage

  • processMessage(msg: Message): void

removeClass

  • removeClass(name: string): 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

restoreLayout

  • Restore the layout to a previously saved configuration.

    Parameters

    • config: 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

saveLayout

  • Save the current layout configuration of the dock panel.

    Returns ILayoutConfig

    A new config object for the current layout state.

    Notes

    The return value can be provided to the restoreLayout method in order to restore the layout to its current configuration.

selectWidget

  • selectWidget(widget: Widget): 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

selectedWidgets

  • selectedWidgets(): IIterator<Widget>

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

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

setFlag

  • setFlag(flag: Flag): void

setHidden

  • setHidden(hidden: boolean): void

  • 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

  • show(): void

tabBars

testFlag

  • testFlag(flag: Flag): boolean

toggleClass

  • toggleClass(name: string, force?: undefined | false | true): boolean

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

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: undefined | false | true

      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.

update

  • update(): void

widgets

  • widgets(): IIterator<Widget>

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

    Returns IIterator<Widget>

    A new iterator over the user widgets in the panel.

    Notes

    This iterator does not include the generated tab bars.

Static attach

  • attach(widget: Widget, host: HTMLElement, ref?: HTMLElement | null): void

  • Attach a widget to a host DOM node.

    Parameters

    • widget: Widget

      The widget of interest.

    • host: HTMLElement

      The DOM node to use as the widget's host.

    • Default value ref: HTMLElement | null = null

      The child of host to use as the reference element. If this is provided, the widget will be inserted before this node in the host. The default is null, which will cause the widget to be added as the last child of the host.

      Notes

      This will throw an error if the widget is not a root widget, if the widget is already attached, or if the host is not attached to the DOM.

    Returns void

Static detach

  • detach(widget: Widget): void

  • Detach the widget from its host DOM node.

    Parameters

    • widget: Widget

      The widget of interest.

      Notes

      This will throw an error if the widget is not a root widget, or if the widget is not attached to the DOM.

    Returns void

Generated using TypeDoc