remoting/webapp/base/js/message_window_helper.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 'use strict';
   6
   7 /** @suppress {duplicate} */
   8 var remoting = remoting || {};
   9
  10 /** @constructor */
  11 remoting.MessageWindowOptions = function() {
  12   /** @type {string} */
  13   this.title = '';
  14
  15   /** @type {string} */
  16   this.message = '';
  17
  18   /** @type {string} */
  19   this.buttonLabel = '';
  20
  21   /** @type {string} */
  22   this.cancelButtonLabel = '';
  23
  24   /** @type {function(number):void} */
  25   this.onResult = function() {};
  26
  27   /** @type {number} */
  28   this.duration = 0;
  29
  30   /** @type {string} */
  31   this.infobox = '';
  32
  33   /** @type {?function():void} */
  34   this.onTimeout = function() {};
  35
  36   /** @type {string} */
  37   this.htmlFile = '';
  38
  39   /** @type {string} */
  40   this.frame = '';
  41
  42   /** @type {number} */
  43   this.minimumWidth = 0;
  44 };
  45
  46 /**
  47  * Create a new message window.
  48  *
  49  * @param {remoting.MessageWindowOptions} options Message window create options
  50  * @constructor
  51  */
  52 remoting.MessageWindow = function(options) {
  53   var title = options.title;
  54   var message = options.message;
  55   var okButtonLabel = options.buttonLabel;
  56   var cancelButtonLabel = options.cancelButtonLabel;
  57   var onResult = options.onResult;
  58   var duration = 0;
  59   if (options.duration) {
  60     duration = options.duration;
  61   }
  62   var infobox = '';
  63   if (options.infobox) {
  64     infobox = options.infobox;
  65   }
  66   var onTimeout = options.onTimeout;
  67
  68   /** @type {number} */
  69   this.id_ = remoting.messageWindowManager.addMessageWindow(this);
  70
  71   /** @type {?function(number):void} */
  72   this.onResult_ = onResult;
  73
  74   /** @type {Window} */
  75   this.window_ = null;
  76
  77   /** @type {number} */
  78   this.timer_ = 0;
  79
  80   /** @type {Array<function():void>} */
  81   this.pendingWindowOperations_ = [];
  82
  83   /**
  84    * Callback to call when the timeout expires.
  85    * @type {?function():void}
  86    */
  87   this.onTimeout_ = onTimeout;
  88
  89   var message_struct = {
  90     command: 'show',
  91     id: this.id_,
  92     title: title,
  93     message: message,
  94     infobox: infobox,
  95     buttonLabel: okButtonLabel,
  96     cancelButtonLabel: cancelButtonLabel,
  97     showSpinner: (duration != 0)
  98   };
  99
 100   var windowAttributes = {
 101     bounds: {
 102       width: options.minimumWidth || 400,
 103       height: 100,
 104       top: undefined,
 105       left: undefined
 106     },
 107     resizable: false,
 108     frame: options.frame || 'chrome'
 109   };
 110
 111   /** @type {remoting.MessageWindow} */
 112   var that = this;
 113
 114   /** @param {chrome.app.window.AppWindow} appWindow */
 115   var onCreate = function(appWindow) {
 116     that.setWindow_(/** @type {Window} */(appWindow.contentWindow));
 117     var onLoad = function() {
 118       appWindow.contentWindow.postMessage(message_struct, '*');
 119     };
 120     appWindow.contentWindow.addEventListener('load', onLoad, false);
 121   };
 122
 123   var htmlFile = options.htmlFile || 'message_window.html';
 124   chrome.app.window.create(
 125       remoting.MessageWindow.htmlFilePrefix + htmlFile,
 126       windowAttributes, onCreate);
 127
 128   if (duration != 0) {
 129     this.timer_ = window.setTimeout(this.onTimeoutHandler_.bind(this),
 130                                     duration);
 131   }
 132 };
 133
 134 /**
 135  * This string is prepended to the htmlFile when message windows are created.
 136  * Normally, this should be left empty, but the shared module needs to specify
 137  * this so that the shared HTML files can be found when running in the
 138  * context of the app stub.
 139  * @type {string}
 140  */
 141 remoting.MessageWindow.htmlFilePrefix = "";
 142
 143 /**
 144  * Called when the timer runs out. This in turn calls the window's
 145  * timeout handler (if any).
 146  */
 147 remoting.MessageWindow.prototype.onTimeoutHandler_ = function() {
 148   this.close();
 149   if (this.onTimeout_) {
 150     this.onTimeout_();
 151   }
 152 };
 153
 154 /**
 155  * Update the message being shown in the window. This should only be called
 156  * after the window has been shown.
 157  *
 158  * @param {string} message The message.
 159  */
 160 remoting.MessageWindow.prototype.updateMessage = function(message) {
 161   if (!this.window_) {
 162     this.pendingWindowOperations_.push(this.updateMessage.bind(this, message));
 163     return;
 164   }
 165
 166   var message_struct = {
 167     command: 'update_message',
 168     message: message
 169   };
 170   this.window_.postMessage(message_struct, '*');
 171 };
 172
 173 /**
 174  * Close the message box and unregister it with the window manager.
 175  */
 176 remoting.MessageWindow.prototype.close = function() {
 177   if (!this.window_) {
 178     this.pendingWindowOperations_.push(this.close.bind(this));
 179     return;
 180   }
 181
 182   if (this.timer_) {
 183     window.clearTimeout(this.timer_);
 184   }
 185   this.timer_ = 0;
 186
 187   // Unregister the window with the window manager.
 188   // After this call, events sent to this window will no longer trigger the
 189   // onResult callback.
 190   remoting.messageWindowManager.deleteMessageWindow(this.id_);
 191   this.window_.close();
 192   this.window_ = null;
 193 };
 194
 195 /**
 196  * Dispatch a message box result to the registered callback.
 197  *
 198  * @param {number} result The dialog result.
 199  */
 200 remoting.MessageWindow.prototype.handleResult = function(result) {
 201   if (this.onResult_) {
 202     this.onResult_(result);
 203   }
 204 }
 205
 206 /**
 207  * Set the window handle and run any pending operations that require it.
 208  *
 209  * @param {Window} window
 210  * @private
 211  */
 212 remoting.MessageWindow.prototype.setWindow_ = function(window) {
 213   console.assert(this.window_ == null, 'Duplicate call to setWindow_().');
 214   this.window_ = window;
 215   for (var i = 0; i < this.pendingWindowOperations_.length; ++i) {
 216     var pendingOperation = this.pendingWindowOperations_[i];
 217     pendingOperation();
 218   }
 219   this.pendingWindowOperations_ = [];
 220 };
 221
 222 /**
 223  * Static method to create and show a confirm message box.
 224  *
 225  * @param {string} title The title of the message box.
 226  * @param {string} message The message.
 227  * @param {string} okButtonLabel The text for the primary button.
 228  * @param {string} cancelButtonLabel The text for the secondary button.
 229  * @param {function(number):void} onResult The callback to invoke when the
 230  *     user closes the message window.
 231  * @return {remoting.MessageWindow}
 232  */
 233 remoting.MessageWindow.showConfirmWindow = function(
 234     title, message, okButtonLabel, cancelButtonLabel, onResult) {
 235   var options = /** @type {remoting.MessageWindowOptions} */ ({
 236     title: title,
 237     message: message,
 238     buttonLabel: okButtonLabel,
 239     cancelButtonLabel: cancelButtonLabel,
 240     onResult: onResult
 241   });
 242   return new remoting.MessageWindow(options);
 243 };
 244
 245 /**
 246  * Static method to create and show a simple message box.
 247  *
 248  * @param {string} title The title of the message box.
 249  * @param {string} message The message.
 250  * @param {string} buttonLabel The text for the primary button.
 251  * @param {function(number):void} onResult The callback to invoke when the
 252  *     user closes the message window.
 253  * @return {remoting.MessageWindow}
 254  */
 255 remoting.MessageWindow.showMessageWindow = function(
 256     title, message, buttonLabel, onResult) {
 257   var options = /** @type {remoting.MessageWindowOptions} */ ({
 258     title: title,
 259     message: message,
 260     buttonLabel: buttonLabel,
 261     onResult: onResult
 262   });
 263   return new remoting.MessageWindow(options);
 264 };
 265
 266 /**
 267  * Static method to create and show an error message box with an "OK" button.
 268  * The app will close when the user dismisses the message window.
 269  *
 270  * @param {string} title The title of the message box.
 271  * @param {string} message The message.
 272  * @return {remoting.MessageWindow}
 273  */
 274 remoting.MessageWindow.showErrorMessage = function(title, message) {
 275   var options = /** @type {remoting.MessageWindowOptions} */ ({
 276     title: title,
 277     message: message,
 278     buttonLabel: chrome.i18n.getMessage(/*i18n-content*/'OK'),
 279     onResult: remoting.MessageWindow.quitApp
 280   });
 281   return new remoting.MessageWindow(options);
 282 };
 283
 284 /**
 285  * Cancel the current connection and close all app windows.
 286  *
 287  * @param {number} result The dialog result.
 288  */
 289 remoting.MessageWindow.quitApp = function(result) {
 290   remoting.messageWindowManager.closeAllMessageWindows();
 291   window.close();
 292 };