Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutputEditorModel

Hierarchy

  • MonacoEditorModel
    • OutputEditorModel

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new OutputEditorModel(resource: Resource, m2p: MonacoToProtocolConverter, p2m: ProtocolToMonacoConverter, logger?: ILogger, editorPreferences?: PreferenceProxy<EditorConfiguration>): OutputEditorModel

  • Parameters

    • resource: Resource
    • m2p: MonacoToProtocolConverter
    • p2m: ProtocolToMonacoConverter
    • Optional logger: ILogger
    • Optional editorPreferences: PreferenceProxy<EditorConfiguration>

    Returns OutputEditorModel

Properties

Protected _dirty

_dirty: boolean

Protected _languageId

_languageId: undefined | string

Protected _valid

_valid: boolean

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

autoSave

autoSave: "on" | "off"

autoSaveDelay

autoSaveDelay: number

Protected bufferSavedVersionId

bufferSavedVersionId: number

Protected Readonly contentChanges

contentChanges: TextDocumentContentChangeEvent[]

Protected Optional Readonly editorPreferences

editorPreferences: PreferenceProxy<EditorConfiguration>

Protected ignoreContentChanges

ignoreContentChanges: boolean

Protected ignoreDirtyEdits

ignoreDirtyEdits: boolean

lineNumbersMinChars

lineNumbersMinChars: number

Protected Optional Readonly logger

logger: ILogger

Protected Readonly m2p

m2p: MonacoToProtocolConverter

Protected model

model: ITextModel

Readonly onDidChangeContent

onDidChangeContent: Event<MonacoModelContentChangedEvent>

Protected Readonly onDidChangeContentEmitter

onDidChangeContentEmitter: Emitter<MonacoModelContentChangedEvent>

Readonly onDidChangeEncoding

onDidChangeEncoding: Event<string>

Protected Readonly onDidChangeEncodingEmitter

onDidChangeEncodingEmitter: Emitter<string>

Readonly onDidChangeValid

onDidChangeValid: Event<void>

Protected Readonly onDidChangeValidEmitter

onDidChangeValidEmitter: Emitter<void>

Readonly onDidSaveModel

onDidSaveModel: Event<ITextModel>

Protected Readonly onDidSaveModelEmitter

onDidSaveModelEmitter: Emitter<ITextModel>

Protected Readonly onDirtyChangedEmitter

onDirtyChangedEmitter: Emitter<void>

Readonly onWillSaveLoopTimeOut

onWillSaveLoopTimeOut: 1500 = 1500

Readonly onWillSaveModel

onWillSaveModel: Event<WillSaveMonacoModelEvent>

Protected Readonly onWillSaveModelEmitter

onWillSaveModelEmitter: Emitter<WillSaveMonacoModelEvent>

Protected Readonly p2m

p2m: ProtocolToMonacoConverter

Protected pendingOperation

pendingOperation: Promise<void>

Protected Readonly resolveModel

resolveModel: Promise<void>

Protected Readonly resource

resource: Resource

Protected resourceVersion

resourceVersion: undefined | ResourceVersion

Protected saveCancellationTokenSource

saveCancellationTokenSource: CancellationTokenSource

suppressOpenEditorWhenDirty

suppressOpenEditorWhenDirty: boolean

Protected syncCancellationTokenSource

syncCancellationTokenSource: CancellationTokenSource

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnAutoSave

toDisposeOnAutoSave: DisposableCollection

Accessors

dirty

  • get dirty(): boolean

  • Returns boolean

languageId

  • get languageId(): string

  • Returns string

lineCount

  • get lineCount(): number

  • Returns number

onDirtyChanged

  • get onDirtyChanged(): Event<void>

  • Returns Event<void>

onDispose

  • get onDispose(): IEvent<void>

  • Returns IEvent<void>

readOnly

  • get readOnly(): boolean

textEditorModel

  • get textEditorModel(): ITextModel

  • Returns ITextModel

uri

  • get uri(): string

  • Returns string

valid

  • get valid(): boolean

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

    Returns boolean

version

  • get version(): number

  • Returns number

Methods

Protected applyEdits

  • applyEdits(operations: IIdentifiedSingleEditOperation[], options?: Partial<ApplyEditsOptions>): void

  • Parameters

    • operations: IIdentifiedSingleEditOperation[]
    • Optional options: Partial<ApplyEditsOptions>

    Returns void

applySnapshot

  • applySnapshot(snapshot: { value: string }): void

  • Parameters

    • snapshot: { value: string }
      • value: string

    Returns void

Protected asContentChangedEvent

  • asContentChangedEvent(event: IModelContentChangedEvent): MonacoModelContentChangedEvent

  • Parameters

    • event: IModelContentChangedEvent

    Returns MonacoModelContentChangedEvent

Protected asTextDocumentContentChangeEvent

  • asTextDocumentContentChangeEvent(change: IModelContentChange): TextDocumentContentChangeEvent

  • Parameters

    • change: IModelContentChange

    Returns TextDocumentContentChangeEvent

Protected cancelSave

  • cancelSave(): CancellationToken

  • Returns CancellationToken

Protected cancelSync

  • cancelSync(): CancellationToken

  • Returns CancellationToken

createSnapshot

  • createSnapshot(): object

  • Returns object

dispose

  • dispose(): void

  • Returns void

Protected doAutoSave

  • doAutoSave(): void

  • Returns void

Protected doSave

  • doSave(reason: TextDocumentSaveReason, token: CancellationToken, overwriteEncoding?: boolean, options?: SaveOptions): Promise<void>

  • Parameters

    • reason: TextDocumentSaveReason
    • token: CancellationToken
    • Optional overwriteEncoding: boolean
    • Optional options: SaveOptions

    Returns Promise<void>

Protected doSync

  • doSync(token: CancellationToken): Promise<void>

  • Parameters

    • token: CancellationToken

    Returns Promise<void>

findMatches

  • findMatches(options: FindMatchesOptions): FindMatch[]

  • Find all matches in an editor for the given options.

    Parameters

    • options: FindMatchesOptions

      the options for finding matches.

    Returns FindMatch[]

    the list of matches.

Protected fireDidChangeContent

  • fireDidChangeContent(event: IModelContentChangedEvent): void

  • Parameters

    • event: IModelContentChangedEvent

    Returns void

Protected fireDidSaveModel

  • fireDidSaveModel(): void

  • Returns void

Protected fireWillSaveModel

  • fireWillSaveModel(reason: TextDocumentSaveReason, token: CancellationToken, options?: SaveOptions): Promise<void>

  • Parameters

    • reason: TextDocumentSaveReason
    • token: CancellationToken
    • Optional options: SaveOptions

    Returns Promise<void>

getEncoding

  • getEncoding(): undefined | string

  • Returns undefined | string

getLineContent

  • getLineContent(lineNumber: number): string

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

    Parameters

    • lineNumber: number

    Returns string

getLineMaxColumn

  • getLineMaxColumn(lineNumber: number): number

  • Parameters

    • lineNumber: number

    Returns number

getText

  • getText(range?: Range): string

  • Return selected text by Range or all text by default

    Parameters

    • Optional range: Range

    Returns string

Protected initialize

  • initialize(value: any): void

  • Important

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

    Parameters

    • value: any

    Returns void

load

  • load(): Promise<MonacoEditorModel>

  • Returns Promise<MonacoEditorModel>

Protected markAsDirty

  • markAsDirty(): void

  • Returns void

offsetAt

  • offsetAt(position: Position): number

  • Parameters

    • position: Position

    Returns number

positionAt

  • positionAt(offset: number): Position

  • Parameters

    • offset: number

    Returns Position

Protected pushContentChanges

  • pushContentChanges(contentChanges: TextDocumentContentChangeEvent[]): void

  • Parameters

    • contentChanges: TextDocumentContentChangeEvent[]

    Returns void

Protected readContents

  • readContents(): Promise<any>

  • Returns Promise<any>

revert

  • revert(options?: RevertOptions): Promise<void>

  • Parameters

    • Optional options: RevertOptions

    Returns Promise<void>

Protected run

  • run(operation: () => Promise<void>): Promise<void>

  • Parameters

    • operation: () => Promise<void>
        • (): Promise<void>

        • Returns Promise<void>

    Returns Promise<void>

save

  • save(options?: SaveOptions): Promise<void>

  • Parameters

    • Optional options: SaveOptions

    Returns Promise<void>

Protected scheduleSave

  • scheduleSave(reason: TextDocumentSaveReason, token?: CancellationToken, overwriteEncoding?: boolean, options?: SaveOptions): Promise<void>

  • Parameters

    • reason: TextDocumentSaveReason
    • Optional token: CancellationToken
    • Optional overwriteEncoding: boolean
    • Optional options: SaveOptions

    Returns Promise<void>

Protected setDirty

  • setDirty(dirty: boolean): void

setEncoding

  • setEncoding(encoding: string, mode: EncodingMode): Promise<void>

  • Parameters

    • encoding: string
    • mode: EncodingMode

    Returns Promise<void>

setLanguageId

  • setLanguageId(languageId: undefined | string): void

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

    Parameters

    • languageId: undefined | string

    Returns void

Protected setPreferredEncoding

  • setPreferredEncoding(encoding: string): boolean

  • Parameters

    • encoding: string

    Returns boolean

Protected setValid

  • setValid(valid: boolean): void

  • Parameters

    • valid: boolean

    Returns void

sync

  • sync(): Promise<void>

  • Returns Promise<void>

Protected trace

  • trace(loggable: Loggable): void

  • Parameters

    • loggable: Loggable

    Returns void

Protected updateContentEncoding

  • updateContentEncoding(): void

  • Returns void

Protected updateModel

  • updateModel<T>(doUpdate: () => T, options?: Partial<ApplyEditsOptions>): T

  • Type parameters

    • T

    Parameters

    • doUpdate: () => T
        • (): T

        • Returns T

    • Optional options: Partial<ApplyEditsOptions>

    Returns T