Upgrade to ExtJS 3.0.3 - Released 10/11/2009

[extjs.git] / docs / source / DelayedTask.html
diff --git a/docs/source/DelayedTask.html b/docs/source/DelayedTask.html

index a237ace..792a3c9 100644 (file)
--- a/docs/source/DelayedTask.html
+++ b/docs/source/DelayedTask.html
@@ -1,11 +1,17 @@
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.util.DelayedTask"></div>/**
+<html>
+<head>
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.0.3
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.util.DelayedTask"></div>/**
   * @class Ext.util.DelayedTask
   * <p> 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
   * @class Ext.util.DelayedTask
   * <p> 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 <tt>buffer</tt> for {@link Ext.util.Observable#addListener addListener/on} will
   * also setup a delayed task for you to buffer events.</p> 
   * @constructor The parameters to this constructor serve as defaults and are not required.
   * option <tt>buffer</tt> for {@link Ext.util.Observable#addListener addListener/on} will
   * also setup a delayed task for you to buffer events.</p> 
   * @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 <code><b>this</b></code> reference) in which the
+ * function is called. If not specified, <code>this</code> 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,
   */
  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
       * 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, <code>this</code> will refer to the browser window.
       * @param {Array} newArgs (optional) Overrides args passed to constructor
       */
      me.delay = function(delay, newFn, newScope, newArgs){
       * @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;
          }
      };
              id = null;
          }
      };
-};</pre>    \r
-</body>\r
+};</pre>
+</body>
  </html>
 \ No newline at end of file
  </html>
 \ No newline at end of file