Class TextModelFactory

An implementation of a model factory for text files.

Hierarchy (view full)

TextModelFactory
- Base64ModelFactory

Implements

CodeModelFactory

Index

Constructors

Properties

_collaborative _isDisposed

Accessors

collaborative contentType fileFormat isDisposed name

Methods

createNew dispose preferredLanguage

Constructors

constructor

new TextModelFactory(collaborative?): TextModelFactory
Instantiates a TextModelFactory.
Parameters
- Optional collaborative: boolean
Returns TextModelFactory
- Defined in packages/docregistry/src/default.ts:207

Properties

`Private` _collaborative

_collaborative: boolean

`Private` _isDisposed

_isDisposed: boolean = false

Accessors

collaborative

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

Returns boolean
Implementation of DocumentRegistry.CodeModelFactory.collaborative
- Defined in packages/docregistry/src/default.ts:243

contentType

get contentType(): string
The type of the file.

Notes
This is a read-only property.

Returns string
Implementation of DocumentRegistry.CodeModelFactory.contentType
- Defined in packages/docregistry/src/default.ts:227

fileFormat

get fileFormat(): FileFormat
The format of the file.

This is a read-only property.

Returns FileFormat
Implementation of DocumentRegistry.CodeModelFactory.fileFormat
- Defined in packages/docregistry/src/default.ts:236

isDisposed

get isDisposed(): boolean
Get whether the model factory has been disposed.

Returns boolean
Implementation of DocumentRegistry.CodeModelFactory.isDisposed
- Defined in packages/docregistry/src/default.ts:250

name

get name(): string
The name of the model type.

Notes
This is a read-only property.

Returns string
Implementation of DocumentRegistry.CodeModelFactory.name
- Defined in packages/docregistry/src/default.ts:217

Methods

createNew

createNew(options?): ICodeModel
Create a new model.
Parameters
- options: DocumentRegistry.IModelOptions<ISharedFile> = {}
  Model options.
Returns ICodeModel
A new document model.
Implementation of DocumentRegistry.CodeModelFactory.createNew
- Defined in packages/docregistry/src/default.ts:268

dispose

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

Returns void
Implementation of DocumentRegistry.CodeModelFactory.dispose
- Defined in packages/docregistry/src/default.ts:257

preferredLanguage

preferredLanguage(path): string
Get the preferred kernel language given a file path.
Parameters
- path: string
Returns string
Implementation of DocumentRegistry.CodeModelFactory.preferredLanguage
- Defined in packages/docregistry/src/default.ts:281