course/yui/build/moodle-course-categoryexpander/moodle-course-categoryexpander.js

   1 YUI.add('moodle-course-categoryexpander', function (Y, NAME) {
   2
   3 /**
   4  * Adds toggling of subcategory with automatic loading using AJAX.
   5  *
   6  * This also includes application of an animation to improve user experience.
   7  *
   8  * @module moodle-course-categoryexpander
   9  */
  10
  11 /**
  12  * The course category expander.
  13  *
  14  * @constructor
  15  * @class Y.Moodle.course.categoryexpander
  16  */
  17
  18 var CSS = {
  19         CONTENTNODE: 'content',
  20         COLLAPSEALL: 'collapse-all',
  21         DISABLED: 'disabled',
  22         LOADED: 'loaded',
  23         NOTLOADED: 'notloaded',
  24         SECTIONCOLLAPSED: 'collapsed',
  25         HASCHILDREN: 'with_children'
  26     },
  27     SELECTORS = {
  28         LOADEDTREES: '.with_children.loaded',
  29         CONTENTNODE: '.content',
  30         CATEGORYLISTENLINK: '.category .info .name',
  31         CATEGORYSPINNERLOCATION: '.name',
  32         CATEGORYWITHCOLLAPSEDLOADEDCHILDREN: '.category.with_children.loaded.collapsed',
  33         CATEGORYWITHMAXIMISEDLOADEDCHILDREN: '.category.with_children.loaded:not(.collapsed)',
  34         COLLAPSEEXPAND: '.collapseexpand',
  35         COURSEBOX: '.coursebox',
  36         COURSEBOXLISTENLINK: '.coursebox .moreinfo',
  37         COURSEBOXSPINNERLOCATION: '.name a',
  38         COURSECATEGORYTREE: '.course_category_tree',
  39         PARENTWITHCHILDREN: '.category'
  40     },
  41     NS = Y.namespace('Moodle.course.categoryexpander'),
  42     TYPE_CATEGORY = 0,
  43     TYPE_COURSE = 1,
  44     URL = M.cfg.wwwroot + '/course/category.ajax.php';
  45
  46 /**
  47  * Set up the category expander.
  48  *
  49  * No arguments are required.
  50  *
  51  * @method init
  52  */
  53 NS.init = function() {
  54     var doc = Y.one(Y.config.doc);
  55     doc.delegate('click', this.toggle_category_expansion, SELECTORS.CATEGORYLISTENLINK, this);
  56     doc.delegate('click', this.toggle_coursebox_expansion, SELECTORS.COURSEBOXLISTENLINK, this);
  57     doc.delegate('click', this.collapse_expand_all, SELECTORS.COLLAPSEEXPAND, this);
  58
  59     // Only set up they keybaord listeners when tab is first pressed - it
  60     // may never happen and modifying the DOM on a large number of nodes
  61     // can be very expensive.
  62     doc.once('key', this.setup_keyboard_listeners, 'tab', this);
  63 };
  64
  65 /**
  66  * Set up keyboard expansion for course content.
  67  *
  68  * This includes setting up the delegation but also adding the nodes to the
  69  * tabflow.
  70  *
  71  * @method setup_keyboard_listeners
  72  */
  73 NS.setup_keyboard_listeners = function() {
  74     var doc = Y.one(Y.config.doc);
  75
  76     doc.all(SELECTORS.CATEGORYLISTENLINK, SELECTORS.COURSEBOXLISTENLINK, SELECTORS.COLLAPSEEXPAND).setAttribute('tabindex', '0');
  77
  78
  79     Y.one(Y.config.doc).delegate('key', this.toggle_category_expansion, 'enter', SELECTORS.CATEGORYLISTENLINK, this);
  80     Y.one(Y.config.doc).delegate('key', this.toggle_coursebox_expansion, 'enter', SELECTORS.COURSEBOXLISTENLINK, this);
  81     Y.one(Y.config.doc).delegate('key', this.collapse_expand_all, 'enter', SELECTORS.COLLAPSEEXPAND, this);
  82 };
  83
  84 /**
  85  * Toggle the animation of the clicked category node.
  86  *
  87  * @method toggle_category_expansion
  88  * @private
  89  * @param {EventFacade} e
  90  */
  91 NS.toggle_category_expansion = function(e) {
  92     // Load the actual dependencies now that we've been called.
  93     Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
  94         // Overload the toggle_category_expansion with the _toggle_category_expansion function to ensure that
  95         // this function isn't called in the future, and call it for the first time.
  96         NS.toggle_category_expansion = NS._toggle_category_expansion;
  97         NS.toggle_category_expansion(e);
  98     });
  99 };
 100
 101 /**
 102  * Toggle the animation of the clicked coursebox node.
 103  *
 104  * @method toggle_coursebox_expansion
 105  * @private
 106  * @param {EventFacade} e
 107  */
 108 NS.toggle_coursebox_expansion = function(e) {
 109     // Load the actual dependencies now that we've been called.
 110     Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
 111         // Overload the toggle_coursebox_expansion with the _toggle_coursebox_expansion function to ensure that
 112         // this function isn't called in the future, and call it for the first time.
 113         NS.toggle_coursebox_expansion = NS._toggle_coursebox_expansion;
 114         NS.toggle_coursebox_expansion(e);
 115     });
 116
 117     e.preventDefault();
 118 };
 119
 120 NS._toggle_coursebox_expansion = function(e) {
 121     var courseboxnode;
 122
 123     // Grab the parent category container - this is where the new content will be added.
 124     courseboxnode = e.target.ancestor(SELECTORS.COURSEBOX, true);
 125     e.preventDefault();
 126
 127     if (courseboxnode.hasClass(CSS.LOADED)) {
 128         // We've already loaded this content so we just need to toggle the view of it.
 129         this.run_expansion(courseboxnode);
 130         return;
 131     }
 132
 133     this._toggle_generic_expansion({
 134         parentnode: courseboxnode,
 135         childnode: courseboxnode.one(SELECTORS.CONTENTNODE),
 136         spinnerhandle: SELECTORS.COURSEBOXSPINNERLOCATION,
 137         data: {
 138             courseid: courseboxnode.getData('courseid'),
 139             type: TYPE_COURSE
 140         }
 141     });
 142 };
 143
 144 NS._toggle_category_expansion = function(e) {
 145     var categorynode,
 146         categoryid,
 147         depth;
 148
 149     if (e.target.test('a') || e.target.test('img')) {
 150         // Return early if either an anchor or an image were clicked.
 151         return;
 152     }
 153
 154     // Grab the parent category container - this is where the new content will be added.
 155     categorynode = e.target.ancestor(SELECTORS.PARENTWITHCHILDREN, true);
 156
 157     if (!categorynode.hasClass(CSS.HASCHILDREN)) {
 158         // Nothing to do here - this category has no children.
 159         return;
 160     }
 161
 162     if (categorynode.hasClass(CSS.LOADED)) {
 163         // We've already loaded this content so we just need to toggle the view of it.
 164         this.run_expansion(categorynode);
 165         return;
 166     }
 167
 168     // We use Data attributes to store the category.
 169     categoryid = categorynode.getData('categoryid');
 170     depth = categorynode.getData('depth');
 171     if (typeof categoryid === "undefined" || typeof depth === "undefined") {
 172         return;
 173     }
 174
 175     this._toggle_generic_expansion({
 176         parentnode: categorynode,
 177         childnode: categorynode.one(SELECTORS.CONTENTNODE),
 178         spinnerhandle: SELECTORS.CATEGORYSPINNERLOCATION,
 179         data: {
 180             categoryid: categoryid,
 181             depth: depth,
 182             showcourses: categorynode.getData('showcourses'),
 183             type: TYPE_CATEGORY
 184         }
 185     });
 186 };
 187
 188 /**
 189  * Wrapper function to handle toggling of generic types.
 190  *
 191  * @method _toggle_generic_expansion
 192  * @private
 193  * @param {Object} config
 194  */
 195 NS._toggle_generic_expansion = function(config) {
 196     if (config.spinnerhandle) {
 197       // Add a spinner to give some feedback to the user.
 198       spinner = M.util.add_spinner(Y, config.parentnode.one(config.spinnerhandle)).show();
 199     }
 200
 201     // Fetch the data.
 202     Y.io(URL, {
 203         method: 'POST',
 204         context: this,
 205         on: {
 206             complete: this.process_results
 207         },
 208         data: config.data,
 209         "arguments": {
 210             parentnode: config.parentnode,
 211             childnode: config.childnode,
 212             spinner: spinner
 213         }
 214     });
 215 };
 216
 217 /**
 218  * Apply the animation on the supplied node.
 219  *
 220  * @method run_expansion
 221  * @private
 222  * @param {Node} categorynode The node to apply the animation to
 223  */
 224 NS.run_expansion = function(categorynode) {
 225     var categorychildren = categorynode.one(SELECTORS.CONTENTNODE),
 226         self = this,
 227         ancestor = categorynode.ancestor(SELECTORS.COURSECATEGORYTREE);
 228
 229     // Add our animation to the categorychildren.
 230     this.add_animation(categorychildren);
 231
 232
 233     // If we already have the class, remove it before showing otherwise we perform the
 234     // animation whilst the node is hidden.
 235     if (categorynode.hasClass(CSS.SECTIONCOLLAPSED)) {
 236         // To avoid a jump effect, we need to set the height of the children to 0 here before removing the SECTIONCOLLAPSED class.
 237         categorychildren.setStyle('height', '0');
 238         categorynode.removeClass(CSS.SECTIONCOLLAPSED);
 239         categorychildren.fx.set('reverse', false);
 240     } else {
 241         categorychildren.fx.set('reverse', true);
 242         categorychildren.fx.once('end', function(e, categorynode) {
 243             categorynode.addClass(CSS.SECTIONCOLLAPSED);
 244         }, this, categorynode);
 245     }
 246
 247     categorychildren.fx.once('end', function(e, categorychildren) {
 248         // Remove the styles that the animation has set.
 249         categorychildren.setStyles({
 250             height: '',
 251             opacity: ''
 252         });
 253
 254         // To avoid memory gobbling, remove the animation. It will be added back if called again.
 255         this.destroy();
 256         self.update_collapsible_actions(ancestor);
 257     }, categorychildren.fx, categorychildren);
 258
 259     // Now that everything has been set up, run the animation.
 260     categorychildren.fx.run();
 261 };
 262
 263 NS.collapse_expand_all = function(e) {
 264     // The collapse/expand button has no actual target but we need to prevent it's default
 265     // action to ensure we don't make the page reload/jump.
 266     e.preventDefault();
 267
 268     if (e.currentTarget.hasClass(CSS.DISABLED)) {
 269         // The collapse/expand is currently disabled.
 270         return;
 271     }
 272
 273     var ancestor = e.currentTarget.ancestor(SELECTORS.COURSECATEGORYTREE);
 274     if (!ancestor) {
 275         return;
 276     }
 277
 278     var collapseall = ancestor.one(SELECTORS.COLLAPSEEXPAND);
 279     if (collapseall.hasClass(CSS.COLLAPSEALL)) {
 280         this.collapse_all(ancestor);
 281     } else {
 282         this.expand_all(ancestor);
 283     }
 284     this.update_collapsible_actions(ancestor);
 285 };
 286
 287 NS.expand_all = function(ancestor) {
 288     var finalexpansions = [];
 289
 290     ancestor.all(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)
 291         .each(function(c) {
 292         if (c.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
 293             // Expand the hidden children first without animation.
 294             c.removeClass(CSS.SECTIONCOLLAPSED);
 295             c.all(SELECTORS.LOADEDTREES).removeClass(CSS.SECTIONCOLLAPSED);
 296         } else {
 297             finalexpansions.push(c);
 298         }
 299     }, this);
 300
 301     // Run the final expansion with animation on the visible items.
 302     Y.all(finalexpansions).each(function(c) {
 303         this.run_expansion(c);
 304     }, this);
 305
 306 };
 307
 308 NS.collapse_all = function(ancestor) {
 309     var finalcollapses = [];
 310
 311     ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)
 312         .each(function(c) {
 313         if (c.ancestor(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)) {
 314             finalcollapses.push(c);
 315         } else {
 316             // Collapse the visible items first
 317             this.run_expansion(c);
 318         }
 319     }, this);
 320
 321     // Run the final collapses now that the these are hidden hidden.
 322     Y.all(finalcollapses).each(function(c) {
 323         c.addClass(CSS.SECTIONCOLLAPSED);
 324         c.all(SELECTORS.LOADEDTREES).addClass(CSS.SECTIONCOLLAPSED);
 325     }, this);
 326 };
 327
 328 NS.update_collapsible_actions = function(ancestor) {
 329     var foundmaximisedchildren = false,
 330         // Grab the anchor for the collapseexpand all link.
 331         togglelink = ancestor.one(SELECTORS.COLLAPSEEXPAND);
 332
 333     if (!togglelink) {
 334         // We should always have a togglelink but ensure.
 335         return;
 336     }
 337
 338     // Search for any visibly expanded children.
 339     ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN).each(function(n) {
 340         // If we can find any collapsed ancestors, skip.
 341         if (n.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
 342             return false;
 343         }
 344         foundmaximisedchildren = true;
 345         return true;
 346     });
 347
 348     if (foundmaximisedchildren) {
 349         // At least one maximised child found. Show the collapseall.
 350         togglelink.setHTML(M.util.get_string('collapseall', 'moodle'))
 351             .addClass(CSS.COLLAPSEALL)
 352             .removeClass(CSS.DISABLED);
 353     } else {
 354         // No maximised children found but there are collapsed children. Show the expandall.
 355         togglelink.setHTML(M.util.get_string('expandall', 'moodle'))
 356             .removeClass(CSS.COLLAPSEALL)
 357             .removeClass(CSS.DISABLED);
 358     }
 359 };
 360
 361 /**
 362  * Process the data returned by Y.io.
 363  * This includes appending it to the relevant part of the DOM, and applying our animations.
 364  *
 365  * @method process_results
 366  * @private
 367  * @param {String} tid The Transaction ID
 368  * @param {Object} response The Reponse returned by Y.IO
 369  * @param {Object} ioargs The additional arguments provided by Y.IO
 370  */
 371 NS.process_results = function(tid, response, args) {
 372     var newnode,
 373         data;
 374     try {
 375         data = Y.JSON.parse(response.responseText);
 376         if (data.error) {
 377             return new M.core.ajaxException(data);
 378         }
 379     } catch (e) {
 380         return new M.core.exception(e);
 381     }
 382
 383     // Insert the returned data into a new Node.
 384     newnode = Y.Node.create(data);
 385
 386     // Append to the existing child location.
 387     args.childnode.appendChild(newnode);
 388
 389     // Now that we have content, we can swap the classes on the toggled container.
 390     args.parentnode
 391         .addClass(CSS.LOADED)
 392         .removeClass(CSS.NOTLOADED);
 393
 394     // Toggle the open/close status of the node now that it's content has been loaded.
 395     this.run_expansion(args.parentnode);
 396
 397     // Remove the spinner now that we've started to show the content.
 398     if (args.spinner) {
 399         args.spinner.hide().destroy();
 400     }
 401 };
 402
 403 /**
 404  * Add our animation to the Node.
 405  *
 406  * @method add_animation
 407  * @private
 408  * @param {Node} childnode
 409  */
 410 NS.add_animation = function(childnode) {
 411     if (typeof childnode.fx !== "undefined") {
 412         // The animation has already been plugged to this node.
 413         return childnode;
 414     }
 415
 416     childnode.plug(Y.Plugin.NodeFX, {
 417         from: {
 418             height: 0,
 419             opacity: 0
 420         },
 421         to: {
 422             // This sets a dynamic height in case the node content changes.
 423             height: function(node) {
 424                 // Get expanded height (offsetHeight may be zero).
 425                 return node.get('scrollHeight');
 426             },
 427             opacity: 1
 428         },
 429         duration: 0.2
 430     });
 431
 432     return childnode;
 433 };
 434
 435
 436 }, '@VERSION@', {"requires": ["node", "event-key"]});