248c56fbaadb6909c56974d9c999797b14ceda82
[moodle.git] / question / type / ddimageortext / amd / src / question.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /*
17  * JavaScript to allow dragging options to slots (using mouse down or touch) or tab through slots using keyboard.
18  *
19  * @module     qtype_ddimageortext/question
20  * @package    qtype_ddimageortext
21  * @copyright  2018 The Open University
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 define(['jquery', 'core/dragdrop', 'core/key_codes'], function($, dragDrop, keys) {
26     "use strict";
28     /**
29      * Initialise one drag-drop onto image question.
30      *
31      * @param {String} containerId id of the outer div for this question.
32      * @param {boolean} readOnly whether the question is being displayed read-only.
33      * @param {Array} places Information about the drop places.
34      * @constructor
35      */
36     function DragDropOntoImageQuestion(containerId, readOnly, places) {
37         this.containerId = containerId;
38         M.util.js_pending('qtype_ddimageortext-init-' + this.containerId);
39         this.places = places;
40         this.allImagesLoaded = false;
41         this.imageLoadingTimeoutId = null;
42         this.isPrinting = false;
43         if (readOnly) {
44             this.getRoot().addClass('qtype_ddimageortext-readonly');
45         }
47         var thisQ = this;
48         this.getNotYetLoadedImages().one('load', function() {
49             thisQ.waitForAllImagesToBeLoaded();
50         });
51         this.waitForAllImagesToBeLoaded();
52     }
54     /**
55      * Waits until all images are loaded before calling setupQuestion().
56      *
57      * This function is called from the onLoad of each image, and also polls with
58      * a time-out, because image on-loads are allegedly unreliable.
59      */
60     DragDropOntoImageQuestion.prototype.waitForAllImagesToBeLoaded = function() {
61         var thisQ = this;
63         // This method may get called multiple times (via image on-loads or timeouts.
64         // If we are already done, don't do it again.
65         if (this.allImagesLoaded) {
66             return;
67         }
69         // Clear any current timeout, if set.
70         if (this.imageLoadingTimeoutId !== null) {
71             clearTimeout(this.imageLoadingTimeoutId);
72         }
74         // If we have not yet loaded all images, set a timeout to
75         // call ourselves again, since apparently images on-load
76         // events are flakey.
77         if (this.getNotYetLoadedImages().length > 0) {
78             this.imageLoadingTimeoutId = setTimeout(function() {
79                 thisQ.waitForAllImagesToBeLoaded();
80             }, 100);
81             return;
82         }
84         // We now have all images. Carry on, but only after giving the layout a chance to settle down.
85         this.allImagesLoaded = true;
86         thisQ.setupQuestion();
87     };
89     /**
90      * Get any of the images in the drag-drop area that are not yet fully loaded.
91      *
92      * @returns {jQuery} those images.
93      */
94     DragDropOntoImageQuestion.prototype.getNotYetLoadedImages = function() {
95         var thisQ = this;
96         return this.getRoot().find('.ddarea img').not(function(i, imgNode) {
97             return thisQ.imageIsLoaded(imgNode);
98         });
99     };
101     /**
102      * Check if an image has loaded without errors.
103      *
104      * @param {HTMLImageElement} imgElement an image.
105      * @returns {boolean} true if this image has loaded without errors.
106      */
107     DragDropOntoImageQuestion.prototype.imageIsLoaded = function(imgElement) {
108         return imgElement.complete && imgElement.naturalHeight !== 0;
109     };
111     /**
112      * Set up the question, once all images have been loaded.
113      */
114     DragDropOntoImageQuestion.prototype.setupQuestion = function() {
115         this.resizeAllDragsAndDrops();
116         this.cloneDrags();
117         this.positionDragsAndDrops();
118         M.util.js_complete('qtype_ddimageortext-init-' + this.containerId);
119     };
121     /**
122      * In each group, resize all the items to be the same size.
123      */
124     DragDropOntoImageQuestion.prototype.resizeAllDragsAndDrops = function() {
125         var thisQ = this;
126         this.getRoot().find('.draghomes > div').each(function(i, node) {
127             thisQ.resizeAllDragsAndDropsInGroup(
128                     thisQ.getClassnameNumericSuffix($(node), 'dragitemgroup'));
129         });
130     };
132     /**
133      * In a given group, set all the drags and drops to be the same size.
134      *
135      * @param {int} group the group number.
136      */
137     DragDropOntoImageQuestion.prototype.resizeAllDragsAndDropsInGroup = function(group) {
138         var root = this.getRoot(),
139             dragHomes = root.find('.dragitemgroup' + group + ' .draghome'),
140             maxWidth = 0,
141             maxHeight = 0;
143         // Find the maximum size of any drag in this groups.
144         dragHomes.each(function(i, drag) {
145             maxWidth = Math.max(maxWidth, Math.ceil(drag.offsetWidth));
146             maxHeight = Math.max(maxHeight, Math.ceil(drag.offsetHeight));
147         });
149         // The size we will want to set is a bit bigger than this.
150         maxWidth += 10;
151         maxHeight += 10;
153         // Set each drag home to that size.
154         dragHomes.each(function(i, drag) {
155             var left = Math.round((maxWidth - drag.offsetWidth) / 2),
156                 top = Math.floor((maxHeight - drag.offsetHeight) / 2);
157             // Set top and left padding so the item is centred.
158             $(drag).css({
159                 'padding-left': left + 'px',
160                 'padding-right': (maxWidth - drag.offsetWidth - left) + 'px',
161                 'padding-top': top + 'px',
162                 'padding-bottom': (maxHeight - drag.offsetHeight - top) + 'px'
163             });
164         });
166         // Create the drops and make them the right size.
167         for (var i in this.places) {
168             if (!this.places.hasOwnProperty((i))) {
169                 continue;
170             }
171             var place = this.places[i],
172                 label = place.text;
173             if (parseInt(place.group) !== group) {
174                 continue;
175             }
176             if (label === '') {
177                 label = M.util.get_string('blank', 'qtype_ddimageortext');
178             }
179             root.find('.dropzones').append('<div class="dropzone active group' + place.group +
180                             ' place' + i + '" tabindex="0">' +
181                     '<span class="accesshide">' + label + '</span>&nbsp;</div>');
182             root.find('.dropzone.place' + i).width(maxWidth - 2).height(maxHeight - 2);
183         }
184     };
186     /**
187      * Invisible 'drag homes' are output by the renderer. These have the same properties
188      * as the drag items but are invisible. We clone these invisible elements to make the
189      * actual drag items.
190      */
191     DragDropOntoImageQuestion.prototype.cloneDrags = function() {
192         var thisQ = this;
193         thisQ.getRoot().find('.draghome').each(function(index, dragHome) {
194             var drag = $(dragHome);
195             var placeHolder = drag.clone();
196             placeHolder.removeClass();
197             placeHolder.addClass('draghome choice' +
198                 thisQ.getChoice(drag) + ' group' +
199                 thisQ.getGroup(drag) + ' dragplaceholder');
200             drag.before(placeHolder);
201         });
202     };
204     /**
205      * Clone drag item for one choice.
206      *
207      * @param {jQuery} dragHome the drag home to clone.
208      */
209     DragDropOntoImageQuestion.prototype.cloneDragsForOneChoice = function(dragHome) {
210         if (dragHome.hasClass('infinite')) {
211             var noOfDrags = this.noOfDropsInGroup(this.getGroup(dragHome));
212             for (var i = 0; i < noOfDrags; i++) {
213                 this.cloneDrag(dragHome);
214             }
215         } else {
216             this.cloneDrag(dragHome);
217         }
218     };
220     /**
221      * Clone drag item.
222      *
223      * @param {jQuery} dragHome
224      */
225     DragDropOntoImageQuestion.prototype.cloneDrag = function(dragHome) {
226         var drag = dragHome.clone();
227         drag.removeClass('draghome')
228             .addClass('drag unplaced moodle-has-zindex')
229             .offset(dragHome.offset());
230         this.getRoot().find('.dragitems').append(drag);
231     };
233     /**
234      * Update the position of drags.
235      */
236     DragDropOntoImageQuestion.prototype.positionDragsAndDrops = function() {
237         var thisQ = this,
238             root = this.getRoot(),
239             bgRatio = this.bgRatio();
241         // Move the drops into position.
242         root.find('.ddarea .dropzone').each(function(i, dropNode) {
243             var drop = $(dropNode),
244                 place = thisQ.places[thisQ.getPlace(drop)];
245             // The xy values come from PHP as strings, so we need parseInt to stop JS doing string concatenation.
246             drop.css('left', parseInt(place.xy[0]) * bgRatio)
247                 .css('top', parseInt(place.xy[1]) * bgRatio);
248             drop.data('originX', parseInt(place.xy[0]))
249                 .data('originY', parseInt(place.xy[1]));
250             thisQ.handleElementScale(drop, 'left top');
251         });
253         // First move all items back home.
254         root.find('.draghome').not('.dragplaceholder').each(function(i, dragNode) {
255             var drag = $(dragNode),
256                 currentPlace = thisQ.getClassnameNumericSuffix(drag, 'inplace');
257             drag.addClass('unplaced')
258                 .removeClass('placed');
259             drag.removeAttr('tabindex');
260             if (currentPlace !== null) {
261                 drag.removeClass('inplace' + currentPlace);
262             }
263         });
265         // Then place the ones that should be placed.
266         root.find('input.placeinput').each(function(i, inputNode) {
267             var input = $(inputNode),
268                 choice = input.val();
269             if (choice.length === 0 || (choice.length > 0 && choice === '0')) {
270                 // No item in this place.
271                 return;
272             }
274             var place = thisQ.getPlace(input);
275             // Get the unplaced drag.
276             var unplacedDrag = thisQ.getUnplacedChoice(thisQ.getGroup(input), choice);
277             // Get the clone of the drag.
278             var hiddenDrag = thisQ.getDragClone(unplacedDrag);
279             if (hiddenDrag.length) {
280                 if (unplacedDrag.hasClass('infinite')) {
281                     var noOfDrags = thisQ.noOfDropsInGroup(thisQ.getGroup(unplacedDrag));
282                     var cloneDrags = thisQ.getInfiniteDragClones(unplacedDrag, false);
283                     if (cloneDrags.length < noOfDrags) {
284                         var cloneDrag = unplacedDrag.clone();
285                         cloneDrag.removeClass('beingdragged');
286                         cloneDrag.removeAttr('tabindex');
287                         hiddenDrag.after(cloneDrag);
288                     } else {
289                         hiddenDrag.addClass('active');
290                     }
291                 } else {
292                     hiddenDrag.addClass('active');
293                 }
294             }
296             // Send the drag to drop.
297             var drop = root.find('.dropzone.place' + place);
298             thisQ.sendDragToDrop(unplacedDrag, drop);
299         });
300     };
302     /**
303      * Handles the start of dragging an item.
304      *
305      * @param {Event} e the touch start or mouse down event.
306      */
307     DragDropOntoImageQuestion.prototype.handleDragStart = function(e) {
308         var thisQ = this,
309             drag = $(e.target).closest('.draghome'),
310             currentIndex = this.calculateZIndex(),
311             newIndex = currentIndex + 2;
313         var info = dragDrop.prepare(e);
314         if (!info.start) {
315             return;
316         }
318         drag.addClass('beingdragged').css('transform', '').css('z-index', newIndex);
319         var currentPlace = this.getClassnameNumericSuffix(drag, 'inplace');
320         if (currentPlace !== null) {
321             this.setInputValue(currentPlace, 0);
322             drag.removeClass('inplace' + currentPlace);
323             var hiddenDrop = thisQ.getDrop(drag, currentPlace);
324             if (hiddenDrop.length) {
325                 hiddenDrop.addClass('active');
326                 drag.offset(hiddenDrop.offset());
327             }
328         } else {
329             var hiddenDrag = thisQ.getDragClone(drag);
330             if (hiddenDrag.length) {
331                 if (drag.hasClass('infinite')) {
332                     var noOfDrags = this.noOfDropsInGroup(thisQ.getGroup(drag));
333                     var cloneDrags = this.getInfiniteDragClones(drag, false);
334                     if (cloneDrags.length < noOfDrags) {
335                         var cloneDrag = drag.clone();
336                         cloneDrag.removeClass('beingdragged');
337                         cloneDrag.removeAttr('tabindex');
338                         hiddenDrag.after(cloneDrag);
339                         drag.offset(cloneDrag.offset());
340                     } else {
341                         hiddenDrag.addClass('active');
342                         drag.offset(hiddenDrag.offset());
343                     }
344                 } else {
345                     hiddenDrag.addClass('active');
346                     drag.offset(hiddenDrag.offset());
347                 }
348             }
349         }
351         dragDrop.start(e, drag, function(x, y, drag) {
352             thisQ.dragMove(x, y, drag);
353         }, function(x, y, drag) {
354             thisQ.dragEnd(x, y, drag);
355         });
356     };
358     /**
359      * Called whenever the currently dragged items moves.
360      *
361      * @param {Number} pageX the x position.
362      * @param {Number} pageY the y position.
363      * @param {jQuery} drag the item being moved.
364      */
365     DragDropOntoImageQuestion.prototype.dragMove = function(pageX, pageY, drag) {
366         var thisQ = this;
367         this.getRoot().find('.dropzone.group' + this.getGroup(drag)).each(function(i, dropNode) {
368             var drop = $(dropNode);
369             if (thisQ.isPointInDrop(pageX, pageY, drop)) {
370                 drop.addClass('valid-drag-over-drop');
371             } else {
372                 drop.removeClass('valid-drag-over-drop');
373             }
374         });
375         this.getRoot().find('.draghome.placed.group' + this.getGroup(drag)).not('.beingdragged').each(function(i, dropNode) {
376             var drop = $(dropNode);
377             if (thisQ.isPointInDrop(pageX, pageY, drop)) {
378                 drop.addClass('valid-drag-over-drop');
379             } else {
380                 drop.removeClass('valid-drag-over-drop');
381             }
382         });
383     };
385     /**
386      * Called when user drops a drag item.
387      *
388      * @param {Number} pageX the x position.
389      * @param {Number} pageY the y position.
390      * @param {jQuery} drag the item being moved.
391      */
392     DragDropOntoImageQuestion.prototype.dragEnd = function(pageX, pageY, drag) {
393         var thisQ = this,
394             root = this.getRoot(),
395             placed = false;
396         root.find('.dropzone.group' + this.getGroup(drag)).each(function(i, dropNode) {
397             var drop = $(dropNode);
398             if (!thisQ.isPointInDrop(pageX, pageY, drop)) {
399                 // Not this drop.
400                 return true;
401             }
403             // Now put this drag into the drop.
404             drop.removeClass('valid-drag-over-drop');
405             thisQ.sendDragToDrop(drag, drop);
406             placed = true;
407             return false; // Stop the each() here.
408         });
410         root.find('.draghome.placed.group' + this.getGroup(drag)).not('.beingdragged').each(function(i, placedNode) {
411             var placedDrag = $(placedNode);
412             if (!thisQ.isPointInDrop(pageX, pageY, placedDrag)) {
413                 // Not this placed drag.
414                 return true;
415             }
417             // Now put this drag into the drop.
418             placedDrag.removeClass('valid-drag-over-drop');
419             var currentPlace = thisQ.getClassnameNumericSuffix(placedDrag, 'inplace');
420             var drop = thisQ.getDrop(drag, currentPlace);
421             thisQ.sendDragToDrop(drag, drop);
422             placed = true;
423             return false; // Stop the each() here.
424         });
426         if (!placed) {
427             this.sendDragHome(drag);
428         }
429     };
431     /**
432      * Animate a drag item into a given place (or back home).
433      *
434      * @param {jQuery|null} drag the item to place. If null, clear the place.
435      * @param {jQuery} drop the place to put it.
436      */
437     DragDropOntoImageQuestion.prototype.sendDragToDrop = function(drag, drop) {
438         // Is there already a drag in this drop? if so, evict it.
439         var oldDrag = this.getCurrentDragInPlace(this.getPlace(drop));
440         if (oldDrag.length !== 0) {
441             oldDrag.addClass('beingdragged');
442             oldDrag.offset(oldDrag.offset());
443             var currentPlace = this.getClassnameNumericSuffix(oldDrag, 'inplace');
444             var hiddenDrop = this.getDrop(oldDrag, currentPlace);
445             hiddenDrop.addClass('active');
446             this.sendDragHome(oldDrag);
447         }
449         if (drag.length === 0) {
450             this.setInputValue(this.getPlace(drop), 0);
451             if (drop.data('isfocus')) {
452                 drop.focus();
453             }
454         } else {
455             this.setInputValue(this.getPlace(drop), this.getChoice(drag));
456             drag.removeClass('unplaced')
457                 .addClass('placed inplace' + this.getPlace(drop));
458             drag.attr('tabindex', 0);
459             this.animateTo(drag, drop);
460         }
461     };
463     /**
464      * Animate a drag back to its home.
465      *
466      * @param {jQuery} drag the item being moved.
467      */
468     DragDropOntoImageQuestion.prototype.sendDragHome = function(drag) {
469         var currentPlace = this.getClassnameNumericSuffix(drag, 'inplace');
470         if (currentPlace !== null) {
471             drag.removeClass('inplace' + currentPlace);
472         }
473         drag.data('unplaced', true);
475         this.animateTo(drag, this.getDragHome(this.getGroup(drag), this.getChoice(drag)));
476     };
478     /**
479      * Handles keyboard events on drops.
480      *
481      * Drops are focusable. Once focused, right/down/space switches to the next choice, and
482      * left/up switches to the previous. Escape clear.
483      *
484      * @param {KeyboardEvent} e
485      */
486     DragDropOntoImageQuestion.prototype.handleKeyPress = function(e) {
487         var drop = $(e.target).closest('.dropzone');
488         if (drop.length === 0) {
489             var placedDrag = $(e.target);
490             var currentPlace = this.getClassnameNumericSuffix(placedDrag, 'inplace');
491             if (currentPlace !== null) {
492                 drop = this.getDrop(placedDrag, currentPlace);
493             }
494         }
495         var currentDrag = this.getCurrentDragInPlace(this.getPlace(drop)),
496             nextDrag = $();
498         switch (e.keyCode) {
499             case keys.space:
500             case keys.arrowRight:
501             case keys.arrowDown:
502                 nextDrag = this.getNextDrag(this.getGroup(drop), currentDrag);
503                 break;
505             case keys.arrowLeft:
506             case keys.arrowUp:
507                 nextDrag = this.getPreviousDrag(this.getGroup(drop), currentDrag);
508                 break;
510             case keys.escape:
511                 questionManager.isKeyboardNavigation = false;
512                 break;
514             default:
515                 questionManager.isKeyboardNavigation = false;
516                 return; // To avoid the preventDefault below.
517         }
519         if (nextDrag.length) {
520             nextDrag.data('isfocus', true);
521             nextDrag.addClass('beingdragged');
522             var hiddenDrag = this.getDragClone(nextDrag);
523             if (hiddenDrag.length) {
524                 if (nextDrag.hasClass('infinite')) {
525                     var noOfDrags = this.noOfDropsInGroup(this.getGroup(nextDrag));
526                     var cloneDrags = this.getInfiniteDragClones(nextDrag, false);
527                     if (cloneDrags.length < noOfDrags) {
528                         var cloneDrag = nextDrag.clone();
529                         cloneDrag.removeClass('beingdragged');
530                         cloneDrag.removeAttr('tabindex');
531                         hiddenDrag.after(cloneDrag);
532                         nextDrag.offset(cloneDrag.offset());
533                     } else {
534                         hiddenDrag.addClass('active');
535                         nextDrag.offset(hiddenDrag.offset());
536                     }
537                 } else {
538                     hiddenDrag.addClass('active');
539                     nextDrag.offset(hiddenDrag.offset());
540                 }
541             }
542         } else {
543             drop.data('isfocus', true);
544         }
546         e.preventDefault();
547         this.sendDragToDrop(nextDrag, drop);
548     };
550     /**
551      * Choose the next drag in a group.
552      *
553      * @param {int} group which group.
554      * @param {jQuery} drag current choice (empty jQuery if there isn't one).
555      * @return {jQuery} the next drag in that group, or null if there wasn't one.
556      */
557     DragDropOntoImageQuestion.prototype.getNextDrag = function(group, drag) {
558         var choice,
559             numChoices = this.noOfChoicesInGroup(group);
561         if (drag.length === 0) {
562             choice = 1; // Was empty, so we want to select the first choice.
563         } else {
564             choice = this.getChoice(drag) + 1;
565         }
567         var next = this.getUnplacedChoice(group, choice);
568         while (next.length === 0 && choice < numChoices) {
569             choice++;
570             next = this.getUnplacedChoice(group, choice);
571         }
573         return next;
574     };
576     /**
577      * Choose the previous drag in a group.
578      *
579      * @param {int} group which group.
580      * @param {jQuery} drag current choice (empty jQuery if there isn't one).
581      * @return {jQuery} the next drag in that group, or null if there wasn't one.
582      */
583     DragDropOntoImageQuestion.prototype.getPreviousDrag = function(group, drag) {
584         var choice;
586         if (drag.length === 0) {
587             choice = this.noOfChoicesInGroup(group);
588         } else {
589             choice = this.getChoice(drag) - 1;
590         }
592         var previous = this.getUnplacedChoice(group, choice);
593         while (previous.length === 0 && choice > 1) {
594             choice--;
595             previous = this.getUnplacedChoice(group, choice);
596         }
598         // Does this choice exist?
599         return previous;
600     };
602     /**
603      * Animate an object to the given destination.
604      *
605      * @param {jQuery} drag the element to be animated.
606      * @param {jQuery} target element marking the place to move it to.
607      */
608     DragDropOntoImageQuestion.prototype.animateTo = function(drag, target) {
609         var currentPos = drag.offset(),
610             targetPos = target.offset(),
611             thisQ = this;
613         M.util.js_pending('qtype_ddimageortext-animate-' + thisQ.containerId);
614         // Animate works in terms of CSS position, whereas locating an object
615         // on the page works best with jQuery offset() function. So, to get
616         // the right target position, we work out the required change in
617         // offset() and then add that to the current CSS position.
618         drag.animate(
619             {
620                 left: parseInt(drag.css('left')) + targetPos.left - currentPos.left,
621                 top: parseInt(drag.css('top')) + targetPos.top - currentPos.top
622             },
623             {
624                 duration: 'fast',
625                 done: function() {
626                     $('body').trigger('dragmoved', [drag, target, thisQ]);
627                     M.util.js_complete('qtype_ddimageortext-animate-' + thisQ.containerId);
628                 }
629             }
630         );
631     };
633     /**
634      * Detect if a point is inside a given DOM node.
635      *
636      * @param {Number} pageX the x position.
637      * @param {Number} pageY the y position.
638      * @param {jQuery} drop the node to check (typically a drop).
639      * @return {boolean} whether the point is inside the node.
640      */
641     DragDropOntoImageQuestion.prototype.isPointInDrop = function(pageX, pageY, drop) {
642         var position = drop.offset();
643         if (drop.hasClass('draghome')) {
644             return pageX >= position.left && pageX < position.left + drop.outerWidth()
645                 && pageY >= position.top && pageY < position.top + drop.outerHeight();
646         }
647         return pageX >= position.left && pageX < position.left + drop.width()
648             && pageY >= position.top && pageY < position.top + drop.height();
649     };
651     /**
652      * Set the value of the hidden input for a place, to record what is currently there.
653      *
654      * @param {int} place which place to set the input value for.
655      * @param {int} choice the value to set.
656      */
657     DragDropOntoImageQuestion.prototype.setInputValue = function(place, choice) {
658         this.getRoot().find('input.placeinput.place' + place).val(choice);
659     };
661     /**
662      * Get the outer div for this question.
663      *
664      * @returns {jQuery} containing that div.
665      */
666     DragDropOntoImageQuestion.prototype.getRoot = function() {
667         return $(document.getElementById(this.containerId));
668     };
670     /**
671      * Get the img that is the background image.
672      * @returns {jQuery} containing that img.
673      */
674     DragDropOntoImageQuestion.prototype.bgImage = function() {
675         return this.getRoot().find('img.dropbackground');
676     };
678     /**
679      * Get drag home for a given choice.
680      *
681      * @param {int} group the group.
682      * @param {int} choice the choice number.
683      * @returns {jQuery} containing that div.
684      */
685     DragDropOntoImageQuestion.prototype.getDragHome = function(group, choice) {
686         if (!this.getRoot().find('.draghome.dragplaceholder.group' + group + '.choice' + choice).is(':visible')) {
687             return this.getRoot().find('.dragitemgroup' + group +
688                 ' .draghome.infinite' +
689                 '.choice' + choice +
690                 '.group' + group);
691         }
692         return this.getRoot().find('.draghome.dragplaceholder.group' + group + '.choice' + choice);
693     };
695     /**
696      * Get an unplaced choice for a particular group.
697      *
698      * @param {int} group the group.
699      * @param {int} choice the choice number.
700      * @returns {jQuery} jQuery wrapping the unplaced choice. If there isn't one, the jQuery will be empty.
701      */
702     DragDropOntoImageQuestion.prototype.getUnplacedChoice = function(group, choice) {
703         return this.getRoot().find('.ddarea .draghome.group' + group + '.choice' + choice + '.unplaced').slice(0, 1);
704     };
706     /**
707      * Get the drag that is currently in a given place.
708      *
709      * @param {int} place the place number.
710      * @return {jQuery} the current drag (or an empty jQuery if none).
711      */
712     DragDropOntoImageQuestion.prototype.getCurrentDragInPlace = function(place) {
713         return this.getRoot().find('.ddarea .draghome.inplace' + place);
714     };
716     /**
717      * Return the number of blanks in a given group.
718      *
719      * @param {int} group the group number.
720      * @returns {int} the number of drops.
721      */
722     DragDropOntoImageQuestion.prototype.noOfDropsInGroup = function(group) {
723         return this.getRoot().find('.dropzone.group' + group).length;
724     };
726     /**
727      * Return the number of choices in a given group.
728      *
729      * @param {int} group the group number.
730      * @returns {int} the number of choices.
731      */
732     DragDropOntoImageQuestion.prototype.noOfChoicesInGroup = function(group) {
733         return this.getRoot().find('.dragitemgroup' + group + ' .draghome').length;
734     };
736     /**
737      * Return the number at the end of the CSS class name with the given prefix.
738      *
739      * @param {jQuery} node
740      * @param {String} prefix name prefix
741      * @returns {Number|null} the suffix if found, else null.
742      */
743     DragDropOntoImageQuestion.prototype.getClassnameNumericSuffix = function(node, prefix) {
744         var classes = node.attr('class');
745         if (classes !== '') {
746             var classesArr = classes.split(' ');
747             for (var index = 0; index < classesArr.length; index++) {
748                 var patt1 = new RegExp('^' + prefix + '([0-9])+$');
749                 if (patt1.test(classesArr[index])) {
750                     var patt2 = new RegExp('([0-9])+$');
751                     var match = patt2.exec(classesArr[index]);
752                     return Number(match[0]);
753                 }
754             }
755         }
756         return null;
757     };
759     /**
760      * Get the choice number of a drag.
761      *
762      * @param {jQuery} drag the drag.
763      * @returns {Number} the choice number.
764      */
765     DragDropOntoImageQuestion.prototype.getChoice = function(drag) {
766         return this.getClassnameNumericSuffix(drag, 'choice');
767     };
769     /**
770      * Given a DOM node that is significant to this question
771      * (drag, drop, ...) get the group it belongs to.
772      *
773      * @param {jQuery} node a DOM node.
774      * @returns {Number} the group it belongs to.
775      */
776     DragDropOntoImageQuestion.prototype.getGroup = function(node) {
777         return this.getClassnameNumericSuffix(node, 'group');
778     };
780     /**
781      * Get the place number of a drop, or its corresponding hidden input.
782      *
783      * @param {jQuery} node the DOM node.
784      * @returns {Number} the place number.
785      */
786     DragDropOntoImageQuestion.prototype.getPlace = function(node) {
787         return this.getClassnameNumericSuffix(node, 'place');
788     };
790     /**
791      * Get drag clone for a given drag.
792      *
793      * @param {jQuery} drag the drag.
794      * @returns {jQuery} the drag's clone.
795      */
796     DragDropOntoImageQuestion.prototype.getDragClone = function(drag) {
797         return this.getRoot().find('.dragitemgroup' +
798             this.getGroup(drag) +
799             ' .draghome' +
800             '.choice' + this.getChoice(drag) +
801             '.group' + this.getGroup(drag) +
802             '.dragplaceholder');
803     };
805     /**
806      * Get infinite drag clones for given drag.
807      *
808      * @param {jQuery} drag the drag.
809      * @param {Boolean} inHome in the home area or not.
810      * @returns {jQuery} the drag's clones.
811      */
812     DragDropOntoImageQuestion.prototype.getInfiniteDragClones = function(drag, inHome) {
813         if (inHome) {
814             return this.getRoot().find('.dragitemgroup' +
815                 this.getGroup(drag) +
816                 ' .draghome' +
817                 '.choice' + this.getChoice(drag) +
818                 '.group' + this.getGroup(drag) +
819                 '.infinite').not('.dragplaceholder');
820         }
821         return this.getRoot().find('.draghome' +
822             '.choice' + this.getChoice(drag) +
823             '.group' + this.getGroup(drag) +
824             '.infinite').not('.dragplaceholder');
825     };
827     /**
828      * Get drop for a given drag and place.
829      *
830      * @param {jQuery} drag the drag.
831      * @param {Integer} currentPlace the current place of drag.
832      * @returns {jQuery} the drop's clone.
833      */
834     DragDropOntoImageQuestion.prototype.getDrop = function(drag, currentPlace) {
835         return this.getRoot().find('.dropzone.group' + this.getGroup(drag) + '.place' + currentPlace);
836     };
838     /**
839      * Handle when the window is resized.
840      */
841     DragDropOntoImageQuestion.prototype.handleResize = function() {
842         var thisQ = this,
843             bgRatio = this.bgRatio();
844         if (this.isPrinting) {
845             bgRatio = 1;
846         }
848         this.getRoot().find('.ddarea .dropzone').each(function(i, dropNode) {
849             $(dropNode)
850                 .css('left', parseInt($(dropNode).data('originX')) * parseFloat(bgRatio))
851                 .css('top', parseInt($(dropNode).data('originY')) * parseFloat(bgRatio));
852             thisQ.handleElementScale(dropNode, 'left top');
853         });
855         this.getRoot().find('div.droparea .draghome').not('.beingdragged').each(function(key, drag) {
856             $(drag)
857                 .css('left', parseFloat($(drag).data('originX')) * parseFloat(bgRatio))
858                 .css('top', parseFloat($(drag).data('originY')) * parseFloat(bgRatio));
859             thisQ.handleElementScale(drag, 'left top');
860         });
861     };
863     /**
864      * Return the background ratio.
865      *
866      * @returns {number} Background ratio.
867      */
868     DragDropOntoImageQuestion.prototype.bgRatio = function() {
869         var bgImg = this.bgImage();
870         var bgImgNaturalWidth = bgImg.get(0).naturalWidth;
871         var bgImgClientWidth = bgImg.width();
873         return bgImgClientWidth / bgImgNaturalWidth;
874     };
876     /**
877      * Scale the drag if needed.
878      *
879      * @param {jQuery} element the item to place.
880      * @param {String} type scaling type
881      */
882     DragDropOntoImageQuestion.prototype.handleElementScale = function(element, type) {
883         var bgRatio = parseFloat(this.bgRatio());
884         if (this.isPrinting) {
885             bgRatio = 1;
886         }
887         $(element).css({
888             '-webkit-transform': 'scale(' + bgRatio + ')',
889             '-moz-transform': 'scale(' + bgRatio + ')',
890             '-ms-transform': 'scale(' + bgRatio + ')',
891             '-o-transform': 'scale(' + bgRatio + ')',
892             'transform': 'scale(' + bgRatio + ')',
893             'transform-origin': type
894         });
895     };
897     /**
898      * Calculate z-index value.
899      *
900      * @returns {number} z-index value
901      */
902     DragDropOntoImageQuestion.prototype.calculateZIndex = function() {
903         var zIndex = 0;
904         this.getRoot().find('.ddarea .dropzone, div.droparea .draghome').each(function(i, dropNode) {
905             dropNode = $(dropNode);
906             // Note that webkit browsers won't return the z-index value from the CSS stylesheet
907             // if the element doesn't have a position specified. Instead it'll return "auto".
908             var itemZIndex = dropNode.css('z-index') ? parseInt(dropNode.css('z-index')) : 0;
910             if (itemZIndex > zIndex) {
911                 zIndex = itemZIndex;
912             }
913         });
915         return zIndex;
916     };
918     /**
919      * Singleton object that handles all the DragDropOntoImageQuestions
920      * on the page, and deals with event dispatching.
921      * @type {Object}
922      */
923     var questionManager = {
925         /**
926          * {boolean} ensures that the event handlers are only initialised once per page.
927          */
928         eventHandlersInitialised: false,
930         /**
931          * {boolean} is printing or not.
932          */
933         isPrinting: false,
935         /**
936          * {boolean} is keyboard navigation or not.
937          */
938         isKeyboardNavigation: false,
940         /**
941          * {Object} all the questions on this page, indexed by containerId (id on the .que div).
942          */
943         questions: {}, // An object containing all the information about each question on the page.
945         /**
946          * Initialise one question.
947          *
948          * @param {String} containerId the id of the div.que that contains this question.
949          * @param {boolean} readOnly whether the question is read-only.
950          * @param {Array} places data.
951          */
952         init: function(containerId, readOnly, places) {
953             questionManager.questions[containerId] =
954                 new DragDropOntoImageQuestion(containerId, readOnly, places);
955             if (!questionManager.eventHandlersInitialised) {
956                 questionManager.setupEventHandlers();
957                 questionManager.eventHandlersInitialised = true;
958             }
959         },
961         /**
962          * Set up the event handlers that make this question type work. (Done once per page.)
963          */
964         setupEventHandlers: function() {
965             $('body')
966                 .on('mousedown touchstart',
967                     '.que.ddimageortext:not(.qtype_ddimageortext-readonly) .draghome',
968                     questionManager.handleDragStart)
969                 .on('keydown',
970                     '.que.ddimageortext:not(.qtype_ddimageortext-readonly) .dropzones .dropzone',
971                     questionManager.handleKeyPress)
972                 .on('keydown',
973                     '.que.ddimageortext:not(.qtype_ddimageortext-readonly) .draghome.placed:not(.beingdragged)',
974                     questionManager.handleKeyPress)
975                 .on('dragmoved', questionManager.handleDragMoved);
976             $(window).on('resize', function() {
977                 questionManager.handleWindowResize(false);
978             });
979             window.addEventListener('beforeprint', function() {
980                 questionManager.isPrinting = true;
981                 questionManager.handleWindowResize(questionManager.isPrinting);
982             });
983             window.addEventListener('afterprint', function() {
984                 questionManager.isPrinting = false;
985                 questionManager.handleWindowResize(questionManager.isPrinting);
986             });
987             setTimeout(function() {
988                 questionManager.fixLayoutIfThingsMoved();
989             }, 100);
990         },
992         /**
993          * Handle mouse down / touch start events on drags.
994          * @param {Event} e the DOM event.
995          */
996         handleDragStart: function(e) {
997             e.preventDefault();
998             var question = questionManager.getQuestionForEvent(e);
999             if (question) {
1000                 question.handleDragStart(e);
1001             }
1002         },
1004         /**
1005          * Handle key down / press events on drags.
1006          * @param {KeyboardEvent} e
1007          */
1008         handleKeyPress: function(e) {
1009             if (questionManager.isKeyboardNavigation) {
1010                 return;
1011             }
1012             questionManager.isKeyboardNavigation = true;
1013             var question = questionManager.getQuestionForEvent(e);
1014             if (question) {
1015                 question.handleKeyPress(e);
1016             }
1017         },
1019         /**
1020          * Handle when the window is resized.
1021          * @param {boolean} isPrinting
1022          */
1023         handleWindowResize: function(isPrinting) {
1024             for (var containerId in questionManager.questions) {
1025                 if (questionManager.questions.hasOwnProperty(containerId)) {
1026                     questionManager.questions[containerId].isPrinting = isPrinting;
1027                     questionManager.questions[containerId].handleResize();
1028                 }
1029             }
1030         },
1032         /**
1033          * Sometimes, despite our best efforts, things change in a way that cannot
1034          * be specifically caught (e.g. dock expanding or collapsing in Boost).
1035          * Therefore, we need to periodically check everything is in the right position.
1036          */
1037         fixLayoutIfThingsMoved: function() {
1038             this.handleWindowResize(questionManager.isPrinting);
1039             // We use setTimeout after finishing work, rather than setInterval,
1040             // in case positioning things is slow. We want 100 ms gap
1041             // between executions, not what setInterval does.
1042             setTimeout(function() {
1043                 questionManager.fixLayoutIfThingsMoved(questionManager.isPrinting);
1044             }, 100);
1045         },
1047         /**
1048          * Handle when drag moved.
1049          *
1050          * @param {Event} e the event.
1051          * @param {jQuery} drag the drag
1052          * @param {jQuery} target the target
1053          * @param {DragDropOntoImageQuestion} thisQ the question.
1054          */
1055         handleDragMoved: function(e, drag, target, thisQ) {
1056             drag.removeClass('beingdragged').css('z-index', '');
1057             drag.css('top', target.position().top).css('left', target.position().left);
1058             target.after(drag);
1059             target.removeClass('active');
1060             if (typeof drag.data('unplaced') !== 'undefined' && drag.data('unplaced') === true) {
1061                 drag.removeClass('placed').addClass('unplaced');
1062                 drag.removeAttr('tabindex');
1063                 drag.removeData('unplaced');
1064                 drag.css('top', '')
1065                     .css('left', '')
1066                     .css('transform', '');
1067                 if (drag.hasClass('infinite') && thisQ.getInfiniteDragClones(drag, true).length > 1) {
1068                     thisQ.getInfiniteDragClones(drag, true).first().remove();
1069                 }
1070             } else {
1071                 drag.data('originX', target.data('originX')).data('originY', target.data('originY'));
1072                 thisQ.handleElementScale(drag, 'left top');
1073             }
1074             if (typeof drag.data('isfocus') !== 'undefined' && drag.data('isfocus') === true) {
1075                 drag.focus();
1076                 drag.removeData('isfocus');
1077             }
1078             if (typeof target.data('isfocus') !== 'undefined' && target.data('isfocus') === true) {
1079                 target.removeData('isfocus');
1080             }
1081             if (questionManager.isKeyboardNavigation) {
1082                 questionManager.isKeyboardNavigation = false;
1083             }
1084         },
1086         /**
1087          * Given an event, work out which question it effects.
1088          * @param {Event} e the event.
1089          * @returns {DragDropOntoImageQuestion|undefined} The question, or undefined.
1090          */
1091         getQuestionForEvent: function(e) {
1092             var containerId = $(e.currentTarget).closest('.que.ddimageortext').attr('id');
1093             return questionManager.questions[containerId];
1094         }
1095     };
1097     /**
1098      * @alias module:qtype_ddimageortext/question
1099      */
1100     return {
1101         /**
1102          * Initialise one drag-drop onto image question.
1103          *
1104          * @param {String} containerId id of the outer div for this question.
1105          * @param {boolean} readOnly whether the question is being displayed read-only.
1106          * @param {Array} Information about the drop places.
1107          */
1108         init: questionManager.init
1109     };
1110 });