sprotty-vscode-webview
Version:
Integration of Sprotty in a VS Code extensions (WebView part)
36 lines • 1.8 kB
TypeScript
/********************************************************************************
* Copyright (c) 2018-2022 TypeFox and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
import { Container } from 'inversify';
import { SprottyDiagramIdentifier } from 'sprotty-vscode-protocol';
import { Messenger } from 'vscode-messenger-webview';
import { SprottyStarterServices, VsCodeApi } from './services';
/**
* Main entry class for running Sprotty in a webview. Call the `start` method to begin sending and receiving messages
* with the host extension.
*/
export declare abstract class SprottyStarter {
readonly vscodeApi: VsCodeApi;
readonly messenger: Messenger;
protected container?: Container;
private startTimeout;
constructor(services?: SprottyStarterServices);
start(): void;
protected sendReadyMessage(): void;
protected acceptDiagramIdentifier(): void;
protected abstract createContainer(diagramIdentifier: SprottyDiagramIdentifier): Container;
protected addVscodeBindings(container: Container, diagramIdentifier: SprottyDiagramIdentifier): void;
}
//# sourceMappingURL=sprotty-starter.d.ts.map