webgui/www/extras/yui/docs/animation/YAHOO.util.Scroll.html
JT Smith 4f68a0933c added YUI and YUI-ext
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

388 lines
No EOL
9.8 KiB
HTML

<html>
<head>
<title>
JavaScript Documentation -
YAHOO.util.Scroll
</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="header">
<h1>JavaScript Documentation</h1>
<h3><a href="./index.html">Animation Utility</a></h3>
<div class="breadcrumbs">
<a href="javascript: alert('This location is TBD');">Home</a>
&gt;
<a href="./index.html">Animation Utility</a>
&gt;
<strong>YAHOO.util.Scroll</strong>
</div>
</div>
<div id="body">
<div class="nav">
<div class="module resources">
<ul class="content">
<li><a href="overview-tree.html">Tree View</a></li>
<li><a href="index-all.html">Element Index</a></li>
</ul>
</div>
<div class="module">
<h4><a href="./allclasses-noframe.html">Classes</a></h4>
<ul class="content">
<li>
<a href="YAHOO.util.html">
YAHOO.util</a>
</li>
<li>
<a href="YAHOO.util.Anim.html">
YAHOO.util.Anim</a>
</li>
<li>
<a href="YAHOO.util.AnimMgr.html">
YAHOO.util.AnimMgr</a>
</li>
<li>
<a href="YAHOO.util.Bezier.html">
YAHOO.util.Bezier</a>
</li>
<li>
<a href="YAHOO.util.ColorAnim.html">
YAHOO.util.ColorAnim</a>
</li>
<li>
<a href="YAHOO.util.Easing.html">
YAHOO.util.Easing</a>
</li>
<li>
<a href="YAHOO.util.Motion.html">
YAHOO.util.Motion</a>
</li>
<li>
<a href="YAHOO.util.Scroll.html">
YAHOO.util.Scroll</a>
</li>
</ul>
</div>
<div class="module">
<h4><a href="./overview-summary.html">Files</a></h4>
<ul class="content">
<li>
<a href="overview-summary-Anim.js.html">
Anim.js</a>
</li>
<li>
<a href="overview-summary-AnimMgr.js.html">
AnimMgr.js</a>
</li>
<li>
<a href="overview-summary-Bezier.js.html">
Bezier.js</a>
</li>
<li>
<a href="overview-summary-ColorAnim.js.html">
ColorAnim.js</a>
</li>
<li>
<a href="overview-summary-Easing.js.html">
Easing.js</a>
</li>
<li>
<a href="overview-summary-Motion.js.html">
Motion.js</a>
</li>
<li>
<a href="overview-summary-Scroll.js.html">
Scroll.js</a>
</li>
</ul>
</div>
</div>
<div id="pri">
<div class="main">
<h2>Class YAHOO.util.Scroll</h2>
<pre>Object
|
+--<a href='YAHOO.util.Anim.html'>YAHOO.util.Anim</a>
|
+--<a href='YAHOO.util.ColorAnim.html'>YAHOO.util.ColorAnim</a>
|
+--<b>YAHOO.util.Scroll</b>
</pre>
<hr />
<!-- Class definition -->
<div class="class-def">
<div class="class-name">
<span class="class-attribs">
</span>
<span class="class-type">class</span>
<b>YAHOO.util.Scroll</b>
</div>
<div class="class-extends">
<dd>extends <a href='YAHOO.util.ColorAnim.html'>YAHOO.util.ColorAnim</a></dd>
</div>
</div>
<div class="meta">
<dl class="requires">
<dt><strong>Requires:</strong></dt>
<dd><a href="YAHOO.util.Anim.html#">YAHOO.util.Anim</a></dd>
<dd><a href="YAHOO.util.AnimMgr.html#">YAHOO.util.AnimMgr</a></dd>
<dd><a href="YAHOO.util.Easing.html#">YAHOO.util.Easing</a></dd>
<dd><a href="YAHOO.util.Bezier.html#">YAHOO.util.Bezier</a></dd>
<dd><a href="YAHOO.util.ColorAnim.html#">YAHOO.util.ColorAnim</a></dd>
<dd>YAHOO.util.Dom </dd>
<dd>YAHOO.util.Event </dd>
<dd>YAHOO.util.CustomEvent </dd>
</dl>
<div class="summary">
<p>
Anim subclass for scrolling elements to a position defined by the "scroll" member of "attributes". All "scroll" members are arrays with x, y scroll positions.
<p>Usage: <code>var myAnim = new YAHOO.util.Scroll(el, { scroll: { to: [0, 800] } }, 1, YAHOO.util.Easing.easeOut);</code></p>
</p>
</div>
</div>
<!-- ======== QUICK LINKS ======== -->
<div class="quick-links">
<strong>Quick Links:</strong>&nbsp;
<a href="#constructor_summary">Constructor Summary</a>
<a href="#constructorDetails">Constructor Details</a>
</div>
<!-- ======== END QUICK LINKS ======== -->
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<div class="section field inheritance">
<h3>Fields inherited from class <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<code><a href="YAHOO.util.Anim.html#attributes">attributes</a>, <a href="YAHOO.util.Anim.html#duration">duration</a>, <a href="YAHOO.util.Anim.html#method">method</a>, <a href="YAHOO.util.Anim.html#useSeconds">useSeconds</a>, <a href="YAHOO.util.Anim.html#currentFrame">currentFrame</a>, <a href="YAHOO.util.Anim.html#totalFrames">totalFrames</a>, <a href="YAHOO.util.Anim.html#onStart">onStart</a>, <a href="YAHOO.util.Anim.html#onTween">onTween</a>, <a href="YAHOO.util.Anim.html#onComplete">onComplete</a></code>
</div>
</div>
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<div class="section contructor summaries">
<h3><a name="constructor_summary">Constructor Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<code class="spec">
<a href="YAHOO.util.Scroll.html#YAHOO.util.Scroll()">YAHOO.util.Scroll</a>
</code>
<div class="description">
&nbsp;
</div>
</div>
</div>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<div class="section method inheritance">
<h3>Methods inherited from class <a href="YAHOO.util.ColorAnim.html">YAHOO.util.ColorAnim</a></h3>
<div class="content">
<code><a href="YAHOO.util.ColorAnim.html#toString">toString</a>, <a href="YAHOO.util.ColorAnim.html#parseColor">parseColor</a>, <a href="YAHOO.util.ColorAnim.html#getAttribute">getAttribute</a>, <a href="YAHOO.util.ColorAnim.html#doMethod">doMethod</a></code>
</div>
</div>
<div class="section method inheritance">
<h3>Methods inherited from class <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a></h3>
<div class="content">
<code><a href="YAHOO.util.Anim.html#setAttribute">setAttribute</a>, <a href="YAHOO.util.Anim.html#getDefaultUnit">getDefaultUnit</a>, <a href="YAHOO.util.Anim.html#init">init</a>, <a href="YAHOO.util.Anim.html#getEl">getEl</a>, <a href="YAHOO.util.Anim.html#isAnimated">isAnimated</a>, <a href="YAHOO.util.Anim.html#getStartTime">getStartTime</a>, <a href="YAHOO.util.Anim.html#animate">animate</a>, <a href="YAHOO.util.Anim.html#stop">stop</a></code>
</div>
</div>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<div class="section constructor details">
<h3><a name="constructorDetails">Constructor Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<h4><a name="YAHOO.util.Scroll()">YAHOO.util.Scroll</a></h4>
<div class="detail">
<code>
<strong>YAHOO.util.Scroll</strong>
()
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>String</code> -
or HTMLElement} el Reference to the element that will be animated
</dd>
<dd>
<code>attributes</code> -
The attribute(s) to be animated. Each attribute is an object with at minimum a "to" or "by" member defined. Additional optional members are "from" (defaults to current value), "units" (defaults to "px"). All attribute names use camelCase.
</dd>
<dd>
<code>duration</code> -
(optional, defaults to 1 second) Length of animation (frames or seconds), defaults to time-based
</dd>
<dd>
<code>method</code> -
(optional, defaults to YAHOO.util.Easing.easeNone) Computes the values that are applied to the attributes per frame (generally a YAHOO.util.Easing method)
</dd>
</dl>
</div>
</div>
</div>
</div>
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<!-- ============ METHOD DETAIL END ========== -->
</div>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<div id="footer">
<hr />
Copyright &copy; 2004 - 2005 Yahoo! Inc. All rights reserved.
<br />
Yahoo! Confidential.
<br /><br />
Documentation generated by <a href="http://jsdoc.sourceforge.net/">JSDoc</a>
version 1.9.5.8
</div>
</body>
</html>