8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @submodule dd-constrain
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * Plugin for the dd-drag module to add the constraining methods to it. It supports constraining to a node or viewport. It supports tick based moves and XY axis constraints.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @class DDConstrained
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @extends Base
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @constructor
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @namespace Plugin
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @event drag:tickAlignX
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Fires when this node is aligned with the tickX value.
2fc36119bc0bdb70a4dabc6e0365bb1fdfe9f56cDav Glass * @param {EventFacade} event An Event Facade object
2fc36119bc0bdb70a4dabc6e0365bb1fdfe9f56cDav Glass * @type {CustomEvent}
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @event drag:tickAlignY
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Fires when this node is aligned with the tickY value.
2fc36119bc0bdb70a4dabc6e0365bb1fdfe9f56cDav Glass * @param {EventFacade} event An Event Facade object
2fc36119bc0bdb70a4dabc6e0365bb1fdfe9f56cDav Glass * @type {CustomEvent}
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren C = function(config) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren C.superclass.constructor.apply(this, arguments);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @property NS
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @default con
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description The Constrained instance will be placed on the Drag instance under the con namespace.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type {String}
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute stickX
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Stick the drag movement to the X-Axis. Default: false
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Boolean
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute stickY
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Stick the drag movement to the Y-Axis
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Boolean
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute tickX
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description The X tick offset the drag node should snap to on each drag move. False for no ticks. Default: false
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute tickY
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description The Y tick offset the drag node should snap to on each drag move. False for no ticks. Default: false
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute tickXArray
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description An array of page coordinates to use as X ticks for drag movement.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Array
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute tickYArray
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description An array of page coordinates to use as Y ticks for drag movement.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Array
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute gutter
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description CSS style string for the gutter of a region (supports negative values): '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type String
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute constrain
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Will attempt to constrain the drag node to the boundaries. Arguments:<br>
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * 'view': Contrain to Viewport<br>
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * '#selector_string': Constrain to this node<br>
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * '{Region Object}': An Object Literal containing a valid region (top, right, bottom, left) of page positions
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @deprecated
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute constrain2region
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description An Object Literal containing a valid region (top, right, bottom, left) of page positions to constrain the drag node to.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Object
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren setter: function(r) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @deprecated
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute constrain2node
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Will attempt to constrain the drag node to the boundaries of this node.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Object
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren setter: function(n) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @deprecated
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute constrain2view
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Will attempt to constrain the drag node to the boundaries of the viewport region.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Object
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren setter: function(n) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @attribute cacheRegion
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Should the region be cached for performace. Default: true
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Boolean
1733ad5823502d24c084b74ae60d838307d23dc0Eduardo Lundgren this.get(HOST).on('drag:end', Y.bind(this._handleEnd, this));
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren this.get(HOST).on('drag:start', Y.bind(this._handleStart, this));
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren this.get(HOST).after('drag:align', Y.bind(this.align, this));
d6ed13752962e9de0d6dc030db3f1bcf54e6e540Eduardo Lundgren this.get(HOST).after('drag:drag', Y.bind(this.drag, this));
c953b35401f84d66214418b1a5560e811a2e69cdDav Glass destructor: function() {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _createEvents
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description This method creates all the events for this Event Target and publishes them so we get Event Bubbling.
1733ad5823502d24c084b74ae60d838307d23dc0Eduardo Lundgren * @method _handleEnd
1733ad5823502d24c084b74ae60d838307d23dc0Eduardo Lundgren * @description Fires on drag:end
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _handleStart
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Fires on drag:start and clears the _regionCache
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @property _regionCache
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Store a cache of the region that we are constraining to
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @type Object
c953b35401f84d66214418b1a5560e811a2e69cdDav Glass * Event handle for window resize event.
c953b35401f84d66214418b1a5560e811a2e69cdDav Glass * @property _cacheHandle
c953b35401f84d66214418b1a5560e811a2e69cdDav Glass * @type {Event}
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _cacheRegion
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Get's the region and caches it, called from window.resize and when the cache is null
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren this._regionCache = this.get('constrain').get('region');
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method resetCache
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Reset the internal region cache.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _getConstraint
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Standardizes the 'constraint' attribute
c953b35401f84d66214418b1a5560e811a2e69cdDav Glass this._cacheHandle = Y.on('resize', Y.bind(this._cacheRegion, this), Y.config.win);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren region = this.get(HOST).get(DRAG_NODE).get('viewportRegion');
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren Y.each(g, function(i, n) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method getRegion
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Get the active region: viewport, node, custom region
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Boolean} inc Include the node's height and width
4076a4eaeee8100e1dcdda3b0acbd0caea5b7829Ryuichi Okumura * @return {Object} The active region.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren oh = host.get(DRAG_NODE).get(OFFSET_HEIGHT);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren ow = host.get(DRAG_NODE).get(OFFSET_WIDTH);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _checkRegion
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Check if xy is inside a given region, if not change to it be inside.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Array} _xy The XY to check if it's in the current region, if it isn't inside the region, it will reset the xy array to be inside the region.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @return {Array} The new XY that is inside the region
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren oh = host.get(DRAG_NODE).get(OFFSET_HEIGHT),
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren ow = host.get(DRAG_NODE).get(OFFSET_WIDTH);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method inRegion
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Checks if the XY passed or the dragNode is inside the active region.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Array} xy Optional XY to check, if not supplied this.get('dragNode').getXY() is used.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @return {Boolean} True if the XY is inside the region, false otherwise.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren xy = xy || this.get(HOST).get(DRAG_NODE).getXY();
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren var _xy = this._checkRegion([xy[0], xy[1]]),
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren if ((xy[0] === _xy[0]) && (xy[1] === _xy[1])) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method align
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Modifies the Drag.actXY method from the after drag:align event. This is where the constraining happens.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren r = this.getRegion(true);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren _xy[1] = (host.startXY[1] - host.deltaXY[1]);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren _xy[0] = (host.startXY[0] - host.deltaXY[0]);
d6ed13752962e9de0d6dc030db3f1bcf54e6e540Eduardo Lundgren * @method drag
d6ed13752962e9de0d6dc030db3f1bcf54e6e540Eduardo Lundgren * @description Fires after drag:drag. Handle the tickX and tickX align events.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren if ((Y.Lang.isNumber(xt) || this.get(TICK_X_ARRAY)) && (this._lastTickXFired !== _xy[0])) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren if ((Y.Lang.isNumber(yt) || this.get(TICK_Y_ARRAY)) && (this._lastTickYFired !== _xy[1])) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _checkTicks
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description This method delegates the proper helper method for tick calculations
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Array} xy The XY coords for the Drag
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Object} r The optional region that we are bound to.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @return {Array} The calced XY coords
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren xy[0] = DDM._calcTicks(xy[0], lx, xt, r[LEFT], r[RIGHT]);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren xy[1] = DDM._calcTicks(xy[1], ly, yt, r[TOP], r[BOTTOM]);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren xy[0] = DDM._calcTickArray(xy[0], this.get(TICK_X_ARRAY), r[LEFT], r[RIGHT]);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren xy[1] = DDM._calcTickArray(xy[1], this.get(TICK_Y_ARRAY), r[TOP], r[BOTTOM]);
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _tickAlignX
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Fires when the actXY[0] reach a new value respecting the tickX gap.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _tickAlignY
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Fires when the actXY[1] reach a new value respecting the tickY gap.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @namespace DD
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _calcTicks
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description Helper method to calculate the tick offsets for a given position
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} pos The current X or Y position
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} start The start X or Y position
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} tick The X or Y tick increment
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} off1 The min offset that we can't pass (region)
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} off2 The max offset that we can't pass (region)
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @return {Number} The new position based on the tick calculation
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren _calcTicks: function(pos, start, tick, off1, off2) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @namespace DD
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @method _calcTickArray
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @description This method is used with the tickXArray and tickYArray config options
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} pos The current X or Y position
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} ticks The array containing our custom tick positions.
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} off1 The min offset that we can't pass (region)
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @param {Number} off2 The max offset that we can't pass (region)
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren * @return The tick position
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren _calcTickArray: function(pos, ticks, off1, off2) {
8e7d713a6c785615b5688f96304ae151241dc885Eduardo Lundgren ret = (diff2 > diff1) ? ticks[i] : ticks[next];