May 25, 2018 · Apr 23, 2018 · Apr 24, 2018 · Apr 25, 2018 · Apr 26, 2018 · Apr 27, 2018
diff --git a/packages/docmanager/src/documentwidget.ts b/packages/docmanager/src/documentwidget.ts
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.

 import {
    Toolbar
 } from '@jupyterlab/apputils';

 import {
    IDocumentWidget, DocumentRegistry
 } from '@jupyterlab/docregistry';

 import {
    Widget
 } from '@phosphor/widgets';

 /**
 * A document widget implementation.
 */
 export
 class DocumentWidget<T extends Widget, U extends DocumentRegistry.IModel> extends Widget implements IDocumentWidget<Widget, DocumentRegistry.IModel> {
  constructor(options: IDocumentWidget.IOptions<Widget, DocumentRegistry.IModel>) {
    super({node: options.node});
    this.content = options.content;
    this.contentReady = options.contentReady;
    this.context = options.context;
    this.toolbar = options.toolbar;

    // Set layout to boxpanel with appropriate sizing for toolbar
  }

  readonly content: Widget;
  readonly contentReady: Promise<void>;
  readonly context: DocumentRegistry.IContext<DocumentRegistry.IModel>;
  readonly toolbar: Toolbar<Widget>;
 }
diff --git a/packages/docregistry/src/default.ts b/packages/docregistry/src/default.ts


 /**
 * The defaultimplemetation of a widget factory.
 * The defaultimplementation of a widget factory.
 */
 export
 abstract class ABCWidgetFactory<T extends DocumentRegistry.IReadyWidget, U extends DocumentRegistry.IModel> implements DocumentRegistry.IWidgetFactory<T, U> {
diff --git a/packages/docregistry/src/registry.ts b/packages/docregistry/src/registry.ts
 } from '@phosphor/widgets';

 import {
  IClientSession
  IClientSession, Toolbar
 } from '@jupyterlab/apputils';

 import {
    readonly canStartKernel?: boolean;
  }

  /**
   * A widget for a document.
   */
  export
  interface IReadyWidget extends Widget {
    /**
     * A promise that resolves when the widget is ready.
     */
    readonly ready: Promise<void>;
  }

  /**
   * The options used to open a widget.
   */
   * The interface for a widget factory.
   */
  export
  interface IWidgetFactory<T extends IReadyWidget, U extends IModel> extends IDisposable, IWidgetFactoryOptions {
  interface IWidgetFactory<T extends Widget, U extends IModel> extends IDisposable, IWidgetFactoryOptions {
    /**
     * A signal emitted when a new widget is created.
     */
    documentWidgetCreated: ISignal<IWidgetFactory<T, U>, IDocumentWidget<T, U>>;

    /**
     *A signal emitted when awidgetis created.
     *Create a new contentwidgetwhich will be initialized later.
     */
 widgetCreated: ISignal<IWidgetFactory<T, U>, T>;
 create(): T;

    /**
     *Create anew widget given a context.
     *Initialize acontent widget.
     *
     *#### Notes
     *It should emit the [widgetCreated] signal with the new widget.
     *@returns a promise that resolves when the content widget is ready to be
     *visible.
     */
    createNew(context: IContext<U>): T;
    initialize(context: IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;

    /**
     * Called when a new document widget is created. Should emit the documentWidgetCreated signal.
     */
    documentWidget(documentWidget: IDocumentWidget<T, U>): void;
  }

  /**
   * A type alias for a standard widget factory.
   */
  export
  type WidgetFactory = IWidgetFactory<IReadyWidget, IModel>;
  type WidgetFactory = IWidgetFactory<Widget, IModel>;

  /**
   * An interface for a widget extension.
  ];
 }

 /**
 * An interface for a document widget.
 */
 export
 interface IDocumentWidget<T extends Widget, U extends DocumentRegistry.IModel> extends Widget {
  readonly content: T;
  readonly contentReady: Promise<void>;
  readonly context: DocumentRegistry.IContext<U>;
  readonly toolbar: Toolbar<Widget>;
 }

 export
 namespace IDocumentWidget {
  export
  interface IOptions<T extends Widget, U extends DocumentRegistry.IModel> extends Widget.IOptions {
    readonly content: T;
    readonly contentReady: Promise<void>;
    readonly context: DocumentRegistry.IContext<U>;
    readonly toolbar: Toolbar<Widget>;
  }
 }

 /**
 * A private namespace for DocumentRegistry data.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,35 @@
		// Copyright (c) Jupyter Development Team.
		// Distributed under the terms of the Modified BSD License.

		import {
		Toolbar
		} from '@jupyterlab/apputils';

		import {
		IDocumentWidget, DocumentRegistry
		} from '@jupyterlab/docregistry';

		import {
		Widget
		} from '@phosphor/widgets';

		/**
		* A document widget implementation.
		*/
		export
		class DocumentWidget<T extends Widget, U extends DocumentRegistry.IModel> extends Widget implements IDocumentWidget<Widget, DocumentRegistry.IModel> {
		constructor(options: IDocumentWidget.IOptions<Widget, DocumentRegistry.IModel>) {
		super({node: options.node});
		this.content = options.content;
		this.contentReady = options.contentReady;
		this.context = options.context;
		this.toolbar = options.toolbar;

		// Set layout to boxpanel with appropriate sizing for toolbar
		}

		readonly content: Widget;
		readonly contentReady: Promise<void>;
		readonly context: DocumentRegistry.IContext<DocumentRegistry.IModel>;
		readonly toolbar: Toolbar<Widget>;
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -277,7 +277,7 @@ class Base64ModelFactory extends TextModelFactory {


		/**
		* The defaultimplemetation of a widget factory.
		* The defaultimplementation of a widget factory.
		*/
		export
		abstract class ABCWidgetFactory<T extends DocumentRegistry.IReadyWidget, U extends DocumentRegistry.IModel> implements DocumentRegistry.IWidgetFactory<T, U> {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,7 +26,7 @@ import {
		} from '@phosphor/widgets';

		import {
		IClientSession
		IClientSession, Toolbar
		} from '@jupyterlab/apputils';

		import {
Expand DownExpand Up		@@ -840,17 +840,6 @@ namespace DocumentRegistry {
		readonly canStartKernel?: boolean;
		}

		/**
		* A widget for a document.
		*/
		export
		interface IReadyWidget extends Widget {
		/**
		* A promise that resolves when the widget is ready.
		*/
		readonly ready: Promise<void>;
		}

		/**
		* The options used to open a widget.
		*/
Expand DownExpand Up		@@ -881,26 +870,36 @@ namespace DocumentRegistry {
		* The interface for a widget factory.
		*/
		export
		interface IWidgetFactory<T extends IReadyWidget, U extends IModel> extends IDisposable, IWidgetFactoryOptions {
		interface IWidgetFactory<T extends Widget, U extends IModel> extends IDisposable, IWidgetFactoryOptions {
		/**
		* A signal emitted when a new widget is created.
		*/
		documentWidgetCreated: ISignal<IWidgetFactory<T, U>, IDocumentWidget<T, U>>;

		/**
		*A signal emitted when awidgetis created.
		*Create a new contentwidgetwhich will be initialized later.
		*/
		widgetCreated: ISignal<IWidgetFactory<T, U>, T>;
		create(): T;

		/**
		*Create anew widget given a context.
		*Initialize acontent widget.
		*
		*#### Notes
		*It should emit the [widgetCreated] signal with the new widget.
		*@returns a promise that resolves when the content widget is ready to be
		*visible.
		*/
		createNew(context: IContext<U>): T;
		initialize(context: IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;

		/**
		* Called when a new document widget is created. Should emit the documentWidgetCreated signal.
		*/
		documentWidget(documentWidget: IDocumentWidget<T, U>): void;
		}

		/**
		* A type alias for a standard widget factory.
		*/
		export
		type WidgetFactory = IWidgetFactory<IReadyWidget, IModel>;
		type WidgetFactory = IWidgetFactory<Widget, IModel>;

		/**
		* An interface for a widget extension.
Expand DownExpand Up		@@ -1193,6 +1192,27 @@ namespace DocumentRegistry {
		];
		}

		/**
		* An interface for a document widget.
		*/
		export
		interface IDocumentWidget<T extends Widget, U extends DocumentRegistry.IModel> extends Widget {
		readonly content: T;
Copy link Contributor blink1073May 22, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. These should have inline comments (especially "ready"). Copy link ContributorAuthor jasongroutMay 23, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. In documenting this promise, I say "A promise resolving when the content widget is ready to be revealed." Would "reveal" be a better name for the promise than "ready"? When the reveal promise resolves, then we reveal the document widget.
		readonly contentReady: Promise<void>;
		readonly context: DocumentRegistry.IContext<U>;
		readonly toolbar: Toolbar<Widget>;
		}

		export
		namespace IDocumentWidget {
		export
		interface IOptions<T extends Widget, U extends DocumentRegistry.IModel> extends Widget.IOptions {
		readonly content: T;
		readonly contentReady: Promise<void>;
		readonly context: DocumentRegistry.IContext<U>;
		readonly toolbar: Toolbar<Widget>;
		}
		}

		/**
		* A private namespace for DocumentRegistry data.
Expand Down