Scroll.html revision 52ee826e6ffab531da043d694b9f792d9e430551
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: dd Scroll (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>dd&nbsp; <span class="subtitle">3.0.0b1</span></h3>
<a href="/index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
&gt; <a href="/module_dd.html" title="dd">dd</a>
&gt; Scroll
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
&nbsp;
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">Scroll</b>
<span class="extends">
- extends <a href="Base.html" title="Base">Base</a>
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
This class is the base scroller class used to create the plugin.DDNodeScroll and plugin.DDWinScroll.
This class should not be called on it's own, it's designed to be a plugin.
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">Scroll</strong>
<code>
(
)
</code>
<div class="description">
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="" rel="yui:property" resource="#property__dimCache">
<h4><a name="property__dimCache" property="yui:name">_dimCache</a>
- <code><span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Cache of the dragNode dims.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property__scrolling">
<h4><a name="property__scrolling" property="yui:name">_scrolling</a>
- <code><span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Tells if we are actively scrolling or not.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property__scrollTimer">
<h4><a name="property__scrollTimer" property="yui:name">_scrollTimer</a>
- <code><span property="yui:type">{Y.later}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Holder for the Timer object returned from Y.later.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property__vpRegionCache">
<h4><a name="property__vpRegionCache" property="yui:name">_vpRegionCache</a>
- <code><span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Cache of the Viewport dims.
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="Base.html">
<h4>Properties inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<span rel="yui:property" resource="Base.html#property_name">
<a class="" href="Base.html#property_name" property="yui:name" title="name">name</a>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private" rel="yui:method" resource="#method__cancelScroll">
<h4>
<a name="method__cancelScroll">_cancelScroll</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_cancelScroll</strong>
(
)
</code>
<div class="description" property="yui:description">
Cancel a currently running scroll timer.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__checkWinScroll">
<h4>
<a name="method__checkWinScroll">_checkWinScroll</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_checkWinScroll</strong>
(
move
)
</code>
<div class="description" property="yui:description">
Check to see if we need to fire the scroll timer. If scroll timer is running this will scroll the window.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">move</span>
&lt;<span property="yui:type">Boolean</span>&gt;
</code>
<span property="yui:description"> Should we move the window. From Y.later</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__getVPRegion">
<h4>
<a name="method__getVPRegion">_getVPRegion</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_getVPRegion</strong>
(
)
</code>
<div class="description" property="yui:description">
Sets the _vpRegionCache property with an Object containing the dims from the viewport.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__initScroll">
<h4>
<a name="method__initScroll">_initScroll</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_initScroll</strong>
(
)
</code>
<div class="description" property="yui:description">
Cancel a previous scroll timer and init a new one.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__setDimCache">
<h4>
<a name="method__setDimCache">_setDimCache</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_setDimCache</strong>
(
)
</code>
<div class="description" property="yui:description">
Set the cache of the dragNode dims.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_toString">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail" >
<code>
<strong property="yui:name">toString</strong>
(
)
</code>
<div class="description" property="yui:description">
General toString method for logging
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="Base.html">
<h4>Methods inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<span rel="yui:method" resource="Base.html#method__aggregateAttrs">
<a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__defDestroyFn">
<a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__defInitFn">
<a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__destroyHierarchy">
<a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__filterAttrCfs">
<a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__getAttrCfgs">
<a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__getClasses">
<a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__initHierarchy">
<a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="Base.html#method__initHierarchyData">
<a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="Base.html#method_destroy">
<a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span>
</span>
<span rel="yui:method" resource="Base.html#method_init">
<a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span>
</span>
<span rel="yui:method" resource="Base.html#method_toString">
<a class="" href="Base.html#method_toString" property="yui:name" title="toString">toString</a>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="" rel="yui:event" resource="#event_bufferChange">
<h4>
<a name="event_bufferChange">bufferChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">bufferChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'buffer' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">Event.Facade</span>&gt;
</code>
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_scrollDelayChange">
<h4>
<a name="event_scrollDelayChange">scrollDelayChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">scrollDelayChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'scrollDelay' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">Event.Facade</span>&gt;
</code>
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="Base.html">
<h4>Events inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4>
<div class="content" rel="yui:events">
<code>
<span rel="yui:event" resource="Base.html#event_destroy">
<a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span>
</span>
<span rel="yui:event" resource="Base.html#event_destroyedChange">
<a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span>
</span>
<span rel="yui:event" resource="Base.html#event_init">
<a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span>
</span>
<span rel="yui:event" resource="Base.html#event_initializedChange">
<a class="" href="Base.html#event_initializedChange" property="yui:name" title="initializedChange">initializedChange</a><span class="">,</span>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:attributes" resource="#configattributes">
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="" rel="yui:attribute" resource="#config_buffer">
<h4><a name="config_buffer">buffer</a>
<code>- <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The number of pixels from the edge of the screen to turn on scrolling. Default: 30
</div>
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_scrollDelay">
<h4><a name="config_scrollDelay">scrollDelay</a>
<code>- <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The number of milliseconds delay to pass to the auto scroller. Default: 235
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="Base.html">
<h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4>
<div class="content" rel="yui:attributes">
<code>
<span rel="yui:attribute" resource="Base.html#config_destroyed">
<a class="" href="Base.html#config_destroyed" property="yui:name" title="destroyed">destroyed</a><span class="">,</span>
</span>
<span rel="yui:attribute" resource="Base.html#config_initialized">
<a class="" href="Base.html#config_initialized" property="yui:name" title="initialized">initialized</a><span class="">,</span>
</span>
</code>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class="selected"><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dd-plugin.html" title="dd-plugin">dd-plugin</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_queue.html" title="queue">queue</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="plugin.DDM.html" title="plugin.DDM">plugin.DDM</a></li>
<li class=""><a href="plugin.DDNodeScroll.html" title="plugin.DDNodeScroll">plugin.DDNodeScroll</a></li>
<li class=""><a href="plugin.DDProxy.html" title="plugin.DDProxy">plugin.DDProxy</a></li>
<li class=""><a href="plugin.DDWindowScroll.html" title="plugin.DDWindowScroll">plugin.DDWindowScroll</a></li>
<li class=""><a href="plugin.Drag.html" title="plugin.Drag">plugin.Drag</a></li>
<li class=""><a href="plugin.DragConstrained.html" title="plugin.DragConstrained">plugin.DragConstrained</a></li>
<li class=""><a href="plugin.Drop.html" title="plugin.Drop">plugin.Drop</a></li>
<li class="selected"><a href="Scroll.html" title="Scroll">Scroll</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="dd-drop-plugin.js.html" title="dd-drop-plugin.js">dd-drop-plugin.js</a></li>
<li class=""><a href="dd-plugin.js.html" title="dd-plugin.js">dd-plugin.js</a></li>
<li class=""><a href="ddm-base.js.html" title="ddm-base.js">ddm-base.js</a></li>
<li class=""><a href="ddm-drop.js.html" title="ddm-drop.js">ddm-drop.js</a></li>
<li class=""><a href="ddm.js.html" title="ddm.js">ddm.js</a></li>
<li class=""><a href="drag.js.html" title="drag.js">drag.js</a></li>
<li class=""><a href="drop.js.html" title="drop.js">drop.js</a></li>
<li class=""><a href="proxy.js.html" title="proxy.js">proxy.js</a></li>
<li class=""><a href="scroll.js.html" title="scroll.js">scroll.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property__dimCache" title="_dimCache">_dimCache</a></li>
<li class=""><a href="#property__scrolling" title="_scrolling">_scrolling</a></li>
<li class=""><a href="#property__scrollTimer" title="_scrollTimer">_scrollTimer</a></li>
<li class=""><a href="#property__vpRegionCache" title="_vpRegionCache">_vpRegionCache</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><a href="#method__cancelScroll" title="_cancelScroll">_cancelScroll</a></li>
<li class="private"><a href="#method__checkWinScroll" title="_checkWinScroll">_checkWinScroll</a></li>
<li class="private"><a href="#method__getVPRegion" title="_getVPRegion">_getVPRegion</a></li>
<li class="private"><a href="#method__initScroll" title="_initScroll">_initScroll</a></li>
<li class="private"><a href="#method__setDimCache" title="_setDimCache">_setDimCache</a></li>
<li class=""><a href="#method_toString" title="toString">toString</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_bufferChange" title="bufferChange">bufferChange</a></li>
<li class=""><a href="#event_scrollDelayChange" title="scrollDelayChange">scrollDelayChange</a></li>
</ul>
</div>
<div id="configList" class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class=""><a href="#config_buffer" title="buffer">buffer</a></li>
<li class=""><a href="#config_scrollDelay" title="scrollDelay">scrollDelay</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = [{"access": "", "host": "Scroll", "name": "buffer", "url": "Scroll.html#config_buffer", "type": "config"}, {"access": "", "host": "Scroll", "name": "bufferChange", "url": "Scroll.html#event_bufferChange", "type": "event"}, {"access": "private", "host": "Scroll", "name": "_cancelScroll", "url": "Scroll.html#method__cancelScroll", "type": "method"}, {"access": "private", "host": "Scroll", "name": "_checkWinScroll", "url": "Scroll.html#method__checkWinScroll", "type": "method"}, {"access": "", "host": "Scroll", "name": "_dimCache", "url": "Scroll.html#property__dimCache", "type": "property"}, {"access": "private", "host": "Scroll", "name": "_getVPRegion", "url": "Scroll.html#method__getVPRegion", "type": "method"}, {"access": "private", "host": "Scroll", "name": "_initScroll", "url": "Scroll.html#method__initScroll", "type": "method"}, {"access": "", "host": "Scroll", "name": "scrollDelay", "url": "Scroll.html#config_scrollDelay", "type": "config"}, {"access": "", "host": "Scroll", "name": "scrollDelayChange", "url": "Scroll.html#event_scrollDelayChange", "type": "event"}, {"access": "", "host": "Scroll", "name": "_scrolling", "url": "Scroll.html#property__scrolling", "type": "property"}, {"access": "", "host": "Scroll", "name": "_scrollTimer", "url": "Scroll.html#property__scrollTimer", "type": "property"}, {"access": "private", "host": "Scroll", "name": "_setDimCache", "url": "Scroll.html#method__setDimCache", "type": "method"}, {"access": "", "host": "Scroll", "name": "toString", "url": "Scroll.html#method_toString", "type": "method"}, {"access": "", "host": "Scroll", "name": "_vpRegionCache", "url": "Scroll.html#property__vpRegionCache", "type": "property"}];
</script>
</body>
</html>