docs/output/Ext.util.DelayedTask.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.util.DelayedTask-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.util.DelayedTask-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.util.DelayedTask-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                         <a class="bookmark" href="../docs/?class=Ext.util.DelayedTask"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   7         </div>
   8                 <h1>Class Ext.util.DelayedTask</h1>
   9         <table cellspacing="0">
  10             <tr><td class="label">Package:</td><td class="hd-info">Ext.util</td></tr>
  11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DelayedTask.js" target="_blank">DelayedTask.js</a></td></tr>
  12             <tr><td class="label">Class:</td><td class="hd-info">DelayedTask</td></tr>
  13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  14                     </table>
  15         <div class="description">
  16             *
  17 Provides a convenient method of performing setTimeout where a new
  18 timeout cancels the old timeout. An example would be performing validation on a keypress.
  19 You can use this class to buffer
  20 the keypress events for a certain number of milliseconds, and perform only if they stop
  21 for that amount of time.        </div>
  22
  23         <div class="hr"></div>
  24                 <a id="Ext.util.DelayedTask-props"></a>
  25         <h2>Public Properties</h2>
  26         <div class="no-members">This class has no public properties.</div>        <a id="Ext.util.DelayedTask-methods"></a>
  27         <h2>Public Methods</h2>
  28                 <table cellspacing="0" class="member-table">
  29             <tr>
  30                 <th class="sig-header" colspan="2">Method</th>
  31                 <th class="msource-header">Defined By</th>
  32             </tr>
  33                 <tr class="method-row expandable">\r
  34         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  35         <td class="sig">\r
  36         <a id="Ext.util.DelayedTask-DelayedTask"></a>\r
  37             <b>DelayedTask</b>(&nbsp;<span class="optional" title="Optional">[<code>Function fn</code>]</span>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>&nbsp;)            <div class="mdesc">\r
  38                         <div class="short">The parameters to this constructor serve as defaults and are not required.</div>\r
  39             <div class="long">\r
  40                 The parameters to this constructor serve as defaults and are not required.    <div class="mdetail-params">\r
  41         <strong>Parameters:</strong>\r
  42         <ul><li><code>fn</code> : Function<div class="sub-desc">(optional) The default function to timeout</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The default scope of that timeout</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The default Array of arguments</div></li>        </ul>\r
  43         <strong>Returns:</strong>\r
  44         <ul>\r
  45             <li><code></code></li>\r
  46         </ul>\r
  47     </div>\r
  48                 </div>\r
  49                         </div>\r
  50         </td>\r
  51         <td class="msource">DelayedTask</td>\r
  52     </tr>\r
  53         <tr class="method-row alt expandable">\r
  54         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  55         <td class="sig">\r
  56         <a id="Ext.util.DelayedTask-cancel"></a>\r
  57             <b>cancel</b>() : void            <div class="mdesc">\r
  58                         <div class="short">Cancel the last queued timeout</div>\r
  59             <div class="long">\r
  60                 Cancel the last queued timeout    <div class="mdetail-params">\r
  61         <strong>Parameters:</strong>\r
  62         <ul><li>None.</li>        </ul>\r
  63         <strong>Returns:</strong>\r
  64         <ul>\r
  65             <li><code>void</code></li>\r
  66         </ul>\r
  67     </div>\r
  68                 </div>\r
  69                         </div>\r
  70         </td>\r
  71         <td class="msource">DelayedTask</td>\r
  72     </tr>\r
  73         <tr class="method-row expandable">\r
  74         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  75         <td class="sig">\r
  76         <a id="Ext.util.DelayedTask-delay"></a>\r
  77             <b>delay</b>(&nbsp;<code>Number delay</code>, <span class="optional" title="Optional">[<code>Function newFn</code>]</span>, <span class="optional" title="Optional">[<code>Object newScope</code>]</span>, <span class="optional" title="Optional">[<code>Array newArgs</code>]</span>&nbsp;) : void            <div class="mdesc">\r
  78                         <div class="short">Cancels any pending timeout and queues a new one</div>\r
  79             <div class="long">\r
  80                 Cancels any pending timeout and queues a new one    <div class="mdetail-params">\r
  81         <strong>Parameters:</strong>\r
  82         <ul><li><code>delay</code> : Number<div class="sub-desc">The milliseconds to delay</div></li><li><code>newFn</code> : Function<div class="sub-desc">(optional) Overrides function passed to constructor</div></li><li><code>newScope</code> : Object<div class="sub-desc">(optional) Overrides scope passed to constructor</div></li><li><code>newArgs</code> : Array<div class="sub-desc">(optional) Overrides args passed to constructor</div></li>        </ul>\r
  83         <strong>Returns:</strong>\r
  84         <ul>\r
  85             <li><code>void</code></li>\r
  86         </ul>\r
  87     </div>\r
  88                 </div>\r
  89                         </div>\r
  90         </td>\r
  91         <td class="msource">DelayedTask</td>\r
  92     </tr>\r
  93             </table>
  94                 <a id="Ext.util.DelayedTask-events"></a>
  95         <h2>Public Events</h2>
  96         <div class="no-members">This class has no public events.</div>
  97         </div>