Interface: ISingleWidgetShell
#
@jupyterlite/application.ISingleWidgetShell
The single widget application shell interface.
Hierarchy#
-
↳
ISingleWidgetShell
Properties#
dataset
#
Readonly
dataset
:DOMStringMap
The dataset for the widget’s DOM node.
Inherited from#
Defined in#
node_modules/@lumino/widgets/types/widget.d.ts:81
disposed
#
Readonly
disposed
:ISignal
<ISingleWidgetShell
,void
>
A signal emitted when the widget is disposed.
Inherited from#
Defined in#
node_modules/@lumino/widgets/types/widget.d.ts:34
id
#
id
:string
Set the id of the widget’s DOM node.
Inherited from#
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.
Inherited from#
Defined in#
node_modules/@lumino/widgets/types/widget.d.ts:46
isDisposed
#
Readonly
isDisposed
:boolean
Test whether the widget has been disposed.
Inherited from#
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.
Inherited from#
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.
Inherited from#
Defined in#
node_modules/@lumino/widgets/types/widget.d.ts:116
node
#
Readonly
node
:HTMLElement
Get the DOM node owned by the widget.
Inherited from#
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.
Inherited from#
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.
Inherited from#
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
>
Inherited from#
SingleWidgetShell.currentChanged
Defined in#
currentWidget
#
get
currentWidget
():null
|Widget
The current widget in the shell’s main area.
Returns#
null
| Widget
Inherited from#
SingleWidgetShell.currentWidget
Defined in#
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
Inherited from#
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
Inherited from#
Defined in#
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
Inherited from#
Defined in#
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
Inherited from#
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.
Inherited from#
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
Inherited from#
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
Inherited from#
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.
Inherited from#
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
Inherited from#
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
Inherited from#
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.
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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
Inherited from#
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.
Inherited from#
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
Inherited from#
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
>