Code coverage report for app/mixins/common/loading_overlay_support.js

Statements: 96.88% (31 / 32)      Branches: 66.67% (8 / 12)      Functions: 100% (8 / 8)      Lines: 96.88% (31 / 32)      Ignored: none     

All files » app/mixins/common/ » loading_overlay_support.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143    1                                     1                                       1                               5 5 5 5               1                           5 5 5                 5 5 5                 13   13 13 13 13 13 4 4 4 4               4     9                 14 14 14 14 14        
'use strict';
 
;require.register("mixins/common/loading_overlay_support", function (exports, require, module) {
  /**
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you under the Apache License, Version 2.0 (the
   * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
   *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
 
  var App = require('app');
 
  /**
   * This Mixin is used for views that should "wait" while some external action is executed (e.g., ajax-request).
   * You should set <code>fieldToObserve</code> to fieldName which value determines begin and end of such action
   * When <code>fieldToObserve</code>-value becomes truly, overlay is shown
   * Overlay size is taken from current view size
   *
   * Usage:
   *
   * <pre>
   *   Em.View.extend(App.LoadingOverlaySupport, {
   *    fieldToObserve: 'someFieldName'
   *   });
   * </pre>
   *
   * Don't forget to add <code><div class="loading-overlay"></div></code> to your view's template
   *
   * @type {Em.Mixin}
   */
  App.LoadingOverlaySupport = Em.Mixin.create({
 
    /**
     * @type {string}
     */
    fieldToObserve: '',
 
    /**
     * Determines if <code>handleFieldChanges</code> should be call on <code>didInsertElement</code>
     *
     * @type {boolean}
     * @default {true}
     */
    handleFieldChangesOnDidInsert: true,
 
    init: function init() {
      var fieldToObserve = this.get('fieldToObserve');
      Em.assert('`fieldToObserve` should be defined', fieldToObserve);
      this.addObserver(fieldToObserve, this, 'handleFieldChanges');
      return this._super.apply(this, arguments);
    },
 
 
    /**
     * Don't allow change `fieldToObserve` after view is initialized. This may cause a lot of errors
     */
    doNotChangeFieldToObserve: function () {
      Em.assert('Do not change `fieldToObserve` after view is initialized', false);
    }.observes('fieldToObserve'),
 
    /**
     * Value in the <code>fieldToObserve</code> may be <code>truly</code> on view init, so
     * <code>handleFieldChanges</code> should be called to check this
     *
     * Example use case:
     *  Switching tabs on the configs page for some service. Every tab should be disabled when switching on it
     *  if needed property is set to <code>true</code>
     *
     * @returns {*}
     */
    didInsertElement: function didInsertElement() {
      this._super.apply(this, arguments);
      Eif (this.get('handleFieldChangesOnDidInsert')) {
        this.handleFieldChanges();
      }
    },
 
 
    /**
     * Remove observer `handleFieldChanges`
     */
    willDestroyElement: function willDestroyElement() {
      var fieldToObserve = this.get('fieldToObserve');
      this.removeObserver(fieldToObserve, this, 'handleFieldChanges');
      this._cleanUp();
    },
 
 
    /**
     * Show overlay when `fieldToObserve`-value is set to some truly
     * Remove overlay otherwise
     */
    handleFieldChanges: function handleFieldChanges() {
      var _this = this;
 
      var fieldToObserve = this.get('fieldToObserve');
      var fieldValue = this.get(fieldToObserve);
      var overlay = this.$('.loading-overlay');
      var polling = this.get('_polling');
      if (fieldValue) {
        Eif (!polling) {
          polling = setInterval(function () {
            Eif (fieldValue && overlay) {
              overlay.addClass('overlay-visible').css({
                width: _this.$().width(),
                height: _this.$().height()
              });
            } else {
              _this._cleanUp();
            }
          }, 50);
          this.set('_polling', polling);
        }
      } else {
        this._cleanUp();
      }
    },
 
 
    /**
     * @private
     */
    _cleanUp: function _cleanUp() {
      clearInterval(this.get('_polling'));
      this.set('_polling', null);
      var overlay = this.$('.loading-overlay');
      Eif (overlay) {
        overlay.removeClass('overlay-visible');
      }
    }
  });
});