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
    this.title.changed.connect(this._updateContentTitle, this);
    content.disposed.connect(() => this.dispose());

    if (options.ready) {
    if (options.reveal) {
      layout.addWidget(spinner);
      // Make sure the ready promise is a Promise<void> to avoid leaking any
      // results.
      this._ready = options.ready.then(() => {
        this._isReady = true;
      this._reveal = options.reveal.then(() => {
        this._isRevealed = true;
        const active = document.activeElement === spinner.node;
        spinner.dispose();
        layout.addWidget(content);
    } else {
      spinner.dispose();
      layout.addWidget(content);
      this._isReady = true;
      this._ready = Promise.resolve(void 0);
      this._isRevealed = true;
      this._reveal = Promise.resolve(undefined);
    }
  }

  readonly toolbar: Toolbar;

  /**
   * Whether the widget isfully populated.
   * Whether the widget isrevealed.
   */
  getisReady(): boolean {
    return this._isReady;
  getisRevealed(): boolean {
    return this._isRevealed;
  }

  /**
   * A promise that resolves when the widget isfully populated.
   * A promise that resolves when the widget isready to be revealed.
   */
  getready(): Promise<void> {
    return this._ready;
  getreveal(): Promise<void> {
    return this._reveal;
  }

  /**
    case 'mouseup':
    case 'mouseout':
      let target = event.target as HTMLElement;
      if (this._isReady &&
      if (this._isRevealed &&
          this.toolbar.node.contains(document.activeElement) &&
          target.tagName !== 'SELECT') {
        this._focusContent();
   * Handle `'activate-request'` messages.
   */
  protected onActivateRequest(msg: Message): void {
    if (this._isReady) {
    if (this._isRevealed) {
      this._focusContent();
    } else {
      this._spinner.node.focus();
  private _changeGuard = false;
  private _spinner = new Spinner();

  private_isReady = false;
  private_ready: Promise<void>;
  private_isRevealed = false;
  private_reveal: Promise<void>;
 }


    toolbar?: Toolbar;

    /**
     * An optional promise for when the content is ready to beshown.
     * An optional promise for when the content is ready to berevealed.
     */
 ready?: Promise<any>;
 reveal?: Promise<any>;
  }

  /**
    toolbar?: Toolbar;

    /**
     * An optional promise for when the content is ready to beshown.
     * An optional promise for when the content is ready to berevealed.
     */
 ready?: Promise<any>;
 reveal?: Promise<any>;
  }

 }
diff --git a/packages/csvviewer/src/widget.ts b/packages/csvviewer/src/widget.ts

    this._context.ready.then(() => {
      this._updateGrid();
      this._ready.resolve(undefined);
      this._reveal.resolve(undefined);
      // Throttle the rendering rate of the widget.
      this._monitor = new ActivityMonitor({
        signal: context.model.contentChanged,
  }

  /**
   * A promise that resolves when the csv viewer is ready.
   * A promise that resolves when the csv viewer is ready to be revealed.
   */
  getready() {
    return this._ready.promise;
  getreveal() {
    return this._reveal.promise;
  }

  /**
  private _grid: DataGrid;
  private _monitor: ActivityMonitor<any, any> | null = null;
  private _delimiter = ',';
  private_ready = new PromiseDelegate<void>();
  private_reveal = new PromiseDelegate<void>();
 }


 export
 class CSVDocumentWidget extends DocumentWidget<CSVViewer> {
  constructor(options: CSVDocumentWidget.IOptions) {
    let {content, context, delimiter,ready, ...other} = options;
    let {content, context, delimiter,reveal, ...other} = options;
    content = content || Private.createContent(context);
 ready = Promise.all([ready, content.ready]);
    super({content, context,ready, ...other});
 reveal = Promise.all([reveal, content.reveal]);
    super({content, context,reveal, ...other});

    if (delimiter) {
      content.delimiter = delimiter;
diff --git a/packages/docregistry/src/default.ts b/packages/docregistry/src/default.ts
 class DocumentWidget<T extends Widget = Widget, U extends DocumentRegistry.IModel = DocumentRegistry.IModel> extends MainAreaWidget<T> implements IDocumentWidget<T, U> {
  constructor(options: DocumentWidget.IOptions<T, U>) {

    // Include the context ready promise in the widgetready promise
    options.ready = Promise.all([options.ready, options.context.ready]);
    // Include the context ready promise in the widgetreveal promise
    options.reveal = Promise.all([options.reveal, options.context.ready]);
    super(options);

    this.context = options.context;
diff --git a/packages/docregistry/src/registry.ts b/packages/docregistry/src/registry.ts
  /**
   * A promise resolving when the content widget is ready to be revealed.
   */
  readonlyready: Promise<void>;
  readonlyreveal: Promise<void>;

  /**
   * The context associated with the document.
diff --git a/packages/notebook/src/panel.ts b/packages/notebook/src/panel.ts
   */
  constructor(options: DocumentWidget.IOptions<Notebook, INotebookModel>) {
    // Set default options
    constnotebookReady = new PromiseDelegate<void>();
    options.ready = Promise.all([options.ready, notebookReady.promise]);
    constnotebookReveal = new PromiseDelegate<void>();
    options.reveal = Promise.all([options.reveal, notebookReveal.promise]);
    super(options);
    this._activated = new Signal<this, void>(this);

        return;
      }

      // The notebook widget is now ready to beshown.
 notebookReady.resolve(undefined);
      // The notebook widget is now ready to berevealed.
 notebookReveal.resolve(undefined);
    });

    this.ready.then(() => {
    this.reveal.then(() => {
      // Set the document edit mode on initial open if it looks like a new document.
      if (this.content.widgets.length === 1) {
        let cellModel = this.content.widgets[0].model;
diff --git a/tests/test-docregistry/src/default.spec.ts b/tests/test-docregistry/src/default.spec.ts

    });

    describe('#ready', () => {
    describe('#reveal', () => {
      beforeEach(setup);

      it('should resolve after theready and context ready promises', async () => {
      it('should resolve after thereveal and context ready promises', async () => {
        let x = Object.create(null);
        letready = sleep(300, x);
        letreveal = sleep(300, x);
        let contextReady = Promise.all([context.ready, x]);
        let widget = new DocumentWidget({ context, content,ready: ready});
        expect(widget.isReady).to.be(false);
        let widget = new DocumentWidget({ context, content,reveal});
        expect(widget.isRevealed).to.be(false);

        // Our promise should resolve before the widgetready promise.
        expect(await Promise.race([widget.ready, ready])).to.be(x);
        // Our promise should resolve before the widgetreveal promise.
        expect(await Promise.race([widget.reveal, reveal])).to.be(x);
        // The context ready promise should also resolve first.
        context.initialize(true);
        expect(await Promise.race([widget.ready, contextReady])).to.eql([undefined, x]);
        // The widget.ready promise should finally resolve.
        expect(await widget.ready).to.be(undefined);
        expect(await Promise.race([widget.reveal, contextReady])).to.eql([undefined, x]);
        // The widget.reveal promise should finally resolve.
        expect(await widget.reveal).to.be(undefined);
      });

    });
Original file line number	Diff line number	Diff line change
Expand Up		@@ -67,12 +67,12 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
		this.title.changed.connect(this._updateContentTitle, this);
		content.disposed.connect(() => this.dispose());

		if (options.ready) {
		if (options.reveal) {
		layout.addWidget(spinner);
		// Make sure the ready promise is a Promise<void> to avoid leaking any
		// results.
		this._ready = options.ready.then(() => {
		this._isReady = true;
		this._reveal = options.reveal.then(() => {
		this._isRevealed = true;
		const active = document.activeElement === spinner.node;
		spinner.dispose();
		layout.addWidget(content);
Expand All		@@ -95,8 +95,8 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
		} else {
		spinner.dispose();
		layout.addWidget(content);
		this._isReady = true;
		this._ready = Promise.resolve(void 0);
		this._isRevealed = true;
		this._reveal = Promise.resolve(undefined);
		}
		}

Expand All		@@ -111,17 +111,17 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
		readonly toolbar: Toolbar;

		/**
		* Whether the widget isfully populated.
		* Whether the widget isrevealed.
		*/
		getisReady(): boolean {
		return this._isReady;
		getisRevealed(): boolean {
		return this._isRevealed;
		}

		/**
		* A promise that resolves when the widget isfully populated.
		* A promise that resolves when the widget isready to be revealed.
		*/
		getready(): Promise<void> {
		return this._ready;
		getreveal(): Promise<void> {
		return this._reveal;
		}

		/**
Expand All		@@ -139,7 +139,7 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
		case 'mouseup':
		case 'mouseout':
		let target = event.target as HTMLElement;
		if (this._isReady &&
		if (this._isRevealed &&
		this.toolbar.node.contains(document.activeElement) &&
		target.tagName !== 'SELECT') {
		this._focusContent();
Expand DownExpand Up		@@ -170,7 +170,7 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
		* Handle `'activate-request'` messages.
		*/
		protected onActivateRequest(msg: Message): void {
		if (this._isReady) {
		if (this._isRevealed) {
		this._focusContent();
		} else {
		this._spinner.node.focus();
Expand DownExpand Up		@@ -239,8 +239,8 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
		private _changeGuard = false;
		private _spinner = new Spinner();

		private_isReady = false;
		private_ready: Promise<void>;
		private_isRevealed = false;
		private_reveal: Promise<void>;
		}


Expand All		@@ -265,9 +265,9 @@ namespace MainAreaWidget {
		toolbar?: Toolbar;

		/**
		* An optional promise for when the content is ready to beshown.
		* An optional promise for when the content is ready to berevealed.
		*/
		ready?: Promise<any>;
		reveal?: Promise<any>;
		}

		/**
Expand All		@@ -293,9 +293,9 @@ namespace MainAreaWidget {
		toolbar?: Toolbar;

		/**
		* An optional promise for when the content is ready to beshown.
		* An optional promise for when the content is ready to berevealed.
		*/
		ready?: Promise<any>;
		reveal?: Promise<any>;
		}

		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -72,7 +72,7 @@ class CSVViewer extends Widget {

		this._context.ready.then(() => {
		this._updateGrid();
		this._ready.resolve(undefined);
		this._reveal.resolve(undefined);
		// Throttle the rendering rate of the widget.
		this._monitor = new ActivityMonitor({
		signal: context.model.contentChanged,
Expand All		@@ -90,10 +90,10 @@ class CSVViewer extends Widget {
		}

		/**
		* A promise that resolves when the csv viewer is ready.
		* A promise that resolves when the csv viewer is ready to be revealed.
		*/
		getready() {
		return this._ready.promise;
		getreveal() {
		return this._reveal.promise;
		}

		/**
Expand DownExpand Up		@@ -145,7 +145,7 @@ class CSVViewer extends Widget {
		private _grid: DataGrid;
		private _monitor: ActivityMonitor<any, any> \| null = null;
		private _delimiter = ',';
		private_ready = new PromiseDelegate<void>();
		private_reveal = new PromiseDelegate<void>();
		}


Expand All		@@ -169,10 +169,10 @@ namespace CSVViewer {
		export
		class CSVDocumentWidget extends DocumentWidget<CSVViewer> {
Copy link Member ian-r-roseMay 24, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. These aren't particularly complex classes and interfaces, but they are missing docstrings for the API docs.
		constructor(options: CSVDocumentWidget.IOptions) {
		let {content, context, delimiter,ready, ...other} = options;
		let {content, context, delimiter,reveal, ...other} = options;
		content = content \|\| Private.createContent(context);
		ready = Promise.all([ready, content.ready]);
		super({content, context,ready, ...other});
		reveal = Promise.all([reveal, content.reveal]);
		super({content, context,reveal, ...other});

		if (delimiter) {
		content.delimiter = delimiter;
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -419,8 +419,8 @@ export
		class DocumentWidget<T extends Widget = Widget, U extends DocumentRegistry.IModel = DocumentRegistry.IModel> extends MainAreaWidget<T> implements IDocumentWidget<T, U> {
		constructor(options: DocumentWidget.IOptions<T, U>) {

		// Include the context ready promise in the widgetready promise
		options.ready = Promise.all([options.ready, options.context.ready]);
		// Include the context ready promise in the widgetreveal promise
		options.reveal = Promise.all([options.reveal, options.context.ready]);
		super(options);

		this.context = options.context;
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1204,7 +1204,7 @@ interface IDocumentWidget<T extends Widget = Widget, U extends DocumentRegistry.
		/**
		* A promise resolving when the content widget is ready to be revealed.
		*/
		readonlyready: Promise<void>;
		readonlyreveal: Promise<void>;

		/**
		* The context associated with the document.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -62,8 +62,8 @@ class NotebookPanel extends DocumentWidget<Notebook, INotebookModel> {
		*/
		constructor(options: DocumentWidget.IOptions<Notebook, INotebookModel>) {
		// Set default options
		constnotebookReady = new PromiseDelegate<void>();
		options.ready = Promise.all([options.ready, notebookReady.promise]);
		constnotebookReveal = new PromiseDelegate<void>();
		options.reveal = Promise.all([options.reveal, notebookReveal.promise]);
		super(options);
		this._activated = new Signal<this, void>(this);
Copy link Member ian-r-roseMay 24, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Why not initialize this below in the private properties listing?

Expand All		@@ -81,11 +81,11 @@ class NotebookPanel extends DocumentWidget<Notebook, INotebookModel> {
		return;
		}

		// The notebook widget is now ready to beshown.
		notebookReady.resolve(undefined);
		// The notebook widget is now ready to berevealed.
		notebookReveal.resolve(undefined);
		});

		this.ready.then(() => {
		this.reveal.then(() => {
		// Set the document edit mode on initial open if it looks like a new document.
		if (this.content.widgets.length === 1) {
		let cellModel = this.content.widgets[0].model;
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -601,23 +601,23 @@ describe('docregistry/default', () => {

		});

		describe('#ready', () => {
		describe('#reveal', () => {
		beforeEach(setup);

		it('should resolve after theready and context ready promises', async () => {
		it('should resolve after thereveal and context ready promises', async () => {
		let x = Object.create(null);
		letready = sleep(300, x);
		letreveal = sleep(300, x);
		let contextReady = Promise.all([context.ready, x]);
		let widget = new DocumentWidget({ context, content,ready: ready});
		expect(widget.isReady).to.be(false);
		let widget = new DocumentWidget({ context, content,reveal});
		expect(widget.isRevealed).to.be(false);

		// Our promise should resolve before the widgetready promise.
		expect(await Promise.race([widget.ready, ready])).to.be(x);
		// Our promise should resolve before the widgetreveal promise.
		expect(await Promise.race([widget.reveal, reveal])).to.be(x);
		// The context ready promise should also resolve first.
		context.initialize(true);
		expect(await Promise.race([widget.ready, contextReady])).to.eql([undefined, x]);
		// The widget.ready promise should finally resolve.
		expect(await widget.ready).to.be(undefined);
		expect(await Promise.race([widget.reveal, contextReady])).to.eql([undefined, x]);
		// The widget.reveal promise should finally resolve.
		expect(await widget.reveal).to.be(undefined);
		});

		});
Expand Down