Class Model

A VDomModel for the CommandEdit renderer.

Hierarchy (view full)

VDomModel
- Model

Index

Constructors

Properties

_notebook _notebookMode stateChanged

Accessors

isDisposed notebook notebookMode

Methods

_onChanged _triggerChange dispose

Constructors

constructor

new Model(): CommandEditStatus.Model
Returns CommandEditStatus.Model
Inherited from VDomModel.constructor

Properties

`Private` _notebook

_notebook: null | Notebook = null

`Private` _notebookMode

_notebookMode: NotebookMode = 'command'

`Readonly` stateChanged

stateChanged: Signal<CommandEditStatus.Model, void>

A signal emitted when any model state changes.

Accessors

isDisposed

get isDisposed(): boolean
Test whether the model is disposed.

Returns boolean
Inherited from VDomModel.isDisposed
- Defined in packages/ui-components/lib/components/vdom.d.ts:184

notebook

set notebook(notebook): void
Set the current notebook for the model.
Parameters
- notebook: null | Notebook
Returns void
- Defined in packages/notebook/src/modestatus.tsx:119

notebookMode

get notebookMode(): NotebookMode
The current mode of the current notebook.

Returns NotebookMode
- Defined in packages/notebook/src/modestatus.tsx:112

Methods

`Private` _onChanged

_onChanged(_notebook): void
On a change to the notebook, update the mode.
Parameters
- _notebook: Notebook
Returns void
- Defined in packages/notebook/src/modestatus.tsx:144

`Private` _triggerChange

_triggerChange(oldState, newState): void
Trigger a state change for the renderer.
Parameters
- oldState: NotebookMode
- newState: NotebookMode
Returns void
- Defined in packages/notebook/src/modestatus.tsx:157

dispose

dispose(): void
Dispose the model.

Returns void
Inherited from VDomModel.dispose
- Defined in packages/ui-components/lib/components/vdom.d.ts:188