plugin.DDNodeScroll.html revision 7ef3127958c8f2202b3879b91c259ef45f9e85c3
<head>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h3>dd <span class="subtitle">3.0.0b1</span></h3>
> plugin.DDNodeScroll
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</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>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
Extends the Scroll class to make a parent node scroll while dragging.
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<code>
(
)
</code>
<div class="description">
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div rel="yui:inheritance">
<h4>Properties inherited from <a href="DD.Scroll.html" property="yui:name" title="DD.Scroll">DD.Scroll</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<a class="private" href="DD.Scroll.html#property__dimCache" property="yui:name" title="_dimCache">_dimCache</a><span class="private">,</span>
</span>
<a class="private" href="DD.Scroll.html#property__scrolling" property="yui:name" title="_scrolling">_scrolling</a><span class="private">,</span>
</span>
<a class="private" href="DD.Scroll.html#property__scrollTimer" property="yui:name" title="_scrollTimer">_scrollTimer</a><span class="private">,</span>
</span>
<a class="private" href="DD.Scroll.html#property__vpRegionCache" property="yui:name" title="_vpRegionCache">_vpRegionCache</a>
</span>
</code>
</div>
</div>
<div class="content" rel="yui:properties">
<code>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div rel="yui:inheritance">
<h4>Methods inherited from <a href="DD.Scroll.html" property="yui:name" title="DD.Scroll">DD.Scroll</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<a class="private" href="DD.Scroll.html#method__cancelScroll" property="yui:name" title="_cancelScroll">_cancelScroll</a><span class="private">,</span>
</span>
<a class="private" href="DD.Scroll.html#method__checkWinScroll" property="yui:name" title="_checkWinScroll">_checkWinScroll</a><span class="private">,</span>
</span>
<a class="private" href="DD.Scroll.html#method__getVPRegion" property="yui:name" title="_getVPRegion">_getVPRegion</a><span class="private">,</span>
</span>
<a class="private" href="DD.Scroll.html#method__initScroll" property="yui:name" title="_initScroll">_initScroll</a><span class="private">,</span>
</span>
<a class="private" href="DD.Scroll.html#method__setDimCache" property="yui:name" title="_setDimCache">_setDimCache</a><span class="private">,</span>
</span>
<a class="" href="DD.Scroll.html#method_align" property="yui:name" title="align">align</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#method_end" property="yui:name" title="end">end</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#method_start" property="yui:name" title="start">start</a><span class="">,</span>
</span>
</span>
</code>
</div>
</div>
<div class="content" rel="yui:methods">
<code>
<a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span>
</span>
<a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span>
</span>
<a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span>
</span>
<a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span>
</span>
<a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span>
</span>
<a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span>
</span>
<a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span>
</span>
<a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span>
</span>
<a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span>
</span>
<a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span>
</span>
<a class="" href="Base.html#method_get" property="yui:name" title="get">get</a><span class="">,</span>
</span>
<a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span>
</span>
</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_nodeChange">
<h4>
<a name="event_nodeChange">nodeChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">nodeChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'node' 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>
</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">
<h4>Events inherited from <a href="DD.Scroll.html" property="yui:name" title="DD.Scroll">DD.Scroll</a>:</h4>
<div class="content" rel="yui:events">
<code>
<a class="" href="DD.Scroll.html#event_bufferChange" property="yui:name" title="bufferChange">bufferChange</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#event_horizontalChange" property="yui:name" title="horizontalChange">horizontalChange</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#event_hostChange" property="yui:name" title="hostChange">hostChange</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#event_parentScrollChange" property="yui:name" title="parentScrollChange">parentScrollChange</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#event_scrollDelayChange" property="yui:name" title="scrollDelayChange">scrollDelayChange</a>
</span>
<a class="" href="DD.Scroll.html#event_verticalChange" property="yui:name" title="verticalChange">verticalChange</a>
</span>
<a class="" href="DD.Scroll.html#event_windowScrollChange" property="yui:name" title="windowScrollChange">windowScrollChange</a>
</span>
</code>
</div>
</div>
<div class="content" rel="yui:events">
<code>
<a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span>
</span>
<a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span>
</span>
<a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span>
</span>
<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_node">
<h4><a name="config_node">node</a>
<code>- <span property="yui:type">Node</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The node we want to scroll. Used to set the internal parentScroll attribute.
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<h4>Configuration attributes inherited from <a href="DD.Scroll.html" property="yui:name" title="DD.Scroll">DD.Scroll</a>:</h4>
<div class="content" rel="yui:attributes">
<code>
<a class="" href="DD.Scroll.html#config_buffer" property="yui:name" title="buffer">buffer</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#config_horizontal" property="yui:name" title="horizontal">horizontal</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#config_host" property="yui:name" title="host">host</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#config_parentScroll" property="yui:name" title="parentScroll">parentScroll</a><span class="">,</span>
</span>
<a class="" href="DD.Scroll.html#config_scrollDelay" property="yui:name" title="scrollDelay">scrollDelay</a>
</span>
</span>
<a class="" href="DD.Scroll.html#config_windowScroll" property="yui:name" title="windowScroll">windowScroll</a>
</span>
</code>
</div>
</div>
<h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4>
<div class="content" rel="yui:attributes">
<code>
<a class="" href="Base.html#config_destroyed" property="yui:name" title="destroyed">destroyed</a><span class="">,</span>
</span>
<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_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="plugin.DDNodeScroll.html" title="plugin.DDNodeScroll">plugin.DDNodeScroll</a></li>
<li class=""><a href="plugin.DDWindowScroll.html" title="plugin.DDWindowScroll">plugin.DDWindowScroll</a></li>
<li class=""><a href="plugin.DragConstrained.html" title="plugin.DragConstrained">plugin.DragConstrained</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_nodeChange" title="nodeChange">nodeChange</a></li>
</ul>
</div>
<div id="configList" class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class=""><a href="#config_node" title="node">node</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = [{"access": "", "host": "DD.Scroll", "name": "align", "url": "DD.Scroll.html#method_align", "type": "method"}, {"access": "", "host": "DD.Scroll", "name": "buffer", "url": "DD.Scroll.html#config_buffer", "type": "config"}, {"access": "", "host": "DD.Scroll", "name": "bufferChange", "url": "DD.Scroll.html#event_bufferChange", "type": "event"}, {"access": "private", "host": "DD.Scroll", "name": "_cancelScroll", "url": "DD.Scroll.html#method__cancelScroll", "type": "method"}, {"access": "private", "host": "DD.Scroll", "name": "_checkWinScroll", "url": "DD.Scroll.html#method__checkWinScroll", "type": "method"}, {"access": "private", "host": "DD.Scroll", "name": "_dimCache", "url": "DD.Scroll.html#property__dimCache", "type": "property"}, {"access": "", "host": "DD.Scroll", "name": "end", "url": "DD.Scroll.html#method_end", "type": "method"}, {"access": "private", "host": "DD.Scroll", "name": "_getVPRegion", "url": "DD.Scroll.html#method__getVPRegion", "type": "method"}, {"access": "", "host": "DD.Scroll", "name": "horizontal", "url": "DD.Scroll.html#config_horizontal", "type": "config"}, {"access": "", "host": "DD.Scroll", "name": "horizontalChange", "url": "DD.Scroll.html#event_horizontalChange", "type": "event"}, {"access": "", "host": "DD.Scroll", "name": "host", "url": "DD.Scroll.html#config_host", "type": "config"}, {"access": "", "host": "DD.Scroll", "name": "hostChange", "url": "DD.Scroll.html#event_hostChange", "type": "event"}, {"access": "private", "host": "DD.Scroll", "name": "_initScroll", "url": "DD.Scroll.html#method__initScroll", "type": "method"}, {"access": "", "host": "plugin.DDNodeScroll", "name": "node", "url": "plugin.DDNodeScroll.html#config_node", "type": "config"}, {"access": "", "host": "plugin.DDNodeScroll", "name": "nodeChange", "url": "plugin.DDNodeScroll.html#event_nodeChange", "type": "event"}, {"access": "", "host": "DD.Scroll", "name": "parentScroll", "url": "DD.Scroll.html#config_parentScroll", "type": "config"}, {"access": "", "host": "DD.Scroll", "name": "parentScrollChange", "url": "DD.Scroll.html#event_parentScrollChange", "type": "event"}, {"access": "", "host": "DD.Scroll", "name": "scrollDelay", "url": "DD.Scroll.html#config_scrollDelay", "type": "config"}, {"access": "", "host": "DD.Scroll", "name": "scrollDelayChange", "url": "DD.Scroll.html#event_scrollDelayChange", "type": "event"}, {"access": "private", "host": "DD.Scroll", "name": "_scrolling", "url": "DD.Scroll.html#property__scrolling", "type": "property"}, {"access": "private", "host": "DD.Scroll", "name": "_scrollTimer", "url": "DD.Scroll.html#property__scrollTimer", "type": "property"}, {"access": "private", "host": "DD.Scroll", "name": "_setDimCache", "url": "DD.Scroll.html#method__setDimCache", "type": "method"}, {"access": "", "host": "DD.Scroll", "name": "start", "url": "DD.Scroll.html#method_start", "type": "method"}, {"access": "", "host": "DD.Scroll", "name": "toString", "url": "DD.Scroll.html#method_toString", "type": "method"}, {"access": "", "host": "DD.Scroll", "name": "vertical", "url": "DD.Scroll.html#config_vertical", "type": "config"}, {"access": "", "host": "DD.Scroll", "name": "verticalChange", "url": "DD.Scroll.html#event_verticalChange", "type": "event"}, {"access": "private", "host": "DD.Scroll", "name": "_vpRegionCache", "url": "DD.Scroll.html#property__vpRegionCache", "type": "property"}, {"access": "", "host": "DD.Scroll", "name": "windowScroll", "url": "DD.Scroll.html#config_windowScroll", "type": "config"}, {"access": "", "host": "plugin.DDWindowScroll", "name": "windowScroll", "url": "plugin.DDWindowScroll.html#config_windowScroll", "type": "config"}, {"access": "", "host": "DD.Scroll", "name": "windowScrollChange", "url": "DD.Scroll.html#event_windowScrollChange", "type": "event"}, {"access": "", "host": "plugin.DDWindowScroll", "name": "windowScrollChange", "url": "plugin.DDWindowScroll.html#event_windowScrollChange", "type": "event"}];
</script>
</body>
</html>