/**
* jquery.timer.js
*
* Copyright (c) 2011 Jason Chavannes <jason.chavannes@gmail.com>
*
* http://jchavannes.com/jquery-timer
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/*
$.timer( [ action ] , [ time ], [ autostart ] )
action A Function to be called by the timer.
time A Number determining how long between actions in milliseconds.
autostart A Boolean indicating whether to start the timer. Defaults to false.
var timer = $.timer(function() {
alert('This message was sent by a timer.');
});
timer.set({ time : 5000, autostart : true });
timer.set(options);
timer.play(reset); // Boolean. Defaults to false.
timer.pause();
timer.stop(); // Pause and resets
timer.toggle(reset); // Boolean. Defaults to false.
timer.once(time); // Number. Defaults to 0.
timer.isActive // Returns true if timer is running
timer.remaining // Remaining time when paused
*/
;(function($) {
$.timer = Timer;
/**
* First parameter can either be a function or an object of parameters.
*
* @param {function | {
* action: function,
* time: int=,
* autostart: boolean=
* }} action
* @param {int=} time
* @param {boolean=} autostart
* @returns {Timer}
*/
function Timer(action, time, autostart) {
if (this.constructor != Timer || this.init) {
return new Timer(action, time, autostart);
}
this.set(action, time, autostart);
return this;
}
/**
* @see Timer
*
* @param {function | {
* action: function,
* time: int=,
* autostart: boolean=
* }} action
* @param {int=} time
* @param {boolean=} autostart
* @returns {Timer}
*/
Timer.prototype.set = function(action, time, autostart) {
this.init = true;
if (typeof action == "object") {
if (action.time) {
time = action.time;
}
if (action.autostart) {
autostart = action.autostart;
}
action = action.action;
}
if (typeof action == "function") {
this.action = action;
}
if (!isNaN(time)) {
this.intervalTime = time;
}
if (autostart && this.isReadyToStart()) {
this.isActive = true;
this.setTimer();
}
return this;
};
Timer.prototype.isReadyToStart = function() {
var notActive = !this.active;
var hasAction = typeof this.action == "function";
var hasTime = !isNaN(this.intervalTime);
return notActive && hasAction && hasTime;
};
/**
* @param {int=} time
* @returns {Timer}
*/
Timer.prototype.once = function(time) {
var timer = this;
if (isNaN(time)) {
timer.action();
return this;
}
setTimeout(fnTimeout, time);
return this;
function fnTimeout() {
timer.action();
}
};
/**
* @param {boolean=} reset
* @returns {Timer}
*/
Timer.prototype.play = function(reset) {
if (this.isReadyToStart()) {
if (reset) {
this.setTimer();
}
else {
this.setTimer(this.remaining);
}
this.isActive = true;
}
return this;
};
/**
* @returns {Timer}
*/
Timer.prototype.pause = function() {
if (this.isActive) {
this.isActive = false;
this.remaining -= new Date() - this.last;
this.clearTimer();
}
return this;
};
/**
* @returns {Timer}
*/
Timer.prototype.stop = function() {
this.isActive = false;
this.remaining = this.intervalTime;
this.clearTimer();
return this;
};
/**
* @param {boolean=} reset
* @returns {Timer}
*/
Timer.prototype.toggle = function(reset) {
if (this.isActive) {
this.pause();
}
else if (reset) {
this.play(true);
}
else {
this.play();
}
return this;
};
/**
* @returns {Timer}
*/
Timer.prototype.reset = function() {
this.isActive = false;
this.play(true);
return this;
};
/**
* @returns {Timer}
*/
Timer.prototype.clearTimer = function() {
clearTimeout(this.timeoutObject);
return this;
};
/**
* @returns {Timer}
*/
Timer.prototype.setTimer = function(time) {
var timer = this;
if (isNaN(time)) {
time = this.intervalTime;
}
this.remaining = time;
this.last = new Date();
this.clearTimer();
this.timeoutObject = setTimeout(fnTimeout, time);
return this;
function fnTimeout() {
timer.execute();
}
};
/**
* @returns {Timer}
*/
Timer.prototype.execute = function() {
if (this.isActive) {
try {
this.action();
}
finally {
this.setTimer();
}
}
return this;
};
})(jQuery);
|
Download
