-
Notifications
You must be signed in to change notification settings - Fork 0
/
timeout.js
174 lines (161 loc) · 4.5 KB
/
timeout.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/**
* <title>PointedEars' DOM Library: Timeout</title>
* @requires object.js
*
* @section Copyright & Disclaimer
*
* @author
* (C) 2002-2013 Thomas Lahn <js@PointedEars.de>
*
* @partof PointedEars' JavaScript Extensions (JSX)
*
* JSX is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JSX is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with JSX. If not, see <http://www.gnu.org/licenses/>.
*/
if (typeof jsx == "undefined")
{
/**
* @namespace
*/
var jsx = {};
}
if (typeof jsx.dom == "undefined")
{
/**
* @namespace
*/
jsx.dom = {};
}
/**
* @namespace
*/
jsx.dom.timeout = (function () {
/* Imports */
var _isMethod = jsx.object.isMethod;
/* Private variables */
var _Timeout = (
/**
* Creates a container for code that can be run later.
*
* @constructor
* @param {Function} f
* Code to be run later. The default is <code>null</code>.
* @param {int} delay
* Milliseconds after which the code will be run by default.
*/
function jsx_dom_timeout_Timeout (f, delay) {
this.running = false;
this.code = f || null;
this.delay = parseInt(delay, 10) || 50;
}
).extend(null, {
/**
* Runs the associated code after <var>delay</var> milliseconds;
* cancels any planned but not yet performed executions.
*
* @memberOf jsx.dom.timeout.Timeout.prototype
* @param {Function} f
* Code to be run later. The default is the value of the
* <code>code</code> property as initialized upon construction.
* This argument's value will modify that property if the type
* is correct.
* @param {int} delay
* Milliseconds after which the code will be run by default.
* The default is the value of the <code>delay</code> property
* as initialized upon construction.
* This argument's value will modify that property if the type
* is correct.
* @return {jsx.dom.timeout.Timeout}
* This object
*/
run: function(f, delay) {
this.unset();
if (typeof f == "function")
{
this.code = f;
}
if (delay)
{
this.delay = parseInt(delay, 10);
}
if (_isMethod(jsx.global, "window", "setTimeout"))
{
this.running = true;
var me = this;
this.data = window.setTimeout(function() {
me.code();
me.unset();
}, this.delay);
}
return this;
},
/**
* Cancels the execution of the associated code
*/
unset: function() {
if (this.running)
{
if (_isMethod(jsx.global, "window", "clearTimeout"))
{
window.clearTimeout(this.data);
}
this.running = false;
}
}
});
return {
/**
* @memberOf jsx.dom.timeout
*/
Timeout: _Timeout,
TimeoutList: (
/**
* Provides a container for {@link #Timeout}s.
*
* @constructor
* @param {Array} timeouts
* The list of {@link jsx.dom.timeout#Timeout Timeouts} to be considered
*/
function jsx_dom_timeout_TimeoutList (timeouts) {
this.timeouts = timeouts || [];
}
).extend(null, {
/**
* Unsets all {@link #Timeout}s in this container
*
* @memberOf jsx.dom.timeout.TimeoutList.prototype
*/
unsetAll: function() {
for (var i = 0, timeouts = this.timeouts, len = timeouts.length; i < len; ++i)
{
timeouts[i].unset();
}
}
}),
/**
* Schedules code for later execution.
*
* @param {String|Function} code
* Code to be executed or function to be called.
* @param {number} iTimeout
* Number of milliseconds after which <var>code</var> should be run.
* The time of execution is implementation-dependent, but the timer
* will usually not start before control has returned to the caller.
* @return {jsx.dom.timeout.Timeout}
* The created <code>Timeout</code>
*/
runAsync: function (code, iTimeout) {
return (new _Timeout(code, iTimeout)).run();
}
};
}());