Class DocumentModel

The default implementation of a document model.

Hierarchy (view full)

CodeEditor.Model
- DocumentModel

Implements

ICodeModel

Constructors

constructor

new DocumentModel(options?): DocumentModel
Construct a new document model.
Parameters
- options: DocumentRegistry.IModelOptions<ISharedFile> = {}
Returns DocumentModel
Overrides Model.constructor
- Defined in packages/docregistry/src/default.ts:27

Properties

`Private` _collaborationEnabled

_collaborationEnabled: boolean

`Private` _contentChanged

_contentChanged: Signal<DocumentModel, void> = ...

`Private` _defaultLang

_defaultLang: string = ''

`Private` _dirty

_dirty: boolean = false

`Private` _readOnly

_readOnly: boolean = false

`Private` _stateChanged

_stateChanged: Signal<DocumentModel, IChangedArgs<any, any, string>> = ...

`Readonly` sharedModel

sharedModel: ISharedFile

The shared notebook model.

`Protected` standaloneModel

standaloneModel: boolean

Whether the model should disposed the shared model on disposal or not.

Accessors

collaborative

get collaborative(): boolean
Whether the model is collaborative or not.

Returns boolean
Implementation of ICodeModel.collaborative
- Defined in packages/docregistry/src/default.ts:106

contentChanged

get contentChanged(): ISignal<this, void>
A signal emitted when the document content changes.

Returns ISignal<this, void>
Implementation of ICodeModel.contentChanged
- Defined in packages/docregistry/src/default.ts:38

defaultKernelLanguage

get defaultKernelLanguage(): string
The default kernel language of the document.

Notes
This is a read-only property.

Returns string
Implementation of ICodeModel.defaultKernelLanguage
- Defined in packages/docregistry/src/default.ts:99

defaultKernelName

get defaultKernelName(): string
The default kernel name of the document.

Notes
This is a read-only property.

Returns string
Implementation of ICodeModel.defaultKernelName
- Defined in packages/docregistry/src/default.ts:89

dirty

get dirty(): boolean
The dirty state of the document.

Returns boolean
Implementation of ICodeModel.dirty
- Defined in packages/docregistry/src/default.ts:52
set dirty(newValue): void
The dirty state of the model.

Notes
This should be cleared when the document is loaded from or saved to disk.
Parameters
- newValue: boolean
Returns void
Implementation of ICodeModel.dirty
- Defined in packages/docregistry/src/default.ts:55

isDisposed

get isDisposed(): boolean
Whether the model is disposed.

Returns boolean
Implementation of ICodeModel.isDisposed
Inherited from CodeEditor.Model.isDisposed
- Defined in packages/codeeditor/lib/editor.d.ts:164

mimeType

get mimeType(): string
A mime type of the model.

Returns string
Implementation of ICodeModel.mimeType
Inherited from CodeEditor.Model.mimeType
- Defined in packages/codeeditor/lib/editor.d.ts:159
set mimeType(newValue): void
A mime type of the model.

Notes
It is never null, the default mime type is text/plain.
Parameters
- newValue: string
Returns void
Implementation of ICodeModel.mimeType
Inherited from CodeEditor.Model.mimeType
- Defined in packages/codeeditor/lib/editor.d.ts:160

mimeTypeChanged

get mimeTypeChanged(): ISignal<this, IChangedArgs<string, string, string>>
A signal emitted when a mimetype changes.

Returns ISignal<this, IChangedArgs<string, string, string>>
Implementation of ICodeModel.mimeTypeChanged
Inherited from CodeEditor.Model.mimeTypeChanged
- Defined in packages/codeeditor/lib/editor.d.ts:151

readOnly

get readOnly(): boolean
The read only state of the document.

Returns boolean
Implementation of ICodeModel.readOnly
- Defined in packages/docregistry/src/default.ts:71
set readOnly(newValue): void
The read-only state of the model.
Parameters
- newValue: boolean
Returns void
Implementation of ICodeModel.readOnly
- Defined in packages/docregistry/src/default.ts:74

selections

get selections(): IObservableMap<ITextSelection[]>
Get the selections for the model.

Returns IObservableMap<ITextSelection[]>
Implementation of ICodeModel.selections
Inherited from CodeEditor.Model.selections
- Defined in packages/codeeditor/lib/editor.d.ts:155

stateChanged

get stateChanged(): ISignal<this, IChangedArgs<any, any, string>>
A signal emitted when the document state changes.

Returns ISignal<this, IChangedArgs<any, any, string>>
Implementation of ICodeModel.stateChanged
- Defined in packages/docregistry/src/default.ts:45

Methods

`Private` _onStateChanged

_onStateChanged(sender, changes): void
Parameters
- sender: ISharedFile
- changes: DocumentChange
Returns void
- Defined in packages/docregistry/src/default.ts:166

dispose

dispose(): void
Dispose of the resources used by the model.

Returns void
Implementation of ICodeModel.dispose
Inherited from Model.dispose
- Defined in packages/codeeditor/lib/editor.d.ts:168

fromJSON

fromJSON(value): void
Deserialize the model from JSON.

Notes
Should emit a [contentChanged] signal.
Parameters
- value: PartialJSONValue
Returns void
Implementation of ICodeModel.fromJSON
- Defined in packages/docregistry/src/default.ts:140

fromString

fromString(value): void
Deserialize the model from a string.

Notes
Should emit a [contentChanged] signal.
Parameters
- value: string
Returns void
Implementation of ICodeModel.fromString
- Defined in packages/docregistry/src/default.ts:123

initialize

initialize(): void
Initialize the model with its current state.

Returns void
- Defined in packages/docregistry/src/default.ts:147

toJSON

toJSON(): PartialJSONValue
Serialize the model to JSON.

Returns PartialJSONValue
Implementation of ICodeModel.toJSON
- Defined in packages/docregistry/src/default.ts:130

toString

toString(): string
Serialize the model to a string.

Returns string
Implementation of ICodeModel.toString
- Defined in packages/docregistry/src/default.ts:113

`Protected` triggerContentChange

triggerContentChange(): void
Trigger a content changed signal.

Returns void
- Defined in packages/docregistry/src/default.ts:161

`Protected` triggerStateChange

triggerStateChange(args): void
Trigger a state change signal.
Parameters
- args: IChangedArgs<any, any, string>
Returns void
- Defined in packages/docregistry/src/default.ts:154

Class DocumentModel

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DocumentModel

Properties

Private _collaborationEnabled

Private _contentChanged

Private _defaultLang

Private _dirty

Private _readOnly

Private _stateChanged

Readonly sharedModel

Protected standaloneModel

Accessors

collaborative

Returns boolean

contentChanged

Returns ISignal<this, void>

defaultKernelLanguage

Notes

Returns string

defaultKernelName

Notes

Returns string

dirty

Returns boolean

Notes

Parameters

Returns void

isDisposed

Returns boolean

mimeType

Returns string

Notes

Parameters

Returns void

mimeTypeChanged

Returns ISignal<this, IChangedArgs<string, string, string>>

readOnly

Returns boolean

Parameters

Returns void

selections

Returns IObservableMap<ITextSelection[]>

stateChanged

Returns ISignal<this, IChangedArgs<any, any, string>>

Methods

Private _onStateChanged

Parameters

Returns void

dispose

Returns void

fromJSON

Notes

Parameters

Returns void

fromString

Notes

Parameters

Returns void

initialize

Returns void

toJSON

Returns PartialJSONValue

toString

Returns string

Protected triggerContentChange

Returns void

Protected triggerStateChange

Parameters

Returns void

Settings

`Private` _collaborationEnabled

`Private` _contentChanged

`Private` _defaultLang

`Private` _dirty

`Private` _readOnly

`Private` _stateChanged

`Readonly` sharedModel

`Protected` standaloneModel

`Private` _onStateChanged

`Protected` triggerContentChange

`Protected` triggerStateChange