projects / roojs1 / blob
? search:


f8a421028b59fdf61dbb56478b63b6a37a252544
[roojs1] / docs / src / Roo_util_DelayedTask.js.html
1 <html><head><title>/home/edward/gitlive/roojs1/Roo/util/DelayedTask.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * &lt;script type=&quot;text/javascript&quot;&gt;
10  */
11
12 /**
13  * @class Roo.util.DelayedTask
14  * Provides a convenient method of performing setTimeout where a new
15  * timeout cancels the old timeout. An example would be performing validation on a keypress.
16  * You can use this class to buffer
17  * the keypress events for a certain number of milliseconds, and perform only if they stop
18  * for that amount of time.
19  * @constructor The parameters to this constructor serve as defaults and are not required.
20  * @param {Function} fn (optional) The default function to timeout
21  * @param {Object} scope (optional) The default scope of that timeout
22  * @param {Array} args (optional) The default Array of arguments
23  */
24 </span><span class="jsdoc-var">Roo.util.DelayedTask </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">fn</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">scope</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">args</span><span class="jsdoc-syntax">){
25     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">d</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">t</span><span class="jsdoc-syntax">;
26
27     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">call </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
28         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">now </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Date</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.getTime</span><span class="jsdoc-syntax">();
29         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">now </span><span class="jsdoc-syntax">- </span><span class="jsdoc-var">t </span><span class="jsdoc-syntax">&gt;= </span><span class="jsdoc-var">d</span><span class="jsdoc-syntax">){
30             </span><span class="jsdoc-var">clearInterval</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">);
31             </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
32             </span><span class="jsdoc-var">fn.apply</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">scope</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">args </span><span class="jsdoc-syntax">|| []);
33         }
34     };
35     </span><span class="jsdoc-comment">/**
36      * Cancels any pending timeout and queues a new one
37      * @param {Number} delay The milliseconds to delay
38      * @param {Function} newFn (optional) Overrides function passed to constructor
39      * @param {Object} newScope (optional) Overrides scope passed to constructor
40      * @param {Array} newArgs (optional) Overrides args passed to constructor
41      */
42     </span><span class="jsdoc-var">this.delay </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">delay</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">newFn</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">newScope</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">newArgs</span><span class="jsdoc-syntax">){
43         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">&amp;&amp; </span><span class="jsdoc-var">delay </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-var">d</span><span class="jsdoc-syntax">){
44             </span><span class="jsdoc-var">this.cancel</span><span class="jsdoc-syntax">();
45         }
46         </span><span class="jsdoc-var">d </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">delay</span><span class="jsdoc-syntax">;
47         </span><span class="jsdoc-var">t </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Date</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.getTime</span><span class="jsdoc-syntax">();
48         </span><span class="jsdoc-var">fn </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">newFn </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">fn</span><span class="jsdoc-syntax">;
49         </span><span class="jsdoc-var">scope </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">newScope </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">scope</span><span class="jsdoc-syntax">;
50         </span><span class="jsdoc-var">args </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">newArgs </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">args</span><span class="jsdoc-syntax">;
51         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">){
52             </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">setInterval</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">call</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">d</span><span class="jsdoc-syntax">);
53         }
54     };
55
56     </span><span class="jsdoc-comment">/**
57      * Cancel the last queued timeout
58      */
59     </span><span class="jsdoc-var">this.cancel </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
60         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">){
61             </span><span class="jsdoc-var">clearInterval</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">);
62             </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
63         }
64     };
65 };</span></code></body></html>
RooJS - Version 1