Upgrade to ExtJS 3.3.1 - Released 11/30/2010
[extjs.git] / docs / source / DDCore.html
index f7ddb0c..3d733c2 100644 (file)
@@ -1,12 +1,18 @@
-<html>\r
-<head>\r
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js">/*
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
+ */
+/*
  * These classes are derivatives of the similarly named classes in the YUI Library.
  * The original license:
  * Copyright (c) 2006, Yahoo! Inc. All rights reserved.
  * These classes are derivatives of the similarly named classes in the YUI Library.
  * The original license:
  * Copyright (c) 2006, Yahoo! Inc. All rights reserved.
@@ -98,7 +104,7 @@ Ext.dd.DragDrop.prototype = {
 
     /**
      * The id of the element that will be dragged.  By default this is same
 
     /**
      * The id of the element that will be dragged.  By default this is same
-     * as the linked element , but could be changed to another element. Ex:
+     * as the linked element, but could be changed to another element. Ex:
      * Ext.dd.DDProxy
      * @property dragElId
      * @type String
      * Ext.dd.DDProxy
      * @property dragElId
      * @type String
@@ -189,7 +195,9 @@ Ext.dd.DragDrop.prototype = {
      * Lock this instance
      * @method lock
      */
      * Lock this instance
      * @method lock
      */
-    lock: function() { this.locked = true; },
+    lock: function() {
+        this.locked = true;
+    },
 
     <div id="prop-Ext.dd.DragDrop-moveOnly"></div>/**
      * When set to true, other DD objects in cooperating DDGroups do not receive
 
     <div id="prop-Ext.dd.DragDrop-moveOnly"></div>/**
      * When set to true, other DD objects in cooperating DDGroups do not receive
@@ -203,7 +211,9 @@ Ext.dd.DragDrop.prototype = {
      * Unlock this instace
      * @method unlock
      */
      * Unlock this instace
      * @method unlock
      */
-    unlock: function() { this.locked = false; },
+    unlock: function() {
+        this.locked = false;
+    },
 
     <div id="prop-Ext.dd.DragDrop-isTarget"></div>/**
      * By default, all instances can be a drop target.  This can be disabled by
 
     <div id="prop-Ext.dd.DragDrop-isTarget"></div>/**
      * By default, all instances can be a drop target.  This can be disabled by
@@ -271,7 +281,6 @@ Ext.dd.DragDrop.prototype = {
      * The up constraint
      * @property minY
      * @type int
      * The up constraint
      * @property minY
      * @type int
-     * @type int
      * @private
      */
     minY: 0,
      * @private
      */
     minY: 0,
@@ -323,7 +332,7 @@ Ext.dd.DragDrop.prototype = {
     primaryButtonOnly: true,
 
     <div id="prop-Ext.dd.DragDrop-available"></div>/**
     primaryButtonOnly: true,
 
     <div id="prop-Ext.dd.DragDrop-available"></div>/**
-     * The availabe property is false until the linked dom element is accessible.
+     * The available property is false until the linked dom element is accessible.
      * @property available
      * @type boolean
      */
      * @property available
      * @type boolean
      */
@@ -714,7 +723,6 @@ Ext.dd.DragDrop.prototype = {
         this.lastPageX = p[0];
         this.lastPageY = p[1];
 
         this.lastPageX = p[0];
         this.lastPageY = p[1];
 
-
         this.setStartPosition(p);
     },
 
         this.setStartPosition(p);
     },
 
@@ -856,7 +864,6 @@ Ext.dd.DragDrop.prototype = {
                 // set the initial element position
                 this.setStartPosition();
 
                 // set the initial element position
                 this.setStartPosition();
 
-
                 this.b4MouseDown(e);
                 this.onMouseDown(e);
 
                 this.b4MouseDown(e);
                 this.onMouseDown(e);
 
@@ -1107,8 +1114,6 @@ Ext.dd.DragDrop.prototype = {
      * @param {boolean} maintainOffset
      */
     resetConstraints: function() {
      * @param {boolean} maintainOffset
      */
     resetConstraints: function() {
-
-
         // Maintain offsets if necessary
         if (this.initPageX || this.initPageX === 0) {
             // figure out how much this thing has moved
         // Maintain offsets if necessary
         if (this.initPageX || this.initPageX === 0) {
             // figure out how much this thing has moved
@@ -1146,7 +1151,6 @@ Ext.dd.DragDrop.prototype = {
      * @private
      */
     getTick: function(val, tickArray) {
      * @private
      */
     getTick: function(val, tickArray) {
-
         if (!tickArray) {
             // If tick interval is not defined, it is effectively 1 pixel,
             // so we return the value passed to us.
         if (!tickArray) {
             // If tick interval is not defined, it is effectively 1 pixel,
             // so we return the value passed to us.
@@ -1183,7 +1187,7 @@ Ext.dd.DragDrop.prototype = {
 };
 
 })();
 };
 
 })();
-<div id="prop-Ext.dd.DragDrop-Only"></div>/**
+/*
  * The drag and drop utility provides a framework for building drag and drop
  * applications.  In addition to enabling drag and drop for specific elements,
  * the drag and drop elements are tracked by the manager class, and the
  * The drag and drop utility provides a framework for building drag and drop
  * applications.  In addition to enabling drag and drop for specific elements,
  * the drag and drop elements are tracked by the manager class, and the
@@ -1214,7 +1218,7 @@ Ext.dd.DragDropMgr = function() {
          * dimension is the DragDrop item group, the second the DragDrop
          * object.
          * @property ids
          * dimension is the DragDrop item group, the second the DragDrop
          * object.
          * @property ids
-         * @type {string: string}
+         * @type String[]
          * @private
          * @static
          */
          * @private
          * @static
          */
@@ -1225,7 +1229,7 @@ Ext.dd.DragDropMgr = function() {
          * if the element that generated the mousedown event is actually the
          * handle and not the html element itself.
          * @property handleIds
          * if the element that generated the mousedown event is actually the
          * handle and not the html element itself.
          * @property handleIds
-         * @type {string: string}
+         * @type String[]
          * @private
          * @static
          */
          * @private
          * @static
          */
@@ -1595,8 +1599,8 @@ Ext.dd.DragDropMgr = function() {
          * Returns true if the specified dd target is a legal target for
          * the specifice drag obj
          * @method isLegalTarget
          * Returns true if the specified dd target is a legal target for
          * the specifice drag obj
          * @method isLegalTarget
-         * @param {DragDrop} the drag obj
-         * @param {DragDrop} the target
+         * @param {DragDrop} oDD the drag obj
+         * @param {DragDrop} oTargetDD the target
          * @return {boolean} true if the target is a legal target for the
          * dd obj
          * @static
          * @return {boolean} true if the target is a legal target for the
          * dd obj
          * @static
@@ -1668,7 +1672,7 @@ Ext.dd.DragDropMgr = function() {
          */
         handleMouseDown: function(e, oDD) {
             if(Ext.QuickTips){
          */
         handleMouseDown: function(e, oDD) {
             if(Ext.QuickTips){
-                Ext.QuickTips.disable();
+                Ext.QuickTips.ddDisable();
             }
             if(this.dragCurrent){
                 // the original browser mouseup wasn't handled (e.g. outside FF browser window)
             }
             if(this.dragCurrent){
                 // the original browser mouseup wasn't handled (e.g. outside FF browser window)
@@ -1726,7 +1730,7 @@ Ext.dd.DragDropMgr = function() {
         handleMouseUp: function(e) {
 
             if(Ext.QuickTips){
         handleMouseUp: function(e) {
 
             if(Ext.QuickTips){
-                Ext.QuickTips.enable();
+                Ext.QuickTips.ddEnable();
             }
             if (! this.dragCurrent) {
                 return;
             }
             if (! this.dragCurrent) {
                 return;
@@ -2268,32 +2272,32 @@ Ext.dd.DragDropMgr = function() {
             return (el) ? el.style : null;
         },
 
             return (el) ? el.style : null;
         },
 
-        <div id="cls-DragDropMgr.ElementWrapper"></div>/**
+        <div id="cls-Ext.dd.DragDropMgr.ElementWrapper"></div>/**
          * Inner class for cached elements
          * Inner class for cached elements
-         * @class DragDropMgr.ElementWrapper
+         * @class Ext.dd.DragDropMgr.ElementWrapper
          * @for DragDropMgr
          * @private
          * @deprecated
          */
         ElementWrapper: function(el) {
          * @for DragDropMgr
          * @private
          * @deprecated
          */
         ElementWrapper: function(el) {
-                <div id="prop-DragDropMgr.ElementWrapper-el"></div>/**
+                <div id="prop-Ext.dd.DragDropMgr.ElementWrapper-el"></div>/**
                  * The element
                  * @property el
                  */
                 this.el = el || null;
                  * The element
                  * @property el
                  */
                 this.el = el || null;
-                <div id="prop-DragDropMgr.ElementWrapper-id"></div>/**
+                <div id="prop-Ext.dd.DragDropMgr.ElementWrapper-id"></div>/**
                  * The element id
                  * @property id
                  */
                 this.id = this.el && el.id;
                  * The element id
                  * @property id
                  */
                 this.id = this.el && el.id;
-                <div id="prop-DragDropMgr.ElementWrapper-css"></div>/**
+                <div id="prop-Ext.dd.DragDropMgr.ElementWrapper-css"></div>/**
                  * A reference to the style property
                  * @property css
                  */
                 this.css = this.el && el.style;
             },
 
                  * A reference to the style property
                  * @property css
                  */
                 this.css = this.el && el.style;
             },
 
-        <div id="method-DragDropMgr.ElementWrapper-getPosX"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-getPosX"></div>/**
          * Returns the X position of an html element
          * @method getPosX
          * @param el the element for which to get the position
          * Returns the X position of an html element
          * @method getPosX
          * @param el the element for which to get the position
@@ -2306,7 +2310,7 @@ Ext.dd.DragDropMgr = function() {
             return Ext.lib.Dom.getX(el);
         },
 
             return Ext.lib.Dom.getX(el);
         },
 
-        <div id="method-DragDropMgr.ElementWrapper-getPosY"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-getPosY"></div>/**
          * Returns the Y position of an html element
          * @method getPosY
          * @param el the element for which to get the position
          * Returns the Y position of an html element
          * @method getPosY
          * @param el the element for which to get the position
@@ -2318,7 +2322,7 @@ Ext.dd.DragDropMgr = function() {
             return Ext.lib.Dom.getY(el);
         },
 
             return Ext.lib.Dom.getY(el);
         },
 
-        <div id="method-DragDropMgr.ElementWrapper-swapNode"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-swapNode"></div>/**
          * Swap two nodes.  In IE, we use the native method, for others we
          * emulate the IE behavior
          * @method swapNode
          * Swap two nodes.  In IE, we use the native method, for others we
          * emulate the IE behavior
          * @method swapNode
@@ -2364,7 +2368,7 @@ Ext.dd.DragDropMgr = function() {
             return { top: t, left: l };
         },
 
             return { top: t, left: l };
         },
 
-        <div id="method-DragDropMgr.ElementWrapper-getStyle"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-getStyle"></div>/**
          * Returns the specified element style property
          * @method getStyle
          * @param {HTMLElement} el          the element
          * Returns the specified element style property
          * @method getStyle
          * @param {HTMLElement} el          the element
@@ -2377,23 +2381,27 @@ Ext.dd.DragDropMgr = function() {
             return Ext.fly(el).getStyle(styleProp);
         },
 
             return Ext.fly(el).getStyle(styleProp);
         },
 
-        <div id="method-DragDropMgr.ElementWrapper-getScrollTop"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-getScrollTop"></div>/**
          * Gets the scrollTop
          * @method getScrollTop
          * @return {int} the document's scrollTop
          * @static
          */
          * Gets the scrollTop
          * @method getScrollTop
          * @return {int} the document's scrollTop
          * @static
          */
-        getScrollTop: function () { return this.getScroll().top; },
+        getScrollTop: function () {
+            return this.getScroll().top;
+        },
 
 
-        <div id="method-DragDropMgr.ElementWrapper-getScrollLeft"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-getScrollLeft"></div>/**
          * Gets the scrollLeft
          * @method getScrollLeft
          * @return {int} the document's scrollTop
          * @static
          */
          * Gets the scrollLeft
          * @method getScrollLeft
          * @return {int} the document's scrollTop
          * @static
          */
-        getScrollLeft: function () { return this.getScroll().left; },
+        getScrollLeft: function () {
+            return this.getScroll().left;
+        },
 
 
-        <div id="method-DragDropMgr.ElementWrapper-moveToEl"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-moveToEl"></div>/**
          * Sets the x/y position of an element to the location of the
          * target element.
          * @method moveToEl
          * Sets the x/y position of an element to the location of the
          * target element.
          * @method moveToEl
@@ -2406,12 +2414,14 @@ Ext.dd.DragDropMgr = function() {
             Ext.lib.Dom.setXY(moveEl, aCoord);
         },
 
             Ext.lib.Dom.setXY(moveEl, aCoord);
         },
 
-        <div id="method-DragDropMgr.ElementWrapper-numericSort"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-numericSort"></div>/**
          * Numeric array sort function
          * @method numericSort
          * @static
          */
          * Numeric array sort function
          * @method numericSort
          * @static
          */
-        numericSort: function(a, b) { return (a - b); },
+        numericSort: function(a, b) {
+            return (a - b);
+        },
 
         /**
          * Internal counter
 
         /**
          * Internal counter
@@ -2443,7 +2453,7 @@ Ext.dd.DragDropMgr = function() {
             }
         },
 
             }
         },
 
-        <div id="method-DragDropMgr.ElementWrapper-handleWasClicked"></div>/**
+        <div id="method-Ext.dd.DragDropMgr.ElementWrapper-handleWasClicked"></div>/**
          * Recursively searches the immediate parent and all child nodes for
          * the handle element in order to determine wheter or not it was
          * clicked.
          * Recursively searches the immediate parent and all child nodes for
          * the handle element in order to determine wheter or not it was
          * clicked.
@@ -2686,8 +2696,6 @@ Ext.extend(Ext.dd.DD, Ext.dd.DragDrop, {
      * @private
      */
     getTargetCoord: function(iPageX, iPageY) {
      * @private
      */
     getTargetCoord: function(iPageX, iPageY) {
-
-
         var x = iPageX - this.deltaX;
         var y = iPageY - this.deltaY;
 
         var x = iPageX - this.deltaX;
         var y = iPageY - this.deltaY;
 
@@ -3155,6 +3163,6 @@ Ext.extend(Ext.dd.DDTarget, Ext.dd.DragDrop, {
     toString: function() {
         return ("DDTarget " + this.id);
     }
     toString: function() {
         return ("DDTarget " + this.id);
     }
-});</pre>    \r
-</body>\r
+});</pre>    
+</body>
 </html>
\ No newline at end of file
 </html>
\ No newline at end of file