Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / ScrollManager.html
index 7535a8b..1301d1e 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><span id='Ext-dd.ScrollManager'>/**
+<!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"><span id='Ext-dd-ScrollManager'>/**
 </span> * @class Ext.dd.ScrollManager
  * &lt;p&gt;Provides automatic scrolling of overflow regions in the page during drag operations.&lt;/p&gt;
  * &lt;p&gt;The ScrollManager configs will be used as the defaults for any scroll container registered with it,
@@ -15,7 +32,7 @@ el.ddScrollConfig = {
 };
 Ext.dd.ScrollManager.register(el);
 &lt;/code&gt;&lt;/pre&gt;
- * &lt;b&gt;Note: This class uses &quot;Point Mode&quot; and is untested in &quot;Intersect Mode&quot;.&lt;/b&gt;
+ * Note: This class is designed to be used in &quot;Point Mode
  * @singleton
  */
 Ext.define('Ext.dd.ScrollManager', {
@@ -133,9 +150,10 @@ Ext.define('Ext.dd.ScrollManager', {
         this.clearProc();
     },
 
-<span id='Ext-dd.ScrollManager-method-register'>    /**
+<span id='Ext-dd-ScrollManager-method-register'>    /**
 </span>     * Registers new overflow element(s) to auto scroll
-     * @param {Mixed/Array} el The id of or the element to be scrolled or an array of either
+     * @param {String/HTMLElement/Ext.Element/String[]/HTMLElement[]/Ext.Element[]} el
+     * The id of or the element to be scrolled or an array of either
      */
     register : function(el){
         if (Ext.isArray(el)) {
@@ -148,9 +166,10 @@ Ext.define('Ext.dd.ScrollManager', {
         }
     },
 
-<span id='Ext-dd.ScrollManager-method-unregister'>    /**
+<span id='Ext-dd-ScrollManager-method-unregister'>    /**
 </span>     * Unregisters overflow element(s) so they are no longer scrolled
-     * @param {Mixed/Array} el The id of or the element to be removed or an array of either
+     * @param {String/HTMLElement/Ext.Element/String[]/HTMLElement[]/Ext.Element[]} el
+     * The id of or the element to be removed or an array of either
      */
     unregister : function(el){
         if(Ext.isArray(el)){
@@ -163,52 +182,51 @@ Ext.define('Ext.dd.ScrollManager', {
         }
     },
 
-<span id='Ext-dd.ScrollManager-property-vthresh'>    /**
+<span id='Ext-dd-ScrollManager-property-vthresh'>    /**
 </span>     * The number of pixels from the top or bottom edge of a container the pointer needs to be to
-     * trigger scrolling (defaults to 25)
+     * trigger scrolling
      * @type Number
      */
     vthresh : 25,
-<span id='Ext-dd.ScrollManager-property-hthresh'>    /**
+<span id='Ext-dd-ScrollManager-property-hthresh'>    /**
 </span>     * The number of pixels from the right or left edge of a container the pointer needs to be to
-     * trigger scrolling (defaults to 25)
+     * trigger scrolling
      * @type Number
      */
     hthresh : 25,
 
-<span id='Ext-dd.ScrollManager-property-increment'>    /**
-</span>     * The number of pixels to scroll in each scroll increment (defaults to 100)
+<span id='Ext-dd-ScrollManager-property-increment'>    /**
+</span>     * The number of pixels to scroll in each scroll increment
      * @type Number
      */
     increment : 100,
 
-<span id='Ext-dd.ScrollManager-property-frequency'>    /**
-</span>     * The frequency of scrolls in milliseconds (defaults to 500)
+<span id='Ext-dd-ScrollManager-property-frequency'>    /**
+</span>     * The frequency of scrolls in milliseconds
      * @type Number
      */
     frequency : 500,
 
-<span id='Ext-dd.ScrollManager-property-animate'>    /**
-</span>     * True to animate the scroll (defaults to true)
+<span id='Ext-dd-ScrollManager-property-animate'>    /**
+</span>     * True to animate the scroll
      * @type Boolean
      */
     animate: true,
 
-<span id='Ext-dd.ScrollManager-property-animDuration'>    /**
-</span>     * The animation duration in seconds -
-     * MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)
+<span id='Ext-dd-ScrollManager-property-animDuration'>    /**
+</span>     * The animation duration in seconds - MUST BE less than Ext.dd.ScrollManager.frequency!
      * @type Number
      */
     animDuration: 0.4,
 
-<span id='Ext-dd.ScrollManager-property-ddGroup'>    /**
-</span>     * The named drag drop {@link Ext.dd.DragSource#ddGroup group} to which this container belongs (defaults to undefined).
+<span id='Ext-dd-ScrollManager-property-ddGroup'>    /**
+</span>     * The named drag drop {@link Ext.dd.DragSource#ddGroup group} to which this container belongs.
      * If a ddGroup is specified, then container scrolling will only occur when a dragged object is in the same ddGroup.
      * @type String
      */
     ddGroup: undefined,
 
-<span id='Ext-dd.ScrollManager-method-refreshCache'>    /**
+<span id='Ext-dd-ScrollManager-method-refreshCache'>    /**
 </span>     * Manually trigger a cache refresh.
      */
     refreshCache : function(){
@@ -221,4 +239,6 @@ Ext.define('Ext.dd.ScrollManager', {
         }
     }
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>