X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..05ce1c11e98b33f14ddee184493bd5a60dc947e2:/docs/source/DelayedTask.html diff --git a/docs/source/DelayedTask.html b/docs/source/DelayedTask.html index a237ace2..792a3c90 100644 --- a/docs/source/DelayedTask.html +++ b/docs/source/DelayedTask.html @@ -1,11 +1,17 @@ - - - The source code - - - - - 
/**
+
+
+  The source code
+    
+    
+
+
+    
/*!
+ * Ext JS Library 3.0.3
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+
/**
  * @class Ext.util.DelayedTask
  * 
 The DelayedTask class provides a convenient way to "buffer" the execution of a method,
  * performing setTimeout where a new timeout cancels the old timeout. When called, the
@@ -29,9 +35,10 @@ Ext.get('myInputField').on('keypress', function(){
  * option buffer for {@link Ext.util.Observable#addListener addListener/on} will
  * also setup a delayed task for you to buffer events.
 
  * @constructor The parameters to this constructor serve as defaults and are not required.
- * @param {Function} fn (optional) The default function to timeout
- * @param {Object} scope (optional) The default scope of that timeout
- * @param {Array} args (optional) The default Array of arguments
+ * @param {Function} fn (optional) The default function to call.
+ * @param {Object} scope The default scope (The this reference) in which the
+ * function is called. If not specified, this will refer to the browser window.
+ * @param {Array} args (optional) The default Array of arguments.
  */
 Ext.util.DelayedTask = function(fn, scope, args){
     var me = this,
@@ -46,7 +53,8 @@ Ext.util.DelayedTask = function(fn, scope, args){
      * 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 {Object} newScope (optional) Overrides scope passed to constructor. Remember that if no scope
+     * is specified, this will refer to the browser window.
      * @param {Array} newArgs (optional) Overrides args passed to constructor
      */
     me.delay = function(delay, newFn, newScope, newArgs){
@@ -66,6 +74,6 @@ Ext.util.DelayedTask = function(fn, scope, args){
             id = null;
         }
     };
-};
    
-
+};
+ \ No newline at end of file