Class FileEditorAdapter

Hierarchy

Constructors

constructor

Properties

_activeEditorChanged _adapterConnected _disposed _docRegistry _editorAdded _editorRemoved _readyDelegate _virtualEditor editor options widget

Accessors

activeEditor activeEditorChanged adapterConnected ceEditor connectionManager disposed documentPath editorAdded editorRemoved editors hasMultipleEditors isConnected isDisposed language languageFileExtension mimeType path ready trans updateFinished virtualDocument widgetId wrapperElement

Methods

connectDocument createVirtualDocument disconnect dispose documentChanged getEditorIndex getEditorIndexAt getEditorWrapper initOnceReady initVirtual onConnected onConnectionClosed onForeignDocumentOpened onSaveState reloadConnection updateDocuments

Constructors

constructor

Properties

Protected _activeEditorChanged

_activeEditorChanged: Signal<WidgetLSPAdapter<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>, IEditorChangedData>

Signal emitted when the active editor have changed.

Protected _adapterConnected

_adapterConnected: Signal<WidgetLSPAdapter<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>, IDocumentConnectionData>

Signal emitted when the adapter is connected.

Protected _disposed

_disposed: Signal<WidgetLSPAdapter<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>, void>

Signal emitted when the adapter is disposed.

Private Readonly _docRegistry

_docRegistry: any

The document registry instance.

Protected _editorAdded

_editorAdded: Signal<WidgetLSPAdapter<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>, IEditorChangedData>

Signal emitted when an editor is changed.

Protected _editorRemoved

_editorRemoved: Signal<WidgetLSPAdapter<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>, IEditorChangedData>

Signal emitted when an editor is removed.

Private _readyDelegate

_readyDelegate: any

Private Readonly _virtualEditor

_virtualEditor: any

Readonly editor

editor: FileEditor

The wrapped FileEditor widget.

Protected options

options: IAdapterOptions

widget

widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>

Accessors

activeEditor

  • get activeEditor(): IEditor

  • Get the activated CM editor.

    Returns IEditor

activeEditorChanged

  • get activeEditorChanged(): ISignal<WidgetLSPAdapter<T>, IEditorChangedData>

  • Signal emitted when the active editor have changed.

    Returns ISignal<WidgetLSPAdapter<T>, IEditorChangedData>

adapterConnected

  • get adapterConnected(): ISignal<WidgetLSPAdapter<T>, IDocumentConnectionData>

  • Signal emitted when the adapter is connected.

    Returns ISignal<WidgetLSPAdapter<T>, IDocumentConnectionData>

ceEditor

connectionManager

  • get connectionManager(): ILSPDocumentConnectionManager

  • The LSP document and connection manager instance.

    Returns ILSPDocumentConnectionManager

disposed

  • get disposed(): ISignal<WidgetLSPAdapter<T>, void>

  • Signal emitted when the adapter is disposed.

    Returns ISignal<WidgetLSPAdapter<T>, void>

documentPath

  • get documentPath(): string

  • Get current path of the document.

    Returns string

editorAdded

  • get editorAdded(): ISignal<WidgetLSPAdapter<T>, IEditorChangedData>

  • Signal emitted when the an editor is changed.

    Returns ISignal<WidgetLSPAdapter<T>, IEditorChangedData>

editorRemoved

  • get editorRemoved(): ISignal<WidgetLSPAdapter<T>, IEditorChangedData>

  • Signal emitted when the an editor is removed.

    Returns ISignal<WidgetLSPAdapter<T>, IEditorChangedData>

editors

  • get editors(): ICodeBlockOptions[]

  • Get the list of CM editors in the document, there is only one editor in the case of file editor.

    Returns ICodeBlockOptions[]

hasMultipleEditors

  • get hasMultipleEditors(): boolean

  • Check if the document contains multiple editors

    Returns boolean

isConnected

  • get isConnected(): boolean

  • The virtual document is connected or not

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Check if the adapter is disposed

    Returns boolean

language

  • get language(): string

  • Get the language identifier of the document

    Returns string

languageFileExtension

  • get languageFileExtension(): string

  • Get the file extension of the document.

    Returns string

mimeType

  • get mimeType(): string

  • Get the mime type of the document.

    Returns string

path

  • get path(): string

  • Get current path of the document.

    Returns string

ready

  • get ready(): Promise<void>

  • Promise that resolves once the adapter is initialized

    Returns Promise<void>

trans

updateFinished

  • get updateFinished(): Promise<void>

  • Promise that resolves once the document is updated

    Returns Promise<void>

virtualDocument

  • get virtualDocument(): VirtualDocument

  • Internal virtual document of the adapter.

    Returns VirtualDocument

widgetId

  • get widgetId(): string

  • Get the ID of the internal widget.

    Returns string

wrapperElement

  • get wrapperElement(): HTMLElement

  • Get the inner HTMLElement of the document widget.

    Returns HTMLElement

Methods

Protected connectDocument

  • Opens a connection for the document. The connection may or may not be initialized, yet, and depending on when this is called, the client may not be fully connected.

    Parameters

    • virtualDocument: VirtualDocument

      a VirtualDocument

    • Optional sendOpen: boolean

      whether to open the document immediately

    Returns Promise<void>

createVirtualDocument

  • Generate the virtual document associated with the document.

    Returns VirtualDocument

disconnect

  • Disconnect virtual document from the language server.

    Returns void

dispose

  • Dispose the widget.

    Returns void

documentChanged

  • Callback called on the document changed event.

    Parameters

    • virtualDocument: VirtualDocument
    • document: VirtualDocument
    • Optional isInit: boolean

    Returns void

getEditorIndex

  • Get the index of input editor

    Parameters

    • ceEditor: IEditor

      instance of the code editor

    Returns number

getEditorIndexAt

  • Get the index of editor from the cursor position in the virtual document. Since there is only one editor, this method always return 0

    Deprecated

    This is error-prone and will be removed in JupyterLab 5.0, use getEditorIndex() with virtualDocument.getEditorAtVirtualLine(position) instead.

    Parameters

    • position: IVirtualPosition

      the position of cursor in the virtual document.

    Returns number

    • index of the virtual editor

getEditorWrapper

  • Get the wrapper of input editor.

    Parameters

    • ceEditor: IEditor

    Returns HTMLElement

Protected initOnceReady

  • Initialization function called once the editor and the LSP connection manager is ready. This function will create the virtual document and connect various signals.

    Returns Promise<void>

Protected initVirtual

  • Create the virtual document using current path and language.

    Returns void

Protected onConnected

  • Connect the virtual document with the language server.

    Parameters

    • data: IDocumentConnectionData

    Returns Promise<void>

onConnectionClosed

  • Callback on connection closed event.

    Parameters

    • _: ILSPDocumentConnectionManager
    • __namedParameters: IDocumentConnectionData

    Returns void

Protected onForeignDocumentOpened

  • Handler for opening a document contained in a parent document. The assumption is that the editor already exists for this, and as such the document should be queued for immediate opening.

    Parameters

    • _: VirtualDocument
    • context: IForeignContext

      information about the foreign VirtualDocument

    Returns Promise<void>

Protected onSaveState

Protected reloadConnection

  • Returns void

updateDocuments

  • Update the virtual document.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc