dd-drop-debug.js revision 76ca635d61eb3f9fb7c9d788a44fa8b1690aa138
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Provides the ability to create a Drop Target.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @module dd
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @submodule dd-drop
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Provides the ability to create a Drop Target.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @class Drop
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @extends Base
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @constructor
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @namespace DD
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @event drop:over
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Fires when a drag element is over this target.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} event An Event Facade object with the following specific property added:
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>drop</dt><dd>The drop object at the time of the event.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>drag</dt><dd>The drag object at the time of the event.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @bubbles DDM
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type {CustomEvent}
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @event drop:enter
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Fires when a drag element enters this target.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} event An Event Facade object with the following specific property added:
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>drop</dt><dd>The drop object at the time of the event.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>drag</dt><dd>The drag object at the time of the event.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @bubbles DDM
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type {CustomEvent}
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @event drop:exit
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Fires when a drag element exits this target.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} event An Event Facade object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @bubbles DDM
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type {CustomEvent}
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @event drop:hit
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Fires when a draggable node is dropped on this Drop Target. (Fired from dd-ddm-drop)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} event An Event Facade object with the following specific property added:
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>drop</dt><dd>The best guess on what was dropped on.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>drag</dt><dd>The drag object at the time of the event.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>others</dt><dd>An array of all the other drop targets that was dropped on.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @bubbles DDM
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type {CustomEvent}
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Drop = function() {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Drop.superclass.constructor.apply(this, arguments);
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //DD init speed up.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (Dom.getStyle(this.el, 'position') == 'fixed') {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Event.on(window, 'scroll', function() {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.activateShim();
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass }, this, true);
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @attribute node
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Y.Node instanace to use as the element to make a Drop Target
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Node
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @attribute groups
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Array of groups to add this drop into.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Array
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass setter: function(g) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Y.each(g, function(v, k) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this._groups[v] = true;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @attribute padding
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description CSS style padding to make the Drop Target bigger than the node.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type String
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass setter: function(p) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @attribute lock
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Set to lock this drop element.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Boolean
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).addClass(DDM.CSS_PREFIX + '-drop-locked');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).removeClass(DDM.CSS_PREFIX + '-drop-locked');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @deprecated
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @attribute bubbles
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Controls the default bubble parent for this Drop instance. Default: Y.DD.DDM. Set to false to disable bubbling. Use bubbleTargets in config.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass setter: function(t) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Y.log('bubbles is deprecated use bubbleTargets: HOST', 'warn', 'dd');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @deprecated
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @attribute useShim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Use the Drop shim. Default: true
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Boolean
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass setter: function(v) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @property _bubbleTargets
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description The default bubbleTarget for this object. Default: Y.DD.DDM
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method addToGroup
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Add this Drop instance to a group, this should be used for on-the-fly group additions.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {String} g The group to add this Drop Instance to.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return {Self}
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @chainable
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass addToGroup: function(g) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this._groups[g] = true;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return this;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method removeFromGroup
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Remove this Drop instance from a group, this should be used for on-the-fly group removals.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {String} g The group to remove this Drop Instance from.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return {Self}
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @chainable
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass removeFromGroup: function(g) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass delete this._groups[g];
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return this;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _createEvents
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description This method creates all the events for this Event Target and publishes them so we get Event Bubbling.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @property _valid
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Flag for determining if the target is valid in this operation.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Boolean
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @property _groups
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description The groups this target belongs to.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Array
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @property shim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Node reference to the targets shim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type {Object}
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @property region
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description A region object associated with this target, used for checking regions while dragging.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @property overTarget
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description This flag is tripped when a drag element is over this target.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Boolean
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method inGroup
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Check if this target is in one of the supplied groups.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {Array} groups The groups to check against
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return Boolean
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this._valid = false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass var ret = false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (this._groups[v]) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this._valid = true;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method initializer
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Private lifecycle method
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //Shouldn't have to do this..
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method destructor
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Lifecycle destructor, unreg the drag from the DDM and remove listeners
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass destructor: function() {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (this.shim && (this.shim !== this.get(NODE))) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.shim = null;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).removeClass(DDM.CSS_PREFIX + '-drop');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _deactivateShim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Removes classes from the target, resets some flags and sets the shims deactive position [-999, -999]
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (!this.shim) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).removeClass(DDM.CSS_PREFIX + '-drop-active-valid');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).removeClass(DDM.CSS_PREFIX + '-drop-active-invalid');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).removeClass(DDM.CSS_PREFIX + '-drop-over');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.overTarget = false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _activateShim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Activates the shim and adds some interaction CSS classes
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false; //Nothing is dragging, no reason to activate.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (this.get(NODE) === DDM.activeDrag.get(NODE)) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //TODO Visibility Check..
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //if (this.inGroup(DDM.activeDrag.get('groups')) && this.get(NODE).isVisible()) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass node.removeClass(DDM.CSS_PREFIX + '-drop-active-invalid');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass node.addClass(DDM.CSS_PREFIX + '-drop-active-valid');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.overTarget = false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass node.removeClass(DDM.CSS_PREFIX + '-drop-active-valid');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass node.addClass(DDM.CSS_PREFIX + '-drop-active-invalid');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method sizeShim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Positions and sizes the shim with the raw data from the node, this can be used to programatically adjust the Targets shim for Animation..
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass sizeShim: function() {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false; //Nothing is dragging, no reason to activate.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (this.get(NODE) === DDM.activeDrag.get(NODE)) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //if (this.get('lock') || !this.get('useShim')) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (!this.shim) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //Apply padding
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (DDM.activeDrag.get('dragMode') === DDM.INTERSECT) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //Intersect Mode, make the shim bigger
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //Set the style on the shim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //Create the region to be used by intersect when a drag node is over us.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _createShim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Creates the Target shim and adds it to the DDM's playground..
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass _createShim: function() {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //No playground, defer
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //Shim already here, cancel
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass s = Y.Node.create('<div id="' + this.get(NODE).get('id') + '_shim"></div>');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass s.on('mouseover', Y.bind(this._handleOverEvent, this));
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass s.on('mouseout', Y.bind(this._handleOutEvent, this));
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _handleOverTarget
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description This handles the over target call made from this object or from the DDM
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).addClass(DDM.CSS_PREFIX + '-drop-over');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass DDM.activeDrag.fire('drag:over', { drop: this, drag: DDM.activeDrag });
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.fire(EV_DROP_OVER, { drop: this, drag: DDM.activeDrag });
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //Prevent an enter before a start..
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.fire(EV_DROP_ENTER, { drop: this, drag: DDM.activeDrag });
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass DDM.activeDrag.fire('drag:enter', { drop: this, drag: DDM.activeDrag });
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass DDM.activeDrag.get(NODE).addClass(DDM.CSS_PREFIX + '-drag-over');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //TODO - Is this needed??
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass //DDM._handleTargetOver();
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _handleOverEvent
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Handles the mouseover DOM event on the Target Shim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _handleOutEvent
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Handles the mouseout DOM event on the Target Shim
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _handleOut
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @description Handles out of target calls/checks
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.overTarget = false;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass this.get(NODE).removeClass(DDM.CSS_PREFIX + '-drop-over');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass DDM.activeDrag.get(NODE).removeClass(DDM.CSS_PREFIX + '-drag-over');
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass}, '@VERSION@' ,{skinnable:false, requires:['dd-ddm-drop', 'dd-drag']});