Options
All
  • Public
  • Public/Protected
  • All
Menu

The application shell for JupyterLab. The namespace for ApplicationShell class statics.

Hierarchy

  • Widget
    • ApplicationShell

Implements

  • IDisposable
  • IMessageHandler

Index

Type aliases

Static Area

Area: "main" | "top" | "left" | "right"

The areas of the application shell where widgets can reside.

Static AreaConfig

AreaConfig: DockLayout.AreaConfig

The restorable description of an area within the main dock panel.

Static IChangedArgs

IChangedArgs: IChangedArgs<Widget>

An arguments object for the changed signals.

Constructors

constructor

Properties

Private _activeChanged

_activeChanged: Signal<this, IChangedArgs<Widget>> = new Signal<this, ApplicationShell.IChangedArgs>(this)

Private _cachedLayout

_cachedLayout: ILayoutConfig | null = null

Private _currentChanged

_currentChanged: Signal<this, IChangedArgs<Widget>> = new Signal<this, ApplicationShell.IChangedArgs>(this)

Private _dockPanel

_dockPanel: DockPanel

Private _hboxPanel

_hboxPanel: BoxPanel

Private _hsplitPanel

_hsplitPanel: SplitPanel

Private _isRestored

_isRestored: boolean = false

Private _layoutModified

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

Private _leftHandler

_leftHandler: SideBarHandler

Private _restored

_restored: PromiseDelegate<ILayout> = new PromiseDelegate<ApplicationShell.ILayout>()

Private _rightHandler

_rightHandler: SideBarHandler

Private _topPanel

_topPanel: Panel

Private _tracker

_tracker: FocusTracker<Widget> = new FocusTracker<Widget>()

dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

id

id: string

Set the id of the widget's DOM node.

isAttached

isAttached: boolean

Test whether the widget's node is attached to the DOM.

isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

isVisible

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.

layout

layout: 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.

node

node: HTMLElement

Get the DOM node owned by the widget.

parent

parent: 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.

title

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.

Accessors

activeChanged

activeWidget

  • get activeWidget(): Widget | null

currentChanged

currentWidget

  • get currentWidget(): Widget | null

layoutModified

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

mode

  • get mode(): DockPanel.Mode
  • set mode(mode: DockPanel.Mode): void

restored

Methods

Private _adjacentBar

  • _adjacentBar(direction: "next" | "previous"): TabBar<Widget> | null

Private _currentTabBar

  • _currentTabBar(): TabBar<Widget> | null

Private _onActiveChanged

  • _onActiveChanged(sender: any, args: IChangedArgs<Widget>): void
  • Handle a change to the dock area active widget.

    Parameters

    • sender: any
    • args: IChangedArgs<Widget>

    Returns void

Private _onCurrentChanged

  • _onCurrentChanged(sender: any, args: IChangedArgs<Widget>): void
  • Handle a change to the dock area current widget.

    Parameters

    • sender: any
    • args: IChangedArgs<Widget>

    Returns void

Private _onLayoutModified

  • _onLayoutModified(): void

activate

  • activate(): void
  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

activateById

  • activateById(id: string): void

activateNextTab

  • activateNextTab(): void

activatePreviousTab

  • activatePreviousTab(): 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

addToLeftArea

  • Add a widget to the left content area.

    Notes

    Widgets must have a unique id property, which will be used as the DOM id.

    Parameters

    Returns void

addToMainArea

  • Add a widget to the main content area.

    Notes

    Widgets must have a unique id property, which will be used as the DOM id. All widgets added to the main area should be disposed after removal (or simply disposed in order to remove).

    Parameters

    Returns void

addToRightArea

  • Add a widget to the right content area.

    Notes

    Widgets must have a unique id property, which will be used as the DOM id.

    Parameters

    Returns void

addToTopArea

  • Add a widget to the top content area.

    Notes

    Widgets must have a unique id property, which will be used as the DOM id.

    Parameters

    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
  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

close

  • close(): void
  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

closeAll

  • closeAll(): void

collapseLeft

  • collapseLeft(): void

collapseRight

  • collapseRight(): 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
  • Dispose of the widget and its descendant widgets.

    Notes

    It is unsafe to use the widget after it has been disposed.

    All calls made to this method after the first are a no-op.

    Returns void

fit

  • fit(): void
  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

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

isEmpty

  • isEmpty(area: Area): boolean

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
  • A message handler invoked on an 'activate-request' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void
  • Handle after-attach messages for the application shell.

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void
  • A message handler invoked on an 'after-detach' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • onAfterHide(msg: Message): void
  • A message handler invoked on an 'after-hide' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • onAfterShow(msg: Message): void
  • A message handler invoked on an 'after-show' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void
  • A message handler invoked on a 'before-attach' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void
  • A message handler invoked on a 'before-detach' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void
  • A message handler invoked on a 'before-hide' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void
  • A message handler invoked on a 'before-show' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

  • onChildAdded(msg: ChildMessage): void
  • A message handler invoked on a 'child-added' message.

    Notes

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

    Parameters

    • msg: ChildMessage

    Returns void

Protected onChildRemoved

  • onChildRemoved(msg: ChildMessage): void
  • A message handler invoked on a 'child-removed' message.

    Notes

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

    Parameters

    • msg: ChildMessage

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void
  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

Protected onFitRequest

  • onFitRequest(msg: Message): void
  • A message handler invoked on a 'fit-request' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onResize

  • onResize(msg: ResizeMessage): void
  • A message handler invoked on a 'resize' message.

    Notes

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

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void
  • A message handler invoked on an 'update-request' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

processMessage

  • processMessage(msg: Message): void
  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns 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

  • restoreLayout(layout: ILayout): void

saveLayout

setFlag

  • setFlag(flag: Flag): void
  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

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

testFlag

  • testFlag(flag: Flag): boolean
  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: boolean): boolean
  • 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.

update

  • update(): void
  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

widgets

  • widgets(area: Area): IIterator<Widget>

Generated using TypeDoc