1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
|
// Copyright 2009 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @fileoverview Action event wrapper implementation.
* @author eae@google.com (Emil A Eklund)
*/
goog.provide('goog.events.actionEventWrapper');
goog.require('goog.a11y.aria');
goog.require('goog.a11y.aria.Role');
goog.require('goog.dom');
goog.require('goog.events');
/** @suppress {extraRequire} */
goog.require('goog.events.EventHandler');
goog.require('goog.events.EventType');
goog.require('goog.events.EventWrapper');
goog.require('goog.events.KeyCodes');
goog.require('goog.userAgent');
/**
* Event wrapper for action handling. Fires when an element is activated either
* by clicking it or by focusing it and pressing Enter.
*
* @constructor
* @implements {goog.events.EventWrapper}
* @private
*/
goog.events.ActionEventWrapper_ = function() {};
/**
* @interface
* @private
*/
goog.events.ActionEventWrapper_.FunctionExtension_ = function() {};
/** @type {!Object|undefined} */
goog.events.ActionEventWrapper_.FunctionExtension_.prototype.scope_;
/** @type {function(?):?|{handleEvent:function(?):?}|null} */
goog.events.ActionEventWrapper_.FunctionExtension_.prototype.listener_;
/**
* Singleton instance of ActionEventWrapper_.
* @type {goog.events.ActionEventWrapper_}
*/
goog.events.actionEventWrapper = new goog.events.ActionEventWrapper_();
/**
* Event types used by the wrapper.
*
* @type {Array<goog.events.EventType>}
* @private
*/
goog.events.ActionEventWrapper_.EVENT_TYPES_ = [
goog.events.EventType.CLICK,
goog.userAgent.GECKO ? goog.events.EventType.KEYPRESS :
goog.events.EventType.KEYDOWN,
goog.events.EventType.KEYUP
];
/**
* Adds an event listener using the wrapper on a DOM Node or an object that has
* implemented {@link goog.events.EventTarget}. A listener can only be added
* once to an object.
*
* @param {goog.events.ListenableType} target The target to listen to events on.
* @param {function(?):?|{handleEvent:function(?):?}|null} listener Callback
* method, or an object with a handleEvent function.
* @param {boolean=} opt_capt Whether to fire in capture phase (defaults to
* false).
* @param {Object=} opt_scope Element in whose scope to call the listener.
* @param {goog.events.EventHandler=} opt_eventHandler Event handler to add
* listener to.
* @override
*/
goog.events.ActionEventWrapper_.prototype.listen = function(
target, listener, opt_capt, opt_scope, opt_eventHandler) {
var callback = function(e) {
var listenerFn = goog.events.wrapListener(listener);
var role = goog.dom.isElement(e.target) ?
goog.a11y.aria.getRole(/** @type {!Element} */ (e.target)) :
null;
if (e.type == goog.events.EventType.CLICK && e.isMouseActionButton()) {
listenerFn.call(opt_scope, e);
} else if (
(e.keyCode == goog.events.KeyCodes.ENTER ||
e.keyCode == goog.events.KeyCodes.MAC_ENTER) &&
e.type != goog.events.EventType.KEYUP) {
// convert keydown to keypress for backward compatibility.
e.type = goog.events.EventType.KEYPRESS;
listenerFn.call(opt_scope, e);
} else if (
e.keyCode == goog.events.KeyCodes.SPACE &&
e.type == goog.events.EventType.KEYUP &&
(role == goog.a11y.aria.Role.BUTTON ||
role == goog.a11y.aria.Role.TAB)) {
listenerFn.call(opt_scope, e);
e.preventDefault();
}
};
callback.listener_ = listener;
callback.scope_ = opt_scope;
if (opt_eventHandler) {
opt_eventHandler.listen(
target, goog.events.ActionEventWrapper_.EVENT_TYPES_, callback,
opt_capt);
} else {
goog.events.listen(
target, goog.events.ActionEventWrapper_.EVENT_TYPES_, callback,
opt_capt);
}
};
/**
* Removes an event listener added using goog.events.EventWrapper.listen.
*
* @param {goog.events.ListenableType} target The node to remove listener from.
* @param {function(?):?|{handleEvent:function(?):?}|null} listener Callback
* method, or an object with a handleEvent function.
* @param {boolean=} opt_capt Whether to fire in capture phase (defaults to
* false).
* @param {Object=} opt_scope Element in whose scope to call the listener.
* @param {goog.events.EventHandler=} opt_eventHandler Event handler to remove
* listener from.
* @override
*/
goog.events.ActionEventWrapper_.prototype.unlisten = function(
target, listener, opt_capt, opt_scope, opt_eventHandler) {
for (var type, j = 0; type = goog.events.ActionEventWrapper_.EVENT_TYPES_[j];
j++) {
var listeners = goog.events.getListeners(target, type, !!opt_capt);
for (var obj, i = 0; obj = listeners[i]; i++) {
var objListener =
/** @type {!goog.events.ActionEventWrapper_.FunctionExtension_} */ (
obj.listener);
if (objListener.listener_ == listener &&
objListener.scope_ == opt_scope) {
if (opt_eventHandler) {
opt_eventHandler.unlisten(
target, type, obj.listener, opt_capt, opt_scope);
} else {
goog.events.unlisten(target, type, obj.listener, opt_capt, opt_scope);
}
break;
}
}
}
};
|