MonacoDiffEditor | Theia TypeDoc

Hierarchy

MonacoEditor
- MonacoDiffEditor

Index

Constructors

constructor

Accessors

Constructors

constructor

new MonacoDiffEditor(uri: URI, node: HTMLElement, originalModel: MonacoEditorModel, modifiedModel: MonacoEditorModel, services: MonacoEditorServices, diffNavigatorFactory: MonacoDiffNavigatorFactory, options?: MonacoDiffEditor.IOptions, override?: EditorServiceOverrides): MonacoDiffEditor

Overrides MonacoEditor.constructor
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:38
Parameters
- uri: URI
- node: HTMLElement
- originalModel: MonacoEditorModel
- modifiedModel: MonacoEditorModel
- services: MonacoEditorServices
- diffNavigatorFactory: MonacoDiffNavigatorFactory
- Optional options: MonacoDiffEditor.IOptions
- Optional override: EditorServiceOverrides
Returns MonacoDiffEditor

Properties

Protected _diffEditor

_diffEditor: IStandaloneDiffEditor

Protected _diffNavigator

_diffNavigator: DiffNavigator

Protected _languageAutoDetected

_languageAutoDetected: boolean = true

Protected Readonly autoSizing

autoSizing: boolean

Protected Readonly contextKeyService

contextKeyService: ContextKeyService

Protected Readonly diffNavigatorFactory

diffNavigatorFactory: MonacoDiffNavigatorFactory

Readonly document

document: MonacoEditorModel

Readonly documents

documents: Set<MonacoEditorModel> = ...

Protected editor

editor: IStandaloneCodeEditor

Protected Readonly m2p

m2p: MonacoToProtocolConverter

Protected Readonly maxHeight

maxHeight: number

Protected Readonly minHeight

minHeight: number

Readonly modifiedModel

modifiedModel: MonacoEditorModel

Readonly node

node: HTMLElement

Protected Readonly onCursorPositionChangedEmitter

onCursorPositionChangedEmitter: Emitter<Position> = ...

Readonly onDidResize

onDidResize: Event<null | Dimension> = ...

Protected Readonly onDocumentContentChangedEmitter

onDocumentContentChangedEmitter: Emitter<TextDocumentChangeEvent> = ...

Readonly onEncodingChanged

onEncodingChanged: Event<string> = ...

Protected Readonly onFocusChangedEmitter

onFocusChangedEmitter: Emitter<boolean> = ...

Readonly onLanguageChanged

onLanguageChanged: Event<string> = ...

Protected Readonly onLanguageChangedEmitter

onLanguageChangedEmitter: Emitter<string> = ...

Protected Readonly onMouseDownEmitter

onMouseDownEmitter: Emitter<EditorMouseEvent> = ...

Protected Readonly onResizeEmitter

onResizeEmitter: Emitter<null | Dimension> = ...

Protected Readonly onScrollChangedEmitter

onScrollChangedEmitter: Emitter<void> = ...

Protected Readonly onSelectionChangedEmitter

onSelectionChangedEmitter: Emitter<Range> = ...

Readonly originalModel

originalModel: MonacoEditorModel

Protected Readonly p2m

p2m: ProtocolToMonacoConverter

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Readonly uri

uri: URI

Accessors

cursor

get cursor(): Position
set cursor(cursor: Position): void

Inherited from MonacoEditor.cursor
- Defined in packages/monaco/src/browser/monaco-editor.ts:227
Returns Position
Inherited from MonacoEditor.cursor
- Defined in packages/monaco/src/browser/monaco-editor.ts:232
Parameters
- cursor: Position
Returns void

diffEditor

get diffEditor(): IStandaloneDiffEditor

- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:56
Returns IStandaloneDiffEditor

diffNavigator

get diffNavigator(): DiffNavigator

- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:60
Returns DiffNavigator

isReadonly

get isReadonly(): boolean

Inherited from MonacoEditor.isReadonly
- Defined in packages/monaco/src/browser/monaco-editor.ts:223
Returns boolean

languageAutoDetected

get languageAutoDetected(): boolean

Inherited from MonacoEditor.languageAutoDetected
- Defined in packages/monaco/src/browser/monaco-editor.ts:552
Returns boolean

onCursorPositionChanged

get onCursorPositionChanged(): Event<Position>

Inherited from MonacoEditor.onCursorPositionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:237
Returns Event<Position>

onDispose

get onDispose(): Event<void>

Inherited from MonacoEditor.onDispose
- Defined in packages/monaco/src/browser/monaco-editor.ts:215
Returns Event<void>

onDocumentContentChanged

get onDocumentContentChanged(): Event<TextDocumentChangeEvent>

Inherited from MonacoEditor.onDocumentContentChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:219
Returns Event<TextDocumentChangeEvent>

onFocusChanged

get onFocusChanged(): Event<boolean>

Inherited from MonacoEditor.onFocusChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:323
Returns Event<boolean>

onMouseDown

get onMouseDown(): Event<EditorMouseEvent>

Inherited from MonacoEditor.onMouseDown
- Defined in packages/monaco/src/browser/monaco-editor.ts:327
Returns Event<EditorMouseEvent>

onScrollChanged

get onScrollChanged(): Event<void>

Inherited from MonacoEditor.onScrollChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:254
Returns Event<void>

onSelectionChanged

get onSelectionChanged(): Event<Range>

Inherited from MonacoEditor.onSelectionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:250
Returns Event<Range>

selection

get selection(): Range
set selection(selection: Range): void

Inherited from MonacoEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:241
Returns Range
Inherited from MonacoEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:245
Parameters
- selection: Range
Returns void

Methods

Protected addHandlers

addHandlers(codeEditor: IStandaloneCodeEditor): void

Inherited from MonacoEditor.addHandlers
- Defined in packages/monaco/src/browser/monaco-editor.ts:162
Parameters
- codeEditor: IStandaloneCodeEditor
Returns void

Protected autoresize

autoresize(): void

Inherited from MonacoEditor.autoresize
- Defined in packages/monaco/src/browser/monaco-editor.ts:380
Returns void

blur

blur(): void

Inherited from MonacoEditor.blur
- Defined in packages/monaco/src/browser/monaco-editor.ts:305
Returns void

Protected computeLayoutSize

computeLayoutSize(hostNode: HTMLElement, dimension: null | IDimension): IDimension

Inherited from MonacoEditor.computeLayoutSize
- Defined in packages/monaco/src/browser/monaco-editor.ts:394
Parameters
- hostNode: HTMLElement
- dimension: null | IDimension
Returns IDimension

Protected create

create(options?: IDiffEditorConstructionOptions, override?: EditorServiceOverrides): Disposable

Overrides MonacoEditor.create
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:64
Parameters
- Optional options: IDiffEditorConstructionOptions
- Optional override: EditorServiceOverrides
Returns Disposable

createMoveToUri

createMoveToUri(resourceUri: URI): URI

Overrides MonacoEditor.createMoveToUri
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:96
Parameters
- resourceUri: URI
Returns URI

deltaDecorations

deltaDecorations(params: DeltaDecorationParams): string[]

Overrides MonacoEditor.deltaDecorations
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:88
Parameters
- params: DeltaDecorationParams
Returns string[]

detectLanguage

detectLanguage(): Promise<void>

Inherited from MonacoEditor.detectLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:556
Returns Promise<void>

dispose

dispose(): void

Inherited from MonacoEditor.dispose
- Defined in packages/monaco/src/browser/monaco-editor.ts:352
Returns void

executeEdits

executeEdits(edits: TextEdit[]): boolean

Inherited from MonacoEditor.executeEdits
- Defined in packages/monaco/src/browser/monaco-editor.ts:537
Parameters
- edits: TextEdit[]
Returns boolean

Protected fireLanguageChanged

fireLanguageChanged(languageId: string): void

Inherited from MonacoEditor.fireLanguageChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:571
Parameters
- languageId: string
Returns void

focus

focus(): void

Inherited from MonacoEditor.focus
- Defined in packages/monaco/src/browser/monaco-editor.ts:291
Returns void

Protected fromMarkdownToString

fromMarkdownToString(maybeMarkdown?: null | string | IMarkdownString | IMarkdownString[]): undefined | string

Inherited from MonacoEditor.fromMarkdownToString
- Defined in packages/monaco/src/browser/monaco-editor.ts:479
Parameters
- Optional maybeMarkdown: null | string | IMarkdownString | IMarkdownString[]
Returns undefined | string

Protected fromStringToMarkdownString

fromStringToMarkdownString(hoverMessage?: string | IMarkdownString | IMarkdownString[]): undefined | IMarkdownString | IMarkdownString[]

Inherited from MonacoEditor.fromStringToMarkdownString
- Defined in packages/monaco/src/browser/monaco-editor.ts:472
Parameters
- Optional hoverMessage: string | IMarkdownString | IMarkdownString[]
Returns undefined | IMarkdownString | IMarkdownString[]

getControl

getControl(): IStandaloneCodeEditor

Inherited from MonacoEditor.getControl
- Defined in packages/monaco/src/browser/monaco-editor.ts:361
Returns IStandaloneCodeEditor

getEncoding

getEncoding(): string

Inherited from MonacoEditor.getEncoding
- Defined in packages/monaco/src/browser/monaco-editor.ts:123
Returns string

Protected getHeight

getHeight(hostNode: HTMLElement, boxSizing: IBoxSizing): number

Inherited from MonacoEditor.getHeight
- Defined in packages/monaco/src/browser/monaco-editor.ts:415
Parameters
- hostNode: HTMLElement
- boxSizing: IBoxSizing
Returns number

Protected getInstantiatorWithOverrides

getInstantiatorWithOverrides(override?: EditorServiceOverrides): IInstantiationService

Inherited from MonacoEditor.getInstantiatorWithOverrides
- Defined in packages/monaco/src/browser/monaco-editor.ts:153
Parameters
- Optional override: EditorServiceOverrides
Returns IInstantiationService

getLinesDecorations

getLinesDecorations(startLineNumber: number, endLineNumber: number): (EditorDecoration & Readonly<{ id: string }>)[]

Inherited from MonacoEditor.getLinesDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:492
Parameters
- startLineNumber: number
- endLineNumber: number
Returns (EditorDecoration & Readonly<{ id: string }>)[]

getResourceUri

getResourceUri(): URI

Overrides MonacoEditor.getResourceUri
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:93
Returns URI

getVisibleColumn

getVisibleColumn(position: Position): number

Inherited from MonacoEditor.getVisibleColumn
- Defined in packages/monaco/src/browser/monaco-editor.ts:517
Parameters
- position: Position
Returns number

getVisibleRanges

getVisibleRanges(): Range[]

Inherited from MonacoEditor.getVisibleRanges
- Defined in packages/monaco/src/browser/monaco-editor.ts:203
Returns Range[]

Protected getWidth

getWidth(hostNode: HTMLElement, boxSizing: IBoxSizing): number

Inherited from MonacoEditor.getWidth
- Defined in packages/monaco/src/browser/monaco-editor.ts:411
Parameters
- hostNode: HTMLElement
- boxSizing: IBoxSizing
Returns number

isActionSupported

isActionSupported(id: string): boolean

Overrides MonacoEditor.isActionSupported
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:83
Parameters
- id: string
Returns boolean

isFindWidgetVisible

isFindWidgetVisible(): boolean

Inherited from MonacoEditor.isFindWidgetVisible
- Defined in packages/monaco/src/browser/monaco-editor.ts:341
true if the find (and replace) widget is visible in the editor. Otherwise, false.

Returns boolean

isFocused

isFocused(__namedParameters?: { strict: boolean }): boolean

Inherited from MonacoEditor.isFocused
- Defined in packages/monaco/src/browser/monaco-editor.ts:313
Parameters
- __namedParameters: { strict: boolean } = ...
  - strict: boolean
Returns boolean

isRenameInputVisible

isRenameInputVisible(): boolean

Inherited from MonacoEditor.isRenameInputVisible
- Defined in packages/monaco/src/browser/monaco-editor.ts:348
true if the name rename refactoring input HTML element is visible. Otherwise, false.

Returns boolean

isSuggestWidgetVisible

isSuggestWidgetVisible(): boolean

Inherited from MonacoEditor.isSuggestWidgetVisible
- Defined in packages/monaco/src/browser/monaco-editor.ts:334
true if the suggest widget is visible in the editor. Otherwise, false.

Returns boolean

Protected mapModelContentChange

mapModelContentChange(change: IModelContentChange): TextDocumentContentChangeDelta

Inherited from MonacoEditor.mapModelContentChange
- Defined in packages/monaco/src/browser/monaco-editor.ts:207
Parameters
- change: IModelContentChange
Returns TextDocumentContentChangeDelta

refresh

refresh(): void

Inherited from MonacoEditor.refresh
- Defined in packages/monaco/src/browser/monaco-editor.ts:365
Returns void

replaceText

replaceText(params: ReplaceTextParams): Promise<boolean>

Inherited from MonacoEditor.replaceText
- Defined in packages/monaco/src/browser/monaco-editor.ts:521
Parameters
- params: ReplaceTextParams
Returns Promise<boolean>

Protected resize

resize(dimension: null | Dimension): void

Overrides MonacoEditor.resize
- Defined in packages/monaco/src/browser/monaco-diff-editor.ts:76
Parameters
- dimension: null | Dimension
Returns void

resizeToFit

resizeToFit(): void

Inherited from MonacoEditor.resizeToFit
- Defined in packages/monaco/src/browser/monaco-editor.ts:369
Returns void

restoreViewState

restoreViewState(state: ICodeEditorViewState): void

Inherited from MonacoEditor.restoreViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:545
Parameters
- state: ICodeEditorViewState
Returns void

revealPosition

revealPosition(raw: Position, options?: RevealPositionOptions): void

Inherited from MonacoEditor.revealPosition
- Defined in packages/monaco/src/browser/monaco-editor.ts:258
Parameters
- raw: Position
- options: RevealPositionOptions = ...
Returns void

revealRange

revealRange(raw: Range, options?: RevealRangeOptions): void

Inherited from MonacoEditor.revealRange
- Defined in packages/monaco/src/browser/monaco-editor.ts:273
Parameters
- raw: Range
- options: RevealRangeOptions = ...
Returns void

runAction

runAction(id: string): Promise<void>

Inherited from MonacoEditor.runAction
- Defined in packages/monaco/src/browser/monaco-editor.ts:445
Parameters
- id: string
Returns Promise<void>

setEncoding

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

Inherited from MonacoEditor.setEncoding
- Defined in packages/monaco/src/browser/monaco-editor.ts:127
Parameters
- encoding: string
- mode: EncodingMode
Returns Promise<void>

setLanguage

setLanguage(languageId: string): void

Inherited from MonacoEditor.setLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:565
Parameters
- languageId: string
Returns void

setSize

setSize(dimension: Dimension): void

Inherited from MonacoEditor.setSize
- Defined in packages/monaco/src/browser/monaco-editor.ts:375
Parameters
- dimension: Dimension
Returns void

storeViewState

storeViewState(): object

Inherited from MonacoEditor.storeViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:541
Returns object

Protected toDeltaDecorations

toDeltaDecorations(params: DeltaDecorationParams): IModelDeltaDecoration[]

Inherited from MonacoEditor.toDeltaDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:458
Parameters
- params: DeltaDecorationParams
Returns IModelDeltaDecoration[]

Protected toEditorDecoration

toEditorDecoration(decoration: IModelDecoration): EditorDecoration & Readonly<{ id: string }>

Inherited from MonacoEditor.toEditorDecoration
- Defined in packages/monaco/src/browser/monaco-editor.ts:502
Parameters
- decoration: IModelDecoration
Returns EditorDecoration & Readonly<{ id: string }>

trigger

trigger(source: string, handlerId: string, payload: any): void

Inherited from MonacoEditor.trigger
- Defined in packages/monaco/src/browser/monaco-editor.ts:357
Parameters
- source: string
- handlerId: string
- payload: any
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

uri: URI

node: HTMLElement

originalModel: MonacoEditorModel

modifiedModel: MonacoEditorModel

services: MonacoEditorServices

diffNavigatorFactory: MonacoDiffNavigatorFactory

Optional options: MonacoDiffEditor.IOptions

Optional override: EditorServiceOverrides

Returns MonacoDiffEditor

Properties

Protected _diffEditor

Protected _diffNavigator

Protected _languageAutoDetected

Protected Readonly autoSizing

Protected Readonly contextKeyService

Protected Readonly diffNavigatorFactory

Readonly document

Readonly documents

Protected editor

Protected Readonly m2p

Protected Readonly maxHeight

Protected Readonly minHeight

Readonly modifiedModel

Readonly node

Protected Readonly onCursorPositionChangedEmitter

Readonly onDidResize

Protected Readonly onDocumentContentChangedEmitter

Readonly onEncodingChanged

Protected Readonly onFocusChangedEmitter

Readonly onLanguageChanged

Protected Readonly onLanguageChangedEmitter

Protected Readonly onMouseDownEmitter

Protected Readonly onResizeEmitter

Protected Readonly onScrollChangedEmitter

Protected Readonly onSelectionChangedEmitter

Readonly originalModel

Protected Readonly p2m

Protected Readonly toDispose

Readonly uri

Accessors

cursor

Returns Position

Parameters

cursor: Position

Returns void

diffEditor

Returns IStandaloneDiffEditor

diffNavigator

Returns DiffNavigator

isReadonly

Returns boolean

languageAutoDetected

Returns boolean

onCursorPositionChanged

Returns Event<Position>

onDispose

Returns Event<void>

onDocumentContentChanged

Returns Event<TextDocumentChangeEvent>

onFocusChanged

Returns Event<boolean>

onMouseDown

Returns Event<EditorMouseEvent>

onScrollChanged

Returns Event<void>

onSelectionChanged

Returns Event<Range>

selection

Returns Range

Parameters

selection: Range