Options
All
  • Public
  • Public/Protected
  • All
Menu

A model.

Hierarchy

  • ITextModel

Index

Events

onDidChangeAttached: IEvent<void>

An event emitted when the model has been attached to the first editor or detached from the last editor.

onDidChangeDecorations: IEvent<IModelDecorationsChangedEvent>

An event emitted when decorations of the model have changed.

onDidChangeLanguage: IEvent<IModelLanguageChangedEvent>

An event emitted when the language associated with the model has changed.

onDidChangeLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>

An event emitted when the language configuration associated with the model has changed.

onDidChangeOptions: IEvent<IModelOptionsChangedEvent>

An event emitted when the model options have changed.

onWillDispose: IEvent<void>

An event emitted right before disposing the model.

Properties

id: string

A unique identifier associated with this model.

uri: Uri

Gets the resource associated with this editor model.

Methods

  • deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[], ownerId?: number): string[]
  • Perform a minimum amount of operations, in order to transform the decorations identified by oldDecorations to the decorations described by newDecorations and returns the new identifiers associated with the resulting decorations.

    Parameters

    • oldDecorations: string[]

      Array containing previous decorations identifiers.

    • newDecorations: IModelDeltaDecoration[]

      Array describing what decorations should result after the call.

    • Optional ownerId: number

      Identifies the editor id in which these decorations should appear. If no ownerId is provided, the decorations will appear in all editors that attach this model.

    Returns string[]

    An array containing the new decorations identifiers.

  • detectIndentation(defaultInsertSpaces: boolean, defaultTabSize: number): void
  • Detect the indentation options for this model from its content.

    Parameters

    • defaultInsertSpaces: boolean
    • defaultTabSize: number

    Returns void

  • dispose(): void
  • findMatches(searchString: string, searchOnlyEditableRange: boolean, isRegex: boolean, matchCase: boolean, wordSeparators: string, captureMatches: boolean, limitResultCount?: number): FindMatch[]
  • findMatches(searchString: string, searchScope: IRange | IRange[], isRegex: boolean, matchCase: boolean, wordSeparators: string, captureMatches: boolean, limitResultCount?: number): FindMatch[]
  • Search the model.

    Parameters

    • searchString: string

      The string used to search. If it is a regular expression, set isRegex to true.

    • searchOnlyEditableRange: boolean

      Limit the searching to only search inside the editable range of the model.

    • isRegex: boolean

      Used to indicate that searchString is a regular expression.

    • matchCase: boolean

      Force the matching to match lower/upper case exactly.

    • wordSeparators: string

      Force the matching to match entire words only. Pass null otherwise.

    • captureMatches: boolean

      The result will contain the captured groups.

    • Optional limitResultCount: number

      Limit the number of results

    Returns FindMatch[]

    The ranges where the matches are. It is empty if not matches have been found.

  • Search the model.

    Parameters

    • searchString: string

      The string used to search. If it is a regular expression, set isRegex to true.

    • searchScope: IRange | IRange[]

      Limit the searching to only search inside these ranges.

    • isRegex: boolean

      Used to indicate that searchString is a regular expression.

    • matchCase: boolean

      Force the matching to match lower/upper case exactly.

    • wordSeparators: string

      Force the matching to match entire words only. Pass null otherwise.

    • captureMatches: boolean

      The result will contain the captured groups.

    • Optional limitResultCount: number

      Limit the number of results

    Returns FindMatch[]

    The ranges where the matches are. It is empty if no matches have been found.

  • findNextMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wordSeparators: string, captureMatches: boolean): FindMatch
  • Search the model for the next match. Loops to the beginning of the model if needed.

    Parameters

    • searchString: string

      The string used to search. If it is a regular expression, set isRegex to true.

    • searchStart: IPosition

      Start the searching at the specified position.

    • isRegex: boolean

      Used to indicate that searchString is a regular expression.

    • matchCase: boolean

      Force the matching to match lower/upper case exactly.

    • wordSeparators: string

      Force the matching to match entire words only. Pass null otherwise.

    • captureMatches: boolean

      The result will contain the captured groups.

    Returns FindMatch

    The range where the next match is. It is null if no next match has been found.

  • findPreviousMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wordSeparators: string, captureMatches: boolean): FindMatch
  • Search the model for the previous match. Loops to the end of the model if needed.

    Parameters

    • searchString: string

      The string used to search. If it is a regular expression, set isRegex to true.

    • searchStart: IPosition

      Start the searching at the specified position.

    • isRegex: boolean

      Used to indicate that searchString is a regular expression.

    • matchCase: boolean

      Force the matching to match lower/upper case exactly.

    • wordSeparators: string

      Force the matching to match entire words only. Pass null otherwise.

    • captureMatches: boolean

      The result will contain the captured groups.

    Returns FindMatch

    The range where the previous match is. It is null if no previous match has been found.

  • getAllDecorations(ownerId?: number, filterOutValidation?: boolean): IModelDecoration[]
  • Gets all the decorations as an array.

    Parameters

    • Optional ownerId: number

      If set, it will ignore decorations belonging to other owners.

    • Optional filterOutValidation: boolean

      If set, it will ignore decorations specific to validation (i.e. warnings, errors).

    Returns IModelDecoration[]

  • getAlternativeVersionId(): number
  • Get the alternative version id of the model. This alternative version id is not always incremented, it will return the same values in the case of undo-redo.

    Returns number

  • getCharacterCountInRange(range: IRange): number
  • getDecorationRange(id: string): Range
  • Get the range associated with a decoration.

    Parameters

    • id: string

      The decoration id.

    Returns Range

    The decoration range or null if the decoration was not found.

  • getDecorationsInRange(range: IRange, ownerId?: number, filterOutValidation?: boolean, onlyMinimapDecorations?: boolean): IModelDecoration[]
  • Gets all the decorations in a range as an array. Only startLineNumber and endLineNumber from range are used for filtering. So for now it returns all the decorations on the same line as range.

    Parameters

    • range: IRange

      The range to search in

    • Optional ownerId: number

      If set, it will ignore decorations belonging to other owners.

    • Optional filterOutValidation: boolean

      If set, it will ignore decorations specific to validation (i.e. warnings, errors).

    • Optional onlyMinimapDecorations: boolean

    Returns IModelDecoration[]

    An array with the decorations

  • getEOL(): string
  • Get the end of line sequence predominantly used in the text buffer.

    Returns string

    EOL char sequence (e.g.: '\n' or '\r\n').

  • getFullModelRange(): Range
  • getLanguageId(): string
  • getLineContent(lineNumber: number): string
  • getLineCount(): number
  • getLineDecorations(lineNumber: number, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[]
  • Gets all the decorations for the line lineNumber as an array.

    Parameters

    • lineNumber: number

      The line number

    • Optional ownerId: number

      If set, it will ignore decorations belonging to other owners.

    • Optional filterOutValidation: boolean

      If set, it will ignore decorations specific to validation (i.e. warnings, errors).

    Returns IModelDecoration[]

    An array with the decorations

  • getLineFirstNonWhitespaceColumn(lineNumber: number): number
  • Returns the column before the first non whitespace character for line at lineNumber. Returns 0 if line is empty or contains only whitespace.

    Parameters

    • lineNumber: number

    Returns number

  • getLineLastNonWhitespaceColumn(lineNumber: number): number
  • Returns the column after the last non whitespace character for line at lineNumber. Returns 0 if line is empty or contains only whitespace.

    Parameters

    • lineNumber: number

    Returns number

  • getLineLength(lineNumber: number): number
  • getLineMaxColumn(lineNumber: number): number
  • getLineMinColumn(lineNumber: number): number
  • getLinesContent(): string[]
  • getLinesDecorations(startLineNumber: number, endLineNumber: number, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[]
  • Gets all the decorations for the lines between startLineNumber and endLineNumber as an array.

    Parameters

    • startLineNumber: number

      The start line number

    • endLineNumber: number

      The end line number

    • Optional ownerId: number

      If set, it will ignore decorations belonging to other owners.

    • Optional filterOutValidation: boolean

      If set, it will ignore decorations specific to validation (i.e. warnings, errors).

    Returns IModelDecoration[]

    An array with the decorations

  • getOverviewRulerDecorations(ownerId?: number, filterOutValidation?: boolean): IModelDecoration[]
  • Gets all the decorations that should be rendered in the overview ruler as an array.

    Parameters

    • Optional ownerId: number

      If set, it will ignore decorations belonging to other owners.

    • Optional filterOutValidation: boolean

      If set, it will ignore decorations specific to validation (i.e. warnings, errors).

    Returns IModelDecoration[]

  • Get the text stored in this model.

    Parameters

    • Optional eol: EndOfLinePreference

      The end of line character preference. Defaults to EndOfLinePreference.TextDefined.

    • Optional preserveBOM: boolean

    Returns string

    The text.

  • Get the text in a certain range.

    Parameters

    • range: IRange

      The range describing what text to get.

    • Optional eol: EndOfLinePreference

      The end of line character preference. This will only be used for multiline ranges. Defaults to EndOfLinePreference.TextDefined.

    Returns string

    The text.

  • getValueLengthInRange(range: IRange): number
  • getVersionId(): number
  • Get the current version id of the model. Anytime a change happens to the model (even undo/redo), the version id is incremented.

    Returns number

  • isAttachedToEditor(): boolean
  • isDisposed(): boolean
  • Advances the given position by the given offset (negative offsets are also accepted) and returns it as a new valid position.

    If the offset and position are such that their combination goes beyond the beginning or end of the model, throws an exception.

    If the offset is such that the new position would be in the middle of a multi-byte line terminator, throws an exception.

    Parameters

    Returns Position

  • normalizeIndentation(str: string): string
  • Normalize a string containing whitespace according to indentation rules (converts to spaces or to tabs).

    Parameters

    • str: string

    Returns string

  • popStackElement(): void
  • Push edit operations, basically editing the model. This is the preferred way of editing the model. The edit operations will land on the undo stack.

    Parameters

    • beforeCursorState: Selection[]

      The cursor state before the edit operations. This cursor state will be returned when undo or redo are invoked.

    • editOperations: IIdentifiedSingleEditOperation[]

      The edit operations.

    • cursorStateComputer: ICursorStateComputer

      A callback that can compute the resulting cursors state after the edit operations have been executed.

    Returns Selection[]

    The cursor state returned by the cursorStateComputer.

  • pushStackElement(): void