<!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: event-custom event-do.js (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>event-custom <span class="subtitle">3.0.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_event-custom.html" title="event-custom">event-custom</a>
> event-do.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="c">/**</span>
<span class="c"> * Custom event engine, DOM event listener abstraction layer, synthetic DOM </span>
<span class="c"> * events.</span>
<span class="c"> * @module event-custom</span>
<span class="c"> * @submodule event-custom-base</span>
<span class="c"> */</span>
<span class="o">(</span><span class="k">function</span><span class="o">()</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Allows for the insertion of methods that are executed before or after</span>
<span class="c"> * a specified method</span>
<span class="c"> * @class Do</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="k">var</span> <span class="nx">BEFORE</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span>
<span class="nx">AFTER</span> <span class="o">=</span> <span class="m">1</span><span class="o">;</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span> <span class="o">=</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Cache of objects touched by the utility</span>
<span class="c"> * @property objs</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="nx">objs</span><span class="o">:</span> <span class="o">{},</span>
<span class="c">/**</span>
<span class="c"> * Execute the supplied method before the specified function</span>
<span class="c"> * @method before</span>
<span class="c"> * @param fn {Function} the function to execute</span>
<span class="c"> * @param obj the object hosting the method to displace</span>
<span class="c"> * @param sFn {string} the name of the method to displace</span>
<span class="c"> * @param c The execution context for fn</span>
<span class="c"> * @return {string} handle for the subscription</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="nx">before</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">,</span> <span class="nx">c</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// Y.log('Do before: ' + sFn, 'info', 'event');</span>
<span class="c"></span> <span class="k">var</span> <span class="nx">f</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">a</span><span class="o">;</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">c</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">a</span> <span class="o">=</span> <span class="o">[</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">c</span><span class="o">].</span><span class="nx">concat</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">4</span><span class="o">,</span> <span class="kc">true</span><span class="o">));</span>
<span class="nx">f</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">rbind</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">Y</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span>
<span class="o">}</span>
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_inject</span><span class="o">(</span><span class="nx">BEFORE</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">);</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Execute the supplied method after the specified function</span>
<span class="c"> * @method after</span>
<span class="c"> * @param fn {Function} the function to execute</span>
<span class="c"> * @param obj the object hosting the method to displace</span>
<span class="c"> * @param sFn {string} the name of the method to displace</span>
<span class="c"> * @param c The execution context for fn</span>
<span class="c"> * @return {string} handle for the subscription</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="nx">after</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">,</span> <span class="nx">c</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">f</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">a</span><span class="o">;</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">c</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">a</span> <span class="o">=</span> <span class="o">[</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">c</span><span class="o">].</span><span class="nx">concat</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">4</span><span class="o">,</span> <span class="kc">true</span><span class="o">));</span>
<span class="nx">f</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">rbind</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">Y</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span>
<span class="o">}</span>
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_inject</span><span class="o">(</span><span class="nx">AFTER</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">);</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Execute the supplied method after the specified function</span>
<span class="c"> * @method _inject</span>
<span class="c"> * @param when {string} before or after</span>
<span class="c"> * @param fn {Function} the function to execute</span>
<span class="c"> * @param obj the object hosting the method to displace</span>
<span class="c"> * @param sFn {string} the name of the method to displace</span>
<span class="c"> * @param c The execution context for fn</span>
<span class="c"> * @return {string} handle for the subscription</span>
<span class="c"> * @private</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="nx">_inject</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">when</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// object id</span>
<span class="c"></span> <span class="k">var</span> <span class="nx">id</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">stamp</span><span class="o">(</span><span class="nx">obj</span><span class="o">),</span> <span class="nx">o</span><span class="o">,</span> <span class="nx">sid</span><span class="o">;</span>
<span class="k">if</span> <span class="o">(!</span> <span class="k">this</span><span class="o">.</span><span class="nx">objs</span><span class="o">[</span><span class="nx">id</span><span class="o">])</span> <span class="o">{</span>
<span class="c">// create a map entry for the obj if it doesn't exist</span>
<span class="c"></span> <span class="k">this</span><span class="o">.</span><span class="nx">objs</span><span class="o">[</span><span class="nx">id</span><span class="o">]</span> <span class="o">=</span> <span class="o">{};</span>
<span class="o">}</span>
<span class="nx">o</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">objs</span><span class="o">[</span><span class="nx">id</span><span class="o">];</span>
<span class="k">if</span> <span class="o">(!</span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">])</span> <span class="o">{</span>
<span class="c">// create a map entry for the method if it doesn't exist</span>
<span class="c"></span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">(</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">);</span>
<span class="c">// re-route the method to our wrapper</span>
<span class="c"></span> <span class="nx">obj</span><span class="o">[</span><span class="nx">sFn</span><span class="o">]</span> <span class="o">=</span>
<span class="k">function</span><span class="o">()</span> <span class="o">{</span>
<span class="k">return</span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">].</span><span class="nx">exec</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">],</span> <span class="nx">arguments</span><span class="o">);</span>
<span class="o">};</span>
<span class="o">}</span>
<span class="c">// subscriber id</span>
<span class="c"></span> <span class="nx">sid</span> <span class="o">=</span> <span class="nx">id</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">stamp</span><span class="o">(</span><span class="nx">fn</span><span class="o">)</span> <span class="o">+</span> <span class="nx">sFn</span><span class="o">;</span>
<span class="c">// register the callback</span>
<span class="c"></span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">].</span><span class="nx">register</span><span class="o">(</span><span class="nx">sid</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">when</span><span class="o">);</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">EventHandle</span><span class="o">(</span><span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">],</span> <span class="nx">sid</span><span class="o">);</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Detach a before or after subscription</span>
<span class="c"> * @method detach</span>
<span class="c"> * @param handle {string} the subscription handle</span>
<span class="c"> */</span>
<span class="nx">detach</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">handle</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">handle</span><span class="o">.</span><span class="nx">detach</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">handle</span><span class="o">.</span><span class="nx">detach</span><span class="o">();</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="nx">_unload</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">,</span> <span class="nx">me</span><span class="o">)</span> <span class="o">{</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="c">//////////////////////////////////////////////////////////////////////////</span>
<span class="c"></span>
<span class="c">/**</span>
<span class="c"> * Wrapper for a displaced method with aop enabled</span>
<span class="c"> * @class Do.Method</span>
<span class="c"> * @constructor</span>
<span class="c"> * @param obj The object to operate on</span>
<span class="c"> * @param sFn The name of the method to displace</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">obj</span> <span class="o">=</span> <span class="nx">obj</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="nx">methodName</span> <span class="o">=</span> <span class="nx">sFn</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="nx">method</span> <span class="o">=</span> <span class="nx">obj</span><span class="o">[</span><span class="nx">sFn</span><span class="o">];</span>
<span class="k">this</span><span class="o">.</span><span class="nx">before</span> <span class="o">=</span> <span class="o">{};</span>
<span class="k">this</span><span class="o">.</span><span class="nx">after</span> <span class="o">=</span> <span class="o">{};</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Register a aop subscriber</span>
<span class="c"> * @method register</span>
<span class="c"> * @param sid {string} the subscriber id</span>
<span class="c"> * @param fn {Function} the function to execute</span>
<span class="c"> * @param when {string} when to execute the function</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">.</span><span class="nx">prototype</span><span class="o">.</span><span class="nx">register</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">sid</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">when</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">when</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">[</span><span class="nx">sid</span><span class="o">]</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">;</span>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">before</span><span class="o">[</span><span class="nx">sid</span><span class="o">]</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Unregister a aop subscriber</span>
<span class="c"> * @method delete</span>
<span class="c"> * @param sid {string} the subscriber id</span>
<span class="c"> * @param fn {Function} the function to execute</span>
<span class="c"> * @param when {string} when to execute the function</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">.</span><span class="nx">prototype</span><span class="o">.</span><span class="nx">_delete</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">sid</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// Y.log('Y.Do._delete: ' + sid, 'info', 'Event');</span>
<span class="c"></span> <span class="nx">delete</span> <span class="k">this</span><span class="o">.</span><span class="nx">before</span><span class="o">[</span><span class="nx">sid</span><span class="o">];</span>
<span class="nx">delete</span> <span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">[</span><span class="nx">sid</span><span class="o">];</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Execute the wrapped method</span>
<span class="c"> * @method exec</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">.</span><span class="nx">prototype</span><span class="o">.</span><span class="nx">exec</span> <span class="o">=</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">args</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">0</span><span class="o">,</span> <span class="kc">true</span><span class="o">),</span>
<span class="nx">i</span><span class="o">,</span> <span class="nx">ret</span><span class="o">,</span> <span class="nx">newRet</span><span class="o">,</span>
<span class="nx">bf</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">before</span><span class="o">,</span>
<span class="nx">af</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">,</span>
<span class="nx">prevented</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span>
<span class="c">// execute before</span>
<span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="k">in</span> <span class="nx">bf</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">bf</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">i</span><span class="o">))</span> <span class="o">{</span>
<span class="nx">ret</span> <span class="o">=</span> <span class="nx">bf</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">ret</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">switch</span> <span class="o">(</span><span class="nx">ret</span><span class="o">.</span><span class="nx">constructor</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">case</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span><span class="o">:</span>
<span class="k">return</span> <span class="nx">ret</span><span class="o">.</span><span class="nx">retVal</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterArgs</span><span class="o">:</span>
<span class="nx">args</span> <span class="o">=</span> <span class="nx">ret</span><span class="o">.</span><span class="nx">newArgs</span><span class="o">;</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Prevent</span><span class="o">:</span>
<span class="nx">prevented</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">default</span><span class="o">:</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="c">// execute method</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(!</span><span class="nx">prevented</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">ret</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">method</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span>
<span class="o">}</span>
<span class="c">// execute after methods.</span>
<span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="k">in</span> <span class="nx">af</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">af</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">i</span><span class="o">))</span> <span class="o">{</span>
<span class="nx">newRet</span> <span class="o">=</span> <span class="nx">af</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span>
<span class="c">// Stop processing if a Halt object is returned</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">newRet</span> <span class="o">&&</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">constructor</span> <span class="o">==</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">retVal</span><span class="o">;</span>
<span class="c">// Check for a new return value</span>
<span class="c"></span> <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">newRet</span> <span class="o">&&</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">constructor</span> <span class="o">==</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterReturn</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">ret</span> <span class="o">=</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">newRetVal</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="k">return</span> <span class="nx">ret</span><span class="o">;</span>
<span class="o">};</span>
<span class="c">//////////////////////////////////////////////////////////////////////////</span>
<span class="c"></span>
<span class="c">/**</span>
<span class="c"> * Return an AlterArgs object when you want to change the arguments that</span>
<span class="c"> * were passed into the function. An example would be a service that scrubs</span>
<span class="c"> * out illegal characters prior to executing the core business logic.</span>
<span class="c"> * @class Do.AlterArgs</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterArgs</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">newArgs</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="nx">newArgs</span> <span class="o">=</span> <span class="nx">newArgs</span><span class="o">;</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Return an AlterReturn object when you want to change the result returned</span>
<span class="c"> * from the core method to the caller</span>
<span class="c"> * @class Do.AlterReturn</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterReturn</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">newRetVal</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="nx">newRetVal</span> <span class="o">=</span> <span class="nx">newRetVal</span><span class="o">;</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Return a Halt object when you want to terminate the execution</span>
<span class="c"> * of all subsequent subscribers as well as the wrapped method</span>
<span class="c"> * if it has not exectued yet.</span>
<span class="c"> * @class Do.Halt</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">retVal</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="nx">retVal</span> <span class="o">=</span> <span class="nx">retVal</span><span class="o">;</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Return a Prevent object when you want to prevent the wrapped function</span>
<span class="c"> * from executing, but want the remaining listeners to execute</span>
<span class="c"> * @class Do.Prevent</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Prevent</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Return an Error object when you want to terminate the execution</span>
<span class="c"> * of all subsequent method calls.</span>
<span class="c"> * @class Do.Error</span>
<span class="c"> * @deprecated use Y.Do.Halt or Y.Do.Prevent</span>
<span class="c"> */</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nb">Error</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span><span class="o">;</span>
<span class="c">//////////////////////////////////////////////////////////////////////////</span>
<span class="c"></span>
<span class="c">// Y["Event"] && Y.Event.addListener(window, "unload", Y.Do._unload, Y.Do);</span>
<span class="c"></span>
<span class="o">})();</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_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</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_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</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="selected"><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_imageloader.html" title="imageloader">imageloader</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-focusmanager.html" title="node-focusmanager">node-focusmanager</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_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_test.html" title="test">test</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>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="CustomEvent.html" title="CustomEvent">CustomEvent</a></li>
<li class=""><a href="Do.html" title="Do">Do</a></li>
<li class=""><a href="Do.AlterArgs.html" title="Do.AlterArgs">Do.AlterArgs</a></li>
<li class=""><a href="Do.AlterReturn.html" title="Do.AlterReturn">Do.AlterReturn</a></li>
<li class=""><a href="Do.Error.html" title="Do.Error">Do.Error</a></li>
<li class=""><a href="Do.Halt.html" title="Do.Halt">Do.Halt</a></li>
<li class=""><a href="Do.Method.html" title="Do.Method">Do.Method</a></li>
<li class=""><a href="Do.Prevent.html" title="Do.Prevent">Do.Prevent</a></li>
<li class=""><a href="EventFacade.html" title="EventFacade">EventFacade</a></li>
<li class=""><a href="EventHandle.html" title="EventHandle">EventHandle</a></li>
<li class=""><a href="EventTarget.html" title="EventTarget">EventTarget</a></li>
<li class=""><a href="Subscriber.html" title="Subscriber">Subscriber</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="event-custom.js.html" title="event-custom.js">event-custom.js</a></li>
<li class="selected"><a href="event-do.js.html" title="event-do.js">event-do.js</a></li>
<li class=""><a href="event-facade.js.html" title="event-facade.js">event-facade.js</a></li>
<li class=""><a href="event-target.js.html" title="event-target.js">event-target.js</a></li>
<li class=""><a href="event.js.html" title="event.js">event.js</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": "EventTarget", "name": "addTarget", "url": "EventTarget.html#method_addTarget", "type": "method"}, {"access": "", "host": "EventTarget", "name": "after", "url": "EventTarget.html#method_after", "type": "method"}, {"access": "", "host": "Do", "name": "after", "url": "Do.html#method_after", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "after", "url": "CustomEvent.html#method_after", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "afters", "url": "CustomEvent.html#property_afters", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "applyConfig", "url": "CustomEvent.html#method_applyConfig", "type": "method"}, {"access": "", "host": "Subscriber", "name": "args", "url": "Subscriber.html#property_args", "type": "property"}, {"access": "", "host": "EventTarget", "name": "before", "url": "EventTarget.html#method_before", "type": "method"}, {"access": "", "host": "Do", "name": "before", "url": "Do.html#method_before", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "broadcast", "url": "CustomEvent.html#property_broadcast", "type": "property"}, {"access": "", "host": "EventTarget", "name": "bubble", "url": "EventTarget.html#method_bubble", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "bubbles", "url": "CustomEvent.html#property_bubbles", "type": "property"}, {"access": "", "host": "Subscriber", "name": "contains", "url": "Subscriber.html#method_contains", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "context", "url": "CustomEvent.html#property_context", "type": "property"}, {"access": "", "host": "Subscriber", "name": "context", "url": "Subscriber.html#property_context", "type": "property"}, {"access": "", "host": "EventFacade", "name": "currentTarget", "url": "EventFacade.html#property_currentTarget", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "defaultFn", "url": "CustomEvent.html#property_defaultFn", "type": "property"}, {"access": "", "host": "Do.Method", "name": "delete", "url": "Do.Method.html#method_delete", "type": "method"}, {"access": "private", "host": "CustomEvent", "name": "_delete", "url": "CustomEvent.html#method__delete", "type": "method"}, {"access": "", "host": "EventTarget", "name": "detach", "url": "EventTarget.html#method_detach", "type": "method"}, {"access": "", "host": "Do", "name": "detach", "url": "Do.html#method_detach", "type": "method"}, {"access": "", "host": "EventHandle", "name": "detach", "url": "EventHandle.html#method_detach", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "detach", "url": "CustomEvent.html#method_detach", "type": "method"}, {"access": "", "host": "EventTarget", "name": "detachAll", "url": "EventTarget.html#method_detachAll", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "detachAll", "url": "CustomEvent.html#method_detachAll", "type": "method"}, {"access": "", "host": "EventFacade", "name": "details", "url": "EventFacade.html#property_details", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "emitFacade", "url": "CustomEvent.html#property_emitFacade", "type": "property"}, {"access": "", "host": "Subscriber", "name": "events", "url": "Subscriber.html#property_events", "type": "property"}, {"access": "", "host": "EventHandle", "name": "evt", "url": "EventHandle.html#property_evt", "type": "property"}, {"access": "", "host": "Do.Method", "name": "exec", "url": "Do.Method.html#method_exec", "type": "method"}, {"access": "", "host": "EventTarget", "name": "fire", "url": "EventTarget.html#method_fire", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "fire", "url": "CustomEvent.html#method_fire", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "fired", "url": "CustomEvent.html#property_fired", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "firedWith", "url": "CustomEvent.html#property_firedWith", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "fireOnce", "url": "CustomEvent.html#property_fireOnce", "type": "property"}, {"access": "", "host": "Subscriber", "name": "fn", "url": "Subscriber.html#property_fn", "type": "property"}, {"access": "", "host": "EventTarget", "name": "getEvent", "url": "EventTarget.html#method_getEvent", "type": "method"}, {"access": "private", "host": "EventTarget", "name": "_getType", "url": "EventTarget.html#method__getType", "type": "method"}, {"access": "", "host": "EventFacade", "name": "halt", "url": "EventFacade.html#method_halt", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "halt", "url": "CustomEvent.html#method_halt", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "host", "url": "CustomEvent.html#property_host", "type": "property"}, {"access": "", "host": "Subscriber", "name": "id", "url": "Subscriber.html#property_id", "type": "property"}, {"access": "private", "host": "Do", "name": "_inject", "url": "Do.html#method__inject", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "log", "url": "CustomEvent.html#method_log", "type": "method"}, {"access": "private", "host": "CustomEvent", "name": "_notify", "url": "CustomEvent.html#method__notify", "type": "method"}, {"access": "", "host": "Subscriber", "name": "notify", "url": "Subscriber.html#method_notify", "type": "method"}, {"access": "", "host": "Do", "name": "objs", "url": "Do.html#property_objs", "type": "property"}, {"access": "", "host": "EventTarget", "name": "on", "url": "EventTarget.html#method_on", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "on", "url": "CustomEvent.html#method_on", "type": "method"}, {"access": "private", "host": "EventTarget", "name": "_parseType", "url": "EventTarget.html#method__parseType", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "preventable", "url": "CustomEvent.html#property_preventable", "type": "property"}, {"access": "", "host": "EventFacade", "name": "preventDefault", "url": "EventFacade.html#method_preventDefault", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "preventDefault", "url": "CustomEvent.html#method_preventDefault", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "prevented", "url": "CustomEvent.html#property_prevented", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "preventedFn", "url": "CustomEvent.html#property_preventedFn", "type": "property"}, {"access": "", "host": "EventTarget", "name": "publish", "url": "EventTarget.html#method_publish", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "queuable", "url": "CustomEvent.html#property_queuable", "type": "property"}, {"access": "", "host": "Do.Method", "name": "register", "url": "Do.Method.html#method_register", "type": "method"}, {"access": "", "host": "EventFacade", "name": "relatedTarget", "url": "EventFacade.html#property_relatedTarget", "type": "property"}, {"access": "", "host": "EventTarget", "name": "removeTarget", "url": "EventTarget.html#method_removeTarget", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "signature", "url": "CustomEvent.html#property_signature", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "silent", "url": "CustomEvent.html#property_silent", "type": "property"}, {"access": "", "host": "EventFacade", "name": "stopImmediatePropagation", "url": "EventFacade.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopImmediatePropagation", "url": "CustomEvent.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopped", "url": "CustomEvent.html#property_stopped", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "stoppedFn", "url": "CustomEvent.html#property_stoppedFn", "type": "property"}, {"access": "", "host": "EventFacade", "name": "stopPropagation", "url": "EventFacade.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopPropagation", "url": "CustomEvent.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "EventHandle", "name": "sub", "url": "EventHandle.html#property_sub", "type": "property"}, {"access": "", "host": "EventTarget", "name": "subscribe", "url": "EventTarget.html#method_subscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "subscribe", "url": "CustomEvent.html#method_subscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "subscribers", "url": "CustomEvent.html#property_subscribers", "type": "property"}, {"access": "", "host": "EventFacade", "name": "target", "url": "EventFacade.html#property_target", "type": "property"}, {"access": "", "host": "EventFacade", "name": "type", "url": "EventFacade.html#property_type", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "type", "url": "CustomEvent.html#property_type", "type": "property"}, {"access": "", "host": "EventTarget", "name": "unsubscribe", "url": "EventTarget.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "unsubscribe", "url": "CustomEvent.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "EventTarget", "name": "unsubscribeAll", "url": "EventTarget.html#method_unsubscribeAll", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "unsubscribeAll", "url": "CustomEvent.html#method_unsubscribeAll", "type": "method"}];
</script>
</body>
</html>