Readonly
nodeGet the DOM node owned by the widget.
The dataset for the widget's DOM node.
Get the method for hiding the widget.
Set the method for hiding the widget.
Get the id of the widget's DOM node.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
Test whether the widget is visible.
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.
Get the layout for the widget.
Set the layout for the widget.
The layout is single-use only. It cannot be changed after the first assignment.
The layout is disposed automatically when the widget is disposed.
Get the parent of the widget.
Set the parent of the widget.
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.
The title object for the widget.
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.
Post an 'activate-request'
message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
The class name to add to the node.
If the class name is already added to the node, this is a no-op.
The class name must not contain whitespace.
Add an item to the end of the toolbar.
The name of the widget to add to the toolbar.
The widget to add to the toolbar.
Whether the item was added to toolbar. Returns false if an item of the same name is already in the toolbar.
The item can be removed from the toolbar by setting its parent to null
.
Create an iterator over the widget's children.
A new iterator over the children of the widget.
The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.
Send a 'close-request'
message to the widget.
This is a simple convenience method for sending the message.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true
if the widget is a descendant, false
otherwise.
Dispose of the widget and its descendant widgets.
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.
Post a 'fit-request'
message to the widget.
This is a simple convenience method for posting the message.
Protected
handleHandle a DOM click event.
Insert an item into the toolbar at the after a target item.
The target item to insert after.
The name of the item.
The widget to add.
Whether the item was added to the toolbar. Returns false if an item of the same name is already in the toolbar.
The index will be clamped to the bounds of the items.
The item can be removed from the toolbar by setting its parent to null
.
Insert an item into the toolbar at the before a target item.
The target item to insert before.
The name of the item.
The widget to add.
Whether the item was added to the toolbar. Returns false if an item of the same name is already in the toolbar.
The index will be clamped to the bounds of the items.
The item can be removed from the toolbar by setting its parent to null
.
Insert an item into the toolbar at the specified index.
The index at which to insert the item.
The name of the item.
The widget to add.
Whether the item was added to the toolbar. Returns false if an item of the same name is already in the toolbar.
The index will be clamped to the bounds of the items.
The item can be removed from the toolbar by setting its parent to null
.
Protected
insertInsert an item relatively to an other item.
Protected
notifyInvoke the message processing routine of the widget's layout.
The message to dispatch to the layout.
This is a no-op if the widget does not have a layout.
This will not typically be called directly by user code.
Protected
onA message handler invoked on an 'activate-request'
message.
The default implementation of this handler is a no-op.
Protected
onProtected
onA message handler invoked on an 'after-detach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-show'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-attach'
message.
The default implementation of this handler is a no-op.
Protected
onProtected
onA message handler invoked on a 'before-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-show'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-added'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-removed'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'close-request'
message.
The default implementation unparents or detaches the widget.
Protected
onA message handler invoked on a 'fit-request'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'update-request'
message.
The default implementation of this handler is a no-op.
Remove a class name from the widget's DOM node.
The class name to remove from the node.
If the class name is not yet added to the node, this is a no-op.
The class name must not contain whitespace.
Show or hide the widget according to a boolean value.
true
to hide the widget, or false
to show it.
This is a convenience method for hide()
and show()
.
Test whether the given widget flag is set.
This will not typically be called directly by user code.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optional
force: booleanWhether 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.
true
if the class is now present, false
otherwise.
The class name must not contain whitespace.
Post an 'update-request'
message to the widget.
This is a simple convenience method for posting the message.
Deprecated
since v4 This class is in @jupyterlab/ui-components