Class DocumentsExtImpl

Implements

DocumentsExt

Constructors

constructor

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

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` editorsAndDocuments

editorsAndDocuments: EditorsAndDocumentsExtImpl

`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, isDirty): void
Parameters
- strUrl: UriComponents
- isDirty: boolean
Returns void
Implementation of DocumentsExt.$acceptDirtyStateChanged
- Defined in packages/plugin-ext/src/plugin/documents.ts:156

$acceptEncodingChanged

$acceptEncodingChanged(strUrl, encoding): void
Parameters
- strUrl: UriComponents
- encoding: string
Returns void
Implementation of DocumentsExt.$acceptEncodingChanged
- Defined in packages/plugin-ext/src/plugin/documents.ts:170

$acceptModelChanged

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

$acceptModelModeChanged

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

$acceptModelSaved

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

$acceptModelWillSave

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

createDocumentData

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

`Protected` fireTextDocumentWillSaveEvent

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

getAllDocumentData

getAllDocumentData(): DocumentDataExt[]
Returns DocumentDataExt[]
- Defined in packages/plugin-ext/src/plugin/documents.ts:204

getDocument

getDocument(resource): TextDocument
Parameters
- resource: Uri
Returns TextDocument
- Defined in packages/plugin-ext/src/plugin/documents.ts:216

getDocumentData

getDocumentData(resource): undefined | DocumentDataExt
Parameters
- resource: Uri
Returns undefined | DocumentDataExt
- Defined in packages/plugin-ext/src/plugin/documents.ts:208

`Private` loadDocument

loadDocument(uri, options?): Promise<undefined | DocumentDataExt>
Parameters
- uri: URI
- Optional options: TextDocumentShowOptions
Returns Promise<undefined | DocumentDataExt>
- Defined in packages/plugin-ext/src/plugin/documents.ts:268

openDocument

openDocument(uri, options?): Promise<undefined | DocumentDataExt>
Parameters
- uri: URI
- Optional options: {
      content?: string;
      encoding?: string;
      language?: string;
  }
  - Optional content?: string
  - Optional encoding?: string
  - Optional language?: string
Returns Promise<undefined | DocumentDataExt>
- Defined in packages/plugin-ext/src/plugin/documents.ts:255

setWordDefinitionFor

setWordDefinitionFor(modeId, wordDefinition): void
Parameters
- modeId: string
- wordDefinition: null | RegExp
Returns void
- Defined in packages/plugin-ext/src/plugin/documents.ts:296

showDocument

showDocument(uri, options?): Promise<undefined | DocumentDataExt>
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>
- Defined in packages/plugin-ext/src/plugin/documents.ts:230

Class DocumentsExtImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DocumentsExtImpl

Properties

Private _onDidAddDocument

Private _onDidChangeDocument

Private _onDidRemoveDocument

Private _onDidSaveTextDocument

Private _onWillSaveTextDocument

Private editorsAndDocuments

Private loadingDocuments

Readonly onDidAddDocument

Readonly onDidChangeDocument

Readonly onDidRemoveDocument

Readonly onDidSaveTextDocument

Readonly onWillSaveTextDocument

Private proxy

Private toDispose

Methods

$acceptDirtyStateChanged

Parameters

Returns void

$acceptEncodingChanged

Parameters

Returns void

$acceptModelChanged

Parameters

Returns void

$acceptModelModeChanged

Parameters

Returns void

$acceptModelSaved

Parameters

Returns void

$acceptModelWillSave

Parameters

Returns Promise<SingleEditOperation[]>

createDocumentData

Parameters

Optional content?: string

Optional encoding?: string

Optional language?: string

Returns Promise<URI>

Protected fireTextDocumentWillSaveEvent

Parameters

accept: ((operation) => void)

Parameters

Returns void

document: TextDocument

fireEvent: ((e) => any)

Parameters

Returns any

reason: TextDocumentSaveReason

Returns Promise<void>

getAllDocumentData

Returns DocumentDataExt[]

getDocument

Parameters

Returns TextDocument

getDocumentData

Parameters

Returns undefined | DocumentDataExt

Private loadDocument

Parameters

Returns Promise<undefined | DocumentDataExt>

openDocument

Parameters

Optional content?: string

Optional encoding?: string

Optional language?: string

Returns Promise<undefined | DocumentDataExt>

setWordDefinitionFor

Parameters

`Private` _onDidAddDocument

`Private` _onDidChangeDocument

`Private` _onDidRemoveDocument

`Private` _onDidSaveTextDocument

`Private` _onWillSaveTextDocument

`Private` editorsAndDocuments

`Private` loadingDocuments

`Readonly` onDidAddDocument

`Readonly` onDidChangeDocument

`Readonly` onDidRemoveDocument

`Readonly` onDidSaveTextDocument

`Readonly` onWillSaveTextDocument

`Private` proxy

`Private` toDispose

`Optional` content?: string

`Optional` encoding?: string

`Optional` language?: string

`Protected` fireTextDocumentWillSaveEvent

`Private` loadDocument

`Optional` content?: string

`Optional` encoding?: string

`Optional` language?: string