Class: SingleWidgetShell¶
application.SingleWidgetShell
The application shell.
Hierarchy¶
Widget↳
SingleWidgetShell
Implements¶
IShell
Constructors¶
constructor¶
• new SingleWidgetShell()
Overrides¶
Widget.constructor
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:20
Properties¶
_currentChanged¶
• Private _currentChanged: any
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:52
_main¶
• Private _main: any
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:51
dataset¶
• Readonly dataset: DOMStringMap
The dataset for the widget’s DOM node.
Implementation of¶
JupyterFrontEnd.IShell.dataset
Inherited from¶
Widget.dataset
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:81
disposed¶
• Readonly disposed: ISignal<SingleWidgetShell, void>
A signal emitted when the widget is disposed.
Implementation of¶
JupyterFrontEnd.IShell.disposed
Inherited from¶
Widget.disposed
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:34
id¶
• id: string
Set the id of the widget’s DOM node.
Implementation of¶
JupyterFrontEnd.IShell.id
Inherited from¶
Widget.id
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:77
isAttached¶
• Readonly isAttached: boolean
Test whether the widget’s node is attached to the DOM.
Implementation of¶
JupyterFrontEnd.IShell.isAttached
Inherited from¶
Widget.isAttached
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:46
isDisposed¶
• Readonly isDisposed: boolean
Test whether the widget has been disposed.
Implementation of¶
JupyterFrontEnd.IShell.isDisposed
Inherited from¶
Widget.isDisposed
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:42
isVisible¶
• Readonly 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.
Implementation of¶
JupyterFrontEnd.IShell.isVisible
Inherited from¶
Widget.isVisible
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:58
layout¶
• layout: null | Layout
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.
Implementation of¶
JupyterFrontEnd.IShell.layout
Inherited from¶
Widget.layout
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:116
node¶
• Readonly node: HTMLElement
Get the DOM node owned by the widget.
Implementation of¶
JupyterFrontEnd.IShell.node
Inherited from¶
Widget.node
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:38
parent¶
• parent: null | Widget
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.
Implementation of¶
JupyterFrontEnd.IShell.parent
Inherited from¶
Widget.parent
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:103
title¶
• Readonly 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.
Implementation of¶
JupyterFrontEnd.IShell.title
Inherited from¶
Widget.title
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:70
Accessors¶
currentChanged¶
• get currentChanged(): ISignal<ISingleWidgetShell, void>
A signal emitted when the current widget changes.
Returns¶
ISignal<ISingleWidgetShell, void>
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:24
currentWidget¶
• get currentWidget(): null | Widget
The current widget in the shell’s main area.
Returns¶
null | Widget
Implementation of¶
JupyterFrontEnd.IShell.currentWidget
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:28
Methods¶
activate¶
▸ activate(): void
Post an 'activate-request' message to the widget.
Notes¶
This is a simple convenience method for posting the message.
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.activate
Inherited from¶
Widget.activate
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:201
activateById¶
▸ activateById(id): void
Activate a widget in its area.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.activateById
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:32
add¶
▸ add(widget, area?, options?): void
Add a widget to the application shell.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The widget being added. |
|
|
Optional region in the shell into which the widget should be added. |
|
|
Optional open options. |
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.add
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:44
addClass¶
▸ addClass(name): void
Add a class name to the widget’s DOM node.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
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
Implementation of¶
JupyterFrontEnd.IShell.addClass
Inherited from¶
Widget.addClass
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:154
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.
Implementation of¶
JupyterFrontEnd.IShell.children
Inherited from¶
Widget.children
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:127
clearFlag¶
▸ clearFlag(flag): void
Clear the given widget flag.
Notes¶
This will not typically be called directly by user code.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.clearFlag
Inherited from¶
Widget.clearFlag
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:256
close¶
▸ close(): void
Send a 'close-request' message to the widget.
Notes¶
This is a simple convenience method for sending the message.
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.close
Inherited from¶
Widget.close
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:208
contains¶
▸ contains(widget): boolean
Test whether a widget is a descendant of this widget.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The descendant widget of interest. |
Returns¶
boolean
true if the widget is a descendant, false otherwise.
Implementation of¶
JupyterFrontEnd.IShell.contains
Inherited from¶
Widget.contains
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:135
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
Implementation of¶
JupyterFrontEnd.IShell.dispose
Inherited from¶
Widget.dispose
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:30
fit¶
▸ fit(): void
Post a 'fit-request' message to the widget.
Notes¶
This is a simple convenience method for posting the message.
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.fit
Inherited from¶
Widget.fit
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:194
hasClass¶
▸ hasClass(name): boolean
Test whether the widget’s DOM node has the given class name.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The class name of interest. |
Returns¶
boolean
true if the node has the class, false otherwise.
Implementation of¶
JupyterFrontEnd.IShell.hasClass
Inherited from¶
Widget.hasClass
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:143
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
Implementation of¶
JupyterFrontEnd.IShell.hide
Inherited from¶
Widget.hide
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:226
notifyLayout¶
▸ Protected notifyLayout(msg): void
Invoke the message processing routine of the widget’s layout.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
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
Implementation of¶
JupyterFrontEnd.IShell.notifyLayout
Inherited from¶
Widget.notifyLayout
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:276
onActivateRequest¶
▸ Protected onActivateRequest(msg): void
A message handler invoked on an 'activate-request' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onActivateRequest
Inherited from¶
Widget.onActivateRequest
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:311
onAfterAttach¶
▸ Protected onAfterAttach(msg): void
A message handler invoked on an 'after-attach' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onAfterAttach
Inherited from¶
Widget.onAfterAttach
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:353
onAfterDetach¶
▸ Protected onAfterDetach(msg): void
A message handler invoked on an 'after-detach' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onAfterDetach
Inherited from¶
Widget.onAfterDetach
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:367
onAfterHide¶
▸ Protected onAfterHide(msg): void
A message handler invoked on an 'after-hide' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onAfterHide
Inherited from¶
Widget.onAfterHide
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:339
onAfterShow¶
▸ Protected onAfterShow(msg): void
A message handler invoked on an 'after-show' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onAfterShow
Inherited from¶
Widget.onAfterShow
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:325
onBeforeAttach¶
▸ Protected onBeforeAttach(msg): void
A message handler invoked on a 'before-attach' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onBeforeAttach
Inherited from¶
Widget.onBeforeAttach
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:346
onBeforeDetach¶
▸ Protected onBeforeDetach(msg): void
A message handler invoked on a 'before-detach' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onBeforeDetach
Inherited from¶
Widget.onBeforeDetach
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:360
onBeforeHide¶
▸ Protected onBeforeHide(msg): void
A message handler invoked on a 'before-hide' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onBeforeHide
Inherited from¶
Widget.onBeforeHide
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:332
onBeforeShow¶
▸ Protected onBeforeShow(msg): void
A message handler invoked on a 'before-show' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onBeforeShow
Inherited from¶
Widget.onBeforeShow
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:318
onChildAdded¶
▸ Protected onChildAdded(msg): void
A message handler invoked on a 'child-added' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onChildAdded
Inherited from¶
Widget.onChildAdded
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:374
onChildRemoved¶
▸ Protected onChildRemoved(msg): void
A message handler invoked on a 'child-removed' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onChildRemoved
Inherited from¶
Widget.onChildRemoved
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:381
onCloseRequest¶
▸ Protected onCloseRequest(msg): void
A message handler invoked on a 'close-request' message.
Notes¶
The default implementation unparents or detaches the widget.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onCloseRequest
Inherited from¶
Widget.onCloseRequest
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:283
onFitRequest¶
▸ Protected onFitRequest(msg): void
A message handler invoked on a 'fit-request' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onFitRequest
Inherited from¶
Widget.onFitRequest
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:304
onResize¶
▸ Protected onResize(msg): void
A message handler invoked on a 'resize' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onResize
Inherited from¶
Widget.onResize
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:290
onUpdateRequest¶
▸ Protected onUpdateRequest(msg): void
A message handler invoked on an 'update-request' message.
Notes¶
The default implementation of this handler is a no-op.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.onUpdateRequest
Inherited from¶
Widget.onUpdateRequest
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:297
processMessage¶
▸ processMessage(msg): void
Process a message sent to the widget.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The message sent to the widget. #### Notes Subclasses may reimplement this method as needed. |
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.processMessage
Inherited from¶
Widget.processMessage
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:265
removeClass¶
▸ removeClass(name): void
Remove a class name from the widget’s DOM node.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
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
Implementation of¶
JupyterFrontEnd.IShell.removeClass
Inherited from¶
Widget.removeClass
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:165
setFlag¶
▸ setFlag(flag): void
Set the given widget flag.
Notes¶
This will not typically be called directly by user code.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.setFlag
Inherited from¶
Widget.setFlag
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:249
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
Implementation of¶
JupyterFrontEnd.IShell.show
Inherited from¶
Widget.show
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:217
testFlag¶
▸ testFlag(flag): boolean
Test whether the given widget flag is set.
Notes¶
This will not typically be called directly by user code.
Parameters¶
Name |
Type |
|---|---|
|
|
Returns¶
boolean
Implementation of¶
JupyterFrontEnd.IShell.testFlag
Inherited from¶
Widget.testFlag
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:242
toggleClass¶
▸ toggleClass(name, force?): boolean
Toggle a class name on the widget’s DOM node.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The class name to toggle on the node. |
|
|
Whether to force add the class ( |
Returns¶
boolean
true if the class is now present, false otherwise.
Notes¶
The class name must not contain whitespace.
Implementation of¶
JupyterFrontEnd.IShell.toggleClass
Inherited from¶
Widget.toggleClass
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:180
update¶
▸ update(): void
Post an 'update-request' message to the widget.
Notes¶
This is a simple convenience method for posting the message.
Returns¶
void
Implementation of¶
JupyterFrontEnd.IShell.update
Inherited from¶
Widget.update
Defined in¶
node_modules/@lumino/widgets/types/widget.d.ts:187
widgets¶
▸ widgets(area): IIterator<Widget>
Return the list of widgets for the given area.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The area |
Returns¶
IIterator<Widget>
Implementation of¶
JupyterFrontEnd.IShell.widgets
Defined in¶
packages/application/lib/singleWidgetShell.d.ts:50