Ext.dd.ScrollManager.html
8.28 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<div class="body-wrap">
<div class="top-tools">
<a class="inner-link" href="#Ext.dd.ScrollManager-props"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-prop">Properties</a>
<a class="inner-link" href="#Ext.dd.ScrollManager-methods"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-method">Methods</a>
<a class="inner-link" href="#Ext.dd.ScrollManager-events"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-event">Events</a>
<a class="bookmark" href="../docs/?class=Ext.dd.ScrollManager"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-fav">Direct Link</a>
</div>
<h1>Class Ext.dd.ScrollManager</h1>
<table cellspacing="0">
<tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/dd/ScrollManager_wev8.js" target="_blank">ScrollManager_wev8.js</a></td></tr>
<tr><td class="label">Class:</td><td class="hd-info">ScrollManager</td></tr>
<tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
</table>
<div class="description">
Provides automatic scrolling of overflow regions in the page during drag operations.<br><br>
<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>
<div class="hr"></div>
<a id="Ext.dd.ScrollManager-props"></a>
<h2>Public Properties</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Property</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="property-row">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-animDuration"></a>
<b>animDuration</b> : Number <div class="mdesc">
The animation duration in seconds -
MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4) </div>
</td>
<td class="msource">ScrollManager</td>
</tr>
<tr class="property-row alt">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-animate"></a>
<b>animate</b> : Boolean <div class="mdesc">
True to animate the scroll (defaults to true) </div>
</td>
<td class="msource">ScrollManager</td>
</tr>
<tr class="property-row">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-frequency"></a>
<b>frequency</b> : Number <div class="mdesc">
The frequency of scrolls in milliseconds (defaults to 500) </div>
</td>
<td class="msource">ScrollManager</td>
</tr>
<tr class="property-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-hthresh"></a>
<b>hthresh</b> : Number <div class="mdesc">
<div class="short">The number of pixels from the right or left edge of a container the pointer needs to be to
trigger scrolling (default...</div>
<div class="long">
The number of pixels from the right or left edge of a container the pointer needs to be to
trigger scrolling (defaults to 25) </div>
</div>
</td>
<td class="msource">ScrollManager</td>
</tr>
<tr class="property-row">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-increment"></a>
<b>increment</b> : Number <div class="mdesc">
The number of pixels to scroll in each scroll increment (defaults to 50) </div>
</td>
<td class="msource">ScrollManager</td>
</tr>
<tr class="property-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-vthresh"></a>
<b>vthresh</b> : Number <div class="mdesc">
<div class="short">The number of pixels from the top or bottom edge of a container the pointer needs to be to
trigger scrolling (default...</div>
<div class="long">
The number of pixels from the top or bottom edge of a container the pointer needs to be to
trigger scrolling (defaults to 25) </div>
</div>
</td>
<td class="msource">ScrollManager</td>
</tr>
</table>
<a id="Ext.dd.ScrollManager-methods"></a>
<h2>Public Methods</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Method</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-refreshCache"></a>
<b>refreshCache</b>() : void <div class="mdesc">
<div class="short">Manually trigger a cache refresh.</div>
<div class="long">
Manually trigger a cache refresh. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">ScrollManager</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-register"></a>
<b>register</b>( <code>Mixed/Array el</code> ) : void <div class="mdesc">
<div class="short">Registers new overflow element(s) to auto scroll</div>
<div class="long">
Registers new overflow element(s) to auto scroll <div class="mdetail-params">
<strong>Parameters:</strong>
<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>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">ScrollManager</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.dd.ScrollManager-unregister"></a>
<b>unregister</b>( <code>Mixed/Array el</code> ) : void <div class="mdesc">
<div class="short">Unregisters overflow element(s) so they are no longer scrolled</div>
<div class="long">
Unregisters overflow element(s) so they are no longer scrolled <div class="mdetail-params">
<strong>Parameters:</strong>
<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>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">ScrollManager</td>
</tr>
</table>
<a id="Ext.dd.ScrollManager-events"></a>
<h2>Public Events</h2>
<div class="no-members">This class has no public events.</div>
</div>