223 lines
No EOL
11 KiB
HTML
223 lines
No EOL
11 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Ext.dd.ScrollManager</title>
|
|
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
|
<!-- GC -->
|
|
</head>
|
|
<body>
|
|
<div class="body-wrap">
|
|
<div class="top-tools">
|
|
<img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="Ext.dd.ScrollManager.html" target="_blank">Print Friendly</a><br/>
|
|
|
|
</div>
|
|
<h1>Class Ext.dd.ScrollManager</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>Ext.dd</td></tr>
|
|
<tr><td class="label">Class:</td><td>ScrollManager</td></tr>
|
|
<tr><td class="label">Extends:</td><td>Object</td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="ScrollManager.jss.html">ScrollManager.js</a></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>
|
|
<br />
|
|
<a href="#properties">Properties</a>
|
|
- <a href="#methods">Methods</a>
|
|
- <a href="#events">Events</a>
|
|
<hr />
|
|
<a name="properties"></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>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#animDuration">animDuration</a> : Number</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The animation duration in seconds -
|
|
MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#animate">animate</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">True to animate the scroll (defaults to true)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#frequency">frequency</a> : Number</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The frequency of scrolls in milliseconds (defaults to 500)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#increment">increment</a> : Number</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The number of pixels to scroll in each scroll increment (defaults to 50)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#thresh">thresh</a> : Number</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The number of pixels from the edge of a container the pointer needs to be to
|
|
trigger scrolling (defaults to 25)</td>
|
|
</tr>
|
|
</table>
|
|
<a name="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>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#refreshCache">refreshCache</a>() : void</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Manually trigger a cache refresh.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#register">register</a>(<code>String/HTMLElement/Element/Array el</code>) : void</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Registers new overflow element(s) to auto scroll</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#unregister">unregister</a>(<code>String/HTMLElement/Element/Array el</code>) : void</td>
|
|
<td class="msource" rowspan="2">ScrollManager</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Unregisters overflow element(s) so they are no longer scrolled</td>
|
|
</tr>
|
|
</table>
|
|
<a name="events"></a>
|
|
<h2>Public Events</h2>
|
|
<div class="no-members">This class has no public events.</div> <h2 class="mdetail-head">Property Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="animDuration"></a>
|
|
<div class="mdetail">
|
|
<h3>animDuration</i></h3>
|
|
<code>public Number animDuration</code>
|
|
<div class="mdetail-desc">
|
|
The animation duration in seconds -
|
|
MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4) </div>
|
|
<div class="mdetail-def">This property is defined by ScrollManager.</div>
|
|
</div>
|
|
<a name="animate"></a>
|
|
<div class="mdetail alt">
|
|
<h3>animate</i></h3>
|
|
<code>public Boolean animate</code>
|
|
<div class="mdetail-desc">
|
|
True to animate the scroll (defaults to true) </div>
|
|
<div class="mdetail-def">This property is defined by ScrollManager.</div>
|
|
</div>
|
|
<a name="frequency"></a>
|
|
<div class="mdetail">
|
|
<h3>frequency</i></h3>
|
|
<code>public Number frequency</code>
|
|
<div class="mdetail-desc">
|
|
The frequency of scrolls in milliseconds (defaults to 500) </div>
|
|
<div class="mdetail-def">This property is defined by ScrollManager.</div>
|
|
</div>
|
|
<a name="increment"></a>
|
|
<div class="mdetail alt">
|
|
<h3>increment</i></h3>
|
|
<code>public Number increment</code>
|
|
<div class="mdetail-desc">
|
|
The number of pixels to scroll in each scroll increment (defaults to 50) </div>
|
|
<div class="mdetail-def">This property is defined by ScrollManager.</div>
|
|
</div>
|
|
<a name="thresh"></a>
|
|
<div class="mdetail">
|
|
<h3>thresh</i></h3>
|
|
<code>public Number thresh</code>
|
|
<div class="mdetail-desc">
|
|
The number of pixels from the edge of a container the pointer needs to be to
|
|
trigger scrolling (defaults to 25) </div>
|
|
<div class="mdetail-def">This property is defined by ScrollManager.</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="refreshCache"></a>
|
|
<div class="mdetail">
|
|
<h3>refreshCache</i></h3>
|
|
<code>public function refreshCache()</code>
|
|
<div class="mdetail-desc">
|
|
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 class="mdetail-def">This method is defined by ScrollManager.</div>
|
|
</div>
|
|
<a name="register"></a>
|
|
<div class="mdetail alt">
|
|
<h3>register</i></h3>
|
|
<code>public function register(<code>String/HTMLElement/Element/Array el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Registers new overflow element(s) to auto scroll
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element/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 class="mdetail-def">This method is defined by ScrollManager.</div>
|
|
</div>
|
|
<a name="unregister"></a>
|
|
<div class="mdetail">
|
|
<h3>unregister</i></h3>
|
|
<code>public function unregister(<code>String/HTMLElement/Element/Array el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Unregisters overflow element(s) so they are no longer scrolled
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element/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 class="mdetail-def">This method is defined by ScrollManager.</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright © 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
|
|
|
|
</body>
|
|
</html> |