Class Model

A VDomModel for rendering the PathStatus status item.

Hierarchy (view full)

VDomModel
- Model

Index

Constructors

Properties

_docManager _name _path _widget stateChanged

Accessors

isDisposed name path widget

Methods

_getAllState _onPathChange _onTitleChange _triggerChange dispose

Constructors

constructor

new Model(docManager): PathStatus.Model
Construct a new model.
Parameters
- docManager: IDocumentManager
  the application document manager. Used to check whether the current widget is a document.
Returns PathStatus.Model
Overrides VDomModel.constructor
- Defined in packages/docmanager/src/pathstatus.tsx:84

Properties

`Private` _docManager

_docManager: IDocumentManager

`Private` _name

_name: string = ''

`Private` _path

_path: string = ''

`Private` _widget

_widget: null | Widget = null

`Readonly` stateChanged

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

name

get name(): string
The name of the current activity.

Returns string
- Defined in packages/docmanager/src/pathstatus.tsx:99

path

get path(): string
The current path for the application.

Returns string
- Defined in packages/docmanager/src/pathstatus.tsx:92

widget

get widget(): null | Widget
The current widget for the application.

Returns null | Widget
- Defined in packages/docmanager/src/pathstatus.tsx:106
set widget(widget): void
Parameters
- widget: null | Widget
Returns void
- Defined in packages/docmanager/src/pathstatus.tsx:109

Methods

`Private` _getAllState

_getAllState(): [string, string]
Get the current state of the model.

Returns [string, string]
- Defined in packages/docmanager/src/pathstatus.tsx:169

`Private` _onPathChange

_onPathChange(_documentModel, newPath): void
React to a path change for the current document.
Parameters
- _documentModel: IContext<DocumentRegistry.IModel>
- newPath: string
Returns void
- Defined in packages/docmanager/src/pathstatus.tsx:155

`Private` _onTitleChange

_onTitleChange(title): void
React to a title change for the current widget.
Parameters
- title: Title<Widget>
Returns void
- Defined in packages/docmanager/src/pathstatus.tsx:146

`Private` _triggerChange

_triggerChange(oldState, newState): void
Trigger a state change to rerender.
Parameters
- oldState: [string, string]
- newState: [string, string]
Returns void
- Defined in packages/docmanager/src/pathstatus.tsx:176

dispose

dispose(): void
Dispose the model.

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