Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / DD.html
index 52a7ff9..693d66c 100644 (file)
@@ -1,4 +1,21 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre>/*
+<!DOCTYPE html>
+<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>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js">/*
  * This is a derivative of the similarly named class in the YUI Library.
  * The original license:
  * Copyright (c) 2006, Yahoo! Inc. All rights reserved.
  */
 
 
-<span id='Ext-dd.DD-method-constructor'><span id='Ext-dd.DD'>/**
-</span></span> * @class Ext.dd.DD
+<span id='Ext-dd-DD'>/**
+</span> * @class Ext.dd.DD
  * A DragDrop implementation where the linked element follows the
  * mouse cursor during a drag.
  * @extends Ext.dd.DragDrop
- * @constructor
- * @param {String} id the id of the linked element
- * @param {String} sGroup the group of related DragDrop items
- * @param {object} config an object containing configurable attributes
- *                Valid properties for DD:
- *                    scroll
  */
-
 Ext.define('Ext.dd.DD', {
     extend: 'Ext.dd.DragDrop',
     requires: ['Ext.dd.DragDropManager'],
+
+<span id='Ext-dd-DD-method-constructor'>    /**
+</span>     * Creates new DD instance.
+     * @param {String} id the id of the linked element
+     * @param {String} sGroup the group of related DragDrop items
+     * @param {Object} config an object containing configurable attributes.
+     * Valid properties for DD: scroll
+     */
     constructor: function(id, sGroup, config) {
         if (id) {
             this.init(id, sGroup, config);
         }
     },
 
-<span id='Ext-dd.DD-property-scroll'>    /**
+<span id='Ext-dd-DD-property-scroll'>    /**
 </span>     * When set to true, the utility automatically tries to scroll the browser
      * window when a drag and drop element is dragged near the viewport boundary.
      * Defaults to true.
      * @property scroll
-     * @type boolean
+     * @type Boolean
      */
     scroll: true,
 
-<span id='Ext-dd.DD-method-autoOffset'>    /**
+<span id='Ext-dd-DD-method-autoOffset'>    /**
 </span>     * Sets the pointer offset to the distance between the linked element's top
      * left corner and the location the element was clicked
      * @method autoOffset
-     * @param {int} iPageX the X coordinate of the click
-     * @param {int} iPageY the Y coordinate of the click
+     * @param {Number} iPageX the X coordinate of the click
+     * @param {Number} iPageY the Y coordinate of the click
      */
     autoOffset: function(iPageX, iPageY) {
         var x = iPageX - this.startPageX;
@@ -51,27 +69,27 @@ Ext.define('Ext.dd.DD', {
         this.setDelta(x, y);
     },
 
-<span id='Ext-dd.DD-method-setDelta'>    /**
+<span id='Ext-dd-DD-method-setDelta'>    /**
 </span>     * Sets the pointer offset.  You can call this directly to force the
      * offset to be in a particular location (e.g., pass in 0,0 to set it
      * to the center of the object)
      * @method setDelta
-     * @param {int} iDeltaX the distance from the left
-     * @param {int} iDeltaY the distance from the top
+     * @param {Number} iDeltaX the distance from the left
+     * @param {Number} iDeltaY the distance from the top
      */
     setDelta: function(iDeltaX, iDeltaY) {
         this.deltaX = iDeltaX;
         this.deltaY = iDeltaY;
     },
 
-<span id='Ext-dd.DD-method-setDragElPos'>    /**
+<span id='Ext-dd-DD-method-setDragElPos'>    /**
 </span>     * Sets the drag element to the location of the mousedown or click event,
      * maintaining the cursor location relative to the location on the element
      * that was clicked.  Override this if you want to place the element in a
      * location other than where the cursor is.
      * @method setDragElPos
-     * @param {int} iPageX the X coordinate of the mousedown or drag event
-     * @param {int} iPageY the Y coordinate of the mousedown or drag event
+     * @param {Number} iPageX the X coordinate of the mousedown or drag event
+     * @param {Number} iPageY the Y coordinate of the mousedown or drag event
      */
     setDragElPos: function(iPageX, iPageY) {
         // the first time we do this, we are going to check to make sure
@@ -81,21 +99,21 @@ Ext.define('Ext.dd.DD', {
         this.alignElWithMouse(el, iPageX, iPageY);
     },
 
-<span id='Ext-dd.DD-method-alignElWithMouse'>    /**
+<span id='Ext-dd-DD-method-alignElWithMouse'>    /**
 </span>     * Sets the element to the location of the mousedown or click event,
      * maintaining the cursor location relative to the location on the element
      * that was clicked.  Override this if you want to place the element in a
      * location other than where the cursor is.
      * @method alignElWithMouse
      * @param {HTMLElement} el the element to move
-     * @param {int} iPageX the X coordinate of the mousedown or drag event
-     * @param {int} iPageY the Y coordinate of the mousedown or drag event
+     * @param {Number} iPageX the X coordinate of the mousedown or drag event
+     * @param {Number} iPageY the Y coordinate of the mousedown or drag event
      */
     alignElWithMouse: function(el, iPageX, iPageY) {
         var oCoord = this.getTargetCoord(iPageX, iPageY),
             fly = el.dom ? el : Ext.fly(el, '_dd'),
             elSize = fly.getSize(),
-            EL = Ext.core.Element,
+            EL = Ext.Element,
             vpSize;
 
         if (!this.deltaSetXY) {
@@ -121,14 +139,14 @@ Ext.define('Ext.dd.DD', {
         return oCoord;
     },
 
-<span id='Ext-dd.DD-method-cachePosition'>    /**
+<span id='Ext-dd-DD-method-cachePosition'>    /**
 </span>     * Saves the most recent position so that we can reset the constraints and
      * tick marks on-demand.  We need to know this so that we can calculate the
      * number of pixels the element is offset from its original position.
      * @method cachePosition
-     * @param iPageX the current x position (optional, this just makes it so we
+     * @param {Number} iPageX (optional) the current x position (this just makes it so we
      * don't have to look it up again)
-     * @param iPageY the current y position (optional, this just makes it so we
+     * @param {Number} iPageY (optional) the current y position (this just makes it so we
      * don't have to look it up again)
      */
     cachePosition: function(iPageX, iPageY) {
@@ -136,30 +154,30 @@ Ext.define('Ext.dd.DD', {
             this.lastPageX = iPageX;
             this.lastPageY = iPageY;
         } else {
-            var aCoord = Ext.core.Element.getXY(this.getEl());
+            var aCoord = Ext.Element.getXY(this.getEl());
             this.lastPageX = aCoord[0];
             this.lastPageY = aCoord[1];
         }
     },
 
-<span id='Ext-dd.DD-method-autoScroll'>    /**
+<span id='Ext-dd-DD-method-autoScroll'>    /**
 </span>     * Auto-scroll the window if the dragged object has been moved beyond the
      * visible window boundary.
      * @method autoScroll
-     * @param {int} x the drag element's x position
-     * @param {int} y the drag element's y position
-     * @param {int} h the height of the drag element
-     * @param {int} w the width of the drag element
+     * @param {Number} x the drag element's x position
+     * @param {Number} y the drag element's y position
+     * @param {Number} h the height of the drag element
+     * @param {Number} w the width of the drag element
      * @private
      */
     autoScroll: function(x, y, h, w) {
 
         if (this.scroll) {
             // The client height
-            var clientH = Ext.core.Element.getViewHeight();
+            var clientH = Ext.Element.getViewHeight();
 
             // The client width
-            var clientW = Ext.core.Element.getViewWidth();
+            var clientW = Ext.Element.getViewWidth();
 
             // The amt scrolled down
             var st = this.DDMInstance.getScrollTop();
@@ -217,12 +235,12 @@ Ext.define('Ext.dd.DD', {
         }
     },
 
-<span id='Ext-dd.DD-method-getTargetCoord'>    /**
+<span id='Ext-dd-DD-method-getTargetCoord'>    /**
 </span>     * Finds the location the element should be placed if we want to move
      * it to where the mouse location less the click offset would place us.
      * @method getTargetCoord
-     * @param {int} iPageX the X coordinate of the click
-     * @param {int} iPageY the Y coordinate of the click
+     * @param {Number} iPageX the X coordinate of the click
+     * @param {Number} iPageY the Y coordinate of the click
      * @return an object that contains the coordinates (Object.x and Object.y)
      * @private
      */
@@ -255,7 +273,7 @@ Ext.define('Ext.dd.DD', {
         return {x: x, y: y};
     },
 
-<span id='Ext-dd.DD-method-applyConfig'>    /**
+<span id='Ext-dd-DD-method-applyConfig'>    /**
 </span>     * Sets up config options specific to this class. Overrides
      * Ext.dd.DragDrop, but all versions of this method through the
      * inheritance chain are called
@@ -265,7 +283,7 @@ Ext.define('Ext.dd.DD', {
         this.scroll = (this.config.scroll !== false);
     },
 
-<span id='Ext-dd.DD-method-b4MouseDown'>    /**
+<span id='Ext-dd-DD-method-b4MouseDown'>    /**
 </span>     * Event that fires prior to the onMouseDown event.  Overrides
      * Ext.dd.DragDrop.
      */
@@ -274,7 +292,7 @@ Ext.define('Ext.dd.DD', {
         this.autoOffset(e.getPageX(), e.getPageY());
     },
 
-<span id='Ext-dd.DD-method-b4Drag'>    /**
+<span id='Ext-dd-DD-method-b4Drag'>    /**
 </span>     * Event that fires prior to the onDrag event.  Overrides
      * Ext.dd.DragDrop.
      */
@@ -314,4 +332,6 @@ Ext.define('Ext.dd.DD', {
     */
 
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>