Source: panels/keyboard_add_layouts/core.js

  1. /**
  2.  * The module initializes a ListView displaying all installed layouts.
  3.  * Implementation details please refer to {@link KeyboardAddLayoutsCore}.
  4.  *
  5.  * @module keyboard_add_layouts/core
  6.  */
  7. define(function(require) {
  8.   'use strict';
  10.   var ListView = require('modules/mvvm/list_view');
  12.   var _ = navigator.mozL10n.get;
  14.   /**
  15.    * @alias module:keyboard_add_layouts/core
  16.    * @class KeyboardAddLayoutsCore
  17.    * @requires module:modules/settings_service
  18.    * @requires module:modules/mvvm/list_view
  19.    * @param {KeyboardContext} context
  20.                               The kyboard context providing installed keyboards.
  21.    * @param {Function} template
  22.                        The template function used to render an installed
  23.                        keyboard.
  24.    * @returns {KeyboardAddLayoutsCore}
  25.    */
  26.   function KeyboardAddLayoutsCore(context, template) {
  27.     this._enabled = false;
  28.     this._listView = null;
  29.     this._keyboardContext = context;
  30.     this._keyboardTemplate = template;
  31.   }
  33.   KeyboardAddLayoutsCore.prototype = {
  34.     /**
  35.      * The value indicates whether the module is responding. If it is false, the
  36.      * UI stops reflecting the updates from the keyboard context.
  37.      *
  38.      * @access public
  39.      * @memberOf KeyboardAddLayoutsCore.prototype
  40.      * @type {Boolean}
  41.      */
  42.     get enabled() {
  43.       return this._enabled;
  44.     },
  46.     set enabled(value) {
  47.       this._enabled = value;
  48.       if (this._listView) {
  49.         this._listView.enabled = this._enabled;
  50.       }
  51.       // Disable all inner list views
  52.       this._keyboardTemplate.listViews.forEach(function(listView) {
  53.         listView.enabled = this._enabled;
  54.       }.bind(this));
  55.     },
  57.     /**
  58.      * @access private
  59.      * @memberOf KeyboardAddLayoutsCore.prototype
  60.      * @param {HTMLElement} listViewRoot
  61.      * @param {ObservableArray} keyboards
  62.      * @param {Function} keyboardTemplate
  63.      */
  64.     _initInstalledLayoutListView:
  65.       function kal_initListView(listViewRoot, keyboards, keyboardTemplate) {
  66.         this._listView = ListView(listViewRoot, keyboards, keyboardTemplate);
  67.     },
  69.     /**
  70.      * The handler is invoked when users disable the must-have input type. In
  71.      * the handler we navigate to the dialog.
  72.      *
  73.      * @access private
  74.      * @memberOf KeyboardAddLayoutsCore.prototype
  75.      * @param {Object} layout
  76.      * @param {String} missingType
  77.      */
  78.     _showEnabledDefaultDialog: function kal_showDialog(layout, missingType) {
  79.       require(['modules/dialog_service'], function(DialogService) {
  80.         var type = _('keyboardType-' + missingType);
  81.         DialogService.alert({
  82.           id: 'defaultKeyboardEnabled',
  83.           args: {
  84.             layoutName: layout.inputManifest.name,
  85.             appName: layout.manifest.name
  86.           }
  87.         }, {
  88.           title: {
  89.             id: 'mustHaveOneKeyboard',
  90.             args: {
  91.               type: type
  92.             }
  93.           }
  94.         });
  95.       });
  96.     },
  98.     /**
  99.      * @access public
  100.      * @memberOf KeyboardAddLayoutsCore.prototype
  101.      * @param {Array} elements
  102.      *                Elements needed by this module.
  103.      * @param {HTMLElement} elements.listViewRoot
  104.      *                      The root element for the list view displaying the
  105.      *                      installed keyboards.
  106.      */
  107.     init: function kal_onInit(elements) {
  108.       var that = this;
  109.       this._keyboardContext.init(function() {
  110.         that._keyboardContext.keyboards(function(keyboards) {
  111.           that._initInstalledLayoutListView(
  112.             elements.listViewRoot, keyboards, that._keyboardTemplate);
  113.           that.enabled = true;
  114.         });
  115.       });
  117.       this._keyboardContext.defaultKeyboardEnabled(
  118.         this._showEnabledDefaultDialog);
  119.     }
  120.   };
  122.   return function ctor_kalCore(context, template) {
  123.     return new KeyboardAddLayoutsCore(context, template);
  124.   };
  125. });