Merge branch 'MDL-68113-master' of https://github.com/HuongNV13/moodle
[moodle.git] / question / type / ddwtos / amd / src / ddwtos.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 make drag-drop into text questions work.
18  *
19  * Some vocabulary to help understand this code:
20  *
21  * The question text contains 'drops' - blanks into which the 'drags', the missing
22  * words, can be put.
23  *
24  * The thing that can be moved into the drops are called 'drags'. There may be
25  * multiple copies of the 'same' drag which does not really cause problems.
26  * Each drag has a 'choice' number which is the value set on the drop's hidden
27  * input when this drag is placed in a drop.
28  *
29  * These may be in separate 'groups', distinguished by colour.
30  * Things can only interact with other things in the same group.
31  * The groups are numbered from 1.
32  *
33  * The place where a given drag started from is called its 'home'.
34  *
35  * @module     qtype_ddwtos/ddwtos
36  * @package    qtype_ddwtos
37  * @copyright  2018 The Open University
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  * @since      3.6
40  */
41 define(['jquery', 'core/dragdrop', 'core/key_codes'], function($, dragDrop, keys) {
43     "use strict";
45     /**
46      * Object to handle one drag-drop into text question.
47      *
48      * @param {String} containerId id of the outer div for this question.
49      * @param {boolean} readOnly whether the question is being displayed read-only.
50      * @constructor
51      */
52     function DragDropToTextQuestion(containerId, readOnly) {
53         this.containerId = containerId;
54         if (readOnly) {
55             this.getRoot().addClass('qtype_ddwtos-readonly');
56         }
57         this.resizeAllDragsAndDrops();
58         this.cloneDrags();
59         this.positionDrags();
60     }
62     /**
63      * In each group, resize all the items to be the same size.
64      */
65     DragDropToTextQuestion.prototype.resizeAllDragsAndDrops = function() {
66         var thisQ = this;
67         this.getRoot().find('.answercontainer > div').each(function(i, node) {
68             thisQ.resizeAllDragsAndDropsInGroup(
69                 thisQ.getClassnameNumericSuffix($(node), 'draggrouphomes'));
70         });
71     };
73     /**
74      * In a given group, set all the drags and drops to be the same size.
75      *
76      * @param {int} group the group number.
77      */
78     DragDropToTextQuestion.prototype.resizeAllDragsAndDropsInGroup = function(group) {
79         var thisQ = this,
80             dragHomes = this.getRoot().find('.draggrouphomes' + group + ' span.draghome'),
81             maxWidth = 0,
82             maxHeight = 0;
84         // Find the maximum size of any drag in this groups.
85         dragHomes.each(function(i, drag) {
86             maxWidth = Math.max(maxWidth, Math.ceil(drag.offsetWidth));
87             maxHeight = Math.max(maxHeight, Math.ceil(0 + drag.offsetHeight));
88         });
90         // The size we will want to set is a bit bigger than this.
91         maxWidth += 8;
92         maxHeight += 2;
94         // Set each drag home to that size.
95         dragHomes.each(function(i, drag) {
96             thisQ.setElementSize(drag, maxWidth, maxHeight);
97         });
99         // Set each drop to that size.
100         this.getRoot().find('span.drop.group' + group).each(function(i, drop) {
101             thisQ.setElementSize(drop, maxWidth, maxHeight);
102         });
103     };
105     /**
106      * Set a given DOM element to be a particular size.
107      *
108      * @param {HTMLElement} element
109      * @param {int} width
110      * @param {int} height
111      */
112     DragDropToTextQuestion.prototype.setElementSize = function(element, width, height) {
113         $(element).width(width).height(height).css('lineHeight', height + 'px');
114     };
116     /**
117      * Invisible 'drag homes' are output by the renderer. These have the same properties
118      * as the drag items but are invisible. We clone these invisible elements to make the
119      * actual drag items.
120      */
121     DragDropToTextQuestion.prototype.cloneDrags = function() {
122         var thisQ = this;
123         thisQ.getRoot().find('span.draghome').each(function(index, draghome) {
124             var drag = $(draghome);
125             var placeHolder = drag.clone();
126             placeHolder.removeClass();
127             placeHolder.addClass('draghome choice' +
128                 thisQ.getChoice(drag) + ' group' +
129                 thisQ.getGroup(drag) + ' dragplaceholder');
130             drag.before(placeHolder);
131         });
132     };
134     /**
135      * Update the position of drags.
136      */
137     DragDropToTextQuestion.prototype.positionDrags = function() {
138         var thisQ = this,
139             root = this.getRoot();
141         // First move all items back home.
142         root.find('span.draghome').not('.dragplaceholder').each(function(i, dragNode) {
143             var drag = $(dragNode),
144                 currentPlace = thisQ.getClassnameNumericSuffix(drag, 'inplace');
145             drag.addClass('unplaced')
146                 .removeClass('placed');
147             drag.removeAttr('tabindex');
148             if (currentPlace !== null) {
149                 drag.removeClass('inplace' + currentPlace);
150             }
151         });
153         // Then place the once that should be placed.
154         root.find('input.placeinput').each(function(i, inputNode) {
155             var input = $(inputNode),
156                 choice = input.val(),
157                 place = thisQ.getPlace(input);
159             // Record the last known position of the drop.
160             var drop = root.find('.drop.place' + place),
161                 dropPosition = drop.offset();
162             drop.data('prev-top', dropPosition.top).data('prev-left', dropPosition.left);
164             if (choice === '0') {
165                 // No item in this place.
166                 return;
167             }
169             // Get the unplaced drag.
170             var unplacedDrag = thisQ.getUnplacedChoice(thisQ.getGroup(input), choice);
171             // Get the clone of the drag.
172             var hiddenDrag = thisQ.getDragClone(unplacedDrag);
173             if (hiddenDrag.length) {
174                 hiddenDrag.addClass('active');
175             }
176             // Send the drag to drop.
177             thisQ.sendDragToDrop(thisQ.getUnplacedChoice(thisQ.getGroup(input), choice), drop);
178         });
179     };
181     /**
182      * Handles the start of dragging an item.
183      *
184      * @param {Event} e the touch start or mouse down event.
185      */
186     DragDropToTextQuestion.prototype.handleDragStart = function(e) {
187         var thisQ = this,
188             drag = $(e.target).closest('.draghome');
190         var info = dragDrop.prepare(e);
191         if (!info.start) {
192             return;
193         }
195         drag.addClass('beingdragged');
196         var currentPlace = this.getClassnameNumericSuffix(drag, 'inplace');
197         if (currentPlace !== null) {
198             this.setInputValue(currentPlace, 0);
199             drag.removeClass('inplace' + currentPlace);
200             var hiddenDrop = thisQ.getDrop(drag, currentPlace);
201             if (hiddenDrop.length) {
202                 hiddenDrop.addClass('active');
203                 drag.offset(hiddenDrop.offset());
204             }
205         } else {
206             var hiddenDrag = thisQ.getDragClone(drag);
207             if (hiddenDrag.length) {
208                 if (drag.hasClass('infinite')) {
209                     var noOfDrags = this.noOfDropsInGroup(this.getGroup(drag));
210                     var cloneDrags = this.getInfiniteDragClones(drag, false);
211                     if (cloneDrags.length < noOfDrags) {
212                         var cloneDrag = drag.clone();
213                         cloneDrag.removeClass('beingdragged');
214                         hiddenDrag.after(cloneDrag);
215                         drag.offset(cloneDrag.offset());
216                     } else {
217                         hiddenDrag.addClass('active');
218                         drag.offset(hiddenDrag.offset());
219                     }
220                 } else {
221                     hiddenDrag.addClass('active');
222                     drag.offset(hiddenDrag.offset());
223                 }
224             }
225         }
227         dragDrop.start(e, drag, function(x, y, drag) {
228             thisQ.dragMove(x, y, drag);
229         }, function(x, y, drag) {
230             thisQ.dragEnd(x, y, drag);
231         });
232     };
234     /**
235      * Called whenever the currently dragged items moves.
236      *
237      * @param {Number} pageX the x position.
238      * @param {Number} pageY the y position.
239      * @param {jQuery} drag the item being moved.
240      */
241     DragDropToTextQuestion.prototype.dragMove = function(pageX, pageY, drag) {
242         var thisQ = this;
243         this.getRoot().find('span.drop.group' + this.getGroup(drag)).each(function(i, dropNode) {
244             var drop = $(dropNode);
245             if (thisQ.isPointInDrop(pageX, pageY, drop)) {
246                 drop.addClass('valid-drag-over-drop');
247             } else {
248                 drop.removeClass('valid-drag-over-drop');
249             }
250         });
251         this.getRoot().find('span.draghome.placed.group' + this.getGroup(drag)).not('.beingdragged').each(function(i, dropNode) {
252             var drop = $(dropNode);
253             if (thisQ.isPointInDrop(pageX, pageY, drop)) {
254                 drop.addClass('valid-drag-over-drop');
255             } else {
256                 drop.removeClass('valid-drag-over-drop');
257             }
258         });
259     };
261     /**
262      * Called when user drops a drag item.
263      *
264      * @param {Number} pageX the x position.
265      * @param {Number} pageY the y position.
266      * @param {jQuery} drag the item being moved.
267      */
268     DragDropToTextQuestion.prototype.dragEnd = function(pageX, pageY, drag) {
269         var thisQ = this,
270             root = this.getRoot(),
271             placed = false;
272         root.find('span.drop.group' + this.getGroup(drag)).each(function(i, dropNode) {
273             var drop = $(dropNode);
274             if (!thisQ.isPointInDrop(pageX, pageY, drop)) {
275                 // Not this drop.
276                 return true;
277             }
279             // Now put this drag into the drop.
280             drop.removeClass('valid-drag-over-drop');
281             thisQ.sendDragToDrop(drag, drop);
282             placed = true;
283             return false; // Stop the each() here.
284         });
286         root.find('span.draghome.placed.group' + this.getGroup(drag)).not('.beingdragged').each(function(i, placedNode) {
287             var placedDrag = $(placedNode);
288             if (!thisQ.isPointInDrop(pageX, pageY, placedDrag)) {
289                 // Not this placed drag.
290                 return true;
291             }
293             // Now put this drag into the drop.
294             placedDrag.removeClass('valid-drag-over-drop');
295             var currentPlace = thisQ.getClassnameNumericSuffix(placedDrag, 'inplace');
296             var drop = thisQ.getDrop(drag, currentPlace);
297             thisQ.sendDragToDrop(drag, drop);
298             placed = true;
299             return false; // Stop the each() here.
300         });
302         if (!placed) {
303             this.sendDragHome(drag);
304         }
305     };
307     /**
308      * Animate a drag item into a given place (or back home).
309      *
310      * @param {jQuery|null} drag the item to place. If null, clear the place.
311      * @param {jQuery} drop the place to put it.
312      */
313     DragDropToTextQuestion.prototype.sendDragToDrop = function(drag, drop) {
314         // Is there already a drag in this drop? if so, evict it.
315         var oldDrag = this.getCurrentDragInPlace(this.getPlace(drop));
316         if (oldDrag.length !== 0) {
317             oldDrag.addClass('beingdragged');
318             oldDrag.offset(oldDrag.offset());
319             var currentPlace = this.getClassnameNumericSuffix(oldDrag, 'inplace');
320             var hiddenDrop = this.getDrop(oldDrag, currentPlace);
321             hiddenDrop.addClass('active');
322             this.sendDragHome(oldDrag);
323         }
325         if (drag.length === 0) {
326             this.setInputValue(this.getPlace(drop), 0);
327             if (drop.data('isfocus')) {
328                 drop.focus();
329             }
330         } else {
331             this.setInputValue(this.getPlace(drop), this.getChoice(drag));
332             drag.removeClass('unplaced')
333                 .addClass('placed inplace' + this.getPlace(drop));
334             drag.attr('tabindex', 0);
335             this.animateTo(drag, drop);
336         }
337     };
339     /**
340      * Animate a drag back to its home.
341      *
342      * @param {jQuery} drag the item being moved.
343      */
344     DragDropToTextQuestion.prototype.sendDragHome = function(drag) {
345         var currentPlace = this.getClassnameNumericSuffix(drag, 'inplace');
346         if (currentPlace !== null) {
347             drag.removeClass('inplace' + currentPlace);
348         }
349         drag.data('unplaced', true);
351         this.animateTo(drag, this.getDragHome(this.getGroup(drag), this.getChoice(drag)));
352     };
354     /**
355      * Handles keyboard events on drops.
356      *
357      * Drops are focusable. Once focused, right/down/space switches to the next choice, and
358      * left/up switches to the previous. Escape clear.
359      *
360      * @param {KeyboardEvent} e
361      */
362     DragDropToTextQuestion.prototype.handleKeyPress = function(e) {
363         var drop = $(e.target).closest('.drop');
364         if (drop.length === 0) {
365             var placedDrag = $(e.target);
366             var currentPlace = this.getClassnameNumericSuffix(placedDrag, 'inplace');
367             if (currentPlace !== null) {
368                 drop = this.getDrop(placedDrag, currentPlace);
369             }
370         }
371         var currentDrag = this.getCurrentDragInPlace(this.getPlace(drop)),
372             nextDrag = $();
374         switch (e.keyCode) {
375             case keys.space:
376             case keys.arrowRight:
377             case keys.arrowDown:
378                 nextDrag = this.getNextDrag(this.getGroup(drop), currentDrag);
379                 break;
381             case keys.arrowLeft:
382             case keys.arrowUp:
383                 nextDrag = this.getPreviousDrag(this.getGroup(drop), currentDrag);
384                 break;
386             case keys.escape:
387                 break;
389             default:
390                 return; // To avoid the preventDefault below.
391         }
393         if (nextDrag.length) {
394             nextDrag.data('isfocus', true);
395         } else {
396             drop.data('isfocus', true);
397         }
399         e.preventDefault();
400         this.sendDragToDrop(nextDrag, drop);
401     };
403     /**
404      * Choose the next drag in a group.
405      *
406      * @param {int} group which group.
407      * @param {jQuery} drag current choice (empty jQuery if there isn't one).
408      * @return {jQuery} the next drag in that group, or null if there wasn't one.
409      */
410     DragDropToTextQuestion.prototype.getNextDrag = function(group, drag) {
411         var choice,
412             numChoices = this.noOfChoicesInGroup(group);
414         if (drag.length === 0) {
415             choice = 1; // Was empty, so we want to select the first choice.
416         } else {
417             choice = this.getChoice(drag) + 1;
418         }
420         var next = this.getUnplacedChoice(group, choice);
421         while (next.length === 0 && choice < numChoices) {
422             choice++;
423             next = this.getUnplacedChoice(group, choice);
424         }
426         return next;
427     };
429     /**
430      * Choose the previous drag in a group.
431      *
432      * @param {int} group which group.
433      * @param {jQuery} drag current choice (empty jQuery if there isn't one).
434      * @return {jQuery} the next drag in that group, or null if there wasn't one.
435      */
436     DragDropToTextQuestion.prototype.getPreviousDrag = function(group, drag) {
437         var choice;
439         if (drag.length === 0) {
440             choice = this.noOfChoicesInGroup(group);
441         } else {
442             choice = this.getChoice(drag) - 1;
443         }
445         var previous = this.getUnplacedChoice(group, choice);
446         while (previous.length === 0 && choice > 1) {
447             choice--;
448             previous = this.getUnplacedChoice(group, choice);
449         }
451         // Does this choice exist?
452         return previous;
453     };
455     /**
456      * Animate an object to the given destination.
457      *
458      * @param {jQuery} drag the element to be animated.
459      * @param {jQuery} target element marking the place to move it to.
460      */
461     DragDropToTextQuestion.prototype.animateTo = function(drag, target) {
462         var currentPos = drag.offset(),
463             targetPos = target.offset(),
464             thisQ = this;
466         M.util.js_pending('qtype_ddwtos-animate-' + thisQ.containerId);
467         // Animate works in terms of CSS position, whereas locating an object
468         // on the page works best with jQuery offset() function. So, to get
469         // the right target position, we work out the required change in
470         // offset() and then add that to the current CSS position.
471         drag.animate(
472             {
473                 left: parseInt(drag.css('left')) + targetPos.left - currentPos.left,
474                 top: parseInt(drag.css('top')) + targetPos.top - currentPos.top
475             },
476             {
477                 duration: 'fast',
478                 done: function() {
479                     $('body').trigger('dragmoved', [drag, target, thisQ]);
480                     M.util.js_complete('qtype_ddwtos-animate-' + thisQ.containerId);
481                 }
482             }
483         );
484     };
486     /**
487      * Detect if a point is inside a given DOM node.
488      *
489      * @param {Number} pageX the x position.
490      * @param {Number} pageY the y position.
491      * @param {jQuery} drop the node to check (typically a drop).
492      * @return {boolean} whether the point is inside the node.
493      */
494     DragDropToTextQuestion.prototype.isPointInDrop = function(pageX, pageY, drop) {
495         var position = drop.offset();
496         return pageX >= position.left && pageX < position.left + drop.width()
497                 && pageY >= position.top && pageY < position.top + drop.height();
498     };
500     /**
501      * Set the value of the hidden input for a place, to record what is currently there.
502      *
503      * @param {int} place which place to set the input value for.
504      * @param {int} choice the value to set.
505      */
506     DragDropToTextQuestion.prototype.setInputValue = function(place, choice) {
507         this.getRoot().find('input.placeinput.place' + place).val(choice);
508     };
510     /**
511      * Get the outer div for this question.
512      *
513      * @returns {jQuery} containing that div.
514      */
515     DragDropToTextQuestion.prototype.getRoot = function() {
516         return $(document.getElementById(this.containerId));
517     };
519     /**
520      * Get drag home for a given choice.
521      *
522      * @param {int} group the group.
523      * @param {int} choice the choice number.
524      * @returns {jQuery} containing that div.
525      */
526     DragDropToTextQuestion.prototype.getDragHome = function(group, choice) {
527         if (!this.getRoot().find('.draghome.dragplaceholder.group' + group + '.choice' + choice).is(':visible')) {
528             return this.getRoot().find('.draggrouphomes' + group +
529                 ' span.draghome.infinite' +
530                 '.choice' + choice +
531                 '.group' + group);
532         }
533         return this.getRoot().find('.draghome.dragplaceholder.group' + group + '.choice' + choice);
534     };
536     /**
537      * Get an unplaced choice for a particular group.
538      *
539      * @param {int} group the group.
540      * @param {int} choice the choice number.
541      * @returns {jQuery} jQuery wrapping the unplaced choice. If there isn't one, the jQuery will be empty.
542      */
543     DragDropToTextQuestion.prototype.getUnplacedChoice = function(group, choice) {
544         return this.getRoot().find('.draghome.group' + group + '.choice' + choice + '.unplaced').slice(0, 1);
545     };
547     /**
548      * Get the drag that is currently in a given place.
549      *
550      * @param {int} place the place number.
551      * @return {jQuery} the current drag (or an empty jQuery if none).
552      */
553     DragDropToTextQuestion.prototype.getCurrentDragInPlace = function(place) {
554         return this.getRoot().find('span.draghome.inplace' + place);
555     };
557     /**
558      * Return the number of blanks in a given group.
559      *
560      * @param {int} group the group number.
561      * @returns {int} the number of drops.
562      */
563     DragDropToTextQuestion.prototype.noOfDropsInGroup = function(group) {
564         return this.getRoot().find('.drop.group' + group).length;
565     };
567     /**
568      * Return the number of choices in a given group.
569      *
570      * @param {int} group the group number.
571      * @returns {int} the number of choices.
572      */
573     DragDropToTextQuestion.prototype.noOfChoicesInGroup = function(group) {
574         return this.getRoot().find('.draghome.group' + group).length;
575     };
577     /**
578      * Return the number at the end of the CSS class name with the given prefix.
579      *
580      * @param {jQuery} node
581      * @param {String} prefix name prefix
582      * @returns {Number|null} the suffix if found, else null.
583      */
584     DragDropToTextQuestion.prototype.getClassnameNumericSuffix = function(node, prefix) {
585         var classes = node.attr('class');
586         if (classes !== '') {
587             var classesArr = classes.split(' ');
588             for (var index = 0; index < classesArr.length; index++) {
589                 var patt1 = new RegExp('^' + prefix + '([0-9])+$');
590                 if (patt1.test(classesArr[index])) {
591                     var patt2 = new RegExp('([0-9])+$');
592                     var match = patt2.exec(classesArr[index]);
593                     return Number(match[0]);
594                 }
595             }
596         }
597         return null;
598     };
600     /**
601      * Get the choice number of a drag.
602      *
603      * @param {jQuery} drag the drag.
604      * @returns {Number} the choice number.
605      */
606     DragDropToTextQuestion.prototype.getChoice = function(drag) {
607         return this.getClassnameNumericSuffix(drag, 'choice');
608     };
610     /**
611      * Given a DOM node that is significant to this question
612      * (drag, drop, ...) get the group it belongs to.
613      *
614      * @param {jQuery} node a DOM node.
615      * @returns {Number} the group it belongs to.
616      */
617     DragDropToTextQuestion.prototype.getGroup = function(node) {
618         return this.getClassnameNumericSuffix(node, 'group');
619     };
621     /**
622      * Get the place number of a drop, or its corresponding hidden input.
623      *
624      * @param {jQuery} node the DOM node.
625      * @returns {Number} the place number.
626      */
627     DragDropToTextQuestion.prototype.getPlace = function(node) {
628         return this.getClassnameNumericSuffix(node, 'place');
629     };
631     /**
632      * Get drag clone for a given drag.
633      *
634      * @param {jQuery} drag the drag.
635      * @returns {jQuery} the drag's clone.
636      */
637     DragDropToTextQuestion.prototype.getDragClone = function(drag) {
638         return this.getRoot().find('.draggrouphomes' +
639             this.getGroup(drag) +
640             ' span.draghome' +
641             '.choice' + this.getChoice(drag) +
642             '.group' + this.getGroup(drag) +
643             '.dragplaceholder');
644     };
646     /**
647      * Get infinite drag clones for given drag.
648      *
649      * @param {jQuery} drag the drag.
650      * @param {Boolean} inHome in the home area or not.
651      * @returns {jQuery} the drag's clones.
652      */
653     DragDropToTextQuestion.prototype.getInfiniteDragClones = function(drag, inHome) {
654         if (inHome) {
655             return this.getRoot().find('.draggrouphomes' +
656                 this.getGroup(drag) +
657                 ' span.draghome' +
658                 '.choice' + this.getChoice(drag) +
659                 '.group' + this.getGroup(drag) +
660                 '.infinite').not('.dragplaceholder');
661         }
662         return this.getRoot().find('span.draghome' +
663             '.choice' + this.getChoice(drag) +
664             '.group' + this.getGroup(drag) +
665             '.infinite').not('.dragplaceholder');
666     };
668     /**
669      * Get drop for a given drag and place.
670      *
671      * @param {jQuery} drag the drag.
672      * @param {Integer} currentPlace the current place of drag.
673      * @returns {jQuery} the drop's clone.
674      */
675     DragDropToTextQuestion.prototype.getDrop = function(drag, currentPlace) {
676         return this.getRoot().find('.drop.group' + this.getGroup(drag) + '.place' + currentPlace);
677     };
679     /**
680      * Singleton that tracks all the DragDropToTextQuestions on this page, and deals
681      * with event dispatching.
682      *
683      * @type {Object}
684      */
685     var questionManager = {
686         /**
687          * {boolean} used to ensure the event handlers are only initialised once per page.
688          */
689         eventHandlersInitialised: false,
691         /**
692          * {DragDropToTextQuestion[]} all the questions on this page, indexed by containerId (id on the .que div).
693          */
694         questions: {},
696         /**
697          * Initialise questions.
698          *
699          * @param {String} containerId id of the outer div for this question.
700          * @param {boolean} readOnly whether the question is being displayed read-only.
701          */
702         init: function(containerId, readOnly) {
703             questionManager.questions[containerId] = new DragDropToTextQuestion(containerId, readOnly);
704             if (!questionManager.eventHandlersInitialised) {
705                 questionManager.setupEventHandlers();
706                 questionManager.eventHandlersInitialised = true;
707             }
708         },
710         /**
711          * Set up the event handlers that make this question type work. (Done once per page.)
712          */
713         setupEventHandlers: function() {
714             $('body').on('mousedown touchstart',
715                 '.que.ddwtos:not(.qtype_ddwtos-readonly) span.draghome',
716                 questionManager.handleDragStart)
717                 .on('keydown',
718                     '.que.ddwtos:not(.qtype_ddwtos-readonly) span.drop',
719                     questionManager.handleKeyPress)
720                 .on('keydown',
721                     '.que.ddwtos:not(.qtype_ddwtos-readonly) span.draghome.placed:not(.beingdragged)',
722                     questionManager.handleKeyPress)
723                 .on('dragmoved', questionManager.handleDragMoved);
724         },
726         /**
727          * Handle mouse down / touch start on drags.
728          * @param {Event} e the DOM event.
729          */
730         handleDragStart: function(e) {
731             e.preventDefault();
732             var question = questionManager.getQuestionForEvent(e);
733             if (question) {
734                 question.handleDragStart(e);
735             }
736         },
738         /**
739          * Handle key down / press on drops.
740          * @param {KeyboardEvent} e
741          */
742         handleKeyPress: function(e) {
743             var question = questionManager.getQuestionForEvent(e);
744             if (question) {
745                 question.handleKeyPress(e);
746             }
747         },
749         /**
750          * Given an event, work out which question it affects.
751          *
752          * @param {Event} e the event.
753          * @returns {DragDropToTextQuestion|undefined} The question, or undefined.
754          */
755         getQuestionForEvent: function(e) {
756             var containerId = $(e.currentTarget).closest('.que.ddwtos').attr('id');
757             return questionManager.questions[containerId];
758         },
760         /**
761          * Handle when drag moved.
762          *
763          * @param {Event} e the event.
764          * @param {jQuery} drag the drag
765          * @param {jQuery} target the target
766          * @param {DragDropToTextQuestion} thisQ the question.
767          */
768         handleDragMoved: function(e, drag, target, thisQ) {
769             drag.removeClass('beingdragged');
770             drag.css('top', '').css('left', '');
771             target.after(drag);
772             target.removeClass('active');
773             if (typeof drag.data('unplaced') !== 'undefined' && drag.data('unplaced') === true) {
774                 drag.removeClass('placed').addClass('unplaced');
775                 drag.removeAttr('tabindex');
776                 drag.removeData('unplaced');
777                 if (drag.hasClass('infinite') && thisQ.getInfiniteDragClones(drag, true).length > 1) {
778                     setTimeout(function() {
779                         thisQ.getInfiniteDragClones(drag, true).first().remove();
780                     });
781                 }
782             }
783             if (typeof drag.data('isfocus') !== 'undefined' && drag.data('isfocus') === true) {
784                 var hiddenDrag = thisQ.getDragClone(drag);
785                 if (hiddenDrag.length) {
786                     if (drag.hasClass('infinite')) {
787                         var noOfDrags = thisQ.noOfDropsInGroup(thisQ.getGroup(drag));
788                         var cloneDrags = thisQ.getInfiniteDragClones(drag, false);
789                         if (cloneDrags.length < noOfDrags) {
790                             var cloneDrag = drag.clone();
791                             cloneDrag.removeClass('beingdragged');
792                             cloneDrag.removeAttr('tabindex');
793                             hiddenDrag.after(cloneDrag);
794                         } else {
795                             hiddenDrag.addClass('active');
796                         }
797                     } else {
798                         hiddenDrag.addClass('active');
799                     }
800                 }
801                 drag.focus();
802                 drag.removeData('isfocus');
803             }
804             if (typeof target.data('isfocus') !== 'undefined' && target.data('isfocus') === true) {
805                 target.removeData('isfocus');
806             }
807         }
808     };
810     /**
811      * @alias module:qtype_ddwtos/ddwtos
812      */
813     return {
814         /**
815          * Initialise one drag-drop into text question.
816          *
817          * @param {String} containerId id of the outer div for this question.
818          * @param {boolean} readOnly whether the question is being displayed read-only.
819          */
820         init: questionManager.init
821     };
822 });