Типы событий
157Веб-программирование --- JavaScript --- Типы событий
На заре развития Всемирной паутины веб-разработчикам приходилось иметь дело лишь с небольшим количеством событий: «load», «click», «mouseover» и другими. Эти довольно старые типы событий хорошо поддерживаются всеми браузерами. По мере развития веб-платформы в нее были включены более мощные прикладные интерфейсы, а количество событий существенно увеличилось. Не существует стандарта, который определял бы полный набор событий, и количество поддерживаемых событий продолжает быстро увеличиваться. Эти новые события определяются в следующих двух источниках:
Спецификация «DOM Level 3 Events», которая после долгих лет застоя стала активно разрабатываться под эгидой консорциума W3C.
Множество новых прикладных интерфейсов в спецификации HTML5 (и в связанных с ней дополнительных спецификациях) определяют новые события, используемые, например, для управления историей посещений, механизмом drag-and-drop (перетащил и бросил), обмена сообщениями между документами и проигрывания аудио- и видеороликов.
Обратите внимание, что многие из этих новых типов событий пока еще не получили широкой поддержки и определяются стандартами, которые еще находятся на стадии проектирования. События, которые вам чаще всего придется использовать в своих веб-приложениях, обычно будут относиться к категории давно существующих и поддерживаемых всеми браузерами: это события для работы с мышью, с клавиатурой, с HTML-формами и с объектом Window. Эти события мы и рассмотрим.
События загрузки документа
Большинству веб-приложений совершенно необходимо, чтобы веб-браузер извещал их о моменте, когда закончится загрузка документа и он будет готов для выполнения операций над ним. Этой цели служит событие load в объекте Window. Событие load возбуждается только после того, как документ и все его изображения будут полностью загружены. Однако обычно сценарии можно запускать сразу после синтаксического анализа документа, до того как будут загружены изображения. Можно существенно сократить время запуска веб-приложения, если начинать выполнение сценариев по событиям, отличным от load.
Событие DOMContentLoaded возбуждается, как только документ будет загружен, разобран синтаксическим анализатором, и будут выполнены все отложенные сценарии. К этому моменту изображения и сценарии с атрибутом async могут продолжать загружаться, но сам документ уже будет готов к выполнению операций. Это событие впервые было введено в Firefox и впоследствии заимствовано всеми другими производителями браузеров, включая корпорацию Microsoft, которая добавила поддержку этого события в IE9. Несмотря на приставку DOM в имени, это событие не является частью стандарта модели событий DOM Level 3 Events, но оно стандартизовано спецификацией HTML5.
В ходе загрузки документа изменяется значение свойства document.readyState. Каждое изменение значения этого свойства в IE сопровождается событием readystatechange в объекте Document, благодаря чему в IE это событие можно использовать для определения момента появления состояния complete. Спецификация HTML5 стандартизует событие readystatechange, но предписывает возбуждать его непосредственно перед событием load, поэтому не совсем понятно, в чем заключается преимущество события readystatechange перед load.
В примере ниже определяется функция whenReady(). Функция, передаваемая функции whenReady(), вызывается (как метод объекта Document) сразу, как только документ будет готов к выполнению операций. whenReady() ожидает появления событий DOMContentLoaded и readystatechange и использует событие load только как запасной вариант, на случай если она будет задействована в старых браузерах, не поддерживающих первые два события. Функция whenReady() будет использоваться в некоторых сценариях, следующих далее:
/* Передайте функции whenReady() свою функцию, и она вызовет ее (как метод
объекта документа), как только завершится синтаксический анализ документа
и он будет готов к выполнению операций. Зарегистрированные функции
вызываются при первом же событии DOMContentLoaded, readystatechange или load.
Как только документ станет готов и будут вызваны все функции,
whenReady() немедленно вызовет все функции, которые были ей переданы. */
var whenReady = (function() { // Эта функция возвращается функцией whenReady()
var funcs = []; // Функции, которые должны вызываться по событию
var ready = false; // Получит значение true при вызове функции handler
// Обработчик событий, который вызывается, как только документ
// будет готов к выполнению операций
function handler(e) {
// Если обработчик уже вызывался, просто вернуть управление
if (ready) return;
// Если это событие readystatechange и состояние получило значение,
// отличное от "complete", значит, документ пока не готов
if (e.type==="readystatechange" && document.readyState !== "complete") return;
// Вызвать все зарегистрированные функции.
// Обратите внимание, что здесь каждый раз проверяется значение
// свойства funcs.length, на случай если одна из вызванных функций
// зарегистрирует дополнительные функции.
for(var i = 0; i < funcs.length; i++)
funcs[i].call(document);
// Теперь можно установить флаг ready в значение true и забыть
// о зарегистрированных функциях
ready = true;
funcs = null;
}
// Зарегистрировать обработчик handler для всех ожидаемых событий
if (document.addEventListener) {
document.addEventListener("DOMContentLoaded", handler, false);
document.addEventListener("readystatechange", handler, false);
window.addEventListener("load", handler, false);
}
// Если IE
else if (document.attachEvent) {
document.attachEvent("onreadystatechange", handler);
window.attachEvent("onload", handler);
}
// Вернуть функцию whenReady
return function whenReady(f) {
if (ready)
f.call(document) // Вызвать функцию, если документ готов
else
funcs.push(f); // Иначе добавить ее в очередь, чтобы вызвать позже
}
}());
События мыши
С мышью связано довольно много событий. Все они перечислены в таблице ниже. Все события мыши, кроме mouseenter и mouseleave, всплывают. Для событий click, возникающих в ссылках и кнопках отправки форм, предусматриваются действия по умолчанию, которые можно отменить. Теоретически имеется возможность отменить событие contextmenu и предотвратить появление контекстного меню, но некоторые браузеры имеют параметры настройки, которые делают это событие неотменяемым.
Тип | Описание |
---|---|
click | Высокоуровневое событие, возбуждаемое, когда пользователь нажимает и отпускает кнопку мыши или иным образом активирует элемент. |
contextmenu | Отменяемое событие, возбуждаемое перед выводом контекстного меню. Текущие браузеры выводят контекстное меню по щелчку правой кнопки мыши, поэтому данное событие можно также использовать как событие click. |
dblclick | Возбуждается, когда пользователь выполняет двойной щелчок. |
mousedown | Возбуждается, когда пользователь нажимает кнопку мыши. |
mouseup | Возбуждается, когда пользователь отпускает кнопку мыши. |
mousemove | Возбуждается, когда пользователь перемещает указатель мыши. |
mouseover | Возбуждается, когда указатель мыши помещается над элементом. Свойство relatedTarget (или fromElement в IE) определяет элемент, с которого был перемещен указатель мыши. |
mouseout | Возбуждается, когда указатель мыши покидает элемент. Свойство relatedTarget (или toElement в IE) определяет элемент, на который был перемещен указатель мыши. |
mouseenter | Подобно mouseover, но не всплывает. Впервые появилось в IE и было стандартизовано в HTML5, но пока поддерживается не всеми браузерами. |
mouseleave | Подобно mouseout, но не всплывает. Впервые появилось в IE и было стандартизовано в HTML5, но пока поддерживается не всеми браузерами. |
Объект, передаваемый обработчикам событий от мыши, имеет свойства clientX и clientY, определяющие координаты указателя относительно окна. Чтобы преобразовать их в координаты документа, к ним необходимо добавить позиции полос прокрутки окна.
Свойства altKey, ctrlKey, metaKey и shiftKey определяют состояния различных клавиш-модификаторов, которые могли удерживаться в нажатом состоянии в момент события: с их помощью можно отличать простой щелчок от щелчка с нажатой клавишей Shift, например.
Свойство button определяет, какая кнопка мыши удерживалась в нажатом состоянии в момент события. Однако разные браузеры записывают в это свойство разные значения, поэтому его сложно использовать переносимым способом.
Некоторые браузеры возбуждают событие click только в случае щелчка левой кнопкой. Поэтому, если потребуется обрабатывать щелчки другими кнопками, следует использовать события mousedown и mouseup. Событие contextmenu обычно сигнализирует о том, что был выполнен щелчок правой кнопкой, но, как отмечалось выше, в обработчиках этого события не всегда бывает возможным предотвратить появление контекстного меню.
В примере ниже демонстрируется функция drag(), которая при вызове из обработчика события mousedown позволяет пользователю перетаскивать мышью абсолютно позиционированные элементы документа. Функция drag() работает с обеими моделями событий, DOM и IE.
Функция drag() принимает два аргумента. Первый - перетаскиваемый элемент. Это может быть элемент, в котором возникло событие mousedown, и содержащий его элемент (например, можно дать пользователю возможность ухватить мышью элемент, который выглядит как заголовок окна, и перетащить содержащий его элемент, который выглядит как окно). Однако в любом случае это должен быть элемент документа, абсолютно позиционированный с помощью CSS-атрибута position. Второй аргумент - объект события, полученный с событием mousedown:
/*
drag() - перетаскивание абсолютно позиционированных HTML-элементов.
Эта функция должна вызываться
из обработчика события onmousedown. Последующие события mousemove будут вызывать
перемещение указанного элемента. Событие mouseup будет завершать перемещение.
Эта реализация действует в обеих моделях событий, стандартной и IE.
Использует функцию getScrollOffsets().
Аргументы:
elementToDrag: элемент, принявший событие mousedown или содержащий его элемент.
Этот элемент должен иметь абсолютное позиционирование. Значения его свойств style.left
и style.top будут изменяться при перемещении указателя мыши пользователем.
event: объект Event, полученный обработчиком события mousedown.
*/
function drag(elementToDrag, event) {
// Преобразовать начальные координаты указателя мыши в координаты документа
var scroll = getScrollOffsets(); // Вспомогательная функция, объявленная ниже
var startX = event.clientX + scroll.x;
var startY = event.clientY + scroll.y;
// Первоначальные координаты (относительно начала документа) элемента, который
// будет перемещаться. Так как elementToDrag имеет абсолютное позиционирование,
// предполагается, что его свойство offsetParent ссылается на тело документа.
var origX = elementToDrag.offsetLeft;
var origY = elementToDrag.offsetTop;
// Найти расстояние между точкой события mousedown и верхним левым углом элемента.
// Это расстояние будет учитываться при перемещении указателя мыши.
var deltaX = startX - origX;
var deltaY = startY - origY;
// Зарегистрировать обработчики событий mousemove и mouseup,
// которые последуют за событием mousedown.
if (document.addEventListener) {
// Стандартная модель событий
// Зарегистрировать перехватывающие обработчики в документе
document.addEventListener("mousemove", moveHandler, true);
document.addEventListener("mouseup", upHandler, true);
}
else if (document.attachEvent) { // Модель событий IE для IE5-8
// В модели событий IE перехват событий осуществляется вызовом
// метода setCapture() элемента.
elementToDrag.setCapture();
elementToDrag.attachEvent("onmousemove", moveHandler);
elementToDrag.attachEvent("onmouseup", upHandler);
// Интерпретировать потерю перехвата событий мыши как событие mouseup
elementToDrag.attachEvent("onlosecapture", upHandler);
}
// Это событие обработано и не должно передаваться другим обработчикам
if (event.stopPropagation)
event.stopPropagation(); // Стандартная модель
else event.cancelBubble = true; // IE
// Предотвратить выполнение действий, предусмотренных по умолчанию.
if (event.preventDefault) event.preventDefault(); // Стандартная модель
else event.returnValue = false; // IE
/*
Этот обработчик перехватывает события mousemove, возникающие
в процессе перетаскивания элемента. Он отвечает за перемещение элемента. */
function moveHandler(e) {
if (!e) e = window.event; // Модель событий IE
// Переместить элемент в позицию указателя мыши с учетом позиций
// полос прокрутки и смещений относительно начального щелчка.
var scroll = getScrollOffsets();
elementToDrag.style.left = (e.clientX + scroll.x - deltaX) + "px";
elementToDrag.style.top = (e.clientY + scroll.y - deltaY) + "px";
// И прервать дальнейшее распространение события.
if (e.stopPropagation) e.stopPropagation(); // Стандартная модель
else e.cancelBubble = true; // IE
}
/*
Этот обработчик перехватывает заключительное событие mouseup,
которое завершает операцию перетаскивания. */
function upHandler(e) {
if (!e) e = window.event; // Модель событий IE
// Удалить перехватывающие обработчики событий.
if (document.removeEventListener) { // Модель событий DOM
document.removeEventListener("mouseup", upHandler, true);
document.removeEventListener("mousemove", moveHandler, true);
}
else if (document.detachEvent) { // Модель событий IE 5+
elementToDrag.detachEvent("onlosecapture", upHandler);
elementToDrag.detachEvent("onmouseup", upHandler);
elementToDrag.detachEvent("onmousemove", moveHandler);
elementToDrag.releaseCapture();
}
// И прервать дальнейшее распространение события.
if (e.stopPropagation) e.stopPropagation(); // Стандартная модель
else e.cancelBubble = true; // IE
}
}
// Возвращает текущие позиции полос прокрутки в виде свойств x и y объекта
function getScrollOffsets(w) {
// Использовать указанное окно или текущее,
// если функция вызвана без аргумента
w = w || window;
// Следующий способ работает во всех браузерах, кроме IE версии 8 и ниже
if (w.pageXOffset != null)
return {x: w.pageXOffset, y:w.pageYOffset};
// Для IE (и других браузеров) в стандартном режиме
var d = w.document;
if (document.compatMode == "CSSICompat")
return {x: d.documentElement.scrollLeft, y: d.documentElement.scrollTop};
// Для браузеров в режиме совместимости
return { x: d.body.scrollLeft, y: d.body.scrollTop };
}
Следующий фрагмент демонстрирует порядок использования функции drag() в HTML-файле:
<!-- Перетаскиваемый элемент -->
<div style="position:absolute; left:100px; top:100px; width:250px;
background-color: white; border: solid black;">
<!-- "Заголовок" окна. Обратите внимание на атрибут onmousedown. -->
<div style="background color: gray; border bottom: dotted black;
padding: 3px; font-family: sans-serif; font-weight: bold;"
onmousedown="drag(this.parentNode, event);"> Перетащи меня <!-- Содержимое заголовка -->
</div>
<!-- Содержимое перетаскиваемого элемента -->
<p>Это тест. Проверка, проверка, проверка.</p><p>Тест</p><p>Тест</p>
</div>
Самым важным здесь является атрибут onmousedown во вложенном элементе <div>. Обратите внимание, что в нем используется свойство this.parentNode. Это говорит о том, что перемещаться будет весь контейнерный элемент.
События ввода текста
Браузеры поддерживают три старых события ввода с клавиатуры. События keydown и keyup являются низкоуровневыми событиями и рассматриваются в следующем разделе. Однако событие keypress является высокоуровневым, сообщающим, что был введен печатаемый символ.
Проект спецификации DOM Level 3 Events определяет более обобщенное событие textinput, генерируемое в ответ на ввод текста, независимо от того, каким способом он был введен.
С предлагаемым событием textinput и реализованным в настоящее время событием textInput передается простой объект события, имеющий свойство data, хранящее введенный текст. (Другое предлагаемое спецификацией свойство, inputMethod, должно определять источник ввода, но оно пока не реализовано.) В случае ввода с клавиатуры свойство data обычно будет содержать единственный символ, но при вводе из других источников в нем может содержаться множество символов.
Объект события, передаваемый с событием keypress, имеет более сложную организацию. Событие keypress представляет ввод единственного символа. Этот символ содержится в объекте события в виде числового значения кодового пункта Юникода и, чтобы преобразовать его в строку, необходимо использовать метод String.fromCharCode(). В большинстве браузеров кодовый пункт введенного символа сохраняется в свойстве keyCode объекта события. Однако по историческим причинам в Firefox вместо него используется свойство charCode.
В большинстве браузеров событие keypress возбуждается только при вводе печатаемого символа. Однако в Firefox событие keypress возбуждается также для непечатаемых символов. Чтобы отличить эти два случая (и проигнорировать непечатаемые символы), можно проверить, существует ли свойство charCode объекта события и содержит ли оно значение 0.
События textinput, textInput и keypress можно отменить, чтобы предотвратить ввод символа. То есть эти события можно использовать для фильтрации ввода. Например, можно предотвратить ввод алфавитных символов в поле, предназначенное для ввода числовых данных.
В примере ниже демонстрируется модуль на языке JavaScript, реализующий такого рода фильтрацию. Он отыскивает элементы <input type=text> с дополнительным (нестандартным) атрибутом data-allowed-chars. Регистрирует обработчики событий textinput, textInput и keypress для всех найденных элементов и ограничивает возможность ввода символами регулярного выражения, заданным в атрибуте data-allowed-chars:
/* Фильтрация ввода для элементов <input>
Этот модуль отыскивает все элементы <input type="text"> в документе, имеющие
атрибут "data-allowed-chars". Регистрирует обработчики событий keypress, textinput
и textInput для этих элементов, чтобы ограничить набор допустимых для ввода символов,
чтобы разрешить вводить только символы, указанные в атрибуте. Если элемент <input>
также имеет атрибут "data-messageid", значение этого атрибута интерпретируется как id
другого элемента документа. Если пользователь вводит недопустимый символ, элемент
с указанным id делается видимым. Если пользователь вводит допустимый символ, элемент
с сообщением скрывается. Данный элемент с сообщением предназначается для вывода
пояснений, почему ввод пользователя был отвергнут. Его оформление необходимо
реализовать с помощью CSS так, чтобы изначально он был невидим.
*/
whenReady(function () { // Вызовет эту функцию, когда документ будет загружен
// Отыскать все элементы <input>
var inputelts = document.getElementsByTagName("input");
// Обойти их в цикле
for(var i = 0 ; i < inputelts.length; i++)
{
var elt = inputelts[i];
// Пропустить элементы, не являющиеся текстовыми полями ввода
// и не имеющие атрибута data-allowed-chars
if (elt.type != "text" || !elt.getAttribute("data-allowed-chars")) continue;
// Зарегистрировать наш обработчик события в этом элементе input
// keypress старое событие и реализовано во всех браузерах.
// textInput поддерживается в Safari и Chrome с 2010 года.
// textinput версия проекта стандарта "DOM Level 3 Events".
if (elt.addEventListener) {
elt.addEventListener("keypress", filter, false);
elt.addEventListener("textInput", filter, false);
elt.addEventListener("textinput", filter, false);
}
// textinput не поддерживается версиями IE, в которых не реализован
// метод addEventListener()
else {
elt.attachEvent("onkeypress", filter);
}
}
// Обработчик событий keypress и textInput, фильтрующий ввод пользователя
function filter(event) {
// Получить объект события и целевой элемент target
var e = event || window.event; // Модель стандартная или IE
var target = e.target || e.srcElement; // Модель стандартная или IE
var text = null; // Введенный текст
// Получить введенный символ или текст
if (e.type === "textinput" || e.type === "textInput")
text = e.data;
else { // Это было событие keypress
// Введенный печатаемый символ в Firefox сохраняется в свойстве charCode
var code = e.charCode || e.keyCode;
// Если была нажата какая либо функциональная клавиша, не фильтровать ее
if (code < 32 || // Управляющий символ ASCII
e.charCode == 0 || // Функциональная клавиша (в Firefox)
e.ctrlKey || e.altKey) // Удерживаемая клавиша-модификатор
return; // Не фильтровать это событие
// Преобразовать код символа в строку
var text = String.fromCharCode(code);
}
// Отыскать необходимую нам информацию в этом элементе input
var allowed = target.getAttribute("data-allowed-chars"); // Допустимые символы
var messageid = target.getAttribute("data-messageid"); // Сообщение id
if (messageid) // Если указано значение id, получить элемент
var messageElement = document.getElementById(messageid);
// Обойти в цикле символы во введенном тексте
for(var i = 0; i < text.length; i++)
{
var c = text.charAt(i);
allowed = new RegExp(allowed, "i"); // Создаем регулярное выражение
if (c.search(allowed) == -1) { // Недопустимый символ?
// Отобразить элемент с сообщением, если указан
if (messageElement) messageElement.style.visibility="visible";
// Отменить действия по умолчанию, чтобы предотвратить вставку текста
if (e.preventDefault) e.preventDefault();
if (e.returnValue) e.returnValue = false;
return false;
}
}
// Если все символы оказались допустимыми, скрыть элемент
// с сообщением, если он был указан
if (messageElement) messageElement.style.visibility = "hidden";
}
});
Ниже показан образец разметки HTML, использующей этот модуль:
<form action="#">
<p><i>Пожалуйста, заполните форму.</i></p>
<fieldset>
<legend>Контактная информация</legend>
<label for="name">Имя</label>
<input id="name" data-allowed-chars="[a-zа-я]" data-messageid="name_valid">
<span id="name_valid" style="color:red;visibility:hidden;margin-left:10px;">Только буквы</span><br>
<label for="telephone">Телефон</label>
<input id="telephone" data-allowed-chars="\d" data-messageid="tel_valid">
<span id="tel_valid" style="color:red;visibility:hidden;margin-left:10px;">Только цифры</span><br>
<label for="email">Email</label>
<input id="email" data-allowed-chars="(\w|\.|\-)+|@" data-messageid="email_valid">
<span id="email_valid" style="color:red;visibility:hidden;margin-left:10px;">Некорректный email</span><br>
</fieldset>
</form>
На рисунке ниже показано использование этой формы. Здесь после ввода имени я вставил цифру, которая была автоматически заблокирована и появилось предупреждающее сообщение:
События keypress и textinput генерируются непосредственно перед фактической вставкой нового текста в элемент документа, обладающий фокусом ввода, благодаря чему обработчики этих событий могут предотвратить вставку текста, отменив событие.
Браузеры также реализуют событие input, которое возбуждается после вставки текста в элемент. Это событие нельзя отменить и соответствующий ему объект события не содержит информации о вставленном тексте - оно просто извещает о том, что текстовое содержимое элемента изменилось. Если, к примеру, потребуется обеспечить ввод только символов в верхнем регистре, можно определить обработчик события input, как показано ниже:
<input id="name" oninput="this.value = this.value.toUpperCase()">
Событие input стандартизовано в спецификации HTML5 и поддерживается всеми современными браузерами, кроме IE. Похожего эффекта в IE можно добиться, обнаруживая изменение значения свойства value текстового элемента ввода с помощью нестандартного события propertychange.
События клавиатуры
События keydown и keyup возбуждаются, когда пользователь нажимает или отпускает клавишу на клавиатуре. Они генерируются для клавиш-модификаторов, функциональных клавиш и алфавитно-цифровых клавиш. Если пользователь удерживает клавишу нажатой настолько долго, что включается режим автоповтора, будет сгенерировано множество событий keydown, прежде чем появится событие keyup.
Объект события, соответствующий этим событиям, имеет свойство keyCode с числовым значением, которое определяет нажатую клавишу. Для клавиш, генерирующих печатаемые символы, в общем случае свойство keyCode содержит кодовый пункт Юникода, соответствующий основному символу, изображенному на клавише. Клавиши с буквами всегда генерируют значения keyCode, соответствующие символам в верхнем регистре, независимо от состояния клавиши Shift, поскольку именно такие символы изображены на клавишах.
Аналогично цифровые клавиши всегда генерируют значения keyCode, соответствующие цифровым символам, изображенным на клавишах, даже если при этом вы удерживали нажатой клавишу Shift, чтобы ввести знак препинания. Для клавиш, не соответствующих печатаемым символам, свойство keyCode будет иметь некоторое другое значение. Эти значения свойства keyCode никогда не были стандартизованы. Однако в разных браузерах они отличаются не настолько сильно, чтобы нельзя было обеспечить переносимость.
Подобно объектам событий мыши, объекты событий клавиатуры имеют свойства altKey, ctrlKey, metaKey и shiftKey, которые получают значение true, если в момент возникновения события удерживалась нажатой соответствующая клавиша-модификатор.
События keydown и keyup, а также свойство keyCode используются уже более десяти лет, но они так и не были стандартизованы. Проект стандарта DOM Level 3 Events стандартизует типы keydown и keyup событий, но не стандартизует свойство keyCode. Вместо этого он определяет новое свойство key, которое должно содержать название клавиши в виде строки. Если клавиша соответствует печатаемому символу, свойство key должно содержать этот печатаемый символ. Для функциональных клавиш свойство key должно содержать такие значения, как F2, Home или Left.
На момент написания этих строк свойство key, определяемое стандартом DOM Level 3 Events, еще не было реализовано ни в одном из браузеров. Однако браузеры на базе механизма Webkit, Safari и Chrome определяют в объектах этих событий свойство keyIdentifier. Для функциональных клавиш, подобно свойству key, свойство keyIdentifier содержит не число, а строку с именем клавиши, таким как Shift или Enter. Для клавиш, соответствующих печатаемым символам, это свойство содержит менее удобное в использовании строковое представление кодового пункта Юникода символа. Например, клавише A соответствует значение U+0041.
В примере ниже определяется класс Keymap, который отображает идентификаторы комбинаций клавиш, такие как PageUp, Alt_Z и ctrl+alt+shift+F5 в функции на языке JavaScript, вызываемые в ответ на нажатия этих комбинаций. Определения привязок клавиш передаются конструктору Keymap() в форме объекта JavaScript, имена свойств которого соответствуют идентификаторам комбинаций клавиш, а значения этих свойств содержат ссылки на функции-обработчики. Добавление и удаление привязок осуществляется с помощью методов bind() и unbind().
Устанавливается объект Keymap в HTML-элемент (обычно в объект Document) с помощью метода install(). При установке объекта Keymap в этом элементе регистрируется обработчик события keydown. Каждый раз, когда нажимается клавиша, обработчик проверяет наличие функции, соответствующей этой комбинации. Если функция существует, она вызывается.
Обработчик события keydown использует свойство key, определяемое стандартом «DOM Level 3 Events», если оно существует. В противном случае он пытается использовать Webkit-свойство keyIdentifier. И как запасной вариант, обработчик использует нестандартное свойство keyCode:
// Функция конструктор
function Keymap(bindings) {
this.map = {}; // Определить отображение идентификатор->обработчик
if (bindings) {
// Скопировать в него начальную карту привязок
for(name in bindings)
this.bind(name, bindings[name]);
}
}
// Связывает указанный идентификатор клавиши с указанной функцией обработчиком
Keymap.prototype.bind = function(key, func) {
this.map[Keymap.normalize(key)] = func;
};
// Удаляет привязку для указанного идентификатора клавиши
Keymap.prototype.unbind = function(key) {
delete this.map[Keymap.normalize(key)];
};
// Устанавливает этот объект Keymap в указанный HTML-элемент
Keymap.prototype.install = function(element) {
var keymap = this;
// Определить функции обработчика события
function handler(event) { return keymap.dispatch(event, element); }
// Установить ее
if (element.addEventListener)
element.addEventListener("keydown", handler, false);
else if (element.attachEvent)
element.attachEvent("onkeydown", handler);
};
// Этот метод делегирует обработку события клавиатуры, опираясь на привязки
Keymap.prototype.dispatch = function(event, element) {
// Изначально нет ни имен клавиш-модификаторов, ни имени клавиши
var modifiers = "";
var keyname = null;
// Сконструировать строки модификаторов в каноническом виде из символов
// в нижнем регистре, расположив их в алфавитном порядке.
if (event.altKey) modifiers += "alt_";
if (event.ctrlKey) modifiers += "ctrl_";
if (event.metaKey) modifiers += "meta_";
if (event.shiftKey) modifiers += "shift_";
// Имя клавиши легко получить, если реализовано свойство key,
// определяемое стандартом DOM Level 3:
if (event.key)
keyname = event.key;
// Для получения имен функциональных клавиш в Safari и Chrome можно
// использовать свойство keyIdentifier
else
if(event.keyIdentifier && event.keyIdentifier.substring(0,2) !== "U+")
keyname = event.keyIdentifier;
// В противном случае можно использовать свойство keyCode
// и отображение код > имя ниже
else keyname = Keymap.keyCodeToKeyName[event.keyCode];
// Если имя клавиши не удалось определить, просто проигнорировать событие
// и вернуть управление.
if (!keyname) return;
// Канонический идентификатор клавиши состоит из имен модификаторов
// и имени клавиши в нижнем регистре
var keyid = modifiers + keyname.toLowerCase();
// Проверить, имеется ли привязка для данного идентификатора клавиши
var handler = this.map[keyid];
if (handler) { // Если обработчик для данной клавиши, вызвать его
// Вызвать функцию обработчик
var retval = handler.call(element, event, keyid);
// Если обработчик вернул false, отменить действия по умолчанию
// и прервать всплытие события
if (retval === false) {
if (event.stopPropagation)
event.stopPropagation(); // модель DOM
else event.cancelBubble = true; // модель IE
if (event.preventDefault)
event.preventDefault(); // DOM
else event.returnValue = false; // IE
}
// Вернуть значение, полученное от обработчика
return retval;
}
};
// Вспомогательная функция преобразования идентификатора клавиши в каноническую форму.
// Нам необходимо преобразовать идентификатор "meta" в "ctrl", чтобы превратить
// идентификатор Meta-C в "Command-C" на компьютерах Mac и в "Ctrl-C" на всех остальных.
Keymap.normalize = function(keyid) {
keyid = keyid.toLowerCase(); // В нижний регистр
var words = keyid.split(/\s+|[\-+_]/); // Вычленить модификаторы
var keyname = words.pop(); // keyname - последнее слово
keyname = Keymap.aliases[keyname] || keyname; // Это псевдоним?
words.sort(); // Сортировать модификаторы
words.push(keyname); // Поместить обратно нормализованное имя
return words.join("_"); // Объединить все вместе
}
Keymap.aliases = {
// Отображение привычных псевдонимов клавиш в их
// "официальные" имена, используемые в DOM Level 3, и отображение кодов клавиш
// в имена ниже. Имя и значение должны состоять только из символов нижнего регистра
"escape":"esc",
"return":"enter",
"delete":"del",
"ctrl":"control",
"space":"spacebar",
"ins":"insert"
};
// Старое свойство keyCode объекта события keydown не стандартизовано
// Но следующие значения с успехом могут использоваться в большинстве браузеров и ОС.
Keymap.keyCodeToKeyName = {
// Клавиши со словами или стрелками на них
8:"Backspace", 9:"Tab", 13:"Enter", 16:"Shift", 17:"Control", 18:"Alt", 19:"Pause",
20:"CapsLock", 27:"Esc", 32:"Spacebar", 33:"PageUp", 34:"PageDown", 35:"End",
36:"Home", 37:"Left", 38:"Up", 39:"Right", 40:"Down", 45:"Insert", 46:"Del",
// Цифровые клавиши на основной клавиатуре (не на дополнительной)
48:"0",49:"1",50:"2",51:"3",52:"4",53:"5",54:"6",55:"7",56:"8",57:"9",
// Буквенные клавиши. Обратите внимание, что здесь не различаются
// символы верхнего и нижнего регистров
65:"A", 66:"B", 67:"C", 68:"D", 69:"E", 70:"F", 71:"G", 72:"H", 73:"I",
74:"J", 75:"K", 76:"L", 77:"M", 78:"N", 79:"O", 80:"P", 81:"Q", 82:"R",
83:"S", 84:"T", 85:"U", 86:"V", 87:"W", 88:"X", 89:"Y", 90:"Z",
// Цифровые клавиши на дополнительной клавиатуре и клавиши со знаками препинания.
// (Не поддерживаются в Opera.)
96:"0",97:"1",98:"2",99:"3",100:"4",101:"5",102:"6",103:"7",104:"8",
105:"9",106:"Multiply", 107:"Add", 109:"Subtract", 110:"Decimal", 111:"Divide",
// Функциональные клавиши
112:"F1", 113:"F2", 114:"F3", 115:"F4", 116:"F5", 117:"F6", 118:"F7", 119:"F8",
120:"F9", 121:"F10", 122:"F11", 123:"F12", 124:"F13", 125:"F14", 126:"F15",
127:"F16", 128:"F17", 129:"F18", 130:"F19", 131:"F20", 132:"F21",
133:"F22", 134:"F23", 135:"F24",
// Клавиши со знаками препинания, для ввода которых не требуется
// удерживать нажатой клавишу Shift.
// Дефис не может использоваться переносимым способом: FF возвращает
// тот же код, что и для клавиши Subtract
59:";", 61:"=", 186:";", 187:"=", // Firefox и Opera возвращают 59,61
188:",", 190:".", 191:"/", 192:"`", 219:"[", 220:"\\", 221:"]", 222:"'"
};
Ниже показан пример использования объекта Keymap:
window.onload = function() {
var keymap = new Keymap; // Создать новый объект Keymap
keymap.bind("ctrl+a", // Комбинация Ctrl+A
function(event, keyid) {
alert("Вы нажали: " + keyid)
});
// Еще одна привязка Ctrl + Enter
keymap.bind("ctrl+enter",
function(event, keyid) {
alert("Вы нажали: " + keyid)
});
keymap.install(document.body); // Устанавливаем объект Keymap для всего документа
};