All Downloads are FREE. Search and download functionalities are using the official Maven repository.

webclient.js-ext.idle-timer.js Maven / Gradle / Ivy

/*
 * Copyright (c) 2009 Nicholas C. Zakas
 * 
 * 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.
 */

/**
 * Idle timer
 * @module idle-timer
 */
(function(){

    //-------------------------------------------------------------------------
    // 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
		inWarning = false,     // In warning stage
        
        //shortcuts
        YUE     = YAHOO.util.Event;

    //-------------------------------------------------------------------------
    // 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;
        
		if (inWarning && enabled)
		{
			i2b2.PM.doLogout();	
		}
		
        //fire appropriate event
        YAHOO.util.IdleTimer.fireEvent(idle ? "idle" : "active");            
		
		if (idle == true)
		{
		   inWarning = true;	
           tId = setTimeout(toggleIdleState, 300000);

		}
    }

    //-------------------------------------------------------------------------
    // Public interface
    //-------------------------------------------------------------------------
    
    /**
     * Centralized control for determining when a user has become idle
     * on the current page.
     * @class IdleTimer
     * @static
     */
    YAHOO.namespace("util");
    var IdleTimer = {
        updateTimer:function(){
					handleUserEvent();
		},
        /**
         * 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;
        },
        
	    isWarn: function(){
            return timeout;
        },
	
        /**
         * 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 warning
			isWarning = false;
			
            //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
            //YUE.on(document, "mousemove", handleUserEvent);
            //YUE.on(document, "keydown", handleUserEvent);
            
            //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(){
			
			inWarning = false;
        
            //set to disabled
            enabled = false;
            
            //clear any pending timeouts
            clearTimeout(tId);
            
            //detach the event handlers
           // YUE.removeListener(document, "mousemove", handleUserEvent);
            //YUE.removeListener(document, "keydown", handleUserEvent);
        }
    
    };

    //inherit event functionality
    YAHOO.lang.augmentObject(IdleTimer, YAHOO.util.EventProvider.prototype);
    
    //create the custom event objects
    IdleTimer.createEvent("active");
    IdleTimer.createEvent("idle");
    IdleTimer.createEvent("warn");
    
    //assign into place
    YAHOO.util.IdleTimer = IdleTimer;
})();




© 2015 - 2024 Weber Informatics LLC | Privacy Policy