jQuery event 源码注释

  1. /*
  2.  * author:prk
  3.  * date:2008-08-17
  4.  * comment:analyse of jquery event
  5.  * 
  6.  */
  7. jQuery.event = {
  8.     // add 事件到一个元素上。
  9.     add : function(elem, types, handler, data) {
  10.         if (elem.nodeType == 3 || elem.nodeType == 8)// 空白节点或注释
  11.             return;
  12.         // IE不能传入window,先复制一下。
  13.         if (jQuery.browser.msie && elem.setInterval)
  14.             elem = window;
  15.         // 为handler分配一个全局唯一的Id
  16.         if (!handler.guid)
  17.             handler.guid = this.guid++;
  18.         // 把data附到handler.data中
  19.         if (data != undefined) {
  20.             var fn = handler;
  21.             handler = this.proxy(fn, function() {// 唯一Id,wrap原始handler Fn
  22.                         return fn.apply(this, arguments);
  23.                     });
  24.             handler.data = data;
  25.         }
  26.         // 初始化元素的events。如果没有取到events中值,就初始化data: {}
  27.         var events = jQuery.data(elem, "events")
  28.                 || jQuery.data(elem, "events", {}),
  29.         // 如果没有取到handle中值,就初始化data: function() {....}
  30.         handle = jQuery.data(elem, "handle")
  31.                 || jQuery.data(elem, "handle"function() {
  32.                     // 处理一个触发器的第二个事件和当page已经unload之后调用一个事件。
  33.                         if (typeof jQuery != "undefined"
  34.                                 && !jQuery.event.triggered)
  35.                             return jQuery.event.handle.apply(// arguments.callee.elem=handle.elem
  36.                                     arguments.callee.elem, arguments);
  37.                     });
  38.         // 增加elem做为handle属性,防止IE由于没有本地Event而内存泄露。
  39.         handle.elem = elem;
  40.         // 处理采用空格分隔多个事件名,如jQuery(...).bind("mouseover mouseout", fn);
  41.         jQuery.each(types.split(/\s+/), function(index, type) {
  42.             // 命名空间的事件,一般不会用到。
  43.                 var parts = type.split(".");
  44.                 type = parts[0];
  45.                 handler.type = parts[1];
  46.                 // 捆绑到本元素type事件的所有处理函数
  47.                 var handlers = events[type];
  48.                 if (!handlers) {// 没有找到处理函数列表就初始化事件队列
  49.                     handlers = events[type] = {};
  50.                     // 如果type不是ready,或ready的setup执行返回false
  51.                     if (!jQuery.event.special[type]
  52.                             || jQuery.event.special[type].setup
  53.                                     .call(elem, data) === false) {
  54.                         // 调用系统的事件函数来注册事件
  55.                         if (elem.addEventListener)// FF
  56.                             elem.addEventListener(type, handle, false);
  57.                         else if (elem.attachEvent)// IE
  58.                             elem.attachEvent("on" + type, handle);
  59.                     }
  60.                 }
  61.                 // 把处理器的id和handler形式属性对的形式保存在handlers列表中,
  62.                 // 也存在events[type][handler.guid]中。
  63.                 handlers[handler.guid] = handler;
  64.                 // 全局缓存这个事件的使用标识
  65.                 jQuery.event.global[type] = true;
  66.             });
  67.         // 防止IE内存泄露。
  68.         elem = null;
  69.     },
  70.     guid : 1,
  71.     global : {},
  72.     // 从元素中remove一个事件
  73.     remove : function(elem, types, handler) {
  74.         if (elem.nodeType == 3 || elem.nodeType == 8)
  75.             return;
  76.         // 取出元素的events中Fn列表
  77.         var events = jQuery.data(elem, "events"), ret, index;
  78.         if (events) {
  79.             // remove所有的该元素的事件 .是命名空间的处理
  80.             if (types == undefined
  81.                     || (typeof types == "string" && types.charAt(0) == "."))
  82.                 for (var type in events)
  83.                     this.remove(elem, type + (types || ""));
  84.             else {
  85.                 // types, handler参数采用{type:xxx,handler:yyy}形式
  86.                 if (types.type) {
  87.                     handler = types.handler;
  88.                     types = types.type;
  89.                 }
  90.                 // 处理采用空格分隔多个事件名 jQuery(...).unbind("mouseover mouseout", fn);
  91.                 jQuery
  92.                         .each(types.split(/\s+/), function(index, type) {
  93.                             // 命名空间的事件,一般不会用到。
  94.                                 var parts = type.split(".");
  95.                                 type = parts[0];
  96.                                 if (events[type]) {// 事件名找到
  97.                                     if (handler)// handler传入,就remove事件名的这个处理函数
  98.                                         delete events[type][handler.guid];//guid的作用
  99.                                     else    // remove这个事件的所有处理函数,带有命名空间的处理
  100.                                         for (handler in events[type])
  101.                                             if (!parts[1]
  102.                                                     || events[type][handler].type == parts[1])
  103.                                                 delete events[type][handler];
  104.                                     // 如果没有该事件的处理函数存在,就remove事件名
  105.                                     for (ret in events[type])// 看看有没有?
  106.                                         break;
  107.                                     if (!ret) {// 没有
  108.                                         if (!jQuery.event.special[type]//不是ready
  109.                                                 || jQuery.event.special[type].teardown
  110.                                                         .call(elem) === false) {// type不等于ready
  111.                                             if (elem.removeEventListener)// 在浏览器中remove事件名
  112.                                                 elem.removeEventListener(type,
  113.                                                         jQuery.data(elem,
  114.                                                                 "handle"),
  115.                                                         false);
  116.                                             else if (elem.detachEvent)
  117.                                                 elem.detachEvent("on" + type,
  118.                                                         jQuery.data(elem,
  119.                                                                 "handle"));
  120.                                         }
  121.                                         ret = null;
  122.                                         delete events[type];// 在缓存中除去。
  123.                                     }
  124.                                 }
  125.                             });
  126.             }
  127.             // 不再使用,除去expando
  128.             for (ret in events)
  129.                 break;
  130.             if (!ret) {
  131.                 var handle = jQuery.data(elem, "handle");
  132.                 if (handle)
  133.                     handle.elem = null;
  134.                 jQuery.removeData(elem, "events");
  135.                 jQuery.removeData(elem, "handle");
  136.             }
  137.         }
  138.     },
  139.     trigger : function(type, data, elem, donative, extra) {
  140.         data = jQuery.makeArray(data);
  141.         if (type.indexOf("!") >= 0) {// 支持!的not的操作如!click,除click之后的所有
  142.             type = type.slice(0, -1);// 除最后一个字符?
  143.             var exclusive = true;
  144.         }
  145.         if (!elem) {// 处理全局的fire事件
  146.             if (this.global[type])
  147.                 jQuery.each(jQuery.cache, function() {
  148.                     // 从cache中找到所有注册该事件的元素,触发改事件的处理函数
  149.                         if (this.events && this.events[type])
  150.                             jQuery.event.trigger(type, data, this.handle.elem);
  151.                     });
  152.         } else {// 处理单个元素事件的fire事件
  153.             if (elem.nodeType == 3 || elem.nodeType == 8)
  154.                 return undefined;
  155.             var val, ret, fn = jQuery.isFunction(elem[type] || null),
  156.             // 我们是否要提交一个伪造的事件?
  157.             event = !data[0] || !data[0].preventDefault;
  158.             // 构建伪造的事件。
  159.             if (event) {
  160.                 data.unshift( {//存到数组中的第一个
  161.                     type : type,
  162.                     target : elem,
  163.                     preventDefault : function() {
  164.                     },
  165.                     stopPropagation : function() {
  166.                     },
  167.                     timeStamp : now()
  168.                 });
  169.                 data[0][expando] = true// 不需要修正伪造事件
  170.             }
  171.             //防止事件名出错
  172.             data[0].type = type;
  173.             if (exclusive)
  174.                 data[0].exclusive = true;
  175.             // 触发事件
  176.             var handle = jQuery.data(elem, "handle");
  177.             if (handle)
  178.                 val = handle.apply(elem, data);
  179.             // Handle triggering native .onfoo handlers (and on links since we
  180.             // don't call .click() for links)
  181.             //处理触发.onfoo这样的本地处理方法,但是是对于links 's .click()不触发
  182.             if ((!fn || (jQuery.nodeName(elem, 'a') && type == "click"))
  183.                     && elem["on" + type]&& elem["on" + type].apply(elem, data) === false)
  184.                 val = false;
  185.             // Extra functions don't get the custom event object
  186.             if (event)
  187.                 data.shift();
  188.             // 处理触发extra事件
  189.             if (extra && jQuery.isFunction(extra)) {
  190.                 //执行extra,同时把结果存到data中。
  191.                 ret = extra.apply(elem, val == null ? data : data.concat(val));
  192.                 // if anything is returned, give it precedence and have it
  193.                 // overwrite the previous value
  194.                 if (ret !== undefined)
  195.                     val = ret;
  196.             }
  197.             // 触发本地事件
  198.             if (fn && donative !== false && val !== false
  199.                     && !(jQuery.nodeName(elem, 'a') && type == "click")) {
  200.                 this.triggered = true;
  201.                 try {
  202.                     elem[type]();
  203.                     //对于一些hidden的元素,IE会报错
  204.                 } catch (e) {
  205.                 }
  206.             }
  207.             this.triggered = false;
  208.         }
  209.         return val;
  210.     },
  211.     handle : function(event) {
  212.         // 返回 undefined or false
  213.         var val, ret, namespace, all, handlers;
  214.         event = arguments[0] = jQuery.event.fix(event || window.event);
  215.         // 命名空间处理
  216.         namespace = event.type.split(".");
  217.         event.type = namespace[0];
  218.         namespace = namespace[1];
  219.         // all = true 表明任何 handler
  220.         all = !namespace && !event.exclusive;
  221.         // 找到元素的events中缓存的事件名的处理函数列表
  222.         handlers = (jQuery.data(this"events") || {})[event.type];
  223.         for (var j in handlers) {// 每个处理函数执行
  224.             var handler = handlers[j];
  225.             // Filter the functions by class
  226.             if (all || handler.type == namespace) {
  227.                 // 传入引用,为了之后删除它们
  228.                 event.handler = handler;
  229.                 event.data = handler.data;
  230.                 ret = handler.apply(this, arguments);// 执行事件处理函数
  231.                 if (val !== false)
  232.                     val = ret;// 只要有一个处理函数返回false,本函数就返回false.
  233.                 if (ret === false) {// 不执行浏览器默认的动作
  234.                     event.preventDefault();
  235.                     event.stopPropagation();
  236.                 }
  237.             }
  238.         }
  239.         return val;
  240.     },
  241.     props : "altKey attrChange attrName bubbles button cancelable charCode clientX "
  242.             + "clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode "
  243.             + "metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX "
  244.             + "screenY shiftKey srcElement target timeStamp toElement type view wheelDelta which"
  245.                     .split(" "),
  246.     //对事件进行包裹。
  247.     fix : function(event) {
  248.         if (event[expando] == true)//表明事件已经包裹过
  249.             return event;
  250.         //保存原始event,同时clone一个。
  251.         var originalEvent = event;
  252.         event = {
  253.             originalEvent : originalEvent
  254.         };
  255.         for (var i = this.props.length, prop;i;) {
  256.             prop = this.props[--i];
  257.             event[prop] = originalEvent[prop];
  258.         }
  259.         
  260.         event[expando] = true;
  261.         
  262.         //加上preventDefault and stopPropagation,在clone不会运行
  263.         event.preventDefault = function() {
  264.             // 在原始事件上运行
  265.             if (originalEvent.preventDefault)
  266.                 originalEvent.preventDefault();
  267.             
  268.             originalEvent.returnValue = false;
  269.         };
  270.         event.stopPropagation = function() {
  271.             // 在原始事件上运行
  272.             if (originalEvent.stopPropagation)
  273.                 originalEvent.stopPropagation();
  274.             
  275.             originalEvent.cancelBubble = true;
  276.         };
  277.         // 修正 timeStamp
  278.         event.timeStamp = event.timeStamp || now();
  279.         // 修正target
  280.         if (!event.target)
  281.             event.target = event.srcElement || document;            
  282.         if (event.target.nodeType == 3)//文本节点是父节点。
  283.             event.target = event.target.parentNode;
  284.         // relatedTarget
  285.         if (!event.relatedTarget && event.fromElement)
  286.             event.relatedTarget = event.fromElement == event.target
  287.                     ? event.toElement
  288.                     : event.fromElement;
  289.         // Calculate pageX/Y if missing and clientX/Y available
  290.         if (event.pageX == null && event.clientX != null) {
  291.             var doc = document.documentElement, body = document.body;
  292.             event.pageX = event.clientX
  293.                     + (doc && doc.scrollLeft || body && body.scrollLeft || 0)
  294.                     - (doc.clientLeft || 0);
  295.             event.pageY = event.clientY
  296.                     + (doc && doc.scrollTop || body && body.scrollTop || 0)
  297.                     - (doc.clientTop || 0);
  298.         }
  299.         // Add which for key events
  300.         if (!event.which
  301.                 && ((event.charCode || event.charCode === 0)
  302.                         ? event.charCode
  303.                         : event.keyCode))
  304.             event.which = event.charCode || event.keyCode;
  305.         // Add metaKey to non-Mac browsers (use ctrl for PC's and Meta for Macs)
  306.         if (!event.metaKey && event.ctrlKey)
  307.             event.metaKey = event.ctrlKe
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值