X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..HEAD:/docs/source/ScrollManager.html diff --git a/docs/source/ScrollManager.html b/docs/source/ScrollManager.html index 7535a8b6..1301d1ed 100644 --- a/docs/source/ScrollManager.html +++ b/docs/source/ScrollManager.html @@ -1,4 +1,21 @@ -Sencha Documentation Project
/**
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
  * @class Ext.dd.ScrollManager
  * <p>Provides automatic scrolling of overflow regions in the page during drag operations.</p>
  * <p>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);
 </code></pre>
- * <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b>
+ * Note: This class is designed to be used in "Point Mode
  * @singleton
  */
 Ext.define('Ext.dd.ScrollManager', {
@@ -133,9 +150,10 @@ Ext.define('Ext.dd.ScrollManager', {
         this.clearProc();
     },
 
-    /**
+    /**
      * 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', {
         }
     },
 
-    /**
+    /**
      * 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', {
         }
     },
 
-    /**
+    /**
      * 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,
-    /**
+    /**
      * 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,
 
-    /**
-     * The number of pixels to scroll in each scroll increment (defaults to 100)
+    /**
+     * The number of pixels to scroll in each scroll increment
      * @type Number
      */
     increment : 100,
 
-    /**
-     * The frequency of scrolls in milliseconds (defaults to 500)
+    /**
+     * The frequency of scrolls in milliseconds
      * @type Number
      */
     frequency : 500,
 
-    /**
-     * True to animate the scroll (defaults to true)
+    /**
+     * True to animate the scroll
      * @type Boolean
      */
     animate: true,
 
-    /**
-     * The animation duration in seconds -
-     * MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)
+    /**
+     * The animation duration in seconds - MUST BE less than Ext.dd.ScrollManager.frequency!
      * @type Number
      */
     animDuration: 0.4,
 
-    /**
-     * The named drag drop {@link Ext.dd.DragSource#ddGroup group} to which this container belongs (defaults to undefined).
+    /**
+     * 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,
 
-    /**
+    /**
      * Manually trigger a cache refresh.
      */
     refreshCache : function(){
@@ -221,4 +239,6 @@ Ext.define('Ext.dd.ScrollManager', {
         }
     }
 });
-
\ No newline at end of file +
+ +