DocumentsExtImpl | Theia TypeDoc

Hierarchy

DocumentsExtImpl

Implements

DocumentsExt

Constructors

constructor

new DocumentsExtImpl(rpc: RPCProtocol, editorsAndDocuments: EditorsAndDocumentsExtImpl): DocumentsExtImpl

- Defined in packages/plugin-ext/src/plugin/documents.ts:52
Parameters
- rpc: RPCProtocol
- editorsAndDocuments: EditorsAndDocumentsExtImpl
Returns DocumentsExtImpl

Properties

Private _onDidAddDocument

_onDidAddDocument: Emitter<TextDocument> = ...

Private _onDidChangeDocument

_onDidChangeDocument: Emitter<TextDocumentChangeEvent> = ...

Private _onDidRemoveDocument

_onDidRemoveDocument: Emitter<TextDocument> = ...

Private _onDidSaveTextDocument

_onDidSaveTextDocument: Emitter<TextDocument> = ...

Private _onWillSaveTextDocument

_onWillSaveTextDocument: Emitter<TextDocumentWillSaveEvent> = ...

Private loadingDocuments

loadingDocuments: Map<string, Promise<undefined | DocumentDataExt>> = ...

Readonly onDidAddDocument

onDidAddDocument: Event<TextDocument> = ...

Readonly onDidChangeDocument

onDidChangeDocument: Event<TextDocumentChangeEvent> = ...

Readonly onDidRemoveDocument

onDidRemoveDocument: Event<TextDocument> = ...

Readonly onDidSaveTextDocument

onDidSaveTextDocument: Event<TextDocument> = ...

Readonly onWillSaveTextDocument

onWillSaveTextDocument: Event<TextDocumentWillSaveEvent> = ...

Private proxy

proxy: DocumentsMain

Private toDispose

toDispose: DisposableCollection = ...

Methods

$acceptDirtyStateChanged

$acceptDirtyStateChanged(strUrl: UriComponents, isDirty: boolean): void

Implementation of DocumentsExt.$acceptDirtyStateChanged
- Defined in packages/plugin-ext/src/plugin/documents.ts:156
Parameters
- strUrl: UriComponents
- isDirty: boolean
Returns void

$acceptModelChanged

$acceptModelChanged(strUrl: UriComponents, e: ModelChangedEvent, isDirty: boolean): void

Implementation of DocumentsExt.$acceptModelChanged
- Defined in packages/plugin-ext/src/plugin/documents.ts:170
Parameters
- strUrl: UriComponents
- e: ModelChangedEvent
- isDirty: boolean
Returns void

$acceptModelModeChanged

$acceptModelModeChanged(startUrl: UriComponents, oldModeId: string, newModeId: string): void

Implementation of DocumentsExt.$acceptModelModeChanged
- Defined in packages/plugin-ext/src/plugin/documents.ts:70
Parameters
- startUrl: UriComponents
- oldModeId: string
- newModeId: string
Returns void

$acceptModelSaved

$acceptModelSaved(strUrl: UriComponents): void

Implementation of DocumentsExt.$acceptModelSaved
- Defined in packages/plugin-ext/src/plugin/documents.ts:81
Parameters
- strUrl: UriComponents
Returns void

$acceptModelWillSave

$acceptModelWillSave(strUrl: UriComponents, reason: TextDocumentSaveReason, saveTimeout: number): Promise<SingleEditOperation[]>

Implementation of DocumentsExt.$acceptModelWillSave
- Defined in packages/plugin-ext/src/plugin/documents.ts:91
Parameters
- strUrl: UriComponents
- reason: TextDocumentSaveReason
- saveTimeout: number
Returns Promise<SingleEditOperation[]>

createDocumentData

createDocumentData(options?: { content?: string; language?: string }): Promise<URI>

- Defined in packages/plugin-ext/src/plugin/documents.ts:275
Parameters
- Optional options: { content?: string; language?: string }
  - Optional content?: string
  - Optional language?: string
Returns Promise<URI>

Protected fireTextDocumentWillSaveEvent

fireTextDocumentWillSaveEvent(__namedParameters: { document: TextDocument; reason: TextDocumentSaveReason; accept: any; fireEvent: any }): Promise<void>

- Defined in packages/plugin-ext/src/plugin/documents.ts:123
Parameters
- __namedParameters: { document: TextDocument; reason: TextDocumentSaveReason; accept: any; fireEvent: any }
  - document: TextDocument
  - reason: TextDocumentSaveReason
  - accept:function
    - accept(operation: SingleEditOperation): void
    - Defined in packages/plugin-ext/src/plugin/documents.ts:129
      Parameters
      - operation: SingleEditOperation
      Returns void
  - fireEvent:function
    - fireEvent(e: TextDocumentWillSaveEvent): any
    - Defined in packages/plugin-ext/src/plugin/documents.ts:128
      Parameters
      - e: TextDocumentWillSaveEvent
      Returns any
Returns Promise<void>

getAllDocumentData

getAllDocumentData(): DocumentDataExt[]

- Defined in packages/plugin-ext/src/plugin/documents.ts:190
Returns DocumentDataExt[]

getDocument

getDocument(resource: Uri): TextDocument

- Defined in packages/plugin-ext/src/plugin/documents.ts:202
Parameters
- resource: Uri
Returns TextDocument

getDocumentData

getDocumentData(resource: Uri): undefined | DocumentDataExt

- Defined in packages/plugin-ext/src/plugin/documents.ts:194
Parameters
- resource: Uri
Returns undefined | DocumentDataExt

Private loadDocument

loadDocument(uri: URI, options?: TextDocumentShowOptions): Promise<undefined | DocumentDataExt>

- Defined in packages/plugin-ext/src/plugin/documents.ts:251
Parameters
- uri: URI
- Optional options: TextDocumentShowOptions
Returns Promise<undefined | DocumentDataExt>

openDocument

openDocument(uri: URI): Promise<undefined | DocumentDataExt>

- Defined in packages/plugin-ext/src/plugin/documents.ts:241
Parameters
- uri: URI
Returns Promise<undefined | DocumentDataExt>

setWordDefinitionFor

setWordDefinitionFor(modeId: string, wordDefinition: null | RegExp): void

- Defined in packages/plugin-ext/src/plugin/documents.ts:279
Parameters
- modeId: string
- wordDefinition: null | RegExp
Returns void

showDocument

showDocument(uri: URI, options?: TextDocumentShowOptions): Promise<undefined | DocumentDataExt>

- Defined in packages/plugin-ext/src/plugin/documents.ts:216
Retrieve document and open it in the editor if need.

Parameters
- uri: URI
  
  path to the resource
- Optional options: TextDocumentShowOptions
  
  if options exists, resource will be opened in editor, otherwise only document object is returned
Returns Promise<undefined | DocumentDataExt>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPCProtocol

editorsAndDocuments: EditorsAndDocumentsExtImpl

Returns DocumentsExtImpl

Properties

Private _onDidAddDocument

Private _onDidChangeDocument

Private _onDidRemoveDocument

Private _onDidSaveTextDocument

Private _onWillSaveTextDocument

Private loadingDocuments

Readonly onDidAddDocument

Readonly onDidChangeDocument

Readonly onDidRemoveDocument

Readonly onDidSaveTextDocument

Readonly onWillSaveTextDocument

Private proxy

Private toDispose

Methods

$acceptDirtyStateChanged

Parameters

strUrl: UriComponents

isDirty: boolean

Returns void

$acceptModelChanged

Parameters

strUrl: UriComponents

e: ModelChangedEvent

isDirty: boolean

Returns void

$acceptModelModeChanged

Parameters

startUrl: UriComponents

oldModeId: string

newModeId: string

Returns void

$acceptModelSaved

Parameters

strUrl: UriComponents

Returns void

$acceptModelWillSave

Parameters

strUrl: UriComponents

reason: TextDocumentSaveReason

saveTimeout: number

Returns Promise<SingleEditOperation[]>

createDocumentData

Parameters

Optional options: { content?: string; language?: string }

Optional content?: string

Optional language?: string

Returns Promise<URI>

Protected fireTextDocumentWillSaveEvent

Parameters

__namedParameters: { document: TextDocument; reason: TextDocumentSaveReason; accept: any; fireEvent: any }

document: TextDocument

reason: TextDocumentSaveReason

accept:function

Parameters

operation: SingleEditOperation

Returns void

fireEvent:function

Parameters

e: TextDocumentWillSaveEvent

Returns any

Returns Promise<void>

getAllDocumentData

Returns DocumentDataExt[]

getDocument

Parameters

resource: Uri

Returns TextDocument