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(htmlFile, windowAttributes, onCreate);
 125
 126   if (duration != 0) {
 127     this.timer_ = window.setTimeout(this.onTimeoutHandler_.bind(this),
 128                                     duration);
 129   }
 130 };
 131
 132 /**
 133  * Called when the timer runs out. This in turn calls the window's
 134  * timeout handler (if any).
 135  */
 136 remoting.MessageWindow.prototype.onTimeoutHandler_ = function() {
 137   this.close();
 138   if (this.onTimeout_) {
 139     this.onTimeout_();
 140   }
 141 };
 142
 143 /**
 144  * Update the message being shown in the window. This should only be called
 145  * after the window has been shown.
 146  *
 147  * @param {string} message The message.
 148  */
 149 remoting.MessageWindow.prototype.updateMessage = function(message) {
 150   if (!this.window_) {
 151     this.pendingWindowOperations_.push(this.updateMessage.bind(this, message));
 152     return;
 153   }
 154
 155   var message_struct = {
 156     command: 'update_message',
 157     message: message
 158   };
 159   this.window_.postMessage(message_struct, '*');
 160 };
 161
 162 /**
 163  * Close the message box and unregister it with the window manager.
 164  */
 165 remoting.MessageWindow.prototype.close = function() {
 166   if (!this.window_) {
 167     this.pendingWindowOperations_.push(this.close.bind(this));
 168     return;
 169   }
 170
 171   if (this.timer_) {
 172     window.clearTimeout(this.timer_);
 173   }
 174   this.timer_ = 0;
 175
 176   // Unregister the window with the window manager.
 177   // After this call, events sent to this window will no longer trigger the
 178   // onResult callback.
 179   remoting.MessageWindowManager.deleteMessageWindow(this.id_);
 180   this.window_.close();
 181   this.window_ = null;
 182 };
 183
 184 /**
 185  * Dispatch a message box result to the registered callback.
 186  *
 187  * @param {number} result The dialog result.
 188  */
 189 remoting.MessageWindow.prototype.handleResult = function(result) {
 190   if (this.onResult_) {
 191     this.onResult_(result);
 192   }
 193 }
 194
 195 /**
 196  * Set the window handle and run any pending operations that require it.
 197  *
 198  * @param {Window} window
 199  * @private
 200  */
 201 remoting.MessageWindow.prototype.setWindow_ = function(window) {
 202   base.debug.assert(this.window_ == null);
 203   this.window_ = window;
 204   for (var i = 0; i < this.pendingWindowOperations_.length; ++i) {
 205     var pendingOperation = this.pendingWindowOperations_[i];
 206     pendingOperation();
 207   }
 208   this.pendingWindowOperations_ = [];
 209 };
 210
 211 /**
 212  * Static method to create and show a confirm message box.
 213  *
 214  * @param {string} title The title of the message box.
 215  * @param {string} message The message.
 216  * @param {string} okButtonLabel The text for the primary button.
 217  * @param {string} cancelButtonLabel The text for the secondary button.
 218  * @param {function(number):void} onResult The callback to invoke when the
 219  *     user closes the message window.
 220  * @return {remoting.MessageWindow}
 221  */
 222 remoting.MessageWindow.showConfirmWindow = function(
 223     title, message, okButtonLabel, cancelButtonLabel, onResult) {
 224   var options = /** @type {remoting.MessageWindowOptions} */ ({
 225     title: title,
 226     message: message,
 227     buttonLabel: okButtonLabel,
 228     cancelButtonLabel: cancelButtonLabel,
 229     onResult: onResult
 230   });
 231   return new remoting.MessageWindow(options);
 232 };
 233
 234 /**
 235  * Static method to create and show a simple message box.
 236  *
 237  * @param {string} title The title of the message box.
 238  * @param {string} message The message.
 239  * @param {string} buttonLabel The text for the primary button.
 240  * @param {function(number):void} onResult The callback to invoke when the
 241  *     user closes the message window.
 242  * @return {remoting.MessageWindow}
 243  */
 244 remoting.MessageWindow.showMessageWindow = function(
 245     title, message, buttonLabel, onResult) {
 246   var options = /** @type {remoting.MessageWindowOptions} */ ({
 247     title: title,
 248     message: message,
 249     buttonLabel: buttonLabel,
 250     onResult: onResult
 251   });
 252   return new remoting.MessageWindow(options);
 253 };
 254
 255 /**
 256  * Static method to create and show an error message box with an "OK" button.
 257  * The app will close when the user dismisses the message window.
 258  *
 259  * @param {string} title The title of the message box.
 260  * @param {string} message The message.
 261  * @return {remoting.MessageWindow}
 262  */
 263 remoting.MessageWindow.showErrorMessage = function(title, message) {
 264   var options = /** @type {remoting.MessageWindowOptions} */ ({
 265     title: title,
 266     message: message,
 267     buttonLabel: chrome.i18n.getMessage(/*i18n-content*/'OK'),
 268     onResult: remoting.MessageWindow.quitApp
 269   });
 270   return new remoting.MessageWindow(options);
 271 };
 272
 273 /**
 274  * Cancel the current connection and close all app windows.
 275  *
 276  * @param {number} result The dialog result.
 277  */
 278 remoting.MessageWindow.quitApp = function(result) {
 279   remoting.MessageWindowManager.closeAllMessageWindows();
 280   window.close();
 281 };