docs/output/Ext.dd.ScrollManager.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.dd.ScrollManager-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.dd.ScrollManager-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.dd.ScrollManager-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                         <a class="bookmark" href="../docs/?class=Ext.dd.ScrollManager"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   7         </div>
   8                 <h1>Class Ext.dd.ScrollManager</h1>
   9         <table cellspacing="0">
  10             <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
  11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/ScrollManager.js" target="_blank">ScrollManager.js</a></td></tr>
  12             <tr><td class="label">Class:</td><td class="hd-info">ScrollManager</td></tr>
  13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  14                     </table>
  15         <div class="description">
  16             *
  17 <p>Provides automatic scrolling of overflow regions in the page during drag operations.</p>
  18 <p>The ScrollManager configs will be used as the defaults for any scroll container registered with it,
  19 but you can also override most of the configs per scroll container by adding a
  20 <tt>ddScrollConfig</tt> object to the target element that contains these properties: <a ext:cls="Ext.dd.ScrollManager" ext:member="hthresh" href="output/Ext.dd.ScrollManager.html#hthresh">hthresh</a>,
  21 <a ext:cls="Ext.dd.ScrollManager" ext:member="vthresh" href="output/Ext.dd.ScrollManager.html#vthresh">vthresh</a>, <a ext:cls="Ext.dd.ScrollManager" ext:member="increment" href="output/Ext.dd.ScrollManager.html#increment">increment</a> and <a ext:cls="Ext.dd.ScrollManager" ext:member="frequency" href="output/Ext.dd.ScrollManager.html#frequency">frequency</a>.  Example usage:
  22 <pre><code>var el = Ext.get(<em>'scroll-ct'</em>);
  23 el.ddScrollConfig = {
  24     vthresh: 50,
  25     hthresh: -1,
  26     frequency: 100,
  27     increment: 200
  28 };
  29 Ext.dd.ScrollManager.register(el);</code></pre>
  30 <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b><br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
  31
  32         <div class="hr"></div>
  33                 <a id="Ext.dd.ScrollManager-props"></a>
  34         <h2>Public Properties</h2>
  35                 <table cellspacing="0" class="member-table">
  36             <tr>
  37                 <th class="sig-header" colspan="2">Property</th>
  38                 <th class="msource-header">Defined By</th>
  39             </tr>
  40                 <tr class="property-row">\r
  41         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  42         <td class="sig">\r
  43         <a id="Ext.dd.ScrollManager-animDuration"></a>\r
  44             <b>animDuration</b> : Number            <div class="mdesc">\r
  45                             The animation duration in seconds -
  46 MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)                        </div>\r
  47         </td>\r
  48         <td class="msource">ScrollManager</td>\r
  49     </tr>\r
  50         <tr class="property-row alt">\r
  51         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  52         <td class="sig">\r
  53         <a id="Ext.dd.ScrollManager-animate"></a>\r
  54             <b>animate</b> : Boolean            <div class="mdesc">\r
  55                             True to animate the scroll (defaults to true)                        </div>\r
  56         </td>\r
  57         <td class="msource">ScrollManager</td>\r
  58     </tr>\r
  59         <tr class="property-row">\r
  60         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  61         <td class="sig">\r
  62         <a id="Ext.dd.ScrollManager-frequency"></a>\r
  63             <b>frequency</b> : Number            <div class="mdesc">\r
  64                             The frequency of scrolls in milliseconds (defaults to 500)                        </div>\r
  65         </td>\r
  66         <td class="msource">ScrollManager</td>\r
  67     </tr>\r
  68         <tr class="property-row alt expandable">\r
  69         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  70         <td class="sig">\r
  71         <a id="Ext.dd.ScrollManager-hthresh"></a>\r
  72             <b>hthresh</b> : Number            <div class="mdesc">\r
  73                         <div class="short">The number of pixels from the right or left edge of a container the pointer needs to be to
  74 trigger scrolling (default...</div>\r
  75             <div class="long">\r
  76                 The number of pixels from the right or left edge of a container the pointer needs to be to
  77 trigger scrolling (defaults to 25)            </div>\r
  78                         </div>\r
  79         </td>\r
  80         <td class="msource">ScrollManager</td>\r
  81     </tr>\r
  82         <tr class="property-row">\r
  83         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  84         <td class="sig">\r
  85         <a id="Ext.dd.ScrollManager-increment"></a>\r
  86             <b>increment</b> : Number            <div class="mdesc">\r
  87                             The number of pixels to scroll in each scroll increment (defaults to 50)                        </div>\r
  88         </td>\r
  89         <td class="msource">ScrollManager</td>\r
  90     </tr>\r
  91         <tr class="property-row alt expandable">\r
  92         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  93         <td class="sig">\r
  94         <a id="Ext.dd.ScrollManager-vthresh"></a>\r
  95             <b>vthresh</b> : Number            <div class="mdesc">\r
  96                         <div class="short">The number of pixels from the top or bottom edge of a container the pointer needs to be to
  97 trigger scrolling (default...</div>\r
  98             <div class="long">\r
  99                 The number of pixels from the top or bottom edge of a container the pointer needs to be to
 100 trigger scrolling (defaults to 25)            </div>\r
 101                         </div>\r
 102         </td>\r
 103         <td class="msource">ScrollManager</td>\r
 104     </tr>\r
 105             </table>
 106                 <a id="Ext.dd.ScrollManager-methods"></a>
 107         <h2>Public Methods</h2>
 108                 <table cellspacing="0" class="member-table">
 109             <tr>
 110                 <th class="sig-header" colspan="2">Method</th>
 111                 <th class="msource-header">Defined By</th>
 112             </tr>
 113                 <tr class="method-row expandable">\r
 114         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 115         <td class="sig">\r
 116         <a id="Ext.dd.ScrollManager-refreshCache"></a>\r
 117             <b>refreshCache</b>() : void            <div class="mdesc">\r
 118                         <div class="short">Manually trigger a cache refresh.</div>\r
 119             <div class="long">\r
 120                 Manually trigger a cache refresh.    <div class="mdetail-params">\r
 121         <strong>Parameters:</strong>\r
 122         <ul><li>None.</li>        </ul>\r
 123         <strong>Returns:</strong>\r
 124         <ul>\r
 125             <li><code>void</code></li>\r
 126         </ul>\r
 127     </div>\r
 128                 </div>\r
 129                         </div>\r
 130         </td>\r
 131         <td class="msource">ScrollManager</td>\r
 132     </tr>\r
 133         <tr class="method-row alt expandable">\r
 134         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 135         <td class="sig">\r
 136         <a id="Ext.dd.ScrollManager-register"></a>\r
 137             <b>register</b>(&nbsp;<code>Mixed/Array el</code>&nbsp;) : void            <div class="mdesc">\r
 138                         <div class="short">Registers new overflow element(s) to auto scroll</div>\r
 139             <div class="long">\r
 140                 Registers new overflow element(s) to auto scroll    <div class="mdetail-params">\r
 141         <strong>Parameters:</strong>\r
 142         <ul><li><code>el</code> : Mixed/Array<div class="sub-desc">The id of or the element to be scrolled or an array of either</div></li>        </ul>\r
 143         <strong>Returns:</strong>\r
 144         <ul>\r
 145             <li><code>void</code></li>\r
 146         </ul>\r
 147     </div>\r
 148                 </div>\r
 149                         </div>\r
 150         </td>\r
 151         <td class="msource">ScrollManager</td>\r
 152     </tr>\r
 153         <tr class="method-row expandable">\r
 154         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 155         <td class="sig">\r
 156         <a id="Ext.dd.ScrollManager-unregister"></a>\r
 157             <b>unregister</b>(&nbsp;<code>Mixed/Array el</code>&nbsp;) : void            <div class="mdesc">\r
 158                         <div class="short">Unregisters overflow element(s) so they are no longer scrolled</div>\r
 159             <div class="long">\r
 160                 Unregisters overflow element(s) so they are no longer scrolled    <div class="mdetail-params">\r
 161         <strong>Parameters:</strong>\r
 162         <ul><li><code>el</code> : Mixed/Array<div class="sub-desc">The id of or the element to be removed or an array of either</div></li>        </ul>\r
 163         <strong>Returns:</strong>\r
 164         <ul>\r
 165             <li><code>void</code></li>\r
 166         </ul>\r
 167     </div>\r
 168                 </div>\r
 169                         </div>\r
 170         </td>\r
 171         <td class="msource">ScrollManager</td>\r
 172     </tr>\r
 173             </table>
 174                 <a id="Ext.dd.ScrollManager-events"></a>
 175         <h2>Public Events</h2>
 176         <div class="no-members">This class has no public events.</div>
 177         </div>