X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/DragTracker.html diff --git a/docs/source/DragTracker.html b/docs/source/DragTracker.html index 7adf88a8..ccd84a0e 100644 --- a/docs/source/DragTracker.html +++ b/docs/source/DragTracker.html @@ -3,8 +3,8 @@ The source code - - + + @@ -33,16 +33,14 @@ Ext.define('Ext.dd.DragTracker', { }, /** - * @property active - * @type Boolean + * @property {Boolean} active * Read-only property indicated whether the user is currently dragging this * tracker. */ active: false, /** - * @property dragTarget - * @type HtmlElement + * @property {HTMLElement} dragTarget * <p><b>Only valid during drag operations. Read-only.</b></p> * <p>The element being dragged.</p> * <p>If the {@link #delegate} option is used, this will be the delegate element which was mousedowned.</p> @@ -64,7 +62,7 @@ Ext.define('Ext.dd.DragTracker', { */ /** - * @cfg {Ext.util.Region/Element} constrainTo + * @cfg {Ext.util.Region/Ext.Element} constrainTo * <p>A {@link Ext.util.Region Region} (Or an element from which a Region measurement will be read) which is used to constrain * the result of the {@link #getOffset} call.</p> * <p>This may be set any time during the DragTracker's lifecycle to set a dynamic constraining region.</p> @@ -110,7 +108,7 @@ Ext.define('Ext.dd.DragTracker', { * used, when the mouse enters a delegate element).</p> * @param {Object} this * @param {Object} e event object - * @param {HtmlElement} target The element mouseovered. + * @param {HTMLElement} target The element mouseovered. */ 'mouseover', @@ -192,7 +190,7 @@ Ext.define('Ext.dd.DragTracker', { /** * Initializes the DragTracker on a given element. - * @param {Ext.core.Element/HTMLElement} el The element + * @param {Ext.Element/HTMLElement} el The element */ initEl: function(el) { this.el = Ext.get(el); @@ -329,7 +327,7 @@ Ext.define('Ext.dd.DragTracker', { } } - // Returning false from a mousemove listener deactivates + // Returning false from a mousemove listener deactivates if (this.fireEvent('mousemove', this, e) === false) { this.onMouseUp(e); } else { @@ -400,6 +398,7 @@ Ext.define('Ext.dd.DragTracker', { * Template method which should be overridden by each DragTracker instance. Called when the user first clicks and * holds the mouse button down. Return false to disallow the drag * @param {Ext.EventObject} e The event object + * @template */ onBeforeStart : function(e) { @@ -409,6 +408,7 @@ Ext.define('Ext.dd.DragTracker', { * Template method which should be overridden by each DragTracker instance. Called when a drag operation starts * (e.g. the user has moved the tracked element beyond the specified tolerance) * @param {Ext.EventObject} e The event object + * @template */ onStart : function(xy) { @@ -417,6 +417,7 @@ Ext.define('Ext.dd.DragTracker', { /** * Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected. * @param {Ext.EventObject} e The event object + * @template */ onDrag : function(e) { @@ -426,6 +427,7 @@ Ext.define('Ext.dd.DragTracker', { * Template method which should be overridden by each DragTracker instance. Called when a drag operation has been completed * (e.g. the user clicked and held the mouse down, dragged the element and then released the mouse button) * @param {Ext.EventObject} e The event object + * @template */ onEnd : function(e) { @@ -435,7 +437,7 @@ Ext.define('Ext.dd.DragTracker', { * </p>Returns the drag target. This is usually the DragTracker's encapsulating element.</p> * <p>If the {@link #delegate} option is being used, this may be a child element which matches the * {@link #delegate} selector.</p> - * @return {Ext.core.Element} The element currently being tracked. + * @return {Ext.Element} The element currently being tracked. */ getDragTarget : function(){ return this.dragTarget; @@ -443,7 +445,7 @@ Ext.define('Ext.dd.DragTracker', { /** * @private - * @returns {Element} The DragTracker's encapsulating element. + * @returns {Ext.Element} The DragTracker's encapsulating element. */ getDragCt : function(){ return this.el; @@ -476,19 +478,21 @@ Ext.define('Ext.dd.DragTracker', { }, /** - * <p>Returns the X, Y offset of the current mouse position from the mousedown point.</p> - * <p>This method may optionally constrain the real offset values, and returns a point coerced in one - * of two modes:</p><ul> - * <li><code>point</code><div class="sub-desc">The current mouse position is coerced into the - * {@link #constrainRegion}, and the resulting position is returned.</div></li> - * <li><code>dragTarget</code><div class="sub-desc">The new {@link Ext.util.Region Region} of the - * {@link #getDragTarget dragTarget} is calculated based upon the current mouse position, and then - * coerced into the {@link #constrainRegion}. The returned mouse position is then adjusted by the - * same delta as was used to coerce the region.</div></li> - * </ul> - * @param constrainMode {String} Optional. If omitted the true mouse position is returned. May be passed - * as <code>'point'</code> or <code>'dragTarget'. See above.</code>. - * @returns {Array} The <code>X, Y</code> offset from the mousedown point, optionally constrained. + * Returns the X, Y offset of the current mouse position from the mousedown point. + * + * This method may optionally constrain the real offset values, and returns a point coerced in one + * of two modes: + * + * - `point` + * The current mouse position is coerced into the constrainRegion and the resulting position is returned. + * - `dragTarget` + * The new {@link Ext.util.Region Region} of the {@link #getDragTarget dragTarget} is calculated + * based upon the current mouse position, and then coerced into the constrainRegion. The returned + * mouse position is then adjusted by the same delta as was used to coerce the region.\ + * + * @param constrainMode {String} (Optional) If omitted the true mouse position is returned. May be passed + * as `point` or `dragTarget`. See above. + * @returns {Number[]} The `X, Y` offset from the mousedown point, optionally constrained. */ getOffset : function(constrain){ var xy = this.getXY(constrain),