Construct a console widget.
Private
_bannerPrivate
_cellsPrivate
_contentPrivate
_dragPrivate
_dragPrivate
_executedPrivate
_executorPrivate
_focusedPrivate
_historyPrivate
_inputPrivate
_mimePrivate
_mimetypePrivate
_msgPrivate
_msgPrivate
_promptPrivate
_translatorReadonly
contentThe content factory used by the console.
The configuration options for the text editor widget.
Readonly
modelThe model factory for the console widget.
Readonly
nodeGet the DOM node owned by the widget.
Readonly
rendermimeThe rendermime instance used by the console.
Readonly
sessionThe client session used by the console.
The list of content cells in the console.
This list does not include the current banner or the prompt for a console. It may include previous banners as raw cells.
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.
Private
_createPrivate
_evtHandle focus
events for the widget.
Private
_evtHandle focusout
events for the widget.
Private
_evtHandle the 'keydown'
event for the widget.
Private
_evtHandle mousedown
events for the widget.
Private
_evtHandle mousemove
event of widget
Private
_evtHandle the 'mouseup'
event for the widget.
Private
_executePrivate
_handleUpdate the console based on the kernel info.
Private
_onHandle cell disposed signals.
Private
_onPrivate
_onPrivate
_shouldPrivate
_startPrivate
_updatePost an 'activate-request'
message to the widget.
This is a simple convenience method for posting the message.
Add a new cell to the content panel.
The code cell widget being added to the content panel.
Optional
msgId: stringThe optional execution message id for the cell.
This method is meant for use by outside classes that want to add cells to a
console. It is distinct from the inject
method in that it requires
rendered code cell widgets and does not execute them (though it can store
the execution message id).
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.
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.
Execute the current prompt.
Whether to force execution without checking code completeness.
The length of time, in milliseconds, that the execution
should wait for the API to determine whether code being submitted is
incomplete before attempting submission anyway. The default value is 250
.
Post a 'fit-request'
message to the widget.
This is a simple convenience method for posting the message.
Inject arbitrary code for the console to execute immediately.
The code contents of the cell being injected.
A promise that indicates when the injected cell's execution ends.
Protected
newProtected
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
onProtected
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
onRemove 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.
A widget containing a Jupyter console.
Notes
The CodeConsole class is intended to be used within a ConsolePanel instance. Under most circumstances, it is not instantiated by user code.