Drag and drop on container page.

STUD-1309

cms/static/coffee/spec/main.coffee

@@ -18,6 +18,7 @@ requirejs.config({
         "jquery.iframe-transport": "xmodule_js/common_static/js/vendor/jQuery-File-Upload/js/jquery.iframe-transport",
         "jquery.inputnumber": "xmodule_js/common_static/js/vendor/html5-input-polyfills/number-polyfill",
         "jquery.immediateDescendents": "xmodule_js/common_static/coffee/src/jquery.immediateDescendents",
+        "jquery.simulate": "xmodule_js/common_static/js/vendor/jquery.simulate",
         "datepair": "xmodule_js/common_static/js/vendor/timepicker/datepair",
         "date": "xmodule_js/common_static/js/vendor/date",
         "underscore": "xmodule_js/common_static/js/vendor/underscore-min",
@@ -100,6 +101,10 @@ requirejs.config({
             deps: ["jquery"],
             exports: "jQuery.fn.inputNumber"
         },
+        "jquery.simulate": {
+            deps: ["jquery"],
+            exports: "jQuery.fn.simulate"
+        },
         "jquery.tinymce": {
             deps: ["jquery", "tinymce"],
             exports: "jQuery.fn.tinymce"
@@ -216,6 +221,7 @@ define([
     "js/spec/views/baseview_spec",
     "js/spec/views/paging_spec",
 
+    "js/spec/views/container_spec",
     "js/spec/views/unit_spec",
     "js/spec/views/xblock_spec",
     "js/spec/views/xblock_editor_spec",

cms/static/js/views/container.js

+define(["jquery", "underscore", "js/views/xblock", "js/utils/module", "gettext", "js/views/feedback_notification"],
+    function ($, _, XBlockView, ModuleUtils, gettext, NotificationView) {
+        var ContainerView = XBlockView.extend({
+
+            xblockReady: function () {
+                XBlockView.prototype.xblockReady.call(this);
+                var verticalContainer = $(this.$el).find('.vertical-container'),
+                    alreadySortable = $(this.$el).find('.ui-sortable'),
+                    newParent,
+                    oldParent,
+                    self = this;
+
+                alreadySortable.sortable("destroy");
+
+                verticalContainer.sortable({
+                    handle: '.drag-handle',
+
+                    stop: function (event, ui) {
+                        console.log('stop');
+
+                        if (oldParent === undefined) {
+                            // If no actual change occurred,
+                            // oldParent will never have been set.
+                            return;
+                        }
+
+                        var saving = new NotificationView.Mini({
+                            title: gettext('Saving…')
+                        });
+                        saving.show();
+
+                        var hideSaving = function () {
+                            saving.hide();
+                        };
+
+                        // If moving from one container to another,
+                        // add to new container before deleting from old to
+                        // avoid creating an orphan if the addition fails.
+                        if (newParent) {
+                            var removeFromParent = oldParent;
+                            self.reorder(newParent, function () {
+                                self.reorder(removeFromParent, hideSaving);
+                            });
+                        }
+                        else {
+                            // No new parent, only reordering within same container.
+                            self.reorder(oldParent, hideSaving);
+                        }
+
+                        oldParent = undefined;
+                        newParent = undefined;
+                    },
+                    update: function (event, ui) {
+                        // When dragging from one ol to another, this method
+                        // will be called twice (once for each list). ui.sender will
+                        // be null if the change is related to the list the element
+                        // was originally in (the case of a move within the same container
+                        // or the deletion from a container when moving to a new container).
+                        var parent = $(event.target).closest('.wrapper-xblock');
+                        if (ui.sender) {
+                            // Move to a new container (the addition part).
+                            newParent = parent;
+                        }
+                        else {
+                            // Reorder inside a container, or deletion when moving to new container.
+                            oldParent = parent;
+                        }
+                    },
+                    helper: "clone",
+                    opacity: '0.5',
+                    placeholder: 'component-placeholder',
+                    forcePlaceholderSize: true,
+                    axis: 'y',
+                    items: '> .vertical-element',
+                    connectWith: ".vertical-container"
+
+                });
+            },
+
+            reorder: function (targetParent, successCallback) {
+                console.log('calling reorder for ' + targetParent.data('locator'));
+
+                // Find descendants with class "wrapper-xblock" whose parent == targetParent.
+                // This is necessary to filter our grandchildren, great-grandchildren, etc.
+                var children = targetParent.find('.wrapper-xblock').filter(function () {
+                    var parent = $(this).parent().closest('.wrapper-xblock');
+                    return parent.data('locator') === targetParent.data('locator');
+                });
+
+                var childLocators = _.map(
+                    children,
+                    function (child) {
+                        return $(child).data('locator');
+                    }
+                );
+                $.ajax({
+                    url: ModuleUtils.getUpdateUrl(targetParent.data('locator')),
+                    type: 'PUT',
+                    dataType: 'json',
+                    contentType: 'application/json',
+                    data: JSON.stringify({
+                        children: childLocators
+                    }),
+                    success: function () {
+                        // change data-parent on the element moved.
+                        console.log('SAVED! ' + targetParent.data('locator') + " with " + childLocators.length + "  children");
+                        if (successCallback) {
+                            successCallback();
+                        }
+                    }
+                });
+
+            }
+        });
+
+        return ContainerView;
+    }); // end define();
\ No newline at end of file

cms/static/js_test.yml

@@ -34,6 +34,7 @@ lib_paths:
     - xmodule_js/common_static/js/vendor/jquery.min.js
     - xmodule_js/common_static/js/vendor/jquery-ui.min.js
     - xmodule_js/common_static/js/vendor/jquery.cookie.js
+    - xmodule_js/common_static/js/vendor/jquery.simulate.js
     - xmodule_js/common_static/js/vendor/underscore-min.js
     - xmodule_js/common_static/js/vendor/underscore.string.min.js
     - xmodule_js/common_static/js/vendor/backbone-min.js

common/static/js/vendor/jquery.simulate.js

+ /*!
+ * jQuery Simulate v@VERSION - simulate browser mouse and keyboard events
+ * https://github.com/jquery/jquery-simulate
+ *
+ * Copyright 2012 jQuery Foundation and other contributors
+ * Released under the MIT license.
+ * http://jquery.org/license
+ *
+ * Date: @DATE
+ */
+
+;(function( $, undefined ) {
+
+var rkeyEvent = /^key/,
+	rmouseEvent = /^(?:mouse|contextmenu)|click/;
+
+$.fn.simulate = function( type, options ) {
+	return this.each(function() {
+		new $.simulate( this, type, options );
+	});
+};
+
+$.simulate = function( elem, type, options ) {
+	var method = $.camelCase( "simulate-" + type );
+
+	this.target = elem;
+	this.options = options;
+
+	if ( this[ method ] ) {
+		this[ method ]();
+	} else {
+		this.simulateEvent( elem, type, options );
+	}
+};
+
+$.extend( $.simulate, {
+
+	keyCode: {
+		BACKSPACE: 8,
+		COMMA: 188,
+		DELETE: 46,
+		DOWN: 40,
+		END: 35,
+		ENTER: 13,
+		ESCAPE: 27,
+		HOME: 36,
+		LEFT: 37,
+		NUMPAD_ADD: 107,
+		NUMPAD_DECIMAL: 110,
+		NUMPAD_DIVIDE: 111,
+		NUMPAD_ENTER: 108,
+		NUMPAD_MULTIPLY: 106,
+		NUMPAD_SUBTRACT: 109,
+		PAGE_DOWN: 34,
+		PAGE_UP: 33,
+		PERIOD: 190,
+		RIGHT: 39,
+		SPACE: 32,
+		TAB: 9,
+		UP: 38
+	},
+
+	buttonCode: {
+		LEFT: 0,
+		MIDDLE: 1,
+		RIGHT: 2
+	}
+});
+
+$.extend( $.simulate.prototype, {
+
+	simulateEvent: function( elem, type, options ) {
+		var event = this.createEvent( type, options );
+		this.dispatchEvent( elem, type, event, options );
+	},
+
+	createEvent: function( type, options ) {
+		if ( rkeyEvent.test( type ) ) {
+			return this.keyEvent( type, options );
+		}
+
+		if ( rmouseEvent.test( type ) ) {
+			return this.mouseEvent( type, options );
+		}
+	},
+
+	mouseEvent: function( type, options ) {
+		var event, eventDoc, doc, body;
+		options = $.extend({
+			bubbles: true,
+			cancelable: (type !== "mousemove"),
+			view: window,
+			detail: 0,
+			screenX: 0,
+			screenY: 0,
+			clientX: 1,
+			clientY: 1,
+			ctrlKey: false,
+			altKey: false,
+			shiftKey: false,
+			metaKey: false,
+			button: 0,
+			relatedTarget: undefined
+		}, options );
+
+		if ( document.createEvent ) {
+			event = document.createEvent( "MouseEvents" );
+			event.initMouseEvent( type, options.bubbles, options.cancelable,
+				options.view, options.detail,
+				options.screenX, options.screenY, options.clientX, options.clientY,
+				options.ctrlKey, options.altKey, options.shiftKey, options.metaKey,
+				options.button, options.relatedTarget || document.body.parentNode );
+
+			// IE 9+ creates events with pageX and pageY set to 0.
+			// Trying to modify the properties throws an error,
+			// so we define getters to return the correct values.
+			if ( event.pageX === 0 && event.pageY === 0 && Object.defineProperty ) {
+				eventDoc = event.relatedTarget.ownerDocument || document;
+				doc = eventDoc.documentElement;
+				body = eventDoc.body;
+
+				Object.defineProperty( event, "pageX", {
+					get: function() {
+						return options.clientX +
+							( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) -
+							( doc && doc.clientLeft || body && body.clientLeft || 0 );
+					}
+				});
+				Object.defineProperty( event, "pageY", {
+					get: function() {
+						return options.clientY +
+							( doc && doc.scrollTop || body && body.scrollTop || 0 ) -
+							( doc && doc.clientTop || body && body.clientTop || 0 );
+					}
+				});
+			}
+		} else if ( document.createEventObject ) {
+			event = document.createEventObject();
+			$.extend( event, options );
+			// standards event.button uses constants defined here: http://msdn.microsoft.com/en-us/library/ie/ff974877(v=vs.85).aspx
+			// old IE event.button uses constants defined here: http://msdn.microsoft.com/en-us/library/ie/ms533544(v=vs.85).aspx
+			// so we actually need to map the standard back to oldIE
+			event.button = {
+				0: 1,
+				1: 4,
+				2: 2
+			}[ event.button ] || event.button;
+		}
+
+		return event;
+	},
+
+	keyEvent: function( type, options ) {
+		var event;
+		options = $.extend({
+			bubbles: true,
+			cancelable: true,
+			view: window,
+			ctrlKey: false,
+			altKey: false,
+			shiftKey: false,
+			metaKey: false,
+			keyCode: 0,
+			charCode: undefined
+		}, options );
+
+		if ( document.createEvent ) {
+			try {
+				event = document.createEvent( "KeyEvents" );
+				event.initKeyEvent( type, options.bubbles, options.cancelable, options.view,
+					options.ctrlKey, options.altKey, options.shiftKey, options.metaKey,
+					options.keyCode, options.charCode );
+			// initKeyEvent throws an exception in WebKit
+			// see: http://stackoverflow.com/questions/6406784/initkeyevent-keypress-only-works-in-firefox-need-a-cross-browser-solution
+			// and also https://bugs.webkit.org/show_bug.cgi?id=13368
+			// fall back to a generic event until we decide to implement initKeyboardEvent
+			} catch( err ) {
+				event = document.createEvent( "Events" );
+				event.initEvent( type, options.bubbles, options.cancelable );
+				$.extend( event, {
+					view: options.view,
+					ctrlKey: options.ctrlKey,
+					altKey: options.altKey,
+					shiftKey: options.shiftKey,
+					metaKey: options.metaKey,
+					keyCode: options.keyCode,
+					charCode: options.charCode
+				});
+			}
+		} else if ( document.createEventObject ) {
+			event = document.createEventObject();
+			$.extend( event, options );
+		}
+
+		if ( !!/msie [\w.]+/.exec( navigator.userAgent.toLowerCase() ) || (({}).toString.call( window.opera ) === "[object Opera]") ) {
+			event.keyCode = (options.charCode > 0) ? options.charCode : options.keyCode;
+			event.charCode = undefined;
+		}
+
+		return event;
+	},
+
+	dispatchEvent: function( elem, type, event ) {
+		if ( elem.dispatchEvent ) {
+			elem.dispatchEvent( event );
+		} else if ( elem.fireEvent ) {
+			elem.fireEvent( "on" + type, event );
+		}
+	},
+
+	simulateFocus: function() {
+		var focusinEvent,
+			triggered = false,
+			element = $( this.target );
+
+		function trigger() {
+			triggered = true;
+		}
+
+		element.bind( "focus", trigger );
+		element[ 0 ].focus();
+
+		if ( !triggered ) {
+			focusinEvent = $.Event( "focusin" );
+			focusinEvent.preventDefault();
+			element.trigger( focusinEvent );
+			element.triggerHandler( "focus" );
+		}
+		element.unbind( "focus", trigger );
+	},
+
+	simulateBlur: function() {
+		var focusoutEvent,
+			triggered = false,
+			element = $( this.target );
+
+		function trigger() {
+			triggered = true;
+		}
+
+		element.bind( "blur", trigger );
+		element[ 0 ].blur();
+
+		// blur events are async in IE
+		setTimeout(function() {
+			// IE won't let the blur occur if the window is inactive
+			if ( element[ 0 ].ownerDocument.activeElement === element[ 0 ] ) {
+				element[ 0 ].ownerDocument.body.focus();
+			}
+
+			// Firefox won't trigger events if the window is inactive
+			// IE doesn't trigger events if we had to manually focus the body
+			if ( !triggered ) {
+				focusoutEvent = $.Event( "focusout" );
+				focusoutEvent.preventDefault();
+				element.trigger( focusoutEvent );
+				element.triggerHandler( "blur" );
+			}
+			element.unbind( "blur", trigger );
+		}, 1 );
+	}
+});
+
+
+
+/** complex events **/
+
+function findCenter( elem ) {
+	var offset,
+		document = $( elem.ownerDocument );
+	elem = $( elem );
+	offset = elem.offset();
+
+	return {
+		x: offset.left + elem.outerWidth() / 2 - document.scrollLeft(),
+		y: offset.top + elem.outerHeight() / 2 - document.scrollTop()
+	};
+}
+
+$.extend( $.simulate.prototype, {
+	simulateDrag: function() {
+		var i = 0,
+			target = this.target,
+			options = this.options,
+			center = findCenter( target ),
+			x = Math.floor( center.x ),
+			y = Math.floor( center.y ),
+			dx = options.dx || 0,
+			dy = options.dy || 0,
+			moves = options.moves || 3,
+			coord = { clientX: x, clientY: y };
+
+		this.simulateEvent( target, "mousedown", coord );
+
+		for ( ; i < moves ; i++ ) {
+			x += dx / moves;
+			y += dy / moves;
+
+			coord = {
+				clientX: Math.round( x ),
+				clientY: Math.round( y )
+			};
+
+			this.simulateEvent( document, "mousemove", coord );
+		}
+
+		this.simulateEvent( target, "mouseup", coord );
+		this.simulateEvent( target, "click", coord );
+	}
+});
+
+})( jQuery );
\ No newline at end of file

lms/templates/vert_module.html

+<%!
+from django.utils.translation import ugettext as _
+%>
 <div class="vert-mod">
-% for idx, item in enumerate(items):
-  <div class="vert vert-${idx}" data-id="${item['id']}">
-    ${item['content']}
-  </div>
-% endfor
+    <ol class="vertical-container">
+        % for idx, item in enumerate(items):
+        <li class="vertical-element">
+            <div class="vert vert-${idx}" data-id="${item['id']}">
+                <span data-tooltip="${_('Drag to reorder')}" class="drag-handle action"></span>
+                ${item['content']}
+            </div>
+        </li>
+        % endfor
+    </ol>
 </div>