@jupyterlite

***`

@jupyterlite / @jupyterlite/application / ISingleWidgetShell

Interface: ISingleWidgetShell#

Defined in: packages/application/src/singleWidgetShell.ts:19

The single widget application shell interface.

Extends#

Properties#

node#

readonly **node**: HTMLElement

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:37

Get the DOM node owned by the widget.

Inherited from#

SingleWidgetShell.node

Accessors#

currentChanged#

Get Signature#

**get** **currentChanged**(): ISignal<ISingleWidgetShell, IChangedArgs<Widget>>

Defined in: packages/application/src/singleWidgetShell.ts:46

A signal emitted when the current widget changes.

Returns#

ISignal<ISingleWidgetShell, IChangedArgs<Widget>>

Inherited from#

SingleWidgetShell.currentChanged

`***

currentWidget#

Get Signature#

get currentWidget(): null | Widget

Defined in: packages/application/src/singleWidgetShell.ts:53

The current widget in the shell’s main area.

Returns#

null | Widget

Inherited from#

SingleWidgetShell.currentWidget

***`

dataset#

Get Signature#

**get** **dataset**(): DOMStringMap

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:88

The dataset for the widget’s DOM node.

Returns#

DOMStringMap

Inherited from#

SingleWidgetShell.dataset

`***

disposed#

Get Signature#

get disposed(): ISignal<this, void>

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:33

A signal emitted when the widget is disposed.

Returns#

ISignal<this, void>

Inherited from#

SingleWidgetShell.disposed

***`

hiddenMode#

Get Signature#

**get** **hiddenMode**(): HiddenMode

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:92

Get the method for hiding the widget.

Returns#

HiddenMode

Set Signature#

**set** **hiddenMode**(value): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:96

Set the method for hiding the widget.

Parameters#
value#

HiddenMode

Returns#

void

Inherited from#

SingleWidgetShell.hiddenMode

`***

id#

Get Signature#

get id(): string

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:80

Get the id of the widget’s DOM node.

Returns#

string

Set Signature#

set id(value): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:84

Set the id of the widget’s DOM node.

Parameters#
value#

string

Returns#

void

Inherited from#

SingleWidgetShell.id

***`

isAttached#

Get Signature#

**get** **isAttached**(): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:45

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

Returns#

boolean

Inherited from#

SingleWidgetShell.isAttached

`***

isDisposed#

Get Signature#

get isDisposed(): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:41

Test whether the widget has been disposed.

Returns#

boolean

Inherited from#

SingleWidgetShell.isDisposed

***`

isHidden#

Get Signature#

**get** **isHidden**(): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:53

Test whether the widget is explicitly hidden.

Notes#

You should prefer !{@link isVisible} over {@link isHidden} if you want to know if the widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden.

Returns#

boolean

Inherited from#

SingleWidgetShell.isHidden

`***

isVisible#

Get Signature#

get isVisible(): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:64

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.

Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.

Returns#

boolean

Inherited from#

SingleWidgetShell.isVisible

***`

layout#

Get Signature#

**get** **layout**(): null | Layout

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:116

Get the layout for the widget.

Returns#

null | Layout

Set Signature#

**set** **layout**(value): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:126

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#
value#

null | Layout

Returns#

void

Inherited from#

SingleWidgetShell.layout

`***

parent#

Get Signature#

get parent(): null | Widget

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:100

Get the parent of the widget.

Returns#

null | Widget

Set Signature#

set parent(value): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:112

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#
value#

null | Widget

Returns#

void

Inherited from#

SingleWidgetShell.parent

***`

title#

Get Signature#

**get** **title**(): Title<Widget>

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:76

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>

Inherited from#

SingleWidgetShell.title

Methods#

activate()#

**activate**(): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:211

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

Notes#

This is a simple convenience method for posting the message.

Returns#

void

Inherited from#

SingleWidgetShell.activate

`***

activateById()#

activateById(id): void

Defined in: packages/application/src/singleWidgetShell.ts:60

Activate a widget in its area.

Parameters#

id#

string

Returns#

void

Inherited from#

SingleWidgetShell.activateById

***`

add()#

**add**(widget, area?, options?): void

Defined in: packages/application/src/singleWidgetShell.ts:78

Add a widget to the application shell.

Parameters#

widget#

Widget

The widget being added.

area?#

"main"

Optional region in the shell into which the widget should be added.

options?#

IOpenOptions

Optional open options.

Returns#

void

Inherited from#

SingleWidgetShell.add

`***

addClass()#

addClass(name): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:164

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

Inherited from#

SingleWidgetShell.addClass

***`

children()#

**children**(): IterableIterator<Widget>

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:137

Create an iterator over the widget’s children.

Returns#

IterableIterator<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#

SingleWidgetShell.children

`***

clearFlag()#

clearFlag(flag): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:275

Clear the given widget flag.

Notes#

This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

Parameters#

flag#

Flag

Returns#

void

Inherited from#

SingleWidgetShell.clearFlag

***`

close()#

**close**(): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:218

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

Notes#

This is a simple convenience method for sending the message.

Returns#

void

Inherited from#

SingleWidgetShell.close

`***

contains()#

contains(widget): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:145

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.

Inherited from#

SingleWidgetShell.contains

***`

dispose()#

**dispose**(): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:29

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#

SingleWidgetShell.dispose

`***

fit()#

fit(): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:204

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

Notes#

This is a simple convenience method for posting the message.

Returns#

void

Inherited from#

SingleWidgetShell.fit

***`

hasClass()#

**hasClass**(name): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:153

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.

Inherited from#

SingleWidgetShell.hasClass

`***

hide()#

hide(): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:236

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#

SingleWidgetShell.hide

***`

notifyLayout()#

protected **notifyLayout**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:295

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

Inherited from#

SingleWidgetShell.notifyLayout

`***

onActivateRequest()#

protected onActivateRequest(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:330

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

Inherited from#

SingleWidgetShell.onActivateRequest

***`

onAfterAttach()#

protected **onAfterAttach**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:372

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

Notes#

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

Parameters#

msg#

Message

Returns#

void

Inherited from#

SingleWidgetShell.onAfterAttach

`***

onAfterDetach()#

protected onAfterDetach(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:386

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

Inherited from#

SingleWidgetShell.onAfterDetach

***`

onAfterHide()#

protected **onAfterHide**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:358

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

Inherited from#

SingleWidgetShell.onAfterHide

`***

onAfterShow()#

protected onAfterShow(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:344

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

Inherited from#

SingleWidgetShell.onAfterShow

***`

onBeforeAttach()#

protected **onBeforeAttach**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:365

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

Inherited from#

SingleWidgetShell.onBeforeAttach

`***

onBeforeDetach()#

protected onBeforeDetach(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:379

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

Inherited from#

SingleWidgetShell.onBeforeDetach

***`

onBeforeHide()#

protected **onBeforeHide**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:351

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

Inherited from#

SingleWidgetShell.onBeforeHide

`***

onBeforeShow()#

protected onBeforeShow(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:337

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

Inherited from#

SingleWidgetShell.onBeforeShow

***`

onChildAdded()#

protected **onChildAdded**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:393

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

Inherited from#

SingleWidgetShell.onChildAdded

`***

onChildRemoved()#

protected onChildRemoved(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:400

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

Inherited from#

SingleWidgetShell.onChildRemoved

***`

onCloseRequest()#

protected **onCloseRequest**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:302

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

Notes#

The default implementation unparents or detaches the widget.

Parameters#

msg#

Message

Returns#

void

Inherited from#

SingleWidgetShell.onCloseRequest

`***

onFitRequest()#

protected onFitRequest(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:323

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

Inherited from#

SingleWidgetShell.onFitRequest

***`

onResize()#

protected **onResize**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:309

A message handler invoked on a 'resize' message.

Notes#

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

Parameters#

msg#

ResizeMessage

Returns#

void

Inherited from#

SingleWidgetShell.onResize

`***

onUpdateRequest()#

protected onUpdateRequest(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:316

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

Inherited from#

SingleWidgetShell.onUpdateRequest

***`

processMessage()#

**processMessage**(msg): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:284

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

Inherited from#

SingleWidgetShell.processMessage

`***

removeClass()#

removeClass(name): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:175

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

Inherited from#

SingleWidgetShell.removeClass

***`

setFlag()#

**setFlag**(flag): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:265

Set the given widget flag.

Notes#

This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

Parameters#

flag#

Flag

Returns#

void

Inherited from#

SingleWidgetShell.setFlag

`***

setHidden()#

setHidden(hidden): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:245

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

Inherited from#

SingleWidgetShell.setHidden

***`

show()#

**show**(): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:227

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#

SingleWidgetShell.show

`***

testFlag()#

testFlag(flag): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:255

Test whether the given widget flag is set.

Notes#

This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

Parameters#

flag#

Flag

Returns#

boolean

Inherited from#

SingleWidgetShell.testFlag

***`

toggleClass()#

**toggleClass**(name, force?): boolean

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:190

Toggle a class name on the widget’s DOM node.

Parameters#

name#

string

The class name to toggle on the node.

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.

Inherited from#

SingleWidgetShell.toggleClass

`***

update()#

update(): void

Defined in: node_modules/@lumino/widgets/types/widget.d.ts:197

Post an 'update-request' message to the widget.

Notes#

This is a simple convenience method for posting the message.

Returns#

void

Inherited from#

SingleWidgetShell.update

***`

widgets()#

**widgets**(area): IterableIterator\<Widget`>

Defined in: packages/application/src/singleWidgetShell.ts:103

Return the list of widgets for the given area.

Parameters#

area#

"main"

The area

Returns#

IterableIterator<Widget>

Inherited from#

SingleWidgetShell.widgets

On this page
Edit on GitHub

This Page