Class Model

A VDomModel for the SavingStatus item.

Hierarchy (view full)

VDomModel
- Model

Index

Constructors

Properties

_docManager _status _widget stateChanged

Accessors

isDisposed status widget

Methods

_onStatusChange dispose

Constructors

constructor

new Model(docManager): SavingStatus.Model
Create a new SavingStatus model.
Parameters
- docManager: IDocumentManager
Returns SavingStatus.Model
Overrides VDomModel.constructor
- Defined in packages/docmanager/src/savingstatus.tsx:93

Properties

`Private` _docManager

_docManager: IDocumentManager

`Private` _status

_status: null | DocumentRegistry.SaveState = null

`Private` _widget

_widget: null | Widget = null

`Readonly` stateChanged

stateChanged: Signal<SavingStatus.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

status

get status(): null | DocumentRegistry.SaveState
The current status of the model.

Returns null | DocumentRegistry.SaveState
- Defined in packages/docmanager/src/savingstatus.tsx:104

widget

get widget(): null | Widget
The current widget for the model. Any widget can be assigned, but it only has any effect if the widget is an IDocument widget known to the application document manager.

Returns null | Widget
- Defined in packages/docmanager/src/savingstatus.tsx:113
set widget(widget): void
Parameters
- widget: null | Widget
Returns void
- Defined in packages/docmanager/src/savingstatus.tsx:116

Methods

`Private` _onStatusChange

_onStatusChange(_, newStatus): void
React to a saving status change from the current document widget.
Parameters
- _: any
- newStatus: DocumentRegistry.SaveState
Returns void
- Defined in packages/docmanager/src/savingstatus.tsx:147

dispose

dispose(): void
Dispose the model.

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