added register content method to dialog and tab (#1415)

* added register content method to dialog and tab
This commit is contained in:
Leila Lali
2018-05-16 09:09:41 -07:00
committed by GitHub
parent d526fe0f7f
commit 45e3c6ae49
7 changed files with 204 additions and 23 deletions

View File

@@ -9,7 +9,7 @@ import * as sqlops from 'sqlops';
import { localize } from 'vs/nls';
import Event, { Emitter } from 'vs/base/common/event';
export class DialogTab implements sqlops.window.modelviewdialog.DialogTab {
export class DialogTab {
public content: string;
constructor(public title: string, content?: string) {
@@ -19,7 +19,7 @@ export class DialogTab implements sqlops.window.modelviewdialog.DialogTab {
}
}
export class Dialog implements sqlops.window.modelviewdialog.Dialog {
export class Dialog {
private static readonly DONE_BUTTON_LABEL = localize('dialogModalDoneButtonLabel', 'Done');
private static readonly CANCEL_BUTTON_LABEL = localize('dialogModalCancelButtonLabel', 'Cancel');

View File

@@ -366,8 +366,21 @@ declare module 'sqlops' {
*/
export function closeDialog(dialog: Dialog): void;
export interface ModelViewPanel {
/**
* Register model view content for the dialog.
* Doesn't do anything if model view is already registered
*/
registerContent(handler: (view: ModelView) => void): void;
/**
* Returns the model view content if registered. Returns undefined if model review is not registered
*/
readonly modelView: ModelView;
}
// Model view dialog classes
export interface Dialog {
export interface Dialog extends ModelViewPanel {
/**
* The title of the dialog
*/
@@ -405,7 +418,7 @@ declare module 'sqlops' {
readonly onValidityChanged: vscode.Event<boolean>;
}
export interface DialogTab {
export interface DialogTab extends ModelViewPanel {
/**
* The title of the tab
*/

View File

@@ -12,10 +12,47 @@ import * as nls from 'vs/nls';
import * as vscode from 'vscode';
import * as sqlops from 'sqlops';
import { SqlMainContext, ExtHostModelViewDialogShape, MainThreadModelViewDialogShape } from 'sql/workbench/api/node/sqlExtHost.protocol';
import { SqlMainContext, ExtHostModelViewDialogShape, MainThreadModelViewDialogShape, ExtHostModelViewShape } from 'sql/workbench/api/node/sqlExtHost.protocol';
import { IItemConfig, ModelComponentTypes, IComponentShape } from 'sql/workbench/api/common/sqlExtHostTypes';
class DialogImpl implements sqlops.window.modelviewdialog.Dialog {
class ModelViewPanelImpl implements sqlops.window.modelviewdialog.ModelViewPanel {
private _modelView: sqlops.ModelView;
private _handle: number;
private _modelViewId: string;
constructor(private _viewType: string,
protected _extHostModelView: ExtHostModelViewShape) {
}
public registerContent(handler: (view: sqlops.ModelView) => void): void {
if (!this._modelViewId) {
let viewId = this._viewType + this.handle;
this.setModelViewId(viewId);
this._extHostModelView.$registerProvider(viewId, modelView => {
this._modelView = modelView;
handler(modelView);
});
}
}
public set handle(value: number) {
this._handle = value;
}
public setModelViewId(value: string) {
this._modelViewId = value;
}
public get modelView(): sqlops.ModelView {
return this._modelView;
}
public set modelView(value: sqlops.ModelView) {
this._modelView = value;
}
}
class DialogImpl extends ModelViewPanelImpl implements sqlops.window.modelviewdialog.Dialog {
public title: string;
public content: string | sqlops.window.modelviewdialog.DialogTab[];
public okButton: sqlops.window.modelviewdialog.Button;
@@ -24,7 +61,10 @@ class DialogImpl implements sqlops.window.modelviewdialog.Dialog {
public readonly onValidityChanged: vscode.Event<boolean>;
private _valid: boolean = true;
constructor(private _extHostModelViewDialog: ExtHostModelViewDialog) {
constructor(private _extHostModelViewDialog: ExtHostModelViewDialog,
extHostModelView: ExtHostModelViewShape) {
super('modelViewDialog', extHostModelView);
this.okButton = this._extHostModelViewDialog.createButton(nls.localize('dialogOkLabel', 'Done'));
this.cancelButton = this._extHostModelViewDialog.createButton(nls.localize('dialogCancelLabel', 'Cancel'));
this.onValidityChanged = this._extHostModelViewDialog.getValidityChangedEvent(this);
@@ -34,13 +74,28 @@ class DialogImpl implements sqlops.window.modelviewdialog.Dialog {
public get valid(): boolean {
return this._valid;
}
public setModelViewId(value: string) {
super.setModelViewId(value);
this.content = value;
}
}
class TabImpl implements sqlops.window.modelviewdialog.DialogTab {
class TabImpl extends ModelViewPanelImpl implements sqlops.window.modelviewdialog.DialogTab {
constructor(
private _extHostModelViewDialog: ExtHostModelViewDialog,
extHostModelView: ExtHostModelViewShape) {
super('modelViewDialogTab', extHostModelView);
}
public title: string;
public content: string;
public handle: number;
constructor(private _extHostModelViewDialog: ExtHostModelViewDialog) { }
public setModelViewId(value: string) {
super.setModelViewId(value);
this.content = value;
}
}
class ButtonImpl implements sqlops.window.modelviewdialog.Button {
@@ -101,7 +156,8 @@ export class ExtHostModelViewDialog implements ExtHostModelViewDialogShape {
private readonly _onClickCallbacks = new Map<number, () => void>();
constructor(
mainContext: IMainContext
mainContext: IMainContext,
private _extHostModelView: ExtHostModelViewShape
) {
this._proxy = mainContext.getProxy(SqlMainContext.MainThreadModelViewDialog);
}
@@ -204,16 +260,16 @@ export class ExtHostModelViewDialog implements ExtHostModelViewDialogShape {
}
public createDialog(title: string): sqlops.window.modelviewdialog.Dialog {
let dialog = new DialogImpl(this);
let dialog = new DialogImpl(this, this._extHostModelView);
dialog.title = title;
this.getDialogHandle(dialog);
dialog.handle = this.getDialogHandle(dialog);
return dialog;
}
public createTab(title: string): sqlops.window.modelviewdialog.DialogTab {
let tab = new TabImpl(this);
let tab = new TabImpl(this, this._extHostModelView);
tab.title = title;
this.getTabHandle(tab);
tab.handle = this.getTabHandle(tab);
return tab;
}

View File

@@ -66,7 +66,7 @@ export function createApiFactory(
const extHostWebviewWidgets = rpcProtocol.set(SqlExtHostContext.ExtHostDashboardWebviews, new ExtHostDashboardWebviews(rpcProtocol));
const extHostModelView = rpcProtocol.set(SqlExtHostContext.ExtHostModelView, new ExtHostModelView(rpcProtocol));
const extHostDashboard = rpcProtocol.set(SqlExtHostContext.ExtHostDashboard, new ExtHostDashboard(rpcProtocol));
const extHostModelViewDialog = rpcProtocol.set(SqlExtHostContext.ExtHostModelViewDialog, new ExtHostModelViewDialog(rpcProtocol));
const extHostModelViewDialog = rpcProtocol.set(SqlExtHostContext.ExtHostModelViewDialog, new ExtHostModelViewDialog(rpcProtocol, extHostModelView));
const extHostQueryEditor = rpcProtocol.set(SqlExtHostContext.ExtHostQueryEditor, new ExtHostQueryEditor(rpcProtocol));

View File

@@ -6,7 +6,7 @@
import * as assert from 'assert';
import { Mock, It, Times } from 'typemoq';
import { ExtHostModelViewDialog } from 'sql/workbench/api/node/extHostModelViewDialog';
import { MainThreadModelViewDialogShape } from 'sql/workbench/api/node/sqlExtHost.protocol';
import { MainThreadModelViewDialogShape, ExtHostModelViewShape } from 'sql/workbench/api/node/sqlExtHost.protocol';
import { IMainContext } from 'vs/workbench/api/node/extHost.protocol';
'use strict';
@@ -14,6 +14,7 @@ import { IMainContext } from 'vs/workbench/api/node/extHost.protocol';
suite('ExtHostModelViewDialog Tests', () => {
let extHostModelViewDialog: ExtHostModelViewDialog;
let mockProxy: Mock<MainThreadModelViewDialogShape>;
let extHostModelView: Mock<ExtHostModelViewShape>;
setup(() => {
mockProxy = Mock.ofInstance(<MainThreadModelViewDialogShape>{
@@ -26,7 +27,11 @@ suite('ExtHostModelViewDialog Tests', () => {
let mainContext = <IMainContext>{
getProxy: proxyType => mockProxy.object
};
extHostModelViewDialog = new ExtHostModelViewDialog(mainContext);
extHostModelView = Mock.ofInstance(<ExtHostModelViewShape> {
$registerProvider: (widget, handler) => undefined
});
extHostModelViewDialog = new ExtHostModelViewDialog(mainContext, extHostModelView.object);
});
test('Creating a dialog returns a dialog with initialized ok and cancel buttons and the given title', () => {