Publish Vulpes Preview 15 sources for desktop, Android and Tundra

Share Gaia assets and adapters, keep private profiles and development documents local, and update both public READMEs.

gaia/tv_apps/smart-system/js/base_ui.js

@@ -0,0 +1,131 @@
+/* global Service */
+'use strict';
+
+(function(window) {
+  var DEBUG = false;
+
+  /**
+   * The virtual class inherited by all UI in system which has
+   * the similar behavior.
+   *
+   * @class BaseUI
+   */
+  function BaseUI() {
+  }
+
+  window.BaseUI = BaseUI;
+
+  BaseUI.prototype.EVENT_PREFIX = 'base-';
+
+  /**
+   * Operations to render UI
+   * Overwrite `view` to provide HTML interface.
+   * Overwrite `_fetchElements` to provide elements reference.
+   * Overwrite `_registerEvents` to register event handler.
+   */
+  BaseUI.prototype.render = function bu_render() {
+    this.publish('willrender');
+    this.containerElement.insertAdjacentHTML('afterbegin', this.view());
+    this._fetchElements();
+    this._registerEvents();
+    this.publish('rendered');
+  };
+
+  /**
+   * Get nessesary elements reference when inited
+   */
+  BaseUI.prototype._fetchElements = function bu__fetchElements() {
+
+  };
+
+  /**
+   * Register event handler
+   */
+  BaseUI.prototype._registerEvents = function bu__registerEvents() {
+
+  };
+
+  /**
+   * Modal Dialog html view
+   */
+  BaseUI.prototype.view = function bu_view() {
+    return '<div class="' + this.CLASS_NAME + '"></div>';
+  };
+
+  BaseUI.prototype.show = function bu_show(ele) {
+    ele = ele || this.element;
+    ele.classList.add('visible');
+  };
+
+  BaseUI.prototype.hide = function bu_hide(ele) {
+    ele = ele || this.element;
+    ele.classList.remove('visible');
+  };
+
+  BaseUI.prototype.broadcast = function bu_broadcast(event, detail) {
+    if (this.element) {
+      var internalEvent = new CustomEvent('_' + event, {
+        bubbles: false,
+        detail: detail || this
+      });
+
+      this.debug(' publishing internal event: ' + event);
+      this.element.dispatchEvent(internalEvent);
+    }
+  };
+
+  BaseUI.prototype.publish = function bu_publish(event, detail) {
+    // Dispatch internal event before external events.
+    this.broadcast(event, detail);
+    var evt = new CustomEvent(this.EVENT_PREFIX + event, {
+      bubbles: true,
+      cancelable: false,
+      detail: detail || this
+    });
+
+    this.debug(' publishing external event: ' + event);
+    // Publish external event.
+    window.dispatchEvent(evt);
+  };
+
+  // Override me.
+  BaseUI.prototype.CLASS_NAME = 'BaseUI';
+
+  // Override me. Human readable ID.
+  BaseUI.prototype.customID = function bu_customID() {
+    return '';
+  };
+
+  /**
+   * Overwrite me if you need to unregister event handlers.
+   */
+  BaseUI.prototype._unregisterEvents = function bu__unregisterEvents() {
+
+  };
+
+  /**
+   * Overwrite me if you need to destruct something.
+   */
+  BaseUI.prototype._destroy = function bu__destroy() {
+
+  };
+
+  BaseUI.prototype.destroy = function bu_destroy() {
+    this.publish('willdestroy');
+    this._unregisterEvents();
+    this._destroy();
+    if (this.element) {
+      this.element.parentNode.removeChild(this.element);
+      this.element = null;
+    }
+    this.publish('destroyed');
+  };
+
+  BaseUI.prototype.debug = function bu_debug(msg) {
+    if (DEBUG && ('DEBUG' in this.constructor && this.constructor.DEBUG)) {
+      console.log('[' + this.CLASS_NAME + '][' + this.customID() + ']' +
+        '[' + Service.currentTime() + ']' +
+        Array.slice(arguments).concat());
+    }
+  };
+}(window));