Source: js/homescreen_window.js

  1. /* global BrowserConfigHelper, AppWindow */
  3. 'use strict';
  4. (function(exports) {
  5.   /**
  6.    * HomescreenWindow creates a instance of homescreen by give manifestURL.
  7.    *
  8.    * ##### Flow chart
  9.    * ![Boot to Homescreen flow chart](http://i.imgur.com/vLA8YEN.png)
  10.    *
  11.    * @class HomescreenWindow
  12.    * @param {String} manifestURL The manifestURL of the homescreen app.
  13.    * @extends AppWindow
  14.    */
  15.   var HomescreenWindow = function HomescreenWindow(manifestURL) {
  16.     this.instanceID = 'homescreen';
  17.     this.setBrowserConfig(manifestURL);
  18.     this.render();
  19.     this.publish('created');
  20.     this.createdTime = this.launchTime = Date.now();
  21.     return this;
  22.   };
  24.   /**
  25.    * Fired when the homescreen window is created.
  26.    * @event HomescreenWindow#homescreencreated
  27.    */
  28.   /**
  29.    * Fired when the homescreen window is removed.
  30.    * @event HomescreenWindow#homescreenterminated
  31.    */
  32.   /**
  33.    * Fired when the homescreen window is opening.
  34.    * @event HomescreenWindow#homescreenopening
  35.    */
  36.   /**
  37.    * Fired when the homescreen window is opened.
  38.    * @event HomescreenWindow#homescreenopen
  39.    */
  40.   /**
  41.    * Fired when the homescreen window is closed.
  42.    * @event HomescreenWindow#homescreenclosed
  43.    */
  44.   /**
  45.    * Fired when the homescreen window is closing.
  46.    * @event HomescreenWindow#homescreenclosing
  47.    */
  48.   /**
  49.    * Fired when the homescreen window is closed.
  50.    * @event HomescreenWindow#homescreenclose
  51.    */
  52.   /**
  53.    * Fired before the homescreen window is rendered.
  54.    * @event HomescreenWindow#homescreenwillrender
  55.    */
  56.   /**
  57.    * Fired when the homescreen window is rendered to the DOM tree.
  58.    * @event HomescreenWindow#homescreenrendered
  59.    */
  60.   /**
  61.    * Fired when the page visibility of the homescreen window is
  62.    * changed to foreground.
  63.    * @event HomescreenWindow#homescreenforeground
  64.    */
  65.   /**
  66.    * Fired when the page visibility of the homescreen window is
  67.    * changed to background.
  68.    * @event HomescreenWindow#homescreenbackground
  69.    */
  71.   HomescreenWindow.prototype = Object.create(AppWindow.prototype);
  73.   HomescreenWindow.prototype.constructor = HomescreenWindow;
  75.   HomescreenWindow.prototype._DEBUG = false;
  77.   HomescreenWindow.prototype.CLASS_NAME = 'HomescreenWindow';
  79.   /**
  80.    * Construct browser config object by manifestURL.
  81.    * @param {String} manifestURL The manifestURL of homescreen.
  82.    */
  83.   HomescreenWindow.prototype.setBrowserConfig =
  84.     function hw_setBrowserConfig(manifestURL) {
  85.       var app = window.applications.getByManifestURL(manifestURL);
  86.       this.origin = app.origin;
  87.       this.manifestURL = app.manifestURL;
  88.       this.url = app.origin + '/index.html#root';
  90.       this.browser_config =
  91.         new BrowserConfigHelper({
  92.           url: this.origin,
  93.           manifestURL: this.manifestURL
  94.         });
  96.       // Necessary for b2gperf now.
  97.       this.name = this.browser_config.name;
  99.       this.manifest = this.browser_config.manifest;
  100.       // XXX: Remove this hardcode
  101.       this.browser_config.url = this.url;
  102.       this.browser_config.isHomescreen = true;
  103.       this.config = this.browser_config;
  104.       this.isHomescreen = true;
  105.     };
  107.   HomescreenWindow.REGISTERED_EVENTS = AppWindow.REGISTERED_EVENTS;
  109.   HomescreenWindow.SUB_COMPONENTS = {
  110.     'transitionController': 'AppTransitionController',
  111.     'modalDialog': 'AppModalDialog',
  112.     'valueSelector': 'ValueSelector',
  113.     'authDialog': 'AppAuthenticationDialog',
  114.     'childWindowFactory': 'ChildWindowFactory',
  115.     'statusbar': 'AppStatusbar'
  116.   };
  118.   HomescreenWindow.prototype.openAnimation = 'zoom-out';
  119.   HomescreenWindow.prototype.closeAnimation = 'zoom-in';
  121.   HomescreenWindow.prototype._handle__opening = function hw__handle__opening() {
  122.     this.ensure();
  123.   };
  125.   HomescreenWindow.prototype._handle_mozbrowserclose =
  126.     function hw__handle_mozbrowserclose(evt) {
  127.       this.restart();
  128.     };
  130.   HomescreenWindow.prototype._handle_mozbrowsererror =
  131.     function hw__handle_mozbrowsererror(evt) {
  132.       if (evt.detail.type == 'fatal') {
  133.         this.loaded = false;
  134.         this.publish('crashed');
  135.         this.restart();
  136.       }
  137.     };
  139.   HomescreenWindow.prototype.restart = function hw_restart() {
  140.     // If the crashing app is the home screen app and it is the displaying app
  141.     // we will need to relaunch it right away.
  142.     // Alternatively, if home screen is not the displaying app,
  143.     // we will not relaunch it until the foreground app is closed.
  144.     // (to be dealt in setDisplayedApp(), not here)
  146.     // If we're displayed, restart immediately.
  147.     if (this.isActive()) {
  148.       this.kill();
  150.       // XXX workaround bug 810431.
  151.       // we need this here and not in other situations
  152.       // as it is expected that homescreen frame is available.
  153.       setTimeout(function() {
  154.         if (this.element) {
  155.           return;
  156.         }
  157.         this.render();
  158.         this.open();
  159.       }.bind(this));
  160.     } else {
  161.       // Otherwise wait until next opening request.
  162.       this.kill();
  163.     }
  164.   };
  166.   HomescreenWindow.prototype.view = function hw_view() {
  167.     var content = `<div class="appWindow homescreen" id="homescreen">
  168.               <div class="fade-overlay"></div>
  169.               <div class="browser-container"></div>
  170.            </div>`;
  171.     return content;
  172.   };
  174.   HomescreenWindow.prototype.eventPrefix = 'homescreen';
  176.   HomescreenWindow.prototype.toggle = function hw_toggle(visible) {
  177.     this.ensure();
  178.     if (this.browser.element) {
  179.       this.setVisible(visible);
  180.     }
  181.   };
  183.   // Ensure the homescreen is loaded and return its frame.  Restarts
  184.   // the homescreen app if it was killed in the background.
  185.   HomescreenWindow.prototype.ensure = function hw_ensure(reset) {
  186.     this.debug('ensuring homescreen...', this.frontWindow, reset);
  187.     if (!this.element) {
  188.       this.render();
  189.     } else if (reset) {
  190.       if (this.frontWindow) {
  191.         // Just kill front window but not switch to the first page.
  192.         this.frontWindow.kill();
  193.       } else {
  194.         var urlWithoutHash = this.browser_config.url.split('#')[0];
  195.         this.browser.element.src = urlWithoutHash + '#' + Date.now();
  196.       }
  197.     }
  199.     return this.element;
  200.   };
  202.   /**
  203.   *
  204.   * The homescreen instance always resizes if it's needed.
  205.   * (ie. the current layout is different from the current window dimensions)
  206.   * This helps with the back-to-homescreen transition.
  207.   *
  208.   */
  209.   HomescreenWindow.prototype.resize = function aw_resize() {
  210.     this.debug('request RESIZE...');
  211.     this.debug(' will resize... ');
  212.     return this._resize();
  213.   };
  215.   /**
  216.    * Hide the overlay element of this window.
  217.    *
  218.    * this {HomescreenWindow}
  219.    * memberof HomescreenWindow
  220.    */
  221.   HomescreenWindow.prototype.hideFadeOverlay = function hw_hideFadeOverlay() {
  222.     this.fadeOverlay.classList.add('hidden');
  223.   };
  225.   /**
  226.    * Show the overlay element of this window.
  227.    *
  228.    * this {HomescreenWindow}
  229.    * memberof HomescreenWindow
  230.    */
  231.   HomescreenWindow.prototype.showFadeOverlay = function hw_showFadeOverlay() {
  232.     this.fadeOverlay.classList.remove('hidden');
  233.   };
  235.   exports.HomescreenWindow = HomescreenWindow;
  236. }(window));