事件是 JavaScript 與 DOM 溝通的主要語言,但也因為瀏覽器歷史包袱,成為細節最多的一塊。本文把最常被忽略的四個部分整理清楚。
所謂跨平台事件,指的是同一個行為在不同瀏覽器上要用不同 API 才能完成。而 EventUtil 就是把這些事件相關函式集中管理的容器(它沒有屬性),負責在 DOM 標準與 IE 舊寫法之間做轉接。
DOM 與 IE 五組主要的差異對照如下:
DOM:charCode / IE:keyCode
DOM:preventDefault() / IE:returnValue = false
DOM:relatedTarget / IE:fromElement 或 toElement
DOM:stopPropagation() / IE:cancelBubble = true
DOM:target / IE:srcElement
把這些差異封裝起來,就能得到一個跨瀏覽器可用的工具:
<html>
<head>
<title>eventUtil</title>
<script type="text/javascript">
var eventUtil = {
// 綁定事件
addListener: function(obj, eventType, fn) {
if (obj.addEventListener) {
obj.addEventListener(eventType, fn, false);
} else if (obj.attachEvent) {
obj.attachEvent('on' + eventType, fn);
} else {
obj['on' + eventType] = fn;
}
},
// 取得 event 物件
getEvent: function(event) {
return event || window.event;
},
// 取得事件目標
getTarget: function(event) {
return event.target || event.srcElement;
},
// 阻止預設行為
preventDefault: function(event) {
if (event.preventDefault) {
event.preventDefault();
} else {
event.returnValue = false;
}
},
// 移除事件
removeListener: function(obj, eventType, fn) {
if (obj.removeEventListener) {
obj.removeEventListener(eventType, fn, false);
} else if (obj.detachEvent) {
obj.detachEvent(eventType, fn);
} else {
obj['on' + eventType] = null;
}
},
// 阻止冒泡
stopPropagation: function(event) {
if (event.stopPropagation) {
event.stopPropagation();
} else {
event.cancelBubble = true;
}
}
};
</script>
</head>
<body>
<input type="button" value="click me" id="btn" />
<p>event</p>
<a>Hello word!</a>
<script type="text/javascript">
function addBtnListen(event) {
var event = eventUtil.getEvent(event);
var target = eventUtil.getTarget(event);
alert("my name is kock");
alert(event.type);
alert(target);
eventUtil.stopPropagation(event);
}
function getBodyListen(event) {
alert("click body");
}
function getLinkListen(event) {
alert("prevent default event");
var event = eventUtil.getEvent(event);
eventUtil.preventDefault(event);
}
window.onload = function() {
var btn = document.getElementById("btn");
var link = document.getElementsByTagName("a")[0];
eventUtil.addListener(btn, "click", addBtnListen);
eventUtil.addListener(document.body, "click", getBodyListen);
eventUtil.addListener(link, "click", getLinkListen);
}
</script>
</body>
</html>
滑鼠移入按鈕時會發現 body 的監聽也被觸發了——這就是冒泡。要攔下它,就呼叫 stopPropagation。
另外,IE 沒有 charCode,可以補一個轉接方法:
eventUtil.formatEvent = function(event) {
if (isIE && isWin) {
// keypress 時才對應到 keyCode,其餘一律給 0
event.charCode = (event.type == "keypress") ? event.keyCode : 0;
event.eventPhase = 2; // IE 僅支援冒泡階段
}
return event;
}
target 只在事件流的目標階段有意義;currentTarget 則在捕獲、目標、冒泡三個階段都有值。兩者只有在事件正好走到目標階段時才會相同。一旦處於捕獲或冒泡階段,target 指向真正被點擊的元素,而 currentTarget 指向目前正處理這個事件的元素。
<div id="outer" style="background:#099"> <p>我是目標div</p> ---- 點擊這部分,輸出:e.target.tagName : P || e.currentTarget.tagName : DIV <p id="inner" style="background:#9C0">我是目標p</p> ---- 點擊這部分,輸出:e.target.tagName : P || e.currentTarget.tagName : DIV <br> ---- 點擊這部分,輸出:e.target.tagName : DIV || e.currentTarget.tagName : DIV </div>
function getObj(id) { return document.getElementById(id); }
function addEvent(obj, event, fn) {
if (window.attachEvent) {
obj.attachEvent("on" + event, fn);
} else if (window.addEventListener) {
obj.addEventListener(event, fn, false);
}
}
function test(e) {
alert("e.target.tagName : " + e.target.tagName +
"\n e.currentTarget.tagName : " + e.currentTarget.tagName);
}
var outer = getObj("outer");
addEvent(outer, "click", test);
這個差異是事件委派(event delegation)的基礎:監聽掛在父層,靠 target 判斷真正被操作的是哪個子元素。
最常見的例子是停用右鍵選單:
document.body.oncontextmenu = function(event) {
if (isIE) {
var oEvent = window.event;
oEvent.returnValue = false; // 也可以直接 return false
} else {
oEvent.preventDefault();
}
}
想徹底搞懂事件,最好的辦法是把它印出來看:
<div style="width:100px;height:100px;background:red" onmouseover="handleEvent(event)" onmouseout="handleEvent(event)" onmousedown="handleEvent(event)" onmouseup="handleEvent(event)" onclick="handleEvent(event)" ondblclick="handleEvent(event)" id="div1"> </div> <p><textarea id="txt1" rows="5" cols="45"></textarea></p> <input type="text" id="textbox" onkeydown="handle(event)" onkeypress="handle(event)" onkeyup="handle(event)" /> <p><textarea id="txt2" rows="10" cols="45"></textarea></p>
function handleEvent(event) {
var oText = document.getElementById('txt1');
oText.value += "\n" + event.type;
oText.value += "\n target is " + (event.srcElement || event.target).id;
oText.value += "\n at (" + event.clientX + "," + event.clientY + ") in the client";
oText.value += "\n at (" + event.screenX + "," + event.screenY + ") in the screen";
oText.value += "\n button down is " + event.button;
// relatedTarget 可用來判斷滑鼠從哪裡來、要往哪裡去
oText.value += "\n relatedTarget is " + event.relatedTarget.tagName;
}
function handle(event) {
var oText2 = document.getElementById('txt2');
oText2.value += "\n" + event.type;
var arrKeys = [];
if (event.shiftKey) { arrKeys.push("Shift"); }
if (event.ctrlKey) { arrKeys.push("Ctrl"); }
if (event.altKey) { arrKeys.push("Alt"); }
oText2.value += "\n keydown is " + arrKeys;
}
把這些屬性實際打印幾次,比讀十篇文章都有效。特別是 clientX/Y 與 screenX/Y 座標系的差別、relatedTarget 在 mouseover/mouseout 上的意義,以及 shiftKey/ctrlKey 這類修飾鍵旗標,都是做拖拉、 tooltip、快捷鍵功能時的必備知識。