May 25, 2018 · Apr 23, 2018 · Apr 24, 2018 · Apr 25, 2018 · Apr 26, 2018 · Apr 27, 2018
diff --git a/packages/apputils/src/mainareawidget.ts b/packages/apputils/src/mainareawidget.ts
    toolbar?: Toolbar;

    /**
     * An optional promise for when the content isfully populated.
     * An optional promise for when the content isready to be shown.
     */
    populated?: Promise<void>;
  }
diff --git a/packages/docmanager/src/documentwidget.ts b/packages/docmanager/src/documentwidget.ts
 // Distributed under the terms of the Modified BSD License.

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

 import {
 * 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;
 class DocumentWidget extends MainAreaWidget implements IDocumentWidget {
  constructor(options: IDocumentWidget.IOptions) {
    super(options);
    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/docmanager/src/widgetmanager.ts b/packages/docmanager/src/widgetmanager.ts
   * @throws If the factory is not registered.
   */
  createWidget(factory: DocumentRegistry.WidgetFactory, context: DocumentRegistry.Context): DocumentRegistry.IReadyWidget {

    let content = factory.create();

    let widget = factory.createNew(context);
    Private.factoryProperty.set(widget, factory);

diff --git a/packages/docregistry/src/default.ts b/packages/docregistry/src/default.ts
  ISignal, Signal
 } from '@phosphor/signaling';

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

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

 import {
  CodeEditor
 } from '@jupyterlab/codeeditor';
 } from '@jupyterlab/observables';

 import {
  DocumentRegistry
  DocumentRegistry, IDocumentWidget
 } from './index';


 * The default implementation of a widget factory.
 */
 export
 abstract class ABCWidgetFactory<T extendsDocumentRegistry.IReadyWidget, U extends DocumentRegistry.IModel> implements DocumentRegistry.IWidgetFactory<T, U> {
 abstract class ABCWidgetFactory<T extendsWidget = Widget, U extends DocumentRegistry.IModel = DocumentRegistry.IModel> implements DocumentRegistry.IWidgetFactory<T, U> {
  /**
   * Construct a new `ABCWidgetFactory`.
   */
  /**
   * A signal emitted when a widget is created.
   */
  getwidgetCreated(): ISignal<DocumentRegistry.IWidgetFactory<T, U>, T> {
    return this._widgetCreated;
  getdocumentWidgetCreated(): ISignal<DocumentRegistry.IWidgetFactory<T, U>, T> {
    return this._documentWidgetCreated;
  }

  /**
    return this._canStartKernel;
  }

  /**
   * Create a new empty content widget.
   */
  abstract createContent(): T;

  /**
   * Populate a content widget.
   *
   * @returns a promise that resolves when the content widget is ready to be
   * shown.
   */
  abstract populate(context: DocumentRegistry.IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;

  abstract documentWidget(documentWidget: IDocumentWidget<T, U>): void;

  /**
   * Create a new widget given a document model and a context.
   *
   * #### Notes
   * It should emit the [widgetCreated] signal with the new widget.
   */
 createNew(context: DocumentRegistry.IContext<U>): T {
 createContent(context: DocumentRegistry.IContext<U>): T {
    let widget = this.createNewWidget(context);
    this._widgetCreated.emit(widget);
    return widget;
  private _modelName: string;
  private _fileTypes: string[];
  private _defaultFor: string[];
  private_widgetCreated = new Signal<DocumentRegistry.IWidgetFactory<T, U>, T>(this);
  private_documentWidgetCreated = new Signal<DocumentRegistry.IWidgetFactory<T, U>, T>(this);
 }
diff --git a/packages/docregistry/src/registry.ts b/packages/docregistry/src/registry.ts
    /**
     * Create a new content widget which will be initialized later.
     */
 create(): T;
 createContent(): T;

    /**
     * Initialize a content widget.
     *
     * @returns a promise that resolves when the content widget is ready to be
     *visible.
     *shown.
     */
 initialize(context: IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;
 populate(context: IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;

    /**
     * Called when a new document widget is created. Should emit the documentWidgetCreated signal.
 * An interface for a document widget.
 */
 export
 interface IDocumentWidget<T extends Widget, U extends DocumentRegistry.IModel> extends Widget {
 interface IDocumentWidget<T extends Widget = Widget, U extends DocumentRegistry.IModel = DocumentRegistry.IModel> extends Widget {
  readonly content: T;
  readonlycontentReady: Promise<void>;
  readonlypopulated: 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 {
  interface IOptions<T extends Widget = Widget, U extends DocumentRegistry.IModel = DocumentRegistry.IModel> extends Widget.IOptions {
    readonly content: T;
    readonly contentReady: Promise<void>;
    readonly context: DocumentRegistry.IContext<U>;
    readonly toolbar: Toolbar<Widget>;
    readonly populated: Promise<void>;
  }
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -256,7 +256,7 @@ namespace MainAreaWidget {
		toolbar?: Toolbar;

		/**
		* An optional promise for when the content isfully populated.
		* An optional promise for when the content isready to be shown.
		*/
		populated?: Promise<void>;
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,7 +2,7 @@
		// Distributed under the terms of the Modified BSD License.

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

		import {
Expand All		@@ -17,19 +17,11 @@ import {
		* 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;
		class DocumentWidget extends MainAreaWidget implements IDocumentWidget {
		constructor(options: IDocumentWidget.IOptions) {
		super(options);
		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		@@ -97,6 +97,9 @@ class DocumentWidgetManager implements IDisposable {
		* @throws If the factory is not registered.
		*/
		createWidget(factory: DocumentRegistry.WidgetFactory, context: DocumentRegistry.Context): DocumentRegistry.IReadyWidget {

		let content = factory.create();

		let widget = factory.createNew(context);
		Private.factoryProperty.set(widget, factory);

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,6 +17,14 @@ import {
		ISignal, Signal
		} from '@phosphor/signaling';

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

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

		import {
		CodeEditor
		} from '@jupyterlab/codeeditor';
Expand All		@@ -30,7 +38,7 @@ import {
		} from '@jupyterlab/observables';

		import {
		DocumentRegistry
		DocumentRegistry, IDocumentWidget
		} from './index';


Expand DownExpand Up		@@ -280,7 +288,7 @@ class Base64ModelFactory extends TextModelFactory {
		* The default implementation of a widget factory.
		*/
		export
		abstract class ABCWidgetFactory<T extendsDocumentRegistry.IReadyWidget, U extends DocumentRegistry.IModel> implements DocumentRegistry.IWidgetFactory<T, U> {
		abstract class ABCWidgetFactory<T extendsWidget = Widget, U extends DocumentRegistry.IModel = DocumentRegistry.IModel> implements DocumentRegistry.IWidgetFactory<T, U> {
		/**
		* Construct a new `ABCWidgetFactory`.
		*/
Expand All		@@ -297,8 +305,8 @@ abstract class ABCWidgetFactory<T extends DocumentRegistry.IReadyWidget, U exten
		/**
		* A signal emitted when a widget is created.
		*/
		getwidgetCreated(): ISignal<DocumentRegistry.IWidgetFactory<T, U>, T> {
		return this._widgetCreated;
		getdocumentWidgetCreated(): ISignal<DocumentRegistry.IWidgetFactory<T, U>, T> {
		return this._documentWidgetCreated;
		}

		/**
Expand DownExpand Up		@@ -364,13 +372,28 @@ abstract class ABCWidgetFactory<T extends DocumentRegistry.IReadyWidget, U exten
		return this._canStartKernel;
		}

		/**
		* Create a new empty content widget.
		*/
		abstract createContent(): T;

		/**
		* Populate a content widget.
		*
		* @returns a promise that resolves when the content widget is ready to be
		* shown.
		*/
		abstract populate(context: DocumentRegistry.IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;

		abstract documentWidget(documentWidget: IDocumentWidget<T, U>): void;

		/**
		* Create a new widget given a document model and a context.
		*
		* #### Notes
		* It should emit the [widgetCreated] signal with the new widget.
		*/
		createNew(context: DocumentRegistry.IContext<U>): T {
		createContent(context: DocumentRegistry.IContext<U>): T {
		let widget = this.createNewWidget(context);
		this._widgetCreated.emit(widget);
		return widget;
Expand All		@@ -389,5 +412,5 @@ abstract class ABCWidgetFactory<T extends DocumentRegistry.IReadyWidget, U exten
		private _modelName: string;
		private _fileTypes: string[];
		private _defaultFor: string[];
		private_widgetCreated = new Signal<DocumentRegistry.IWidgetFactory<T, U>, T>(this);
		private_documentWidgetCreated = new Signal<DocumentRegistry.IWidgetFactory<T, U>, T>(this);
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -879,15 +879,15 @@ namespace DocumentRegistry {
		/**
		* Create a new content widget which will be initialized later.
		*/
		create(): T;
		createContent(): T;

		/**
		* Initialize a content widget.
		*
		* @returns a promise that resolves when the content widget is ready to be
		*visible.
		*shown.
		*/
		initialize(context: IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;
		populate(context: IContext<U>, toolbar: Toolbar<Widget>, content: T): Promise<void>;

		/**
		* Called when a new document widget is created. Should emit the documentWidgetCreated signal.
Expand DownExpand Up		@@ -1196,21 +1196,21 @@ namespace DocumentRegistry {
		* An interface for a document widget.
		*/
		export
		interface IDocumentWidget<T extends Widget, U extends DocumentRegistry.IModel> extends Widget {
		interface IDocumentWidget<T extends Widget = Widget, U extends DocumentRegistry.IModel = 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.
		readonlycontentReady: Promise<void>;
		readonlypopulated: 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 {
		interface IOptions<T extends Widget = Widget, U extends DocumentRegistry.IModel = DocumentRegistry.IModel> extends Widget.IOptions {
		readonly content: T;
		readonly contentReady: Promise<void>;
		readonly context: DocumentRegistry.IContext<U>;
		readonly toolbar: Toolbar<Widget>;
		readonly populated: Promise<void>;
		}
		}

Expand Down