polygerrit-ui/app/elements/plugins/gr-popup-interface/gr-popup-interface.js

/**
 * @license
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import './gr-plugin-popup.js';
import {dom, flush} from '@polymer/polymer/lib/legacy/polymer.dom.js';

/**
 * Plugin popup API.
 * Provides method for opening and closing popups from plugin.
 * opt_moduleName is a name of custom element that will be automatically
 * inserted on popup opening.
 *
 * @constructor
 * @param {!Object} plugin
 * @param {opt_moduleName=} string
 */
export function GrPopupInterface(plugin, opt_moduleName) {
  this.plugin = plugin;
  this._openingPromise = null;
  this._popup = null;
  this._moduleName = opt_moduleName || null;
}

GrPopupInterface.prototype._getElement = function() {
  return dom(this._popup);
};

/**
 * Opens the popup, inserts it into DOM over current UI.
 * Creates the popup if not previously created. Creates popup content element,
 * if it was provided with constructor.
 *
 * @returns {!Promise<!Object>}
 */
GrPopupInterface.prototype.open = function() {
  if (!this._openingPromise) {
    this._openingPromise =
        this.plugin.hook('plugin-overlay').getLastAttached()
            .then(hookEl => {
              const popup = document.createElement('gr-plugin-popup');
              if (this._moduleName) {
                const el = dom(popup).appendChild(
                    document.createElement(this._moduleName));
                el.plugin = this.plugin;
              }
              this._popup = dom(hookEl).appendChild(popup);
              flush();
              return this._popup.open().then(() => this);
            });
  }
  return this._openingPromise;
};

/**
 * Hides the popup.
 */
GrPopupInterface.prototype.close = function() {
  if (!this._popup) { return; }
  this._popup.close();
  this._openingPromise = null;
};