Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 aperonnet 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="../source/util/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
            Provides a convenient method of performing setTimeout where a new
17
timeout cancels the old timeout. An example would be performing validation on a keypress.
18
You can use this class to buffer
19
the keypress events for a certain number of milliseconds, and perform only if they stop
20
for that amount of time.        </div>
21
 
22
        <div class="hr"></div>
23
                <a id="Ext.util.DelayedTask-props"></a>
24
        <h2>Public Properties</h2>
25
        <div class="no-members">This class has no public properties.</div>        <a id="Ext.util.DelayedTask-methods"></a>
26
        <h2>Public Methods</h2>
27
                <table cellspacing="0" class="member-table">
28
            <tr>
29
                <th class="sig-header" colspan="2">Method</th>
30
                <th class="msource-header">Defined By</th>
31
            </tr>
32
                <tr class="method-row expandable">
33
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
34
        <td class="sig">
35
        <a id="Ext.util.DelayedTask-DelayedTask"></a>
36
            <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">
37
                        <div class="short">The parameters to this constructor serve as defaults and are not required.</div>
38
            <div class="long">
39
                The parameters to this constructor serve as defaults and are not required.    <div class="mdetail-params">
40
        <strong>Parameters:</strong>
41
        <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>
42
        <strong>Returns:</strong>
43
        <ul>
44
            <li><code></code></li>
45
        </ul>
46
    </div>
47
                </div>
48
                        </div>
49
        </td>
50
        <td class="msource">DelayedTask</td>
51
    </tr>
52
        <tr class="method-row alt expandable">
53
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
54
        <td class="sig">
55
        <a id="Ext.util.DelayedTask-cancel"></a>
56
            <b>cancel</b>() : void            <div class="mdesc">
57
                        <div class="short">Cancel the last queued timeout</div>
58
            <div class="long">
59
                Cancel the last queued timeout    <div class="mdetail-params">
60
        <strong>Parameters:</strong>
61
        <ul><li>None.</li>        </ul>
62
        <strong>Returns:</strong>
63
        <ul>
64
            <li><code>void</code></li>
65
        </ul>
66
    </div>
67
                </div>
68
                        </div>
69
        </td>
70
        <td class="msource">DelayedTask</td>
71
    </tr>
72
        <tr class="method-row expandable">
73
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
74
        <td class="sig">
75
        <a id="Ext.util.DelayedTask-delay"></a>
76
            <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">
77
                        <div class="short">Cancels any pending timeout and queues a new one</div>
78
            <div class="long">
79
                Cancels any pending timeout and queues a new one    <div class="mdetail-params">
80
        <strong>Parameters:</strong>
81
        <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>
82
        <strong>Returns:</strong>
83
        <ul>
84
            <li><code>void</code></li>
85
        </ul>
86
    </div>
87
                </div>
88
                        </div>
89
        </td>
90
        <td class="msource">DelayedTask</td>
91
    </tr>
92
            </table>
93
                <a id="Ext.util.DelayedTask-events"></a>
94
        <h2>Public Events</h2>
95
        <div class="no-members">This class has no public events.</div>
96
        </div>