source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.dd.ScrollManager.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 9.3 KB
Line 
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,
19but 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>);
23el.ddScrollConfig = {
24    vthresh: 50,
25    hthresh: -1,
26    frequency: 100,
27    increment: 200
28};
29Ext.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">
41        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
42        <td class="sig">
43        <a id="Ext.dd.ScrollManager-animDuration"></a>
44            <b>animDuration</b> : Number            <div class="mdesc">
45                            The animation duration in seconds -
46MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)                        </div>
47        </td>
48        <td class="msource">ScrollManager</td>
49    </tr>
50        <tr class="property-row alt">
51        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
52        <td class="sig">
53        <a id="Ext.dd.ScrollManager-animate"></a>
54            <b>animate</b> : Boolean            <div class="mdesc">
55                            True to animate the scroll (defaults to true)                        </div>
56        </td>
57        <td class="msource">ScrollManager</td>
58    </tr>
59        <tr class="property-row">
60        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
61        <td class="sig">
62        <a id="Ext.dd.ScrollManager-frequency"></a>
63            <b>frequency</b> : Number            <div class="mdesc">
64                            The frequency of scrolls in milliseconds (defaults to 500)                        </div>
65        </td>
66        <td class="msource">ScrollManager</td>
67    </tr>
68        <tr class="property-row alt expandable">
69        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
70        <td class="sig">
71        <a id="Ext.dd.ScrollManager-hthresh"></a>
72            <b>hthresh</b> : Number            <div class="mdesc">
73                        <div class="short">The number of pixels from the right or left edge of a container the pointer needs to be to
74trigger scrolling (default...</div>
75            <div class="long">
76                The number of pixels from the right or left edge of a container the pointer needs to be to
77trigger scrolling (defaults to 25)            </div>
78                        </div>
79        </td>
80        <td class="msource">ScrollManager</td>
81    </tr>
82        <tr class="property-row">
83        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
84        <td class="sig">
85        <a id="Ext.dd.ScrollManager-increment"></a>
86            <b>increment</b> : Number            <div class="mdesc">
87                            The number of pixels to scroll in each scroll increment (defaults to 50)                        </div>
88        </td>
89        <td class="msource">ScrollManager</td>
90    </tr>
91        <tr class="property-row alt expandable">
92        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
93        <td class="sig">
94        <a id="Ext.dd.ScrollManager-vthresh"></a>
95            <b>vthresh</b> : Number            <div class="mdesc">
96                        <div class="short">The number of pixels from the top or bottom edge of a container the pointer needs to be to
97trigger scrolling (default...</div>
98            <div class="long">
99                The number of pixels from the top or bottom edge of a container the pointer needs to be to
100trigger scrolling (defaults to 25)            </div>
101                        </div>
102        </td>
103        <td class="msource">ScrollManager</td>
104    </tr>
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">
114        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
115        <td class="sig">
116        <a id="Ext.dd.ScrollManager-refreshCache"></a>
117            <b>refreshCache</b>() : void            <div class="mdesc">
118                        <div class="short">Manually trigger a cache refresh.</div>
119            <div class="long">
120                Manually trigger a cache refresh.    <div class="mdetail-params">
121        <strong>Parameters:</strong>
122        <ul><li>None.</li>        </ul>
123        <strong>Returns:</strong>
124        <ul>
125            <li><code>void</code></li>
126        </ul>
127    </div>
128                </div>
129                        </div>
130        </td>
131        <td class="msource">ScrollManager</td>
132    </tr>
133        <tr class="method-row alt expandable">
134        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
135        <td class="sig">
136        <a id="Ext.dd.ScrollManager-register"></a>
137            <b>register</b>(&nbsp;<code>Mixed/Array el</code>&nbsp;) : void            <div class="mdesc">
138                        <div class="short">Registers new overflow element(s) to auto scroll</div>
139            <div class="long">
140                Registers new overflow element(s) to auto scroll    <div class="mdetail-params">
141        <strong>Parameters:</strong>
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>
143        <strong>Returns:</strong>
144        <ul>
145            <li><code>void</code></li>
146        </ul>
147    </div>
148                </div>
149                        </div>
150        </td>
151        <td class="msource">ScrollManager</td>
152    </tr>
153        <tr class="method-row expandable">
154        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
155        <td class="sig">
156        <a id="Ext.dd.ScrollManager-unregister"></a>
157            <b>unregister</b>(&nbsp;<code>Mixed/Array el</code>&nbsp;) : void            <div class="mdesc">
158                        <div class="short">Unregisters overflow element(s) so they are no longer scrolled</div>
159            <div class="long">
160                Unregisters overflow element(s) so they are no longer scrolled    <div class="mdetail-params">
161        <strong>Parameters:</strong>
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>
163        <strong>Returns:</strong>
164        <ul>
165            <li><code>void</code></li>
166        </ul>
167    </div>
168                </div>
169                        </div>
170        </td>
171        <td class="msource">ScrollManager</td>
172    </tr>
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>
Note: See TracBrowser for help on using the repository browser.