Idle timer

build/gallery-idletimer/gallery-idletimer-debug.js

@@ -0,0 +1,150 @@
+YUI.add('gallery-idletimer', function(Y) {
+
+/*
+ * Copyright (c) 2009 Nicholas C. Zakas. All rights reserved.
+ * http://www.nczonline.net/
+ */
+
+/**
+ * Idle timer
+ * @module gallery-idletimer
+ */
+
+//-------------------------------------------------------------------------
+// Private variables
+//-------------------------------------------------------------------------
+
+var idle    = false,        //indicates if the user is idle
+    tId     = -1,           //timeout ID
+    enabled = false,        //indicates if the idle timer is enabled
+    timeout = 30000;        //the amount of time (ms) before the user is considered idle
+
+//-------------------------------------------------------------------------
+// Private functions
+//-------------------------------------------------------------------------
+
+/* (intentionally not documented)
+ * Handles a user event indicating that the user isn't idle.
+ * @param {Event} event A DOM2-normalized event object.
+ * @return {void}
+ */
+function handleUserEvent(){
+
+    //clear any existing timeout
+    clearTimeout(tId);
+
+    //if the idle timer is enabled
+    if (enabled){
+
+        //if it's idle, that means the user is no longer idle
+        if (idle){
+            toggleIdleState();           
+        } 
+
+        //set a new timeout
+        tId = setTimeout(toggleIdleState, timeout);
+    }    
+}
+
+/* (intentionally not documented)
+ * Toggles the idle state and fires an appropriate event.
+ * @return {void}
+ */
+function toggleIdleState(){
+
+    //toggle the state
+    idle = !idle;
+
+    //fire appropriate event
+    Y.IdleTimer.fire(idle ? "idle" : "active");            
+}
+
+//-------------------------------------------------------------------------
+// Public interface
+//-------------------------------------------------------------------------
+
+/**
+ * Centralized control for determining when a user has become idle
+ * on the current page.
+ * @class IdleTimer
+ * @static
+ */
+Y.IdleTimer = {
+
+    /**
+     * Indicates if the idle timer is running or not.
+     * @return {Boolean} True if the idle timer is running, false if not.
+     * @method isRunning
+     * @static
+     */
+    isRunning: function(){
+        return enabled;
+    },
+
+    /**
+     * Indicates if the user is idle or not.
+     * @return {Boolean} True if the user is idle, false if not.
+     * @method isIdle
+     * @static
+     */        
+    isIdle: function(){
+        return idle;
+    },
+
+    /**
+     * Starts the idle timer. This adds appropriate event handlers
+     * and starts the first timeout.
+     * @param {int} newTimeout (Optional) A new value for the timeout period in ms.
+     * @return {void}
+     * @method start
+     * @static
+     */ 
+    start: function(newTimeout){
+
+        //set to enabled
+        enabled = true;
+
+        //set idle to false to begin with
+        idle = false;
+
+        //assign a new timeout if necessary
+        if (typeof newTimeout == "number"){
+            timeout = newTimeout;
+        }
+
+        //assign appropriate event handlers
+        Y.on("mousemove", handleUserEvent, document);
+        Y.on("keydown", handleUserEvent, document);
+
+        //set a timeout to toggle state
+        tId = setTimeout(toggleIdleState, timeout);
+    },
+
+    /**
+     * Stops the idle timer. This removes appropriate event handlers
+     * and cancels any pending timeouts.
+     * @return {void}
+     * @method stop
+     * @static
+     */         
+    stop: function(){
+
+        //set to disabled
+        enabled = false;
+
+        //clear any pending timeouts
+        clearTimeout(tId);
+
+        //detach the event handlers
+        Y.detach("mousemove", handleUserEvent, document);
+        Y.detach("keydown", handleUserEvent, document);
+    }
+
+};
+
+//inherit event functionality
+Y.augment(Y.IdleTimer, Y.Event.Target);
+
+
+
+}, '@VERSION@' ,{requires:['event','event-custom']});

build/gallery-idletimer/gallery-idletimer.js

@@ -0,0 +1,150 @@
+YUI.add('gallery-idletimer', function(Y) {
+
+/*
+ * Copyright (c) 2009 Nicholas C. Zakas. All rights reserved.
+ * http://www.nczonline.net/
+ */
+
+/**
+ * Idle timer
+ * @module gallery-idletimer
+ */
+
+//-------------------------------------------------------------------------
+// Private variables
+//-------------------------------------------------------------------------
+
+var idle    = false,        //indicates if the user is idle
+    tId     = -1,           //timeout ID
+    enabled = false,        //indicates if the idle timer is enabled
+    timeout = 30000;        //the amount of time (ms) before the user is considered idle
+
+//-------------------------------------------------------------------------
+// Private functions
+//-------------------------------------------------------------------------
+
+/* (intentionally not documented)
+ * Handles a user event indicating that the user isn't idle.
+ * @param {Event} event A DOM2-normalized event object.
+ * @return {void}
+ */
+function handleUserEvent(){
+
+    //clear any existing timeout
+    clearTimeout(tId);
+
+    //if the idle timer is enabled
+    if (enabled){
+
+        //if it's idle, that means the user is no longer idle
+        if (idle){
+            toggleIdleState();           
+        } 
+
+        //set a new timeout
+        tId = setTimeout(toggleIdleState, timeout);
+    }    
+}
+
+/* (intentionally not documented)
+ * Toggles the idle state and fires an appropriate event.
+ * @return {void}
+ */
+function toggleIdleState(){
+
+    //toggle the state
+    idle = !idle;
+
+    //fire appropriate event
+    Y.IdleTimer.fire(idle ? "idle" : "active");            
+}
+
+//-------------------------------------------------------------------------
+// Public interface
+//-------------------------------------------------------------------------
+
+/**
+ * Centralized control for determining when a user has become idle
+ * on the current page.
+ * @class IdleTimer
+ * @static
+ */
+Y.IdleTimer = {
+
+    /**
+     * Indicates if the idle timer is running or not.
+     * @return {Boolean} True if the idle timer is running, false if not.
+     * @method isRunning
+     * @static
+     */
+    isRunning: function(){
+        return enabled;
+    },
+
+    /**
+     * Indicates if the user is idle or not.
+     * @return {Boolean} True if the user is idle, false if not.
+     * @method isIdle
+     * @static
+     */        
+    isIdle: function(){
+        return idle;
+    },
+
+    /**
+     * Starts the idle timer. This adds appropriate event handlers
+     * and starts the first timeout.
+     * @param {int} newTimeout (Optional) A new value for the timeout period in ms.
+     * @return {void}
+     * @method start
+     * @static
+     */ 
+    start: function(newTimeout){
+
+        //set to enabled
+        enabled = true;
+
+        //set idle to false to begin with
+        idle = false;
+
+        //assign a new timeout if necessary
+        if (typeof newTimeout == "number"){
+            timeout = newTimeout;
+        }
+
+        //assign appropriate event handlers
+        Y.on("mousemove", handleUserEvent, document);
+        Y.on("keydown", handleUserEvent, document);
+
+        //set a timeout to toggle state
+        tId = setTimeout(toggleIdleState, timeout);
+    },
+
+    /**
+     * Stops the idle timer. This removes appropriate event handlers
+     * and cancels any pending timeouts.
+     * @return {void}
+     * @method stop
+     * @static
+     */         
+    stop: function(){
+
+        //set to disabled
+        enabled = false;
+
+        //clear any pending timeouts
+        clearTimeout(tId);
+
+        //detach the event handlers
+        Y.detach("mousemove", handleUserEvent, document);
+        Y.detach("keydown", handleUserEvent, document);
+    }
+
+};
+
+//inherit event functionality
+Y.augment(Y.IdleTimer, Y.Event.Target);
+
+
+
+}, '@VERSION@' ,{requires:['event','event-custom']});

src/gallery-idletimer/build.properties

@@ -0,0 +1,4 @@
+builddir=../../../builder/componentbuild
+component=gallery-idletimer
+component.jsfiles=idletimer.js
+component.requires=event,event-custom

src/gallery-idletimer/build.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="YUI" default="local">
+    <property file="build.properties" />
+    <import file="${builddir}/3.x/bootstrap.xml" 
+            description="Default Build Properties and Targets" />
+</project>