Theia API Documentation v1.65.0
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _dirty: boolean
    _languageId: undefined | string
    _valid: boolean

    Use valid to access it. Use setValid to mutate it.

    bufferSavedVersionId: number
    editorPreferences?: EditorPreferences
    ignoreContentChanges: boolean
    ignoreDirtyEdits: boolean
    lineNumbersMinChars: number
    logger?: ILogger
    model: ITextModel
    onDidChangeContentEmitter: Emitter<MonacoModelContentChangedEvent>
    onDidChangeEncoding: Event<string>
    onDidChangeEncodingEmitter: Emitter<string>
    onDidChangeReadOnly: Event<boolean | MarkdownString>
    onDidChangeValid: Event<void>
    onDidChangeValidEmitter: Emitter<void>
    onDidSaveModel: Event<ITextModel>
    onDidSaveModelEmitter: Emitter<ITextModel>
    onDirtyChangedEmitter: Emitter<void>
    onModelWillSaveModel: Registration<WillSaveMonacoModelEvent, Promise<void>>
    onWillSaveLoopTimeOut: 1500

    there is no general save timeout, each participant should introduce a sensible timeout

    onWillSaveModelListeners: ListenerList<WillSaveMonacoModelEvent, Promise<void>>
    pendingOperation: Promise<void>
    resolveModel: Promise<void>
    resource: Resource
    resourceVersion: undefined | ResourceVersion
    saveCancellationTokenSource: CancellationTokenSource
    suppressOpenEditorWhenDirty: boolean
    syncCancellationTokenSource: CancellationTokenSource
    toDisposeOnAutoSave: DisposableCollection

    Accessors

    • get autosaveable(): undefined | boolean

      If false, the saveable will not participate in autosaving.

      Returns undefined | boolean

    • get dirty(): boolean

      Returns boolean

    • get languageId(): string

      The identifier of the language associated with this document.

      Returns string

    • get lineCount(): number

      The number of lines in this document.

      Returns number

    • get onContentChanged(): Event<void>

      This event is fired when the content of the saveable changes. While onDirtyChanged is fired to notify the UI that the widget is dirty, onContentChanged is used for the auto save throttling.

      Returns Event<void>

    • get onDirtyChanged(): Event<void>

      This event is fired when the content of the dirty variable changes.

      Returns Event<void>

    • get onDispose(): IEvent<void>

      Returns IEvent<void>

    • get onWillDispose(): Event<void>

      Emitted when the text model is about to be disposed.

      Returns Event<void>

    • get textEditorModel(): ITextModel & ITextModel

      Same as ITextEditorModel#textEditorModel, but never null.

      Returns ITextModel & ITextModel

    • get uri(): string

      The associated URI for this document. Most documents have the file-scheme, indicating that they represent files on disk. However, some documents may have other schemes indicating that they are not available on disk.

      Returns string

    • get valid(): boolean

      Whether it is possible to load content from the underlying resource.

      Returns boolean

    • get version(): number

      The version number of this document (it will increase after each change, including undo/redo).

      Returns number

    Methods

    • Creates a snapshot of the model's contents.

      Parameters

      • OptionalpreserveBOM: boolean

      Returns ITextSnapshot

    • Dispose this object.

      Returns void

    • Optionally return file filters for the "Save As" dialog. The keys of the returned object are the names of the filters and the values are arrays of file extensions. For example: { 'Text Files': ['txt', 'text'], 'All Files': ['*'] } If no filters are provided, a default filter of All Files (*.*) will be used.

      Returns { [name: string]: string[] }

    • Parameters

      • event: IModelContentChangedEvent

      Returns void

    • Returns undefined | string

    • The language id of the text model if known.

      Returns undefined | string

    • Retrieves a line in a text document expressed as a one-based position.

      Parameters

      • lineNumber: number

      Returns string

    • Parameters

      • lineNumber: number

        1-based

      Returns number

    • Return selected text by Range or all text by default

      Parameters

      Returns string

    • Only this method can create an instance of monaco.editor.IModel, there should not be other calls to monaco.editor.createModel.

      Parameters

      • value: string | ITextBufferFactory

      Returns void

    • Find out if this text model has been disposed.

      Returns boolean

    • Find out if the editor model was resolved or not.

      Returns boolean

    • Returns void

    • Converts a zero-based offset to a position.

      Parameters

      • offset: number

        A zero-based offset.

      Returns Position

      A valid position.

    • Returns Promise<undefined | string | ITextBufferFactory>

    • Returns void

    • Resolves the model.

      Returns Promise<void>

    • Parameters

      • operation: () => Promise<void>

      Returns Promise<void>

    • Saves dirty changes.

      Parameters

      Returns Promise<void>

    • It's a hack to dispatch close notification with an old language id; don't use it.

      Parameters

      • languageId: undefined | string

      Returns void

    • Parameters

      • encoding: string

      Returns boolean

    • Parameters

      • valid: boolean

      Returns void

    • Returns Promise<void>

    • Creates a valid position. If the position is outside of the backing document, this method will return a position that is ensured to be inside the document and valid. For example, when the position is { line: 1, character: 0 } and the document is empty, this method will return with { line: 0, character: 0 }.

      Parameters

      Returns Position

    • Creates a valid range. If the range argument is outside of the document, this method will return with a new range that does not exceed the boundaries of the document. For example, if the argument is { start: { line: 1, character: 0 }, end: { line: 1, character: 0 } } and the document is empty, the return value is { start: { line: 0, character: 0 }, end: { line: 0, character: 0 } }.

      Parameters

      Returns Range

    • Returns void