NOBUG fixed up whitespace
[moodle.git] / course / yui / toolboxes / toolboxes.js
1 YUI.add('moodle-course-toolboxes', function(Y) {
3     // The following properties contain common strings.
4     // We separate them out here because when this JS is minified the content is less as
5     // Variables get compacted to single/double characters and the full length of the string
6     // exists only once.
8     // The CSS classes we use.
9     var CSS = {
10         ACTIVITYINSTANCE : 'activityinstance',
11         AVAILABILITYINFODIV : 'div.availabilityinfo',
12         CONDITIONALHIDDEN : 'conditionalhidden',
13         DIMCLASS : 'dimmed',
14         DIMMEDTEXT : 'dimmed_text',
15         EDITINSTRUCTIONS : 'editinstructions',
16         HIDE : 'hide',
17         MODINDENTCOUNT : 'mod-indent-',
18         MODINDENTHUGE : 'mod-indent-huge',
19         MODULEIDPREFIX : 'module-',
20         SECTIONHIDDENCLASS : 'hidden',
21         SECTIONIDPREFIX : 'section-',
22         SHOW : 'editing_show',
23         TITLEEDITOR : 'titleeditor'
24     },
25     // The CSS selectors we use.
26     SELECTOR = {
27         ACTIONLINKTEXT : '.actionlinktext',
28         ACTIVITYACTION : 'a.cm-edit-action[data-action]',
29         ACTIVITYFORM : 'form.'+CSS.ACTIVITYINSTANCE,
30         ACTIVITYICON : 'img.activityicon',
31         ACTIVITYLI : 'li.activity',
32         ACTIVITYTITLE : 'input[name=title]',
33         COMMANDSPAN : '.commands',
34         CONTENTAFTERLINK : 'div.contentafterlink',
35         HIDE : 'a.editing_hide',
36         HIGHLIGHT : 'a.editing_highlight',
37         INSTANCENAME : 'span.instancename',
38         MODINDENTDIV : 'div.mod-indent',
39         PAGECONTENT : 'div#page-content',
40         SECTIONLI : 'li.section',
41         SHOW : 'a.'+CSS.SHOW,
42         SHOWHIDE : 'a.editing_showhide'
43     },
44     BODY = Y.one(document.body);
46     /**
47      * The toolbox classes
48      *
49      * TOOLBOX is a generic class which should never be directly instantiated
50      * RESOURCETOOLBOX is a class extending TOOLBOX containing code specific to resources
51      * SECTIONTOOLBOX is a class extending TOOLBOX containing code specific to sections
52      */
53     var TOOLBOX = function() {
54         TOOLBOX.superclass.constructor.apply(this, arguments);
55     }
57     Y.extend(TOOLBOX, Y.Base, {
58         /**
59          * Send a request using the REST API
60          *
61          * @param data The data to submit
62          * @param statusspinner (optional) A statusspinner which may contain a section loader
63          * @param optionalconfig (optional) Any additional configuration to submit
64          * @return response responseText field from responce
65          */
66         send_request : function(data, statusspinner, optionalconfig) {
67             // Default data structure
68             if (!data) {
69                 data = {};
70             }
71             // Handle any variables which we must pass back through to
72             var pageparams = this.get('config').pageparams;
73             for (varname in pageparams) {
74                 data[varname] = pageparams[varname];
75             }
77             data.sesskey = M.cfg.sesskey;
78             data.courseId = this.get('courseid');
80             var uri = M.cfg.wwwroot + this.get('ajaxurl');
82             // Define the configuration to send with the request
83             var responsetext = [];
84             var config = {
85                 method: 'POST',
86                 data: data,
87                 on: {
88                     success: function(tid, response) {
89                         try {
90                             responsetext = Y.JSON.parse(response.responseText);
91                             if (responsetext.error) {
92                                 new M.core.ajaxException(responsetext);
93                             }
94                         } catch (e) {}
95                         if (statusspinner) {
96                             window.setTimeout(function(e) {
97                                 statusspinner.hide();
98                             }, 400);
99                         }
100                     },
101                     failure : function(tid, response) {
102                         if (statusspinner) {
103                             statusspinner.hide();
104                         }
105                         new M.core.ajaxException(response);
106                     }
107                 },
108                 context: this,
109                 sync: true
110             }
112             // Apply optional config
113             if (optionalconfig) {
114                 for (varname in optionalconfig) {
115                     config[varname] = optionalconfig[varname];
116                 }
117             }
119             if (statusspinner) {
120                 statusspinner.show();
121             }
123             // Send the request
124             Y.io(uri, config);
125             return responsetext;
126         }
127     },
128     {
129         NAME : 'course-toolbox',
130         ATTRS : {
131             // The ID of the current course
132             courseid : {
133                 'value' : 0
134             },
135             ajaxurl : {
136                 'value' : 0
137             },
138             config : {
139                 'value' : 0
140             }
141         }
142     }
143     );
145     /**
146      * Resource and activity toolbox class.
147      *
148      * This class is responsible for managing AJAX interactions with activities and resources
149      * when viewing a course in editing mode.
150      *
151      * @namespace M.course.toolbox
152      * @class ResourceToolbox
153      * @constructor
154      */
155     var RESOURCETOOLBOX = function() {
156         RESOURCETOOLBOX.superclass.constructor.apply(this, arguments);
157     }
159     Y.extend(RESOURCETOOLBOX, TOOLBOX, {
160         /**
161          * No groups are being used.
162          * @static
163          * @const GROUPS_NONE
164          * @type Number
165          */
166         GROUPS_NONE     : 0,
167         /**
168          * Separate groups are being used.
169          * @static
170          * @const GROUPS_SEPARATE
171          * @type Number
172          */
173         GROUPS_SEPARATE : 1,
174         /**
175          * Visible groups are being used.
176          * @static
177          * @const GROUPS_VISIBLE
178          * @type Number
179          */
180         GROUPS_VISIBLE  : 2,
182         /**
183          * Events that were added when editing a title.
184          * These should all be detached when editing is complete.
185          * @property edittitleevents
186          * @type {Event[]}
187          * @protected
188          */
189         edittitleevents : [],
191         /**
192          * Initialize the resource toolbox
193          *
194          * For each activity the commands are updated and a reference to the activity is attached.
195          * This way it doesn't matter where the commands are going to called from they have a reference to the
196          * activity that they relate to.
197          * This is essential as some of the actions are displayed in an actionmenu which removes them from the
198          * page flow.
199          *
200          * This function also creates a single event delegate to manage all AJAX actions for all activities on
201          * the page.
202          *
203          * @method initializer
204          */
205         initializer : function(config) {
206             M.course.coursebase.register_module(this);
207             Y.all(SELECTOR.ACTIVITYLI).each(function(activity){
208                 activity.setData('toolbox', this);
209                 activity.all(SELECTOR.COMMANDSPAN+ ' ' + SELECTOR.ACTIVITYACTION).each(function(){
210                     this.setData('activity', activity);
211                 });
212             }, this);
213             Y.delegate('click', this.handle_data_action, BODY, SELECTOR.ACTIVITYACTION, this);
214         },
216         /**
217          * Handles the delegation event. When this is fired someone has triggered an action.
218          *
219          * Note not all actions will result in an AJAX enhancement.
220          *
221          * @protected
222          * @method handle_data_action
223          * @param {EventFacade} ev The event that was triggered.
224          * @returns {boolean}
225          */
226         handle_data_action : function(ev) {
227             // We need to get the anchor element that triggered this event.
228             var node = ev.target;
229             if (!node.test('a')) {
230                 node = node.ancestor(SELECTOR.ACTIVITYACTION);
231             }
233             // From the anchor we can get both the activity (added during initialisation) and the action being
234             // performed (added by the UI as a data attribute).
235             var action = node.getData('action'),
236                 activity = node.getData('activity');
237             if (!node.test('a') || !action || !activity) {
238                 // It wasn't a valid action node.
239                 return;
240             }
242             // Switch based upon the action and do the desired thing.
243             switch (action) {
244                 case 'edittitle' :
245                     // The user wishes to edit the title of the event.
246                     this.edit_title(ev, node, activity, action);
247                     break;
248                 case 'moveleft' :
249                 case 'moveright' :
250                     // The user changing the indent of the activity.
251                     this.change_indent(ev, node, activity, action);
252                     break;
253                 case 'delete' :
254                     // The user is deleting the activity.
255                     this.delete_with_confirmation(ev, node, activity, action);
256                     break;
257                 case 'hide' :
258                 case 'show' :
259                     // The user is changing the visibility of the activity.
260                     this.change_visibility(ev, node, activity, action);
261                     break;
262                 case 'groupsseparate' :
263                 case 'groupsvisible' :
264                 case 'groupsnone' :
265                     // The user is changing the group mode.
266                     callback = 'change_groupmode';
267                     this.change_groupmode(ev, node, activity, action);
268                     break;
269                 case 'move' :
270                 case 'update' :
271                 case 'duplicate' :
272                 case 'assignroles' :
273                 default:
274                     // Nothing to do here!
275                     break;
276             }
277         },
279         /**
280          * Change the indent of the activity or resource.
281          *
282          * @protected
283          * @method change_indent
284          * @param {EventFacade} ev The event that was fired.
285          * @param {Node} button The button that triggered this action.
286          * @param {Node} activity The activity node that this action will be performed on.
287          * @param {String} action The action that has been requested. Will be 'moveleft' or 'moveright'.
288          */
289         change_indent : function(ev, button, activity, action) {
290             // Prevent the default button action
291             ev.preventDefault();
293             var direction = (action === 'moveleft') ? -1 : 1;
295             // And we need to determine the current and new indent level
296             var indentdiv = activity.one(SELECTOR.MODINDENTDIV);
297             var indent = indentdiv.getAttribute('class').match(/mod-indent-(\d{1,})/);
299             if (indent) {
300                 var oldindent = parseInt(indent[1]);
301                 var newindent = Math.max(0, (oldindent + parseInt(direction)));
302                 indentdiv.removeClass(indent[0]);
303             } else {
304                 var oldindent = 0;
305                 var newindent = 1;
306             }
308             // Perform the move
309             indentdiv.addClass(CSS.MODINDENTCOUNT + newindent);
310             var data = {
311                 'class' : 'resource',
312                 'field' : 'indent',
313                 'value' : newindent,
314                 'id'    : Y.Moodle.core_course.util.cm.getId(activity)
315             };
316             var commands = activity.one(SELECTOR.COMMANDSPAN);
317             var spinner = M.util.add_spinner(Y, commands).setStyles({
318                 position: 'absolute',
319                 top: 0
320             });
321             if (BODY.hasClass('dir-ltr')) {
322                 spinner.setStyle('left', '100%');
323             }  else {
324                 spinner.setStyle('right', '100%');
325             }
326             this.send_request(data, spinner);
328             // Handle removal/addition of the moveleft button.
329             if (newindent == 0) {
330                 button.addClass('hidden');
331             } else if (newindent == 1 && oldindent == 0) {
332                 button.ancestor('.menu').one('[data-action=moveleft]').removeClass('hidden');
333             }
335             // Handle massive indentation to match non-ajax display
336             var hashugeclass = indentdiv.hasClass(CSS.MODINDENTHUGE);
337             if (newindent > 15 && !hashugeclass) {
338                 indentdiv.addClass(CSS.MODINDENTHUGE);
339             } else if (newindent <= 15 && hashugeclass) {
340                 indentdiv.removeClass(CSS.MODINDENTHUGE);
341             }
342         },
344         /**
345          * Deletes the given activity or resource after confirmation.
346          *
347          * @protected
348          * @method delete_with_confirmation
349          * @param {EventFacade} ev The event that was fired.
350          * @param {Node} button The button that triggered this action.
351          * @param {Node} activity The activity node that this action will be performed on.
352          * @return Boolean
353          */
354         delete_with_confirmation : function(ev, button, activity) {
355             // Prevent the default button action
356             ev.preventDefault();
358             // Get the element we're working on
359             var element   = activity
361             // Create confirm string (different if element has or does not have name)
362             var confirmstring = '';
363             var plugindata = {
364                 type : M.util.get_string('pluginname', element.getAttribute('class').match(/modtype_([^\s]*)/)[1])
365             }
366             if (Y.Moodle.core_course.util.cm.getName(element) != null) {
367                 plugindata.name = Y.Moodle.core_course.util.cm.getName(element)
368                 confirmstring = M.util.get_string('deletechecktypename', 'moodle', plugindata);
369             } else {
370                 confirmstring = M.util.get_string('deletechecktype', 'moodle', plugindata)
371             }
373             // Confirm element removal
374             if (!confirm(confirmstring)) {
375                 return false;
376             }
378             // Actually remove the element
379             element.remove();
380             var data = {
381                 'class' : 'resource',
382                 'action' : 'DELETE',
383                 'id'    : Y.Moodle.core_course.util.cm.getId(element)
384             };
385             this.send_request(data);
386             if (M.core.actionmenu && M.core.actionmenu.instance) {
387                 M.core.actionmenu.instance.hideMenu();
388             }
389         },
391         /**
392          * Changes the visibility of this activity or resource.
393          *
394          * @protected
395          * @method change_visibility
396          * @param {EventFacade} ev The event that was fired.
397          * @param {Node} button The button that triggered this action.
398          * @param {Node} activity The activity node that this action will be performed on.
399          * @param {String} action The action that has been requested.
400          * @return Boolean
401          */
402         change_visibility : function(ev, button, activity, action) {
403             // Prevent the default button action
404             ev.preventDefault();
406             // Return early if the current section is hidden
407             var section = activity.ancestor(M.course.format.get_section_selector(Y));
408             if (section && section.hasClass(CSS.SECTIONHIDDENCLASS)) {
409                 return;
410             }
412             // Get the element we're working on
413             var element = activity;
414             var value = this.handle_resource_dim(button, activity, action);
416             // Send the request
417             var data = {
418                 'class' : 'resource',
419                 'field' : 'visible',
420                 'value' : value,
421                 'id'    : Y.Moodle.core_course.util.cm.getId(element)
422             };
423             var spinner = M.util.add_spinner(Y, element.one(SELECTOR.COMMANDSPAN));
424             this.send_request(data, spinner);
425             return false; // Need to return false to stop the delegate for the new state firing
426         },
428         /**
429          * Handles the UI aspect of dimming the activity or resource.
430          *
431          * @protected
432          * @method handle_resource_dim
433          * @param {Node} button The button that triggered the action.
434          * @param {Node} activity The activity node that this action will be performed on.
435          * @param {String} status Whether the activity was shown or hidden.
436          * @returns {number} 1 if we were changing to visible, 0 if we were hiding.
437          */
438         handle_resource_dim : function(button, activity, status) {
439             var toggleclass = CSS.DIMCLASS,
440                 dimarea = activity.one('a'),
441                 availabilityinfo = activity.one(CSS.AVAILABILITYINFODIV),
442                 newstatus = (status === 'hide') ? 'show' : 'hide',
443                 newstring = M.util.get_string(newstatus, 'moodle');
445             // Update button info.
446             button.one('img').setAttrs({
447                 'alt' : newstring,
448                 'src'   : M.util.image_url('t/' + newstatus)
449             });
450             button.set('title', newstring);
451             button.replaceClass('editing_'+status, 'editing_'+newstatus)
452             button.setData('action', newstatus);
454             // If activity is conditionally hidden, then don't toggle.
455             if (Y.Moodle.core_course.util.cm.getName(activity) == null) {
456                 toggleclass = CSS.DIMMEDTEXT;
457                 dimarea = activity.all(SELECTOR.MODINDENTDIV + ' > div').item(1);
458             }
459             if (!dimarea.hasClass(CSS.CONDITIONALHIDDEN)) {
460                 // Change the UI.
461                 dimarea.toggleClass(toggleclass);
462                 // We need to toggle dimming on the description too.
463                 activity.all(SELECTOR.CONTENTAFTERLINK).toggleClass(CSS.DIMMEDTEXT);
464             }
465             // Toggle availablity info for conditional activities.
466             if (availabilityinfo) {
467                 availabilityinfo.toggleClass(CSS.HIDE);
468             }
469             return (status === 'hide') ? 0 : 1;
470         },
472         /**
473          * Changes the groupmode of the activity to the next groupmode in the sequence.
474          *
475          * @protected
476          * @method change_groupmode
477          * @param {EventFacade} ev The event that was fired.
478          * @param {Node} button The button that triggered this action.
479          * @param {Node} activity The activity node that this action will be performed on.
480          * @param {String} action The action that has been requested.
481          * @return Boolean
482          */
483         change_groupmode : function(ev, button, activity, action) {
484             // Prevent the default button action.
485             ev.preventDefault();
487             // Current Mode
488             var groupmode = parseInt(button.getData('nextgroupmode'), 10),
489                 newtitle = '',
490                 iconsrc = '',
491                 newtitlestr,
492                 data,
493                 spinner,
494                 nextgroupmode = groupmode + 1;
496             if (nextgroupmode > 2) {
497                 nextgroupmode = 0;
498             }
500             if (groupmode === this.GROUPS_NONE) {
501                 newtitle = 'groupsnone';
502                 iconsrc = M.util.image_url('t/groupn', 'moodle');
503             } else if (groupmode === this.GROUPS_SEPARATE) {
504                 newtitle = 'groupsseparate';
505                 iconsrc = M.util.image_url('t/groups', 'moodle');
506             } else if (groupmode === this.GROUPS_VISIBLE) {
507                 newtitle = 'groupsvisible';
508                 iconsrc = M.util.image_url('t/groupv', 'moodle');
509             }
510             newtitlestr = M.util.get_string(newtitle, 'moodle'),
511             newtitlestr = M.util.get_string('clicktochangeinbrackets', 'moodle', newtitlestr);
513             // Change the UI
514             button.one('img').setAttrs({
515                 'alt' : newtitlestr,
516                 'src' : iconsrc
517             });
518             button.setAttribute('title', newtitlestr).setData('action', newtitle).setData('nextgroupmode', nextgroupmode);
520             // And send the request
521             data = {
522                 'class' : 'resource',
523                 'field' : 'groupmode',
524                 'value' : groupmode,
525                 'id'    : Y.Moodle.core_course.util.cm.getId(activity)
526             };
528             spinner = M.util.add_spinner(Y, activity.one(SELECTOR.COMMANDSPAN));
529             this.send_request(data, spinner);
530             return false; // Need to return false to stop the delegate for the new state firing
531         },
533         /**
534          * Edit the title for the resource
535          *
536          * @protected
537          * @method edit_title
538          * @param {EventFacade} ev The event that was fired.
539          * @param {Node} button The button that triggered this action.
540          * @param {Node} activity The activity node that this action will be performed on.
541          * @param {String} action The action that has been requested.
542          * @return Boolean
543          */
544         edit_title : function(ev, button, activity) {
545             // Get the element we're working on
546             var activityid = Y.Moodle.core_course.util.cm.getId(activity),
547                 instancename  = activity.one(SELECTOR.INSTANCENAME),
548                 currenttitle = instancename.get('firstChild'),
549                 oldtitle = currenttitle.get('data'),
550                 titletext = oldtitle,
551                 thisevent,
552                 anchor = instancename.ancestor('a'),// Grab the anchor so that we can swap it with the edit form.
553                 data = {
554                     'class'   : 'resource',
555                     'field'   : 'gettitle',
556                     'id'      : activityid
557                 },
558                 response = this.send_request(data);
560             if (M.core.actionmenu && M.core.actionmenu.instance) {
561                 M.core.actionmenu.instance.hideMenu();
562             }
564             // Try to retrieve the existing string from the server
565             if (response.instancename) {
566                 titletext = response.instancename;
567             }
569             // Create the editor and submit button
570             var editform = Y.Node.create('<form class="'+CSS.ACTIVITYINSTANCE+'" action="#" />');
571             var editinstructions = Y.Node.create('<span class="'+CSS.EDITINSTRUCTIONS+'" id="id_editinstructions" />')
572                 .set('innerHTML', M.util.get_string('edittitleinstructions', 'moodle'));
573             var editor = Y.Node.create('<input name="title" type="text" class="'+CSS.TITLEEDITOR+'" />').setAttrs({
574                 'value' : titletext,
575                 'autocomplete' : 'off',
576                 'aria-describedby' : 'id_editinstructions',
577                 'maxLength' : '255'
578             })
580             // Clear the existing content and put the editor in
581             editform.appendChild(activity.one(SELECTOR.ACTIVITYICON).cloneNode());
582             editform.appendChild(editor);
583             editform.setData('anchor', anchor);
584             anchor.replace(editform);
585             activity.one('div').appendChild(editinstructions);
586             ev.preventDefault();
588             // Focus and select the editor text
589             editor.focus().select();
591             // Cancel the edit if we lose focus or the escape key is pressed.
592             thisevent = editor.on('blur', this.edit_title_cancel, this, activity, false);
593             this.edittitleevents.push(thisevent);
594             thisevent = editor.on('key', this.edit_title_cancel, 'esc', this, activity, true);
595             this.edittitleevents.push(thisevent);
597             // Handle form submission.
598             thisevent = editform.on('submit', this.edit_title_submit, this, activity, oldtitle);
599             this.edittitleevents.push(thisevent);
600         },
602         /**
603          * Handles the submit event when editing the activity or resources title.
604          *
605          * @protected
606          * @method edit_title_submit
607          * @param {EventFacade} ev The event that triggered this.
608          * @param {Node} activity The activity whose title we are altering.
609          * @param {String} originaltitle The original title the activity or resource had.
610          */
611         edit_title_submit : function(ev, activity, originaltitle) {
612             // We don't actually want to submit anything
613             ev.preventDefault();
615             var newtitle = Y.Lang.trim(activity.one(SELECTOR.ACTIVITYFORM + ' ' + SELECTOR.ACTIVITYTITLE).get('value'));
616             this.edit_title_clear(activity);
617             var spinner = M.util.add_spinner(Y, activity.one(SELECTOR.INSTANCENAME));
618             if (newtitle != null && newtitle != "" && newtitle != originaltitle) {
619                 var data = {
620                     'class'   : 'resource',
621                     'field'   : 'updatetitle',
622                     'title'   : newtitle,
623                     'id'      : Y.Moodle.core_course.util.cm.getId(activity)
624                 };
625                 var response = this.send_request(data, spinner);
626                 if (response.instancename) {
627                     activity.one(SELECTOR.INSTANCENAME).setContent(response.instancename);
628                 }
629             }
630         },
632         /**
633          * Handles the cancel event when editing the activity or resources title.
634          *
635          * @protected
636          * @method edit_title_cancel
637          * @param {EventFacade} ev The event that triggered this.
638          * @param {Node} activity The activity whose title we are altering.
639          * @param {Boolean} preventdefault If true we should prevent the default action from occuring.
640          */
641         edit_title_cancel : function(ev, activity, preventdefault) {
642             if (preventdefault) {
643                 ev.preventDefault();
644             }
645             this.edit_title_clear(activity);
646         },
648         /**
649          * Handles clearing the editing UI and returning things to the original state they were in.
650          *
651          * @protected
652          * @method edit_title_clear
653          * @param {Node} activity  The activity whose title we were altering.
654          */
655         edit_title_clear : function(activity) {
656             // Detach all listen events to prevent duplicate triggers
657             var thisevent;
658             while (thisevent = this.edittitleevents.shift()) {
659                 thisevent.detach();
660             }
661             var editform = activity.one(SELECTOR.ACTIVITYFORM),
662                 instructions = activity.one('#id_editinstructions');
663             if (editform) {
664                 editform.replace(editform.getData('anchor'));
665             }
666             if (instructions) {
667                 instructions.remove();
668             }
669         },
671         /**
672          * Set the visibility of the current resource (identified by the element)
673          * to match the hidden parameter (this is not a toggle).
674          * Only changes the visibility in the browser (no ajax update).
675          *
676          * @public This method is used by other modules.
677          * @method set_visibility_resource_ui
678          * @param args An object with 'element' being the A node containing the resource
679          *             and 'visible' being the state that the visibility should be set to.
680          */
681         set_visibility_resource_ui: function(args) {
682             var element = args.element,
683                 shouldbevisible = args.visible,
684                 buttonnode = element.one(SELECTOR.SHOW),
685                 visible = (buttonnode === null),
686                 status = 'hide';
687             if (visible) {
688                 buttonnode = element.one(SELECTOR.HIDE);
689                 status = 'show'
690             }
691             if (visible != shouldbevisible) {
692                 this.handle_resource_dim(buttonnode, buttonnode.getData('activity'), status);
693             }
694         }
695     }, {
696         NAME : 'course-resource-toolbox',
697         ATTRS : {
698             courseid : {
699                 'value' : 0
700             },
701             format : {
702                 'value' : 'topics'
703             }
704         }
705     });
707     var SECTIONTOOLBOX = function() {
708         SECTIONTOOLBOX.superclass.constructor.apply(this, arguments);
709     }
711     Y.extend(SECTIONTOOLBOX, TOOLBOX, {
712         /**
713          * Initialize the toolboxes module
714          *
715          * Updates all span.commands with relevant handlers and other required changes
716          */
717         initializer : function(config) {
718             this.setup_for_section();
719             M.course.coursebase.register_module(this);
721             // Section Highlighting
722             Y.delegate('click', this.toggle_highlight, SELECTOR.PAGECONTENT, SELECTOR.SECTIONLI + ' ' + SELECTOR.HIGHLIGHT, this);
723             // Section Visibility
724             Y.delegate('click', this.toggle_hide_section, SELECTOR.PAGECONTENT, SELECTOR.SECTIONLI + ' ' + SELECTOR.SHOWHIDE, this);
725         },
726         /**
727          * Update any section areas within the scope of the specified
728          * selector with AJAX equivelants
729          *
730          * @param baseselector The selector to limit scope to
731          * @return void
732          */
733         setup_for_section : function(baseselector) {
734             // Left here for potential future use - not currently needed due to YUI delegation in initializer()
735             /*if (!baseselector) {
736                 var baseselector = SELECTOR.PAGECONTENT;
737             }
739             Y.all(baseselector).each(this._setup_for_section, this);*/
740         },
741         _setup_for_section : function(toolboxtarget) {
742             // Left here for potential future use - not currently needed due to YUI delegation in initializer()
743         },
744         toggle_hide_section : function(e) {
745             // Prevent the default button action
746             e.preventDefault();
748             // Get the section we're working on
749             var section = e.target.ancestor(M.course.format.get_section_selector(Y));
750             var button = e.target.ancestor('a', true);
751             var hideicon = button.one('img');
753             // The value to submit
754             var value;
755             // The status text for strings and images
756             var status,
757                 oldstatus;
759             if (!section.hasClass(CSS.SECTIONHIDDENCLASS)) {
760                 section.addClass(CSS.SECTIONHIDDENCLASS);
761                 value = 0;
762                 status = 'show';
763                 oldstatus = 'hide';
764             } else {
765                 section.removeClass(CSS.SECTIONHIDDENCLASS);
766                 value = 1;
767                 status = 'hide';
768                 oldstatus = 'show';
769             }
771             var newstring = M.util.get_string(status + 'fromothers', 'format_' + this.get('format'));
772             hideicon.setAttrs({
773                 'alt' : newstring,
774                 'src'   : M.util.image_url('i/' + status)
775             });
776             button.set('title', newstring);
778             // Change the highlight status
779             var data = {
780                 'class' : 'section',
781                 'field' : 'visible',
782                 'id'    : Y.Moodle.core_course.util.section.getId(section.ancestor(M.course.format.get_section_wrapper(Y), true)),
783                 'value' : value
784             };
786             var lightbox = M.util.add_lightbox(Y, section);
787             lightbox.show();
789             var response = this.send_request(data, lightbox);
791             var activities = section.all(SELECTOR.ACTIVITYLI);
792             activities.each(function(node) {
793                 if (node.one(SELECTOR.SHOW)) {
794                     var button = node.one(SELECTOR.SHOW);
795                 } else {
796                     var button = node.one(SELECTOR.HIDE);
797                 }
798                 var activityid = Y.Moodle.core_course.util.cm.getId(node);
800                 // NOTE: resourcestotoggle is returned as a string instead
801                 // of a Number so we must cast our activityid to a String.
802                 if (Y.Array.indexOf(response.resourcestotoggle, "" + activityid) != -1) {
803                     node.getData('toolbox').handle_resource_dim(button, node, oldstatus);
804                 }
805             }, this);
806         },
807         toggle_highlight : function(e) {
808             // Prevent the default button action
809             e.preventDefault();
811             // Get the section we're working on
812             var section = e.target.ancestor(M.course.format.get_section_selector(Y));
813             var button = e.target.ancestor('a', true);
814             var buttonicon = button.one('img');
816             // Determine whether the marker is currently set
817             var togglestatus = section.hasClass('current');
818             var value = 0;
820             // Set the current highlighted item text
821             var old_string = M.util.get_string('markthistopic', 'moodle');
822             Y.one(SELECTOR.PAGECONTENT)
823                 .all(M.course.format.get_section_selector(Y) + '.current ' + SELECTOR.HIGHLIGHT)
824                 .set('title', old_string);
825             Y.one(SELECTOR.PAGECONTENT)
826                 .all(M.course.format.get_section_selector(Y) + '.current ' + SELECTOR.HIGHLIGHT + ' img')
827                 .set('alt', old_string)
828                 .set('src', M.util.image_url('i/marker'));
830             // Remove the highlighting from all sections
831             var allsections = Y.one(SELECTOR.PAGECONTENT).all(M.course.format.get_section_selector(Y))
832                 .removeClass('current');
834             // Then add it if required to the selected section
835             if (!togglestatus) {
836                 section.addClass('current');
837                 value = Y.Moodle.core_course.util.section.getId(section.ancestor(M.course.format.get_section_wrapper(Y), true));
838                 var new_string = M.util.get_string('markedthistopic', 'moodle');
839                 button
840                     .set('title', new_string);
841                 buttonicon
842                     .set('alt', new_string)
843                     .set('src', M.util.image_url('i/marked'));
844             }
846             // Change the highlight status
847             var data = {
848                 'class' : 'course',
849                 'field' : 'marker',
850                 'value' : value
851             };
852             var lightbox = M.util.add_lightbox(Y, section);
853             lightbox.show();
854             this.send_request(data, lightbox);
855         }
856     }, {
857         NAME : 'course-section-toolbox',
858         ATTRS : {
859             courseid : {
860                 'value' : 0
861             },
862             format : {
863                 'value' : 'topics'
864             }
865         }
866     });
868     M.course = M.course || {};
869     M.course.resource_toolbox = null;
870     M.course.init_resource_toolbox = function(config) {
871         M.course.resource_toolbox = new RESOURCETOOLBOX(config);
872         return M.course.resource_toolbox;
873     };
875     M.course.init_section_toolbox = function(config) {
876         return new SECTIONTOOLBOX(config);
877     };
879     M.course.register_new_module = function(module) {
880         if (typeof module === 'string') {
881             module = Y.one(module);
882         }
883         if (M.course.resource_toolbox !== null) {
884             module.setData('toolbox', M.course.resource_toolbox);
885             module.all(SELECTOR.COMMANDSPAN+ ' ' + SELECTOR.ACTIVITYACTION).each(function(){
886                 this.setData('activity', module);
887             });
888         }
889     }
891 },
892 '@VERSION@', {
893     requires : ['base', 'node', 'io', 'moodle-course-coursebase']
895 );