@oat-sa/tao-core-ui 1.60.2 → 1.62.0

package/dist/resource/selectable.js

@@ -3,79 +3,75 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
     $ = $ && Object.prototype.hasOwnProperty.call($, 'default') ? $['default'] : $;
     _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
 
-    /**
-     * This program is free software; you can redistribute it and/or
-     * modify it under the terms of the GNU General Public License
-     * as published by the Free Software Foundation; under version 2
-     * of the License (non-upgradable).
-     *
-     * This program is distributed in the hope that it will be useful,
-     * but WITHOUT ANY WARRANTY; without even the implied warranty of
-     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-     * GNU General Public License for more details.
-     *
-     * You should have received a copy of the GNU General Public License
-     * along with this program; if not, write to the Free Software
-     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-     *
-     * Copyright (c) 2017-2019 (original work) Open Assessment Technologies SA ;
-     */
-    /**
-     * The CSS class to distinguish selected elements
+    /**
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; under version 2
+     * of the License (non-upgradable).
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+     *
+     * Copyright (c) 2017-2019 (original work) Open Assessment Technologies SA ;
      */
 
-    var selectedClass = 'selected';
-    /**
-     * Creates a selectable context
-     *
-     * @param {component} component - the component instance to make selectable
-     * @param {Object} [config] - default configuration, use the component's config otherwise
-     * @param {preventSelection} [config.preventSelection] - callback to prevent the selectin of a node
-     * @returns {selectable} the augmented component
-     * @throws {TypeError} without a propert component
+    /**
+     * The CSS class to distinguish selected elements
      */
+    var selectedClass = 'selected';
 
+    /**
+     * Creates a selectable context
+     *
+     * @param {component} component - the component instance to make selectable
+     * @param {Object} [config] - default configuration, use the component's config otherwise
+     * @param {preventSelection} [config.preventSelection] - callback to prevent the selectin of a node
+     * @returns {selectable} the augmented component
+     * @throws {TypeError} without a propert component
+     */
     function selectableFactory(component, config) {
       var selection = {};
-      var nodes = {}; //validate the component in parameter
+      var nodes = {};
 
+      //validate the component in parameter
       var isAComponent = _.all(['on', 'trigger', 'init', 'render', 'is', 'getElement'], function (method) {
         return _.isFunction(component[method]);
       });
-
       var getConfig = function getConfig() {
         return _.defaults(component.getConfig() || {}, config || {});
       };
-
       if (!_.isObject(component) || !isAComponent) {
         throw new TypeError('Selectable expects a component');
       }
-      /**
-       * @typedef {Object} selectable
-       */
-
 
+      /**
+       * @typedef {Object} selectable
+       */
       return _.assign(component, {
-        /**
-         * Get all selectable nodes
-         * @returns {Object[]} nodes
+        /**
+         * Get all selectable nodes
+         * @returns {Object[]} nodes
          */
         getNodes: function getNodes() {
           return nodes;
         },
-
-        /**
-         * Get a given node
-         * @param {String} uri - the key
-         * @returns {Object?} the node
+        /**
+         * Get a given node
+         * @param {String} uri - the key
+         * @returns {Object?} the node
          */
         getNode: function getNode(uri) {
           return uri && _.isPlainObject(nodes[uri]) ? nodes[uri] : false;
         },
-
-        /**
-         * Set the selectable nodes
-         * @param {Object[]} newNodes
+        /**
+         * Set the selectable nodes
+         * @param {Object[]} newNodes
          */
         setNodes: function setNodes(newNodes) {
           if (_.isArray(newNodes)) {
@@ -83,41 +79,37 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
               if (node.uri) {
                 acc[node.uri] = node;
               }
-
               return acc;
             }, {});
           } else if (_.isObject(newNodes)) {
             nodes = newNodes;
           }
         },
-
-        /**
-         * Add a node
-         * @param {String} uri - the key
-         * @param {Object} node - the node to add
-         * @returns {Boolean}
-         * @fires selectable#add
+        /**
+         * Add a node
+         * @param {String} uri - the key
+         * @param {Object} node - the node to add
+         * @returns {Boolean}
+         * @fires selectable#add
          */
         addNode: function addNode(uri, node) {
           if (_.isPlainObject(node)) {
             nodes[uri] = node;
-            /**
-             * @event selectable#add a node is added
-             * @param {String} uri - the URI of the added node
-             */
 
+            /**
+             * @event selectable#add a node is added
+             * @param {String} uri - the URI of the added node
+             */
             this.trigger('add', uri, node);
             return true;
           }
-
           return false;
         },
-
-        /**
-         * Remove a node
-         * @param {String} uri - the URI of the node to remove
-         * @returns {Boolean}
-         * @fires selectable#remove
+        /**
+         * Remove a node
+         * @param {String} uri - the URI of the node to remove
+         * @returns {Boolean}
+         * @fires selectable#remove
          */
         removeNode: function removeNode(uri) {
           if (this.hasNode(uri)) {
@@ -125,105 +117,90 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
             if (selection[uri]) {
               this.unselect(uri);
             }
-
             nodes = _.omit(nodes, uri);
-            /**
-             * @event selectable#remove a node is removed
-             * @param {String} uri - the URI of the removed node
-             */
 
+            /**
+             * @event selectable#remove a node is removed
+             * @param {String} uri - the URI of the removed node
+             */
             this.trigger('remove', uri);
             return true;
           }
-
           return false;
         },
-
-        /**
-         * Check if the given node exists
-         * @param {String} uri - the node's URI
-         * @returns {Boolean} true if the node exists
+        /**
+         * Check if the given node exists
+         * @param {String} uri - the node's URI
+         * @returns {Boolean} true if the node exists
          */
         hasNode: function hasNode(uri) {
           return typeof nodes[uri] !== 'undefined';
         },
-
-        /**
-         * Retrieve the current selection
-         * @returns {Object} the selection
+        /**
+         * Retrieve the current selection
+         * @returns {Object} the selection
          */
         getSelection: function getSelection() {
           return selection;
         },
-
-        /**
-         * Clear the current selection
-         * @returns {selectable} chains
-         * @fires selectable#change
+        /**
+         * Clear the current selection
+         * @returns {selectable} chains
+         * @fires selectable#change
          */
         clearSelection: function clearSelection() {
           if (_.size(selection) > 0) {
             selection = {};
           }
-
           if (this.is('rendered')) {
             $('.' + selectedClass, this.getElement()).removeClass(selectedClass);
             this.trigger('change', selection);
           }
-
           return this;
         },
-
-        /**
-         * Apply the selection to the given URIs.
-         * @param {String[]} uris - the list of URIs to select
-         * @param {Boolean} [only=false] - if true the selection is done "only" on the given URIs (unselect previous)
-         * @param {Boolean} [onlyVisible=true] - if true the selection was done "only" for visible nodes.
-         * @param {Boolean} [withChildren=false] - if true, all loaded children of selected node(s) get selected
-         * @returns {selectable} chains
-         * @fires selectable#change
+        /**
+         * Apply the selection to the given URIs.
+         * @param {String[]} uris - the list of URIs to select
+         * @param {Boolean} [only=false] - if true the selection is done "only" on the given URIs (unselect previous)
+         * @param {Boolean} [onlyVisible=true] - if true the selection was done "only" for visible nodes.
+         * @param {Boolean} [withChildren=false] - if true, all loaded children of selected node(s) get selected
+         * @returns {selectable} chains
+         * @fires selectable#change
          */
         select: function select(uris, only, onlyVisible, withChildren) {
           var self = this;
           var $component;
           var currentConfig = getConfig();
-
           if (this.is('rendered')) {
             $component = this.getElement();
-
             if (only) {
               selection = {};
               $('.' + selectedClass, this.getElement()).removeClass(selectedClass);
             }
-
             if (!_.isArray(uris)) {
               uris = [uris];
             }
-
             _(uris).reject(function (uri) {
               return typeof selection[uri] !== 'undefined' || !nodes[uri];
             }).forEach(function (uri) {
               var $node = $('[data-uri="' + uri + '"]', $component);
               var selectNode = $node.length;
-
               if (selectNode && currentConfig && _.isFunction(currentConfig.preventSelection)) {
-                /**
-                 * @callback preventSelection
-                 * @param {String} uri
-                 * @param {Object} node
-                 * @param {jQueryElement} $node
-                 * @returns {Boolean} true to prevent the node to be selected
+                /**
+                 * @callback preventSelection
+                 * @param {String} uri
+                 * @param {Object} node
+                 * @param {jQueryElement} $node
+                 * @returns {Boolean} true to prevent the node to be selected
                  */
                 if (currentConfig.preventSelection(uri, nodes[uri], $node)) {
                   selectNode = false;
                 }
               }
-
               if (selectNode) {
                 $node.addClass(selectedClass);
                 selection[uri] = nodes[uri];
               }
-
               if (withChildren && self.is('multiple')) {
                 // add children to selection object
                 $node.find('[data-uri]').each(function (i, child) {
@@ -235,16 +212,13 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
                 });
               }
             });
-
             this.trigger('change', selection, onlyVisible);
           }
-
           return this;
         },
-
-        /**
-         * Select only all visible nodes.
-         * @returns {Object[]} nodes
+        /**
+         * Select only all visible nodes.
+         * @returns {Object[]} nodes
          */
         selectVisible: function selectVisible() {
           var $component = this.getElement();
@@ -255,34 +229,28 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
             return $(element).data('uri');
           }), false, true);
         },
-
-        /**
-         * Removes the given URIs from the selection.
-         * @param {String[]} uris - the list of URIs to select
-         * @returns {selectable} chains
-         * @fires selectable#change
+        /**
+         * Removes the given URIs from the selection.
+         * @param {String[]} uris - the list of URIs to select
+         * @returns {selectable} chains
+         * @fires selectable#change
          */
         unselect: function unselect(uris) {
           var $component;
-
           if (this.is('rendered')) {
             $component = this.getElement();
-
             if (!_.isArray(uris)) {
               uris = [uris];
             }
-
             _(uris).filter(function (uri) {
               return typeof selection[uri] !== 'undefined' || !nodes[uri];
             }).forEach(function (uri) {
               var $node = $('[data-uri="' + uri + '"]', $component);
-
               if ($node.length) {
                 $node.removeClass(selectedClass);
                 selection = _.omit(selection, uri);
-              } // always unselect children
-
-
+              }
+              // always unselect children
               $node.find('[data-uri]').each(function (i, child) {
                 $(child).removeClass(selectedClass);
               }).map(function () {
@@ -291,17 +259,14 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
                 selection = _.omit(selection, childUri);
               });
             });
-
             this.trigger('change', selection);
           }
-
           return this;
         },
-
-        /**
-         * Select all nodes.
-         * @returns {selectable} chains
-         * @fires selectable#change
+        /**
+         * Select all nodes.
+         * @returns {selectable} chains
+         * @fires selectable#change
          */
         selectAll: function selectAll() {
           return this.select(_.keys(nodes));