DelayedTask.js
/**
* @class Ext.util.DelayedTask
* Provides a convenient method of performing setTimeout where a new
* timeout cancels the old timeout. An example would be performing validation on a keypress.
* You can use this class to buffer
* the keypress events for a certain number of milliseconds, and perform only if they stop
* for that amount of time.
* @constructor The parameters to this constructor serve as defaults and are not required.
* @param {<i>Function</i>} fn (optional) The default function to timeout
* @param {<i>Object</i>} scope (optional) The default scope of that timeout
* @param {<i>Array</i>} args (optional) The default Array of arguments
*/
Ext.util.DelayedTask = function(fn, scope, args){
var timeoutId = null;
/**
* Cancels any pending timeout and queues a new one
* @param {Number} delay The milliseconds to delay
* @param {Function} newFn (optional) Overrides function passed to constructor
* @param {Object} newScope (optional) Overrides scope passed to constructor
* @param {Array} newArgs (optional) Overrides args passed to constructor
*/
this.delay = function(delay, newFn, newScope, newArgs){
if(timeoutId){
clearTimeout(timeoutId);
}
fn = newFn || fn;
scope = newScope || scope;
args = newArgs || args;
timeoutId = setTimeout(fn.createDelegate(scope, args), delay);
};
/**
* Cancel the last queued timeout
*/
this.cancel = function(){
if(timeoutId){
clearTimeout(timeoutId);
timeoutId = null;
}
};
};
yui-ext - Copyright © 2006 Jack Slocum. |
Yahoo! UI - Copyright © 2006 Yahoo! Inc.
All rights reserved.