chrome-devtools-frontend/front_end/models/extensions/ExtensionView.ts

Chrome DevTools UI

/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import * as UI from '../../ui/legacy/legacy.js';

import {type ExtensionServer} from './ExtensionServer.js';

export class ExtensionView extends UI.Widget.Widget {
  private readonly server: ExtensionServer;
  private readonly id: string;
  private iframe: HTMLIFrameElement;
  private frameIndex?: number;
  constructor(server: ExtensionServer, id: string, src: string, className: string) {
    super();
    this.setHideOnDetach();
    this.element.className = 'vbox flex-auto';  // Override

    // TODO(crbug.com/872438): remove once we can use this.iframe instead
    this.element.tabIndex = -1;

    this.server = server;
    this.id = id;
    this.iframe = document.createElement('iframe');
    this.iframe.addEventListener('load', this.onLoad.bind(this), false);
    this.iframe.src = src;
    this.iframe.className = className;

    // TODO(crbug.com/872438): make this.iframe the default focused element
    this.setDefaultFocusedElement(this.element);

    this.element.appendChild(this.iframe);
  }

  override wasShown(): void {
    super.wasShown();
    if (typeof this.frameIndex === 'number') {
      this.server.notifyViewShown(this.id, this.frameIndex);
    }
  }

  override willHide(): void {
    if (typeof this.frameIndex === 'number') {
      this.server.notifyViewHidden(this.id);
    }
  }

  private onLoad(): void {
    const frames = window.frames;
    this.frameIndex = Array.prototype.indexOf.call(frames, this.iframe.contentWindow);
    if (this.isShowing()) {
      this.server.notifyViewShown(this.id, this.frameIndex);
    }
  }
}

export class ExtensionNotifierView extends UI.Widget.VBox {
  private readonly server: ExtensionServer;
  private readonly id: string;
  constructor(server: ExtensionServer, id: string) {
    super();

    this.server = server;
    this.id = id;
  }

  override wasShown(): void {
    this.server.notifyViewShown(this.id);
  }

  override willHide(): void {
    this.server.notifyViewHidden(this.id);
  }
}