API Docs for: 3.10.3
Show:

File: test/js/EventTarget.js

  1.  
  2. /**
  3.  * Simple custom event implementation.
  4.  * @namespace Test
  5.  * @module test
  6.  * @class EventTarget
  7.  * @constructor
  8.  */
  9. YUITest.EventTarget = function(){
  10.  
  11.     /**
  12.      * Event handlers for the various events.
  13.      * @type Object
  14.      * @private
  15.      * @property _handlers
  16.      * @static
  17.      */
  18.     this._handlers = {};
  19.  
  20. };
  21.     
  22. YUITest.EventTarget.prototype = {
  23.  
  24.     //restore prototype
  25.     constructor: YUITest.EventTarget,
  26.             
  27.     //-------------------------------------------------------------------------
  28.     // Event Handling
  29.     //-------------------------------------------------------------------------
  30.     
  31.     /**
  32.      * Adds a listener for a given event type.
  33.      * @param {String} type The type of event to add a listener for.
  34.      * @param {Function} listener The function to call when the event occurs.
  35.      * @return {void}
  36.      * @method attach
  37.      */
  38.     attach: function(type, listener){
  39.         if (typeof this._handlers[type] == "undefined"){
  40.             this._handlers[type] = [];
  41.         }
  42.  
  43.         this._handlers[type].push(listener);
  44.     },
  45.     
  46.     /**
  47.      * Adds a listener for a given event type.
  48.      * @param {String} type The type of event to add a listener for.
  49.      * @param {Function} listener The function to call when the event occurs.
  50.      * @return {void}
  51.      * @method subscribe
  52.      * @deprecated
  53.      */
  54.     subscribe: function(type, listener){
  55.         this.attach.apply(this, arguments);
  56.     },
  57.     
  58.     /**
  59.      * Fires an event based on the passed-in object.
  60.      * @param {Object|String} event An object with at least a 'type' attribute
  61.      *      or a string indicating the event name.
  62.      * @return {void}
  63.      * @method fire
  64.      */    
  65.     fire: function(event){
  66.         if (typeof event == "string"){
  67.             event = { type: event };
  68.         }
  69.         if (!event.target){
  70.             event.target = this;
  71.         }
  72.         
  73.         if (!event.type){
  74.             throw new Error("Event object missing 'type' property.");
  75.         }
  76.         
  77.         if (this._handlers[event.type] instanceof Array){
  78.             var handlers = this._handlers[event.type];
  79.             for (var i=0, len=handlers.length; i < len; i++){
  80.                 handlers[i].call(this, event);
  81.             }
  82.         }            
  83.     },
  84.  
  85.     /**
  86.      * Removes a listener for a given event type.
  87.      * @param {String} type The type of event to remove a listener from.
  88.      * @param {Function} listener The function to remove from the event.
  89.      * @return {void}
  90.      * @method detach
  91.      */
  92.     detach: function(type, listener){
  93.         if (this._handlers[type] instanceof Array){
  94.             var handlers = this._handlers[type];
  95.             for (var i=0, len=handlers.length; i < len; i++){
  96.                 if (handlers[i] === listener){
  97.                     handlers.splice(i, 1);
  98.                     break;
  99.                 }
  100.             }
  101.         }            
  102.     },
  103.     
  104.     /**
  105.      * Removes a listener for a given event type.
  106.      * @param {String} type The type of event to remove a listener from.
  107.      * @param {Function} listener The function to remove from the event.
  108.      * @return {void}
  109.      * @method unsubscribe
  110.      * @deprecated
  111.      */
  112.     unsubscribe: function(type, listener){
  113.         this.detach.apply(this, arguments);          
  114.     }    
  115.  
  116. };
  117.  
  118.