value-change.js.html revision 6a4ccbcd6643ac95948e8b7f9284b6e56f748cba
<head>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h3>value-change <span class="subtitle">3.2.0pr1</span></h3>
> value-change.js (source view)
<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>
<div id="srcout">
<style>
#doc3 .classopts { display:none; }
</style>
<div class="highlight"><pre><span class="cm">/**</span>
<span class="cm"> * Adds a synthetic <code>valueChange</code> event that fires when the</span>
<span class="cm"> * <code>value</code> property of an input field or textarea changes as a result</span>
<span class="cm"> * of a keystroke, mouse operation, or input method editor (IME) input event.</span>
<span class="cm"> *</span>
<span class="cm"> * @module value-change</span>
<span class="cm"> */</span>
<span class="cm">/**</span>
<span class="cm"> * Provides the implementation for the synthetic <code>valueChange</code> event.</span>
<span class="cm"> *</span>
<span class="cm"> * @class ValueChange</span>
<span class="cm"> * @static</span>
<span class="cm"> */</span>
<span class="kd">var</span> <span class="nx">VALUE</span> <span class="o">=</span> <span class="s1">'value'</span><span class="p">,</span>
<span class="nx">VALUE_CHANGE</span> <span class="o">=</span> <span class="s1">'valueChange'</span><span class="p">,</span>
<span class="c1">// Just a simple namespace to make methods overridable.</span>
<span class="nx">VC</span> <span class="o">=</span> <span class="p">{</span>
<span class="c1">// -- Static Constants -----------------------------------------------------</span>
<span class="nx">TIMEOUT</span><span class="o">:</span> <span class="mi">10000</span><span class="p">,</span>
<span class="c1">// -- Protected Static Properties ------------------------------------------</span>
<span class="nx">_events</span> <span class="o">:</span> <span class="p">{},</span>
<span class="nx">_history</span> <span class="o">:</span> <span class="p">{},</span>
<span class="nx">_intervals</span><span class="o">:</span> <span class="p">{},</span>
<span class="nx">_timeouts</span> <span class="o">:</span> <span class="p">{},</span>
<span class="c1">// -- Protected Static Methods ---------------------------------------------</span>
<span class="nx">_poll</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">node</span><span class="p">,</span> <span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">stamp</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">stamp</span><span class="p">(</span><span class="nx">node</span><span class="p">),</span>
<span class="nx">newVal</span> <span class="o">=</span> <span class="nx">node</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="nx">VALUE</span><span class="p">),</span>
<span class="nx">prevVal</span> <span class="o">=</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_history</span><span class="p">[</span><span class="nx">stamp</span><span class="p">];</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">newVal</span> <span class="o">!==</span> <span class="nx">prevVal</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_history</span><span class="p">[</span><span class="nx">stamp</span><span class="p">]</span> <span class="o">=</span> <span class="nx">newVal</span><span class="p">;</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_events</span><span class="p">[</span><span class="nx">stamp</span><span class="p">].</span><span class="nx">fire</span><span class="p">({</span>
<span class="c1">// _event : e, // TODO: is this correct?</span>
<span class="nx">newVal</span> <span class="o">:</span> <span class="nx">newVal</span><span class="p">,</span>
<span class="nx">prevVal</span><span class="o">:</span> <span class="nx">prevVal</span>
<span class="p">});</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_startPolling</span><span class="p">(</span><span class="nx">node</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="nx">_startPolling</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">node</span><span class="p">,</span> <span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">stamp</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">stamp</span><span class="p">(</span><span class="nx">node</span><span class="p">);</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_stopPolling</span><span class="p">(</span><span class="nx">node</span><span class="p">);</span> <span class="c1">// avoid dupes</span>
<span class="c1">// Poll for changes to the node's value. We can't rely on keyboard</span>
<span class="c1">// events for this, since the value may change due to a mouse-initiated</span>
<span class="c1">// paste event, an IME input event, or for some other reason that</span>
<span class="c1">// doesn't trigger a key event.</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_intervals</span><span class="p">[</span><span class="nx">stamp</span><span class="p">]</span> <span class="o">=</span> <span class="nx">setInterval</span><span class="p">(</span><span class="nx">Y</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">VC</span><span class="p">.</span><span class="nx">_poll</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="nx">node</span><span class="p">,</span> <span class="nx">e</span><span class="p">),</span> <span class="mi">20</span><span class="p">);</span>
<span class="c1">// If we don't see any changes within the timeout period (10 seconds by</span>
<span class="c1">// default), stop polling.</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_timeouts</span><span class="p">[</span><span class="nx">stamp</span><span class="p">]</span> <span class="o">=</span> <span class="nx">setTimeout</span><span class="p">(</span><span class="nx">Y</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">VC</span><span class="p">.</span><span class="nx">_stopPolling</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="nx">node</span><span class="p">),</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">TIMEOUT</span><span class="p">);</span>
<span class="p">},</span>
<span class="nx">_stopPolling</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">node</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">stamp</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">stamp</span><span class="p">(</span><span class="nx">node</span><span class="p">);</span>
<span class="nx">clearTimeout</span><span class="p">(</span><span class="nx">VC</span><span class="p">.</span><span class="nx">_timeouts</span><span class="p">[</span><span class="nx">stamp</span><span class="p">]);</span>
<span class="nx">clearInterval</span><span class="p">(</span><span class="nx">VC</span><span class="p">.</span><span class="nx">_intervals</span><span class="p">[</span><span class="nx">stamp</span><span class="p">]);</span>
<span class="p">},</span>
<span class="c1">// -- Protected Static Event Handlers --------------------------------------</span>
<span class="nx">_onBlur</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_stopPolling</span><span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">currentTarget</span><span class="p">);</span>
<span class="p">},</span>
<span class="nx">_onKeyDown</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_startPolling</span><span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">currentTarget</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="p">},</span>
<span class="nx">_onKeyUp</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// These charCodes indicate that an IME has started. We'll restart</span>
<span class="c1">// polling and give the IME up to 10 seconds (by default) to finish.</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">charCode</span> <span class="o">===</span> <span class="mi">229</span> <span class="o">||</span> <span class="nx">e</span><span class="p">.</span><span class="nx">charCode</span> <span class="o">===</span> <span class="mi">197</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_startPolling</span><span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">currentTarget</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="nx">_onMouseDown</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_startPolling</span><span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">currentTarget</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="p">},</span>
<span class="nx">_onSubscribe</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">node</span><span class="p">,</span> <span class="nx">subscription</span><span class="p">,</span> <span class="nx">customEvent</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">Y</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span><span class="nx">node</span><span class="p">).</span><span class="nx">each</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">node</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">stamp</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">stamp</span><span class="p">(</span><span class="nx">node</span><span class="p">);</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_events</span><span class="p">[</span><span class="nx">stamp</span><span class="p">]</span> <span class="o">=</span> <span class="nx">customEvent</span><span class="p">;</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_history</span><span class="p">[</span><span class="nx">stamp</span><span class="p">]</span> <span class="o">=</span> <span class="nx">node</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="nx">VALUE</span><span class="p">);</span>
<span class="nx">node</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="nx">VALUE_CHANGE</span> <span class="o">+</span> <span class="s1">'|blur'</span><span class="p">,</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_onBlur</span><span class="p">);</span>
<span class="nx">node</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="nx">VALUE_CHANGE</span> <span class="o">+</span> <span class="s1">'|mousedown'</span><span class="p">,</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_onMouseDown</span><span class="p">);</span>
<span class="nx">node</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="nx">VALUE_CHANGE</span> <span class="o">+</span> <span class="s1">'|keydown'</span><span class="p">,</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_onKeyDown</span><span class="p">);</span>
<span class="nx">node</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="nx">VALUE_CHANGE</span> <span class="o">+</span> <span class="s1">'|keyup'</span><span class="p">,</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_onKeyUp</span><span class="p">);</span>
<span class="p">});</span>
<span class="p">},</span>
<span class="nx">_onUnsubscribe</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">node</span><span class="p">,</span> <span class="nx">subscription</span><span class="p">,</span> <span class="nx">customEvent</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">Y</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span><span class="nx">node</span><span class="p">).</span><span class="nx">each</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">node</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">stamp</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">stamp</span><span class="p">(</span><span class="nx">node</span><span class="p">);</span>
<span class="nx">node</span><span class="p">.</span><span class="nx">detachAll</span><span class="p">(</span><span class="nx">VALUE_CHANGE</span> <span class="o">+</span> <span class="s1">'|*'</span><span class="p">);</span>
<span class="nx">VC</span><span class="p">.</span><span class="nx">_stopPolling</span><span class="p">(</span><span class="nx">node</span><span class="p">);</span>
<span class="k">delete</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_events</span><span class="p">[</span><span class="nx">stamp</span><span class="p">];</span>
<span class="k">delete</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_history</span><span class="p">[</span><span class="nx">stamp</span><span class="p">];</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * <p></span>
<span class="cm"> * Synthetic event that fires when the <code>value</code> property of an input</span>
<span class="cm"> * field or textarea changes as a result of a keystroke, mouse operation, or</span>
<span class="cm"> * input method editor (IME) input event.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * Unlike the <code>onchange</code> event, this event fires when the value</span>
<span class="cm"> * actually changes and not when the element loses focus. This event also</span>
<span class="cm"> * reports IME and multi-stroke input more reliably than <code>oninput</code> or</span>
<span class="cm"> * the various key events across browsers.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * This event is provided by the <code>value-change</code> module.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * <strong>Usage example:</strong></span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <code><pre></span>
<span class="cm"> * YUI().use('value-change', function (Y) {</span>
<span class="cm"> * &nbsp;&nbsp;Y.one('input').on('valueChange', function (e) {</span>
<span class="cm"> * &nbsp;&nbsp;&nbsp;&nbsp;// Handle valueChange events on the first input element on the page.</span>
<span class="cm"> * &nbsp;&nbsp;});</span>
<span class="cm"> * });</span>
<span class="cm"> * </pre></code></span>
<span class="cm"> *</span>
<span class="cm"> * @event valueChange</span>
<span class="cm"> * @param {EventFacade} e Event facade with the following additional</span>
<span class="cm"> * properties:</span>
<span class="cm"> *</span>
<span class="cm"> * <dl></span>
<span class="cm"> * <dt>prevVal (String)</dt></span>
<span class="cm"> * <dd></span>
<span class="cm"> * Previous value before the latest change.</span>
<span class="cm"> * </dd></span>
<span class="cm"> *</span>
<span class="cm"> * <dt>newVal (String)</dt></span>
<span class="cm"> * <dd></span>
<span class="cm"> * New value after the latest change.</span>
<span class="cm"> * </dd></span>
<span class="cm"> * </dl></span>
<span class="cm"> *</span>
<span class="cm"> * @for YUI</span>
<span class="cm"> */</span>
<span class="c1">// FIXME: synthetic events don't seem to respect the context param of on()</span>
<span class="nx">Y</span><span class="p">.</span><span class="nx">Event</span><span class="p">.</span><span class="nx">define</span><span class="p">(</span><span class="nx">VALUE_CHANGE</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">detach</span><span class="o">:</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_onUnsubscribe</span><span class="p">,</span>
<span class="nx">on</span> <span class="o">:</span> <span class="nx">VC</span><span class="p">.</span><span class="nx">_onSubscribe</span><span class="p">,</span>
<span class="nx">publishConfig</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">broadcast</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="nx">emitFacade</span><span class="o">:</span> <span class="kc">true</span>
<span class="p">}</span>
<span class="p">});</span>
<span class="nx">Y</span><span class="p">.</span><span class="nx">ValueChange</span> <span class="o">=</span> <span class="nx">VC</span><span class="p">;</span>
</pre></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_history-deprecated.html" title="history-deprecated">history-deprecated</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_scrollview-paginator.html" title="scrollview-paginator">scrollview-paginator</a></li>
<li class=""><a href="module_scrollview-scrollbars.html" title="scrollview-scrollbars">scrollview-scrollbars</a></li>
<li class=""><a href="module_widget-position-align.html" title="widget-position-align">widget-position-align</a></li>
<li class=""><a href="module_widget-position-constrain.html" title="widget-position-constrain">widget-position-constrain</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class="selected"><a href="value-change.js.html" title="value-change.js">value-change.js</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2010 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [];
</script>
</body>
</html>